ne
node-easywechat2
npm i node-easywechat2
Deprecated!
Please use node-easywechat instead, see: https://github.com/hpyer/node-easywechat/issues/7
ne

node-easywechat2

EasyWechat for Node.js

by Hpyer

2.6.2 (see all)License:MITTypeScript:Not Found
npm i node-easywechat2
Readme

EasyWechat for Node.js

!!!注:node-easywechat2 的包废弃了,请使用node-easywechat代替!!!

!!!注:node-easywechat2 的包废弃了,请使用node-easywechat代替!!!

!!!注:node-easywechat2 的包废弃了,请使用node-easywechat代替!!!

Build Status npm License

注:2.x分支针对 EasyWechat 的 5.x版本(由于4.x与5.x的结构基本一致,就不升级大版本了)。若您需要 EasyWechat 的 3.x版本,请切换到 1.x 分支。

EasyWechat 是一个由 安正超 大神用 PHP 开发的开源的微信非官方 SDK。其功能强大,使用方便,个人一直很喜欢,所以近日将其在 Node.js 上实现。本人会尽量还原其配置项以及接口的调用方式,但毕竟语言环境不同,具体的实现方式会有些许差别,还请各位开发者见谅。

注:虽然也使用了 EasyWechat 这个名称,但是和 安正超 大神没有任何关系,请各位开发者不要因使用本包产生的疑惑而去打扰大神,如有疑问请在本项目中提 issue,谢谢~

安装

npm install -S node-easywechat2

使用说明

绝大部分API都可以根据 EasyWechat 的文档 来使用。小部分(如获取请求相关数据、返回响应数据、支付证书等)的操作,由于语言环境的不同,会有不同处理。具体可以查看 node-easywechat-demo 以及下方的自定义模块说明 。如果仍有疑问,请提issue,谢谢~

// 公众号
let officialAccount = new EasyWechat.Factory.OfficialAccount({
  // ...
});

// 小程序
let miniProgram = new EasyWechat.Factory.MiniProgram({
  // ...
});

// 微信支付
let payment = new EasyWechat.Factory.Payment({
  // ...
});

// 微信支付
let openPlatform = new EasyWechat.Factory.OpenPlatform({
  // ...
});

// 企业微信
let openPlatform = new EasyWechat.Factory.Work({
  // ...
});

// 通用方式
let app = EasyWechat.Factory.getInstance('OficialAccount', {
  // ...
});

配置项示例

// 公众号配置
{
  // 微信公众号的 app key
  app_id: '',
  // 微信公众号的 app secret
  secret: '',
  // 微信公众号的 token
  token: '',
  // EncodingAESKey
  aes_key: '',

  // 缓存以文件(默认设置)存储时,需要的配置项
  file_cache: {
    path: './cache/', // 文件存储目录(请确保该目录有读写权限)
    fileMode: 0o666,  // 文件权限
    ext: '.cache'     // 文件扩展名
  },
  // 自定义缓存驱动
  // 您需要实现一个继承 EasyWechat.CacheInterface 的缓存驱动类
  // 实例化以后利用 “模块替换” 功能赋值给 app.cache

  // 网页授权认证
  oauth: {
    // 网页授权类型
    scope: 'snsapi_userinfo',
    // 网页授权回调地址,完整的URL
    redirect: 'http://node-easywechat.hpyer.cn/wxlogin/callback'
  }
}
// 微信支付配置
{
  // 应用的 app_id
  app_id: 'xxx',
  // 商户号
  mch_id: 'your-mch-id',
  // 签名密钥
  key: 'key-for-signature',
  // 默认回调地址,也可以在下单时单独设置来覆盖它,完整URL,不带参数
  notify_url: 'http://xxx.com/pay/notify',
  // 证书地址,Node.js 只需要 .pfx 证书文件即可
  cert_path: 'path/to/your/cert.pfx', // XXX: 绝对路径!!!!
}
// 小程序配置
{
  // appId
  app_id: 'your-app-id',
  // appSecret
  secret: 'your-app-secret'
}
// 企业微信配置
{
  // corpId
  corp_id: 'your-corp-id',
  // agentId
  agent_id: 'your-agent-id',
  // appSecret
  secret: 'your-app-secret'
}

模块支持情况

  • 公众号模块
  • 微信支付
  • 小程序
  • 开放平台
  • 企业微信
  • 企业微信开放平台
  • 小微商户
  • 自定义

自定义模块(模块替换)使用方法

使用自定义模块的主要目的,是为了消除不同框架、不同软件包的使用方法所带来的差异,以提升 node-easywechat 的使用效率。下面就来说说几个主要模块的自定义方法。

日志模块(log)
// 创建实例
const Easywechat = require('node-easywechat2');
let officialAccount = new Easywechat.Factory.OfficialAccount({
  ...
});

// 自定义日志处理方法
const myLogger = () => {
  // 注意:这里返回的方法不能使用箭头函数,否则会导致获取到的 arguments 异常
  // 若需要关闭日志,则返回空的函数即可
  return function() {
    let args = arguments;
    args[0] = 'myLogger: ' + args[0];
    return console.log.apply(null, arguments);
  }
}

// 使用 rebind 方法,将 myLogger 绑定为 log 模块
officialAccount.rebind('log', myLogger);
请求模块(request)
// request 模块需实例化 EasyWechat.Http.Request 类
// 实例化时,需要传入 IncomingMessage 实例
let request = new EasyWechat.Http.Request(req);

// 当然,由于 IncomingMessage 的 body 流的特殊性,某些框架(目前已知:fastify)
// 可能会自动读取后挂载到上下文中,从而导致 node-easywechat 去尝试读取时报错。
// 这时可以选择传入第二个参数,即post的内容
// 支持 Buffer、object对象、JSON字符串、XML字符串、QueryString格式的POST内容字符串
let request = new EasyWechat.Http.Request(req, content);

// 若此法方法仍不能满足你的需求,可以选择继承 EasyWechat.Http.Request 类,
// 并重写其中相关的方法
// 参考:https://github.com/hpyer/node-easywechat/issues/5

// 使用 rebind 方法,绑定 request 实例
officialAccount.rebind('request', request);
缓存模块(cache)
// cache 模块需要您继承并实例化 EasyWechat.CacheInterface 接口
// 以 redis 为例
const Redis = require('redis');
const BlueBird = require('bluebird');

BlueBird.promisifyAll(Redis.RedisClient.prototype);
BlueBird.promisifyAll(Redis.Multi.prototype);

class RedisCache extends EasyWechat.CacheInterface
{
  constructor (options)
  {
    super();

    this.$client = null;
    try {
      this.$client = Redis.createClient(options);
    }
    catch (e) {
      console.log('无法创建Redis客户端', e);
    }
  }

  async get(id)
  {
    if (!this.$client) return false;
    let content = null;
    try {
      content = JSON.parse(await this.$client.getAsync(id));
    }
    catch (e) {
      console.log('获取Redis缓存失败', id, e);
      return false;
    }
    return content;
  }

  async has(id)
  {
    if (!this.$client) return false;
    try {
      let res = await this.$client.existsAsync(id);
      return res == 1;
    }
    catch (e) {
      return false;
    }
  }

  async set(id, data = null, lifeTime = 0)
  {
    if (!this.$client) return false;
    try {
      if (lifeTime > 0) {
        await this.$client.setAsync(id, JSON.stringify(data), 'EX', lifeTime);
      }
      else {
        await this.$client.setAsync(id, JSON.stringify(data));
      }
    }
    catch (e) {
      console.log('设置Redis缓存失败', id, data, e);
      return false;
    }
    return true;
  }

  async delete(id)
  {
    if (!this.$client) return false;
    try {
      let res = await this.$client.delAsync(id);
      return true;
    }
    catch (e) {
      return false;
    }
  }
}
let redisCache = new RedisCache(req);

// 使用 rebind 方法,绑定 cache 实例
officialAccount.rebind('cache', redisCache);

Downloads/wk

1

GitHub Stars

65

LAST COMMIT

3mos ago

MAINTAINERS

1

CONTRIBUTORS

4

OPEN ISSUES

0

OPEN PRs

0
VersionTagPublished
2.6.2
latest
1yr ago
No alternatives found
No tutorials found
Add a tutorial