wechat_gate

WechatGate

微信公眾平台開發函式庫

支援的介面:

• access_token(後端API使用)
• 使用者授權資訊取得(OAuth2)
• JS-SDK
• 回覆訊息封裝
• 選單介面
• 素材介面

功能特點:

• 自動管理access_token和JS-SDK的ticket刷新和過期
• 多微信公眾號支持
• 多環境支援(development, production)，方便本地測試
• Controler和helper方法(微信session管理等等)
• 介面簡單，方便客製

使用影片教學: 微信公眾號開發

Installation

Add this line to your application's Gemfile:

 gem 'wechat-gate'

And then execute:

 $ bundle

Or install it yourself as:

 $ gem install wechat-gate

公眾號

在開工之前你需要在微信公眾帳號平台做以下設定:

1. 開通你的公眾號碼（服務號碼），並開通微信認證（300元認證服務費）
2. 在公眾號後台「公眾號設定」 － 「功能設定」中設定你的JS介面安全域名，就是你的公眾號所調用的網站的域名
3. 在「介面權限」－ 「網頁授權取得使用者基本資料」中設定你的授權回呼頁面域名，這個用於OAuth2的回呼域名認證
4. 在「基本配置」中查看並配置你的AppID和AppSecret

配置

在Rails專案config目錄下建立檔案wechat.yml，並配置你的公眾號資訊.

 # 区分不同的环境
eggman:
  development:
    host: http://wechat-test1.eggman.tv

    wechat_id: xxxxxxxxxx
    app_id: xxxxxxxxxx
    app_secret: xxxxxxxxxx

    oauth2_redirect_uri: "http://wechat-test1.eggman.tv/wechat/users/callback"

    push_url: "http://wechat-test1.eggman.tv/wechat/push"
    push_token: xxxxxxxxxxxxxxxxxxxx
  production:
    host: https://eggman.tv

    wechat_id: xxxxxxxxxx
    app_id: xxxxxxxxxxxxxxxxxxxx
    app_secret: xxxxxxxxxxxxxxxxxxxxxxxxxx

# 如果不需要多环境支持，也可以这样
app_name:
  app_id: <%= ENV['WECHAT_APP_NAME_APP_ID'] %>
  app_secret: <%= ENV['WECHAT_APP_NAME_APP_SECRET'] %>
  oauth2_redirect_uri: <%= ENV['WECHAT_APP_NAME_OAUTH2_REDIRECT_URI'] %>

然後在ApplicationController中指定目前要讀取的公眾號名稱：

 self.wechat_gate_app_name = 'eggman'

後端調用

後台API操作(例如微信用戶資訊取得等等操作)。

預設在controller中已經初始化了配置，方法為wechat_gate_config ，直接使用就行。

 wechat_gate_config . users # 获取用户列表
wechat_gate_config . user ( 'ONE_OPEN_ID' ) # 获取一个用户的详细信息
wechat_gate_config . access_token # 获取当前access_token

# OAuth 2
wechat_gate_config . oauth2_entrance_url ( scope : "snsapi_userinfo" , state : "CURENT_STATE" ) # 获取当前OAuth2授权入口URL
wechat_gate_config . oauth2_access_token ( "TOKEN" ) # 根据OAuth2返回的TOKEN获取access_token
wechat_gate_config . oauth2_user ( "ACCESS_TOKEN" , "ONE_OPEN_ID" ) # 获取一个用户的信息

wechat_gate_config . medias # 获取素材列表, 参数type: image | video | voice | news (图文)

wechat_gate_config . menu_get # 获取菜单
wechat_gate_config . menu_create ( MENU_HASH ) # 创建菜单

wechat_gate_config . generate_js_request_params ( REFERER_URL ) # 返回JS-SDK的验证参数，供前端JS-SDK使用

當然你也可以手動來初始化配置，甚至指定設定檔的路徑：

 config = WechatGate::Config.new('eggman', '/path/to/what/ever/you/want.yml')

access_token和JS_SDK中ticket都有過期時間和刷新次數限制，這裡已經考慮了，你可以不用管，如果你想手工刷新，可以這樣:

 config.refresh_access_token
config.refresh_jsapi_ticket

設定檔支援erb

更多介面和文件請直接看源碼，寫的很詳細

JS-SDK

  def ticket
    url = CGI . unescape ( params [ :url ] ) # 微信中用户访问的页面
    @data = wechat_gate_config . generate_js_request_params ( url ) # 生成微信JS-SDK所需的jsapi_ticket，signature等等参数供前段js使用
    render content_type : "application/javascript"
  end

ticket.js.erb:

 var wxServerConfig = <%= @data.to_json.html_safe %>;
<%= params[:callback] %>();

然後在微信端頁面引入以下程式碼:

 ( function ( ) {
  var ticket = document . createElement ( "script" ) ;
  ticket . src = "http://localhost/api/wechat_ticket/ticket.js?url=" + encodeURIComponent ( window . location . href . split ( '#' ) [ 0 ] ) + "&callback=wxCallback" ;
  var s = document . getElementsByTagName ( "script" ) [ 0 ] ;
  s . parentNode . insertBefore ( ticket , s ) ;
} ) ( ) ; 

其他功能

自訂選單

首先設定選單設定文件，config/wechat_menu.yml，支援erb，格式請參考微信自訂選單文件:

 button:
  - type: view
    name: 我的2
    url: <%= @config.oauth2_entrance_url(scope: 'snsapi_userinfo', state: 'profile') %>
  - type: view
    name: 课程
    sub_button:
      - type: view
        name: 免费课程
        url:  <%= @config.oauth2_entrance_url(scope: 'snsapi_userinfo', state: 'free') %>
      - type: view
        name: 付费课程
        url:  <%= @config.oauth2_entrance_url(scope: 'snsapi_userinfo', state: 'paid') %>

其中的**@config**變數為目前微信公眾號實例，請不要修改，直接使用

然後執行rake任務:

 $rails wechat_gate:create_menu APP_NAME=eggman CONFIG=/path/to/wechat.yml MENU=/path/to/wechat_menu.yml

其中，CONFIG預設為config/wechat.yml，MENU預設為config/wechat_menu.yml，APP_NAME必須指定

TODO

添加測試