wechat-oauth
微信公共平台OAuth接口消息接口服务中间件与API SDK
模块状态
功能列表
- OAuth授权
- 获取基本信息
OAuth2.0网页授权,使用此接口须通过微信认证,如果用户在微信中(Web微信除外)访问公众号的第三方网页,公众号开发者可以通过此接口获取当前用户基本信息(包括昵称、性别、城市、国家)。详见:官方文档
详细参见API文档
Installation
$ npm install wechat-oauth
Usage
初始化
引入OAuth并实例化
var OAuth = ;var client = 'your appid' 'your secret';
以上即可满足单进程使用。 当多进程时,token需要全局维护,以下为保存token的接口。
var oauthApi = 'appid' 'secret' { // 传入一个根据openid获取对应的全局token的方法 // 在getUser时会通过该方法来获取token fs;} { // 请将token存储到全局,跨进程、跨机器级别的全局,比如写到数据库、redis等 // 这样才能在cluster模式及多机情况下使用,以下为写入到文件的示例 // 持久化时请注意,每个openid都对应一个唯一的token! fs;};
附上全局维护AccessToken的示例代码:
Mongodb|mongoose
var TokenSchema =access_token: Stringexpires_in: Numberrefresh_token: Stringopenid: Stringscope: Stringcreate_at: String;
自定义getToken方法
TokenSchemastatics { this;};
自定义saveToken方法
TokenSchemastatics { // 有则更新,无则添加 var query = openid: openid; var options = upsert: true; this;}; mongoose;
初始化:
var client = appid secret { // 传入一个根据openid获取对应的全局token的方法 // 在getUser时会通过该方法来获取token Token;} { // 持久化时请注意,每个openid都对应一个唯一的token! Token;};
MySQL:
建表SQL
( `access_token` varchar(200) COLLATE utf8_bin NOT NULL COMMENT '令牌', `expires_in` varchar(10) COLLATE utf8_bin NOT NULL COMMENT '有效期', `refresh_token` varchar(200) COLLATE utf8_bin NOT NULL COMMENT '刷新参数', `openid` varchar(50) COLLATE utf8_bin NOT NULL COMMENT '用户编号', `scope` varchar(50) COLLATE utf8_bin NOT NULL COMMENT '作用域', `create_at` varchar(20) COLLATE utf8_bin NOT NULL COMMENT '令牌建立时间') ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='微信令牌表';
设置openid为唯一索引
`token` ADD UNIQUE KEY `openid` (`openid`);
使用示例:
var client = appid secret { var sql = 'SELECT * FROM token WHERE openid = ?'; db;} { var sql = 'REPLACE INTO token(access_token, expires_in, refresh_token, openid, scope, create_at) VALUES(?, ?, ?, ?, ?, ?)'; var fields = tokenaccess_token tokenexpires_in tokenrefresh_token tokenopenid tokenscope tokencreate_at; db;};
小程序初始化
使用小程序时,需要在初始化OAuth时指定isMiniProgram
参数为true
单进程
var OAuth = ;var client = 'your appid' 'your secret' null null true; // 最后一个参数即isMiniProgram
多进程
var oauthApi = 'appid' 'secret' getToken saveToken true;
注意:微信不会将用户的sessionKey过期时间告知开发者,该时间会根据用户与小程序互动频繁程度等因素发生变化,建议根据小程序客户端wx.checkSession()
方法检验凭证是否依旧有效,若失效应该再次使用code换取新的sessionKey。故而此例中的getToken
和saveToken
方法过期机制须有不同。
官方文档
引导用户
生成引导用户点击的URL。
var url = client;
如果是PC上的网页,请使用以下方式生成
var url = client;
获取Openid和AccessToken
用户点击上步生成的URL后会被重定向到上步设置的 redirectUrl
,并且会带有code
参数,我们可以使用这个code
换取access_token
和用户的openid
client;
获取用户信息
如果我们生成引导用户点击的URL中scope
参数值为snsapi_userinfo
,接下来我们就可以使用openid
换取用户详细信息(必须在getAccessToken方法执行完成之后)
client;
捐赠
如果您觉得Wechat OAuth对您有帮助,欢迎请作者一杯咖啡
交流群
QQ群:157964097,使用疑问,开发,贡献代码请加群。
Contributors
感谢以下贡献者:
$ git summary
project : wechat-oauth
repo age : 2 years, 2 months
active : 13 days
commits : 29
files : 11
authors :
24 Jackson Tian 82.8%
1 Kainy Guo 3.4%
1 Teng Fei 3.4%
1 cherry-geqi 3.4%
1 welch 3.4%
1 wzw 3.4%
License
The MIT license.