node package manager

wechat-oauth

wechat-oauth

微信公共平台OAuth接口消息接口服务中间件与API SDK

模块状态

  • NPM version
  • Build Status
  • Dependencies Status
  • Coverage Status

功能列表

  • OAuth授权
  • 获取基本信息

OAuth2.0网页授权，使用此接口须通过微信认证，如果用户在微信中（Web微信除外）访问公众号的第三方网页，公众号开发者可以通过此接口获取当前用户基本信息（包括昵称、性别、城市、国家）。详见：官方文档

详细参见API文档

Installation

$ npm install wechat-oauth

Usage

初始化

引入OAuth并实例化

var OAuth = require('wechat-oauth');
var client = new OAuth('your appid', 'your secret');

以上即可满足单进程使用。 当多进程时，token需要全局维护，以下为保存token的接口。

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

var TokenSchema = new Schema({
  access_token: String,
  expires_in: Number,
  refresh_token: String,
  openid: String,
  scope: String,
  create_at: String
});

自定义getToken方法

TokenSchema.statics.getToken = function (openid, cb) {
  this.findOne({openid:openid}, function (err, result) {
    if (err) throw err;
    return cb(null, result);
  });
};

自定义saveToken方法

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');

初始化：

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

CREATE TABLE `token` (
  `access_token` varchar(107) COLLATE utf8_bin NOT NULL COMMENT '令牌',
  `expires_in` varchar(10) COLLATE utf8_bin NOT NULL COMMENT '有效期',
  `refresh_token` varchar(107) COLLATE utf8_bin NOT NULL COMMENT '刷新参数',
  `openid` varchar(28) 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为唯一索引

ALTER TABLE `token`
  ADD UNIQUE KEY `openid` (`openid`);

使用示例：

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);
  });
});

引导用户

生成引导用户点击的URL。

var url = client.getAuthorizeURL('redirectUrl', 'state', 'scope');

如果是PC上的网页，请使用以下方式生成

var url = client.getAuthorizeURLForWebsite('redirectUrl');

获取Openid和AccessToken

用户点击上步生成的URL后会被重定向到上步设置的 redirectUrl，并且会带有code参数，我们可以使用这个code换取access_token和用户的openid

client.getAccessToken('code', function (err, result) {
  var accessToken = result.data.access_token;
  var openid = result.data.openid;
});

获取用户信息

如果我们生成引导用户点击的URL中scope参数值为snsapi_userinfo，接下来我们就可以使用openid换取用户详细信息（必须在getAccessToken方法执行完成之后）

client.getUser(openid, function (err, result) {
  var userInfo = result;
});

捐赠

如果您觉得Wechat OAuth对您有帮助，欢迎请作者一杯咖啡

捐赠wechat

或者

交流群

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.

We ♥ your boss

Selectively mirror the npm registry inside your firewall. Filter packages based on security, licensing, code quality and more. Build awesome stuff faster. Try npm Enterprise for free…

how? learn more

Collaborators list

Stats

Try it out

Keywords

weixin, wechat

Dependencies (1)

urllib

Dependents (27)

wechat-cards, tutu-backend, gears_node_application, nlfw, passport-wechat, momiwpi, think-wechatservice, carlover-react, passport-wechat2, nodenie, passport-wx, wxoauth-express, wechat-wrap, niefengjun, niefeng, passport-wechat-oa, maodou-h5, moa-plugin-wechat, passport-wechat-niu, passport-wechat-public, passport-wechat-sails-auth, moa-api, think-wechatService, wechat-component, transfar_weixin, wechat-nodejs-sdk, dora-wechat-oauth