Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/node-webot/wechat-oauth
Wechat OAuth
https://github.com/node-webot/wechat-oauth
Last synced: 3 days ago
JSON representation
Wechat OAuth
- Host: GitHub
- URL: https://github.com/node-webot/wechat-oauth
- Owner: node-webot
- License: other
- Created: 2014-11-25T12:19:18.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2022-02-11T09:18:21.000Z (over 2 years ago)
- Last Synced: 2024-10-31T11:18:48.314Z (11 days ago)
- Language: JavaScript
- Size: 236 KB
- Stars: 805
- Watchers: 54
- Forks: 138
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: MIT-License
Awesome Lists containing this project
README
wechat-oauth
===============
微信公共平台OAuth接口消息接口服务中间件与API SDK
## 模块状态
- [](http://badge.fury.io/js/wechat-oauth)
- [](https://travis-ci.org/node-webot/wechat-oauth)
- [](https://david-dm.org/node-webot/wechat-oauth)
- [](https://coveralls.io/r/node-webot/wechat-oauth)
## 功能列表
- OAuth授权
- 获取基本信息
OAuth2.0网页授权，使用此接口须通过微信认证，如果用户在微信中（Web微信除外）访问公众号的第三方网页，公众号开发者可以通过此接口获取当前用户基本信息（包括昵称、性别、城市、国家）。详见：[官方文档](http://mp.weixin.qq.com/wiki/index.php?title=网页授权获取用户基本信息)
详细参见[API文档](http://doxmate.cool/node-webot/wechat-oauth/api.html)
## Installation
```sh
$ npm install wechat-oauth
```
## Usage
### 初始化
引入OAuth并实例化
```js
var OAuth = require('wechat-oauth');
var client = new OAuth('your appid', 'your secret');
```
以上即可满足单进程使用。
当多进程时，token需要全局维护，以下为保存token的接口。
```js
var oauthApi = new OAuth('appid', 'secret', function (openid, callback) {
// 传入一个根据openid获取对应的全局token的方法
// 在getUser时会通过该方法来获取token
fs.readFile(openid +':access_token.txt', 'utf8', function (err, txt) {
if (err) {return callback(err);}
callback(null, JSON.parse(txt));
});
}, function (openid, token, callback) {
// 请将token存储到全局，跨进程、跨机器级别的全局，比如写到数据库、redis等
// 这样才能在cluster模式及多机情况下使用，以下为写入到文件的示例
// 持久化时请注意，每个openid都对应一个唯一的token!
fs.writeFile(openid + ':access_token.txt', JSON.stringify(token), callback);
});
```
附上全局维护AccessToken的示例代码：
Mongodb|mongoose
``` js
var TokenSchema = new Schema({
access_token: String,
expires_in: Number,
refresh_token: String,
openid: String,
scope: String,
create_at: String
});
```
自定义getToken方法
```js
TokenSchema.statics.getToken = function (openid, cb) {
this.findOne({openid:openid}, function (err, result) {
if (err) throw err;
return cb(null, result);
});
};
```
自定义saveToken方法
```js
TokenSchema.statics.setToken = function (openid, token, cb) {
// 有则更新，无则添加
var query = {openid: openid};
var options = {upsert: true};
this.update(query, token, options, function (err, result) {
if (err) throw err;
return cb(null);
});
};
mongoose.model('Token', 'TokenSchema');
```
初始化：
```js
var client = new OAuth(appid, secret, function (openid, callback) {
// 传入一个根据openid获取对应的全局token的方法
// 在getUser时会通过该方法来获取token
Token.getToken(openid, callback);
}, function (openid, token, callback) {
// 持久化时请注意，每个openid都对应一个唯一的token!
Token.setToken(openid, token, callback);
});
```
MySQL:
建表SQL
```sql
CREATE TABLE `token` (
`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为唯一索引
```sql
ALTER TABLE `token`
ADD UNIQUE KEY `openid` (`openid`);
```
使用示例：
```js
var client = new Oauth(appid, secret, function (openid, callback) {
var sql = 'SELECT * FROM token WHERE openid = ?';
db.query(sql, [openid], function (err, result) {
if(err) {
return callback(err);
}
return callback(null, result[0]);
});
}, function (openid, token, callback) {
var sql = 'REPLACE INTO token(access_token, expires_in, refresh_token, openid, scope, create_at) VALUES(?, ?, ?, ?, ?, ?)';
var fields = [token.access_token, token.expires_in, token.refresh_token, token.openid, token.scope, token.create_at];
db.query(sql, fields, function (err, result) {
return callback(err);
});
});
```
### 小程序初始化
使用小程序时，需要在初始化OAuth时指定`isMiniProgram`参数为`true`
单进程
```js
var OAuth = require('wechat-oauth');
var client = new OAuth('your appid', 'your secret', null, null, true); // 最后一个参数即isMiniProgram
```
多进程
```js
var oauthApi = new OAuth('appid', 'secret', getToken, saveToken, true);
```
注意：微信不会将用户的sessionKey过期时间告知开发者，该时间会根据用户与小程序互动频繁程度等因素发生变化，建议根据小程序客户端`wx.checkSession()`方法检验凭证是否依旧有效，若失效应该再次使用code换取新的sessionKey。故而此例中的`getToken`和`saveToken`方法过期机制须有不同。
[官方文档](https://developers.weixin.qq.com/miniprogram/dev/api/signature.html)
### 引导用户
生成引导用户点击的URL。
```js
var url = client.getAuthorizeURL('redirectUrl', 'state', 'scope');
```
如果是PC上的网页，请使用以下方式生成
```js
var url = client.getAuthorizeURLForWebsite('redirectUrl');
```
### 获取Openid和AccessToken
用户点击上步生成的URL后会被重定向到上步设置的 `redirectUrl`，并且会带有`code`参数，我们可以使用这个`code`换取`access_token`和用户的`openid`
```js
client.getAccessToken('code', function (err, result) {
var accessToken = result.data.access_token;
var openid = result.data.openid;
});
```
### 获取用户信息
如果我们生成引导用户点击的URL中`scope`参数值为`snsapi_userinfo`，接下来我们就可以使用`openid`换取用户详细信息（必须在getAccessToken方法执行完成之后）
```js
client.getUser(openid, function (err, result) {
var userInfo = result;
});
```
## 捐赠
如果您觉得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.