{"id":22433760,"url":"https://github.com/gavinning/wechatautologin","last_synced_at":"2025-03-27T07:46:11.667Z","repository":{"id":147923498,"uuid":"419666864","full_name":"gavinning/WechatAutologin","owner":"gavinning","description":"关注微信号自动登录、Redis缓存策略循环利用未过期二维码，突破每日10万限制","archived":false,"fork":false,"pushed_at":"2021-10-25T13:19:18.000Z","size":187,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-01T12:46:40.580Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gavinning.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-10-21T09:49:57.000Z","updated_at":"2022-10-09T11:55:21.000Z","dependencies_parsed_at":"2023-05-02T02:16:23.010Z","dependency_job_id":null,"html_url":"https://github.com/gavinning/WechatAutologin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gavinning%2FWechatAutologin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gavinning%2FWechatAutologin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gavinning%2FWechatAutologin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gavinning%2FWechatAutologin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gavinning","download_url":"https://codeload.github.com/gavinning/WechatAutologin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245806390,"owners_count":20675296,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-05T22:15:49.973Z","updated_at":"2025-03-27T07:46:11.661Z","avatar_url":"https://github.com/gavinning.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 微信公众号关注并自动登录\n\n* 生成微信公众号带参二维码\n* 二维码自动缓存复用，突破每日10万限制\n* 支持公众号其他通用消息处理\n\n### 安装使用\n```sh\nnpm i @4a/wechat\nyarn add @4a/wechat\n```\n```ts\nimport Wechat from '@4a/wechat'\n// Or\nimport { Wechat } from '@4a/wechat'\n\nexport new Wechat(opt: Options)\n```\n初始化参数 **Options**\n```ts\n/**\n * 初始化参数\n * @param appId 公众号appid\n * @param appSecret 公众号secret\n * @param appToken 公众号token\n * @param safemode 安全模式，默认为false，建议为false\n * @param encodingAesKey 安全模式下加密信息\n * @param debug debug模式会打印一些调试信息\n * @param redis ioredis实例\n * @param qrcodeTimeout 二维码有效期，默认22天，涉及到二维码复用缓存策略，如非必要不建议调整\n * @param accessTokenTimeout 公众号token缓存时间，默认100分钟\n * @param MsgAdapterFactory 公众号通用消息处理工厂函数，返回:tnwx.MsgAdapter\n */\nexport interface Options {\n    appId: string;\n    appSecret: string;\n    appToken: string;\n    msgAdapter: MsgAdapter;\n    safemode?: boolean;\n    encodingAesKey?: string;\n    debug?: boolean;\n    redis: Redis;\n    qrcodeTimeout?: number;\n    accessTokenTimeout?: number;\n    MsgAdapterFactory: (wechat: Wechat) =\u003e MsgAdapter;\n}\n```\n方法集合 **Methods**\n```ts\nexport declare class Wechat {\n    /**\n     * 微信公众号消息聚合处理，包含认证和通用消息处理\n     * 根据请求类型自动调用(authHandler | messageHandler)\n     */\n    wechatRequestHandler(ctx: Context): Promise\u003cstring\u003e;\n    /**\n     * 处理微信公众号认证请求\n     */\n    authHandler(ctx: Context): string;\n    /**\n     * 微信公众号消息通用处理，仅处理消息，不处理认证\n     */\n    messageHandler(ctx: Context): Promise\u003cstring\u003e;\n    /**\n     * 获取闲置微信公众号带参二维码\n     */\n    getFreeWechatQrcode(): Promise\u003c{ scene_id: string; url: string; }\u003e;\n    /**\n     * 清零二维码作业状态，重置为闲置状态\n     */\n    closeQrcodeWorking(scene_id: string): void;\n    /**\n     * 获取微信公众号AccessToken，缓存默认有效期100分钟\n     * 优先从缓存获取，缓存失效则从微信获取，推荐使用此方法\n     */\n    getAccessToken(): Promise\u003cimport(\"./config\").AccessTokenPayload\u003e;\n    /**\n     * 注意！请勿频繁调用此方法，微信有调用数量限制\n     * 从微信获取微信公众号AccessToken，不经过缓存，不处理缓存\n     * 除非知道自己在做什么，否则推荐调用`getAccessToken`方法\n     */\n    getAccessTokenFromWechat(): Promise\u003cimport(\"./config\").AccessTokenPayload\u003e;\n    /**\n     * 从缓存中查询微信公众号带参二维码元数据\n     * @param scene_id 场景id，Redis缓存key必须\n     */\n    getQrcodeFromRedis(scene_id: string): Promise\u003cvoid | import(\"./config\").QrcodePayload\u003e;\n}\n```\n\n### 缓存策略\n* `Redis`内有两个二维码集合，一个Hash\n    * `Free`集合：用于存放闲置二维码\n    * `Loading`集合：用于存放作业二维码\n    * `Hash`：用于存放二维码元数据\n* 当前端请求二维码时，使用`SPOP`命令从`Free`集合中取出一个闲置二维码\n    1. 当前端调用`closeQrcode`接口时，**作业二维码清零**\n    2. 当检查到二维码完成当前作业时，**作业二维码清零**\n* 每次请求二维码时检查集合过期时间，集合过期时间是二维码过期时间的一半 + 截止到当天晚上23点30分\n* 如果集合过期，则清理所有集合和Hash，重建缓存逻辑（防止二维码大量过期导致前端服务异常）\n\u003cbr /\u003e\n\u003cbr /\u003e\n\n\u003e **作业二维码清零，重置为闲置二维码：**  \n\u003e 使用`SMOVE`命令把目标二维码从`Loading`集合移动到`Free`集合，完成清零操作\n\n\u003cbr /\u003e\n\n### 占用的 Redis Keys\n```sh\n# 微信公众号access_token Key\nMod:@4a/wechat:accessToken:{AppId}\n\n    example:\n        Mod:@4a/wechat:accessToken:wx1234\n\n\n# 闲置二维码集合Key @Set\nMod:@4a/wechat:qrcodes:free\n\n# 作业中二维码集合Key @Set\nMod:@4a/wechat:qrcodes:loading\n\n# 二维码集合过期时间Key @String\nMod:@4a/wechat:qrcodes:cleanKey\n\n# 二维码元数据存储 @Hash\nMod:@4a/wechat:qrcodes:hash\n\n    Key: SceneId\n    example: HGET Mod:@4a/wechat:qrcodes:hash {SceneId}\n\n```\n\n### 鸣谢\n感谢开源优秀作品[`tnwx`](https://gitee.com/javen205/TNWX)提供支持\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgavinning%2Fwechatautologin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgavinning%2Fwechatautologin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgavinning%2Fwechatautologin/lists"}