wechat jssdk下載 - wechat jssdk源碼下載

wechat-jssdk

微信JSSDK與NodeJS及Web端整合WeChat JS-SDK integration with NodeJS and Web.

English | Release Notes

主要功能

?服務端
?瀏覽器端
?OAuth網頁授權
?微信卡券
?微信支付
?微信小程式
?使用Stores
?完整Demo

使用方法

npm install wechat-jssdk --save
# 或者
yarn add wechat-jssdk

 const { Wechat } = require ( 'wechat-jssdk' ) ;
const wx = new Wechat ( wechatConfig ) ;

Wechat 配置項

wechatConfig為以下格式:

 {
  //第一个为设置网页授权回调地址
  wechatRedirectUrl : "http://yourdomain.com/wechat/oauth-callback" , 
  wechatToken : "xxx" , //第一次在微信控制台保存开发者配置信息时使用
  appId : "xxx" ,
  appSecret : "xxx" ,
  card : true , //开启卡券支持，默认关闭
  payment : true , //开启支付支持，默认关闭
  merchantId : '' , //商户ID
  paymentSandBox : true , //沙箱模式，验收用例
  paymentKey : '' , //必传，验签密钥，TIP:获取沙箱密钥也需要真实的密钥，所以即使在沙箱模式下，真实验签密钥也需要传入。
  //pfx 证书
  paymentCertificatePfx : fs . readFileSync ( path . join ( process . cwd ( ) , 'cert/apiclient_cert.p12' ) ) ,
  //默认微信支付通知地址
  paymentNotifyUrl : `http://your.domain.com/api/wechat/payment/` ,
  //小程序配置
  "miniProgram" : {
    "appId" : "mp_appid" ,
    "appSecret" : "mp_app_secret" ,
  }
}

其他支援的設定都有預設值，基本上都是微信API的位址，且基本上不會改變, 可以查看./lib/config.js .

設定微信環境

1.去微信公眾平台

下載類似MP_verify_XHZon7GAGRdcAFxx.txt這樣的檔案放到網站根目錄, 如http://yourdomain.com/MP_verify_XHZon7GAGRdcAFxx.txt ，微信會驗證這個連結.

2.然後在你的express/koa app中提供一個介面給瀏覽器取得驗證資訊, @see demo

 //express app:
router . get ( '/get-signature' , ( req , res ) => {
  wx . jssdk . getSignature ( req . query . url ) . then ( signatureData => {
    res . json ( signatureData ) ;
  } ) ;
} ) ;
//koa2/koa-router app:
router . get ( '/get-signature' , async ctx => {
  ctx . body = await wx . jssdk . getSignature ( ctx . request . query . url ) ;
} ) ;

3.取得簽章後，進入下一步瀏覽器端使用方法.

瀏覽器端

 const WechatJSSDK = require ( 'wechat-jssdk/dist/client.umd' ) ;
//ES6 import
import WechatJSSDK from 'wechat-jssdk/dist/client.umd' ;

//没有打包的话直接script扔到html，然后从`window`获取, e.g:
const wechatObj = new window . WechatJSSDK ( config )

config應該為:

 const config = {
  //前4个是微信验证签名必须的参数，第2-4个参数为类似上面 '/get-signature' 从node端获取的结果
  'appId' : 'xxx' ,
  'nonceStr' : 'xxx' ,
  'signature' : 'xxx' ,
  'timestamp' : 'xxx' ,
  //下面为可选参数
  'debug' : true , //开启 debug 模式
  'jsApiList' : [ ] , //设置所有想要使用的微信jsapi列表, 默认值为 ['updateAppMessageShareData','updateTimelineShareData','onMenuShareTimeline', 'onMenuShareAppMessage']，分享到朋友圈及聊天记录
  'customUrl' : '' //自定义微信js链接
}
const wechatObj = new WechatJSSDK ( config ) ;
wechatObj . initialize ( )
  . then ( w => {
    //set up your share info, "w" is the same instance as "wechatObj"
  } )
  . catch ( err => {
    console . error ( err ) ;
  } ) ;

驗證簽名成功後, 就可以自訂你的分享內容了:

sdk預設只註冊了updateAppMessageShareData ， updateTimelineShareData ， onMenuShareTimeline(wx即将废弃) ， onMenuShareAppMessage(wx即将废弃)

 //自定义分享到聊天窗口
//内部调用 `wechatObj.callWechatApi('updateAppMessageShareData', {...})`， 语法糖而已
wechatObj . updateAppMessageShareData ( {
  type : 'link' ,
  title : 'title' ,
  link : location . href ,
  imgUrl : '/logo.png' ,
  desc : 'description' ,
  success : function ( ) { } ,
  fail : function ( ) { } ,
  complete : function ( ) { } ,
  cancel : function ( ) { }
} ) ;
//自定义分享到朋友圈
//语法糖
wechatObj . updateTimelineShareData ( {
  type : 'link' ,
  title : 'title' ,
  link : location . href ,
  imgUrl : '/logo.png'
} ) ;

要取得原始的微信物件wx ，可以透過wechatObj.getOriginalWx()來取得。
如果第一次驗證失敗，可以在error回呼裡更新簽名訊息，並重新發送驗證請求：
wechatObj.signSignature(newSignatureConfig); , newSignatureConfig只需包含：

 {
  'nonceStr': 'xxx',
  'signature': 'xxx',
  'timestamp': 'xxx',
}

呼叫其他微信介面：
wechatObj.callWechatApi(apiName, apiConfig)
apiName和apiConfig請參考微信官方介面文檔

OAuth

預設產生微信授權URL為wx.oauth.snsUserInfoUrl和wx.oauth.snsUserBaseUrl ，其中的預設回呼URL為wechatConfig中配置的wechatRedirectUrl . 你也可以透過wx.oauth. generateOAuthUrl(customUrl, scope, state)可以透過呼叫wx.oauth.state.地址

 //callback url handler
//如"wechatRedirectUrl"配置为 "http://127.0.0.1/wechat/oauth-callback", 你的路由需要为：
router . get ( '/wechat/oauth-callback' , function ( req , res ) {
  //得到code，获取用户信息
  wx . oauth . getUserInfo ( req . query . code )
          . then ( function ( userProfile ) {
            console . log ( userProfile )
            res . render ( "demo" , {
              wechatInfo : userProfile
            } ) ;
          } ) ;
} ) ;

TIP: 確保上面的重定向位址網域已經在微信裡的授權回呼位址設定裡設定過。

微信卡券

在wechatConfig設定card: true來支援卡券功能的服務端支援, 參考demo.
要查看卡券APIs, 參考cards apis

微信支付

在wechatConfig設定payment: true來支援微信支付功能的服務端支援, 其他一些支付必須的配置也需要一同設定.
參考demo.
要查看支付APIs, 參考payment apis

小程式

使用小程式的服務端支援(看介面), 在設定裡設定小程式的appId和appSecret :

 const { Wechat , MiniProgram } = require ( 'wechat-jssdk' ) ;
const wechatConfig = {
  "appId" : "appid" ,
  "appSecret" : "app_secret" ,
  //...other configs
  //...
  //小程序配置
  "miniProgram" : {
    "appId" : "mp_appid" ,
    "appSecret" : "mp_app_secret" ,
  }
} ;
const wx = new Wechat ( wechatConfig ) ;
//调用小程序接口
wx . miniProgram . getSession ( 'code' ) ;

//手动实例化 MiniProgram
const miniProgram = new MiniProgram ( {
  miniProgram : {
    "appId" : "mp_appid" ,
    "appSecret" : "mp_app_secret" ,
  }
} )

使用Stores

Store用來自訂儲存token持久化(如文件，資料庫等待)，實作自己的Store, 請查看API
自帶Store: FileStore , MongoStore ，預設為FileStore , 儲存到wechat-info.json檔.

APIs

查看API wiki

Demo

在v3.1.0後，demo頁面增加卡券和付款的用例測試， Copy demo/wechat-config-sample.js到demo/wechat-config.js ,
然後在裡面裡面修改appId , appSecret , 及其他的配置如支付的其他配置如果需要使用支付功能的話.

在./demo/index.js中設定你自己的appId , appSecret ，然後npm start或npm run dev , 使用微信開發者工具測試。