@ddn/egg-wechat 1.0.24 → 1.0.25

package/app/service/wechat/component.js

@@ -3,33 +3,93 @@
 const Service = require('egg').Service;
 
 class ComponentService extends Service {
-  
+
+  get wechatConfig() {
+    return this.app.config.wechat || {};
+  }
+
+  /**
+   * Redis Key 策略：
+   * - scoped（默认）：key 中包含 componentAppId，适合多应用隔离
+   * - legacy：兼容历史项目（如 ddn-hub）使用的固定 key
+   */
+  get redisKeyStrategy() {
+    return this.wechatConfig.redisKeyStrategy || 'scoped';
+  }
+
+  get authUrlReturnObject() {
+    return Boolean(this.wechatConfig.authUrlReturnObject);
+  }
+
+  _assertComponentConfig() {
+    const { componentAppId, componentAppSecret } = this.wechatConfig;
+    if (!componentAppId || !componentAppSecret) {
+      throw new Error('未配置微信开放平台 Component AppID 或 Secret');
+    }
+  }
+
+  _getKeyComponentAccessToken(componentAppId) {
+    if (this.redisKeyStrategy === 'legacy') return 'wechat:component:access_token';
+    return `wechat:component_access_token:${componentAppId}`;
+  }
+
+  _getKeyComponentVerifyTicket(componentAppId) {
+    if (this.redisKeyStrategy === 'legacy') return 'wechat:component:verify_ticket';
+    return `wechat:component_verify_ticket:${componentAppId}`;
+  }
+
+  _getKeyPreAuthCode(componentAppId) {
+    if (this.redisKeyStrategy === 'legacy') return 'wechat:component:pre_auth_code';
+    return `wechat:component_preauth_code:${componentAppId}`;
+  }
+
+  _getKeyAuthorizerAccessToken(authorizerAppId) {
+    if (this.redisKeyStrategy === 'legacy') return `wechat:authorizer:${authorizerAppId}:access_token`;
+    return `wechat:authorizer_access_token:${authorizerAppId}`;
+  }
+
+  async getComponentVerifyTicket() {
+    const { app } = this;
+    const { componentAppId } = this.wechatConfig;
+    this._assertComponentConfig();
+
+    const primaryKey = this._getKeyComponentVerifyTicket(componentAppId);
+    const ticket = await app.redis.get(primaryKey);
+    if (ticket) return ticket;
+
+    // 兼容旧 key（历史项目可能写入该 key）
+    const legacyCompat = await app.redis.get('wechat:component:ticket');
+    if (legacyCompat) return legacyCompat;
+
+    throw new Error('未收到微信推送的 Component Verify Ticket，请等待微信服务器推送');
+  }
+
   /**
    * 获取 Component Access Token
    * 优先从 Redis 获取，过期则刷新
    */
   async getComponentAccessToken() {
     const { ctx, app } = this;
-    const { componentAppId, componentAppSecret } = app.config.wechat;
-    
-    if (!componentAppId || !componentAppSecret) {
-      throw new Error('未配置微信开放平台 Component AppID 或 Secret');
-    }
+    const { componentAppId, componentAppSecret } = this.wechatConfig;
+
+    this._assertComponentConfig();
 
-    const cacheKey = `wechat:component_access_token:${componentAppId}`;
+    const cacheKey = this._getKeyComponentAccessToken(componentAppId);
     let token = await app.redis.get(cacheKey);
 
+    // 兼容策略切换：当从 scoped 切到 legacy（或反向）时，兜底尝试另一个 key
+    if (!token) {
+      const fallbackKey = this.redisKeyStrategy === 'legacy'
+        ? `wechat:component_access_token:${componentAppId}`
+        : 'wechat:component:access_token';
+      token = await app.redis.get(fallbackKey);
+    }
+
     if (token) {
       return token;
     }
 
-    // 获取 Component Verify Ticket
-    const ticketKey = `wechat:component_verify_ticket:${componentAppId}`;
-    const ticket = await app.redis.get(ticketKey);
-
-    if (!ticket) {
-      throw new Error('未收到微信推送的 Component Verify Ticket，请等待微信服务器推送');
-    }
+    const ticket = await this.getComponentVerifyTicket();
 
     // 请求微信接口获取 Token
     const url = 'https://api.weixin.qq.com/cgi-bin/component/api_component_token';
@@ -40,8 +100,8 @@ class ComponentService extends Service {
       data: {
         component_appid: componentAppId,
         component_appsecret: componentAppSecret,
-        component_verify_ticket: ticket
-      }
+        component_verify_ticket: ticket,
+      },
     });
 
     if (result.data.errcode) {
@@ -52,7 +112,15 @@ class ComponentService extends Service {
     const expiresIn = result.data.expires_in;
 
     // 缓存 Token (提前 5 分钟过期)
-    await app.redis.set(cacheKey, token, 'EX', expiresIn - 300);
+    const ttl = Math.max(Number(expiresIn || 7200) - 300, 60);
+    await app.redis.set(cacheKey, token, 'EX', ttl);
+
+    // legacy / scoped 兼容：同时写入兼容 key，避免灰度期间读取不到
+    if (this.redisKeyStrategy === 'legacy') {
+      await app.redis.set(`wechat:component_access_token:${componentAppId}`, token, 'EX', ttl);
+    } else {
+      await app.redis.set('wechat:component:access_token', token, 'EX', ttl);
+    }
 
     return token;
   }
@@ -63,16 +131,23 @@ class ComponentService extends Service {
    */
   async saveComponentVerifyTicket(ticket) {
     const { app } = this;
-    const { componentAppId } = app.config.wechat;
-    
+    const { componentAppId } = this.wechatConfig;
+
     if (!componentAppId) return;
 
-    const key = `wechat:component_verify_ticket:${componentAppId}`;
+    const key = this._getKeyComponentVerifyTicket(componentAppId);
     // Ticket 有效期通常为 12 小时，这里设置 12 小时过期
     await app.redis.set(key, ticket, 'EX', 12 * 3600);
-    
+
     // 兼容旧的 Redis Key
     await app.redis.set('wechat:component:ticket', ticket, 'EX', 12 * 3600);
+
+    // legacy / scoped 兼容：同时写入兼容 key，避免灰度期间读取不到
+    if (this.redisKeyStrategy === 'legacy') {
+      await app.redis.set(`wechat:component_verify_ticket:${componentAppId}`, ticket, 'EX', 12 * 3600);
+    } else {
+      await app.redis.set('wechat:component:verify_ticket', ticket, 'EX', 12 * 3600);
+    }
   }
 
   /**
@@ -80,25 +155,112 @@ class ComponentService extends Service {
    */
   async getPreAuthCode() {
     const { ctx, app } = this;
-    const { componentAppId } = app.config.wechat;
-    
+    const { componentAppId } = this.wechatConfig;
+
+    const cacheKey = this._getKeyPreAuthCode(componentAppId);
+    let cached = await app.redis.get(cacheKey);
+    if (!cached) {
+      const fallbackKey = this.redisKeyStrategy === 'legacy'
+        ? `wechat:component_preauth_code:${componentAppId}`
+        : 'wechat:component:pre_auth_code';
+      cached = await app.redis.get(fallbackKey);
+    }
+    if (cached) return cached;
+
     const token = await this.getComponentAccessToken();
-    
+
     const url = `https://api.weixin.qq.com/cgi-bin/component/api_create_preauthcode?component_access_token=${token}`;
     const result = await ctx.curl(url, {
       method: 'POST',
       contentType: 'json',
       dataType: 'json',
       data: {
-        component_appid: componentAppId
-      }
+        component_appid: componentAppId,
+      },
     });
 
     if (result.data.errcode) {
       throw new Error(`获取预授权码失败: ${result.data.errmsg}`);
     }
 
-    return result.data.pre_auth_code;
+    const preAuthCode = result.data.pre_auth_code;
+    const expiresIn = Number(result.data.expires_in || 600);
+    const ttl = Math.max(expiresIn - 30, 60);
+
+    await app.redis.set(cacheKey, preAuthCode, 'EX', ttl);
+
+    // legacy / scoped 兼容：同时写入兼容 key
+    if (this.redisKeyStrategy === 'legacy') {
+      await app.redis.set(`wechat:component_preauth_code:${componentAppId}`, preAuthCode, 'EX', ttl);
+    } else {
+      await app.redis.set('wechat:component:pre_auth_code', preAuthCode, 'EX', ttl);
+    }
+
+    return preAuthCode;
+  }
+
+  /**
+   * 获取授权方 authorizer_access_token（缓存）
+   * https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/api/api_authorizer_token.html
+   */
+  async getAuthorizerAccessToken(authorizerAppId, authorizerRefreshToken) {
+    const { ctx, app } = this;
+    this._assertComponentConfig();
+
+    if (!authorizerAppId) {
+      throw new Error('authorizerAppId is required');
+    }
+    if (!authorizerRefreshToken) {
+      throw new Error('authorizerRefreshToken is required');
+    }
+
+    const cacheKey = this._getKeyAuthorizerAccessToken(authorizerAppId);
+    let cached = await app.redis.get(cacheKey);
+    if (!cached) {
+      const fallbackKey = this.redisKeyStrategy === 'legacy'
+        ? `wechat:authorizer_access_token:${authorizerAppId}`
+        : `wechat:authorizer:${authorizerAppId}:access_token`;
+      cached = await app.redis.get(fallbackKey);
+    }
+    if (cached) {
+      return { authorizer_access_token: cached, from_cache: true };
+    }
+
+    const { componentAppId } = this.wechatConfig;
+    const componentAccessToken = await this.getComponentAccessToken();
+    const url = `https://api.weixin.qq.com/cgi-bin/component/api_authorizer_token?component_access_token=${encodeURIComponent(componentAccessToken)}`;
+
+    const result = await ctx.curl(url, {
+      method: 'POST',
+      contentType: 'json',
+      dataType: 'json',
+      data: {
+        component_appid: componentAppId,
+        authorizer_appid: authorizerAppId,
+        authorizer_refresh_token: authorizerRefreshToken,
+      },
+    });
+
+    const data = result.data || {};
+    if (data.errcode) {
+      throw new Error(`获取 authorizer_access_token 失败: ${data.errmsg}`);
+    }
+
+    const token = data.authorizer_access_token;
+    const expiresIn = Number(data.expires_in || 7200);
+    const ttl = Math.max(expiresIn - 300, 60);
+
+    if (token) {
+      await app.redis.set(cacheKey, token, 'EX', ttl);
+      // legacy / scoped 兼容：同时写入兼容 key
+      if (this.redisKeyStrategy === 'legacy') {
+        await app.redis.set(`wechat:authorizer_access_token:${authorizerAppId}`, token, 'EX', ttl);
+      } else {
+        await app.redis.set(`wechat:authorizer:${authorizerAppId}:access_token`, token, 'EX', ttl);
+      }
+    }
+
+    return data;
   }
 
   /**
@@ -111,15 +273,15 @@ class ComponentService extends Service {
 
     const token = await this.getComponentAccessToken();
     const url = `https://api.weixin.qq.com/cgi-bin/component/api_query_auth?component_access_token=${token}`;
-    
+
     const result = await ctx.curl(url, {
       method: 'POST',
       contentType: 'json',
       dataType: 'json',
       data: {
         component_appid: componentAppId,
-        authorization_code: authCode
-      }
+        authorization_code: authCode,
+      },
     });
 
     if (result.data.errcode) {
@@ -139,15 +301,15 @@ class ComponentService extends Service {
 
     const token = await this.getComponentAccessToken();
     const url = `https://api.weixin.qq.com/cgi-bin/component/api_get_authorizer_info?component_access_token=${token}`;
-    
+
     const result = await ctx.curl(url, {
       method: 'POST',
       contentType: 'json',
       dataType: 'json',
       data: {
         component_appid: componentAppId,
-        authorizer_appid: authorizerAppId
-      }
+        authorizer_appid: authorizerAppId,
+      },
     });
 
     if (result.data.errcode) {
@@ -166,7 +328,7 @@ class ComponentService extends Service {
   async sendCustomMessage(accessToken, toUser, content) {
     const { ctx } = this;
     const url = `https://api.weixin.qq.com/cgi-bin/message/custom/send?access_token=${accessToken}`;
-    
+
     const result = await ctx.curl(url, {
       method: 'POST',
       contentType: 'json',
@@ -175,9 +337,9 @@ class ComponentService extends Service {
         touser: toUser,
         msgtype: 'text',
         text: {
-          content: content
-        }
-      }
+          content,
+        },
+      },
     });
 
     return result.data;
@@ -203,12 +365,15 @@ class ComponentService extends Service {
    * @param {number} authType 授权类型 (1: 公众号, 2: 小程序, 3: 两者都可)
    */
   async getAuthUrl(redirectUri, authType = 3) {
-    const { app } = this;
-    const { componentAppId } = app.config.wechat;
+    const { componentAppId } = this.wechatConfig;
     const preAuthCode = await this.getPreAuthCode();
     const encodedRedirectUri = encodeURIComponent(redirectUri);
-    
-    return `https://mp.weixin.qq.com/cgi-bin/componentloginpage?component_appid=${componentAppId}&pre_auth_code=${preAuthCode}&redirect_uri=${encodedRedirectUri}&auth_type=${authType}`;
+
+    const url = `https://mp.weixin.qq.com/cgi-bin/componentloginpage?component_appid=${componentAppId}&pre_auth_code=${preAuthCode}&redirect_uri=${encodedRedirectUri}&auth_type=${authType}`;
+    if (this.authUrlReturnObject) {
+      return { pc: url, mobile: url };
+    }
+    return url;
   }
 }
 

package/app/service/wechat/mp.js

@@ -168,7 +168,7 @@ class MPService extends Service {
       nonce_str: service.wechat.sign.createNonceStr(),
       out_trade_no: data.tradeNo || new Date().getTime(), // 内部订单号
       total_fee: data.totalFee || 1, // 单位为分的标价金额
-      body: data.body || '未知产品-测试商品', // 应用市场上的APP名字-商品概述	
+      body: data.body || '未知产品-测试商品', // 应用市场上的APP名字-商品概述
       spbill_create_ip: ctx.ip, // 支付提交用户端ip
       notify_url: data.notifyUrl || '', // 异步接收微信支付结果通知
       trade_type: 'JSAPI',

package/app/service/wechat/wcs.js

@@ -27,8 +27,8 @@ class WCSService extends Service {
     } = this.app.config.wechat;
     const url = `${tokenUri}?grant_type=client_credential&appid=${appId}&secret=${appSecret}`;
     const res = await this.ctx.curl(url, jsonType);
-    if (res.data.errcode){
-      throw new Error(res.data.errmsg)
+    if (res.data.errcode) {
+      throw new Error(res.data.errmsg);
     }
     return res.data;
   }
@@ -42,8 +42,8 @@ class WCSService extends Service {
   async getTicket(token) {
     const url = `${ticketUri}?access_token=${token}&type=jsapi`;
     const res = await this.ctx.curl(url, jsonType);
-    if (res.data.errcode){
-      throw new Error(res.data.errmsg)
+    if (res.data.errcode) {
+      throw new Error(res.data.errmsg);
     }
     return res.data;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ddn/egg-wechat",
-  "version": "1.0.24",
+  "version": "1.0.25",
   "description": "Eggjs plugin for wechat",
   "types": "./index.d.ts",
   "eggPlugin": {
@@ -36,12 +36,12 @@
     "node": ">=8.0.0"
   },
   "scripts": {
-    "test": "npm run lint -- --fix && egg-bin pkgfiles && npm run test-local",
+    "test": "npm run lint -- --fix && npm run test-local",
     "test-local": "egg-bin test",
     "cov": "egg-bin cov",
     "lint": "eslint .",
-    "ci": "egg-bin pkgfiles --check && npm run lint && npm run cov",
-    "pkgfiles": "egg-bin pkgfiles",
+    "ci": "npm run lint && npm run cov",
+    "pkgfiles": "echo 'pkgfiles step skipped'",
     "autod": "autod"
   },
   "files": [