通用配置

Cache配置

PowerWeChat考虑到大家存在集群部署或者和其他应用环境共享Token令牌的需求，所以将在Config中提供了Cache配置。

我们提供了以下选择：

  1. 选择不配置。默认就会存储在程序的运行内存空间，重启之后需要重新获取。不推荐在生产环境使用。
  2. 选择配置到PowerWeChat实现redis，这样不同的实例能够共享一份缓存 (强烈推荐)
  3. 选择自定义Cache。用户可能需要自己实现Cache，例如实现db共享或者在别的服务已经提供了Token中控。

方式一、 默认程序内存

什么都不用配置。

方式二、powerwechat提供redis中控

我们找了一个企业微信的初始化代码代码作为参考。具体用法可以打开PowerWeChat Toturial。

  1. import (  
  2.  "github.com/ArtisanCloud/PowerWeChat/v3/src/kernel"  
  3.  "github.com/ArtisanCloud/PowerWeChat/v3/src/work"
  4.  "power-wechat-tutorial/config"
  5. )
  6. func NewWeComContactService(conf *config.Configuration) (*work.Work, error) {
  7.   app, err := work.NewWork(&work.UserConfig{
  8.     // ...
  9.     Cache: kernel.NewRedisClient(&kernel.UniversalOptions{
  10.       Addrs:     []string{"127.0.0.1:6379"},
  11.       Password: "",
  12.       DB:       0,
  13.     }),
  14.   })
  15.   return app, err
  16. }

参数配置基本上和go-redis是一样的。当前PowerWeChat走的是懒加载模式，也就是只有业务请求需要用到token了才会去加载刷新。

TIP

小提示，如果遇到了redis抛这出下面这种错误：

MISCONF Redis is configured to save RDB snapshots, but it is currently not able to persist on disk. Commands that may modify the data set are disabled, because this instance is configured to report errors during writes if RDB snapshotting fails (stop-writes-on-bgsave-error option). Please check the Redis logs for details about the RDB error

那么你可以进入到redis-cli里面，执行一下config set stop-writes-on-bgsave-error no。 参考链接：stackoverflow

方案三、自定义Cache

我们Cache字段接受CacheInterface 类型，只要将下面这些方法实现传给Cache即可。

  1. type CacheInterface interface {
  2.  Get(key string, defaultValue interface{}) (ptrValue interface{}, err error)
  3.  Set(key string, value interface{}, expires time.Duration) error
  4.  Has(key string) bool
  5.  AddNX(key string, value interface{}, ttl time.Duration) bool
  6.  Add(key string, value interface{}, ttl time.Duration) (err error)
  7.  Remember(key string, ttl time.Duration, callback func() interface{}) (obj interface{}, err error)
  8. }

在使用这个方案之前，我们先要通过流程图了解一下PowerWeChat的Cache工作机制。

PowerWeChat Cache Process

通过流程图我们可以看到，PowerWeChat每次都会执行Cache.Get，而Cache.Set只会在没有值的时候重新获取并设置。

这里已经可以满足两个以下自定义场景：

  1. Token刷新和获取都是PowerWeChat维护。使用者需要存储在其他地方，例如： mysql、postgresql、Memcached等，那么您将Cache.Get和Cache.Set两者都实现即可。
  2. Token获取和刷新是由别的程序维护，您只要实现Cache.Get操作逻辑即可，Cache.Set可以继续留空。

实现自定义Cache Key：

虽然目前我们只缓存了access_token，但未来我们可能会加入更多的一些数据到cache里

您需要保持统一的cache key算法，才能让PowerWeChat正确读取到cache中的数据，我们下面以缓存access_token为例：

  1. 使用appid和secret进行字符串拼接。例如: appid=testappid; secret=testsecret, 那么结果为: testappidtestsecret
  2. 计算字符串的md5。”testappidtestsecret” 的md5值为 “edc5f6181730baffc0b88cf96658aeff”
  3. 加上PowerWeChat前缀命名空间：”powerwechat.access_token.”
  4. 最终结果access_token的cache key为：”powerwechat.access_token.edc5f6181730baffc0b88cf96658aeff”

同时，cache value里面是一个json字符串：

  1. "{\"access_token\":\"X9a0AH0LhQCjgPi5_AY5HV2cQLPXngS0gmjLdn8Up_CZcsP6PFaod_xRVGhqVjgsYsERCJ0XNHR43i8VuLLnsyXwh2dxSna1Pj7KOdu5RBpq75SMpGTYfA5a3QlhJLiQ1hHa0vjuwi4KasRtGjHx3298Xdeo2mr7YmVQWhVfh7sQBwVpfAUxw7vTGN4QxXSyxKTxhINSGGT8O2SZOF1CHg\",\"expires_in\":7200}"
  3. // redis-cli 打印结果
  4. // ➜  ~ redis-cli
  5. // 127.0.0.1:6379> keys *
  6. // 1) "powerwechat.access_token.d41d8cd98f00b204e9800998ecf8427e"
  7. // 127.0.0.1:6379> get powerwechat.access_token.d41d8cd98f00b204e9800998ecf8427e
  8. // "{\"access_token\":\"X9a0AH0LhQCjgPi5_AY5HV2cQLPXngS0gmjLdn8Up_CZcsP6PFaod_xRVGhqVjgsYsERCJ0XNHR43i8VuLLnsyXwh2dxSna1Pj7KOdu5RBpq75SMpGTYfA5a3QlhJLiQ1hHa0vjuwi4KasRtGjHx3298Xdeo2mr7YmVQWhVfh7sQBwVpfAUxw7vTGN4QxXSyxKTxhINSGGT8O2SZOF1CHg\",\"expires_in\":7200}"

PowerWeChat当前会将access_token的cache value按照下面结构来解析，后面可能会扩展其他的字段：

  1. type T struct {
  2.     AccessToken string `json:"access_token"`
  3.     ExpiresIn   int    `json:"expires_in"`
  4. }

实现参考

我们已经实现了redis和memory两种cache模块，如果需要PowerWeChat来支持更多的类型，都可以与我们联系：

  1. memory
  2. redis