go wx gateway
1.0.0
go-wx-gateway是基於go-wx-api的實現的微信公眾號網關服務。go-wx-gateway是微信公眾號平台API介面的反向代理程序go-wx-gateway不是簡單地把微信公眾號API相關的資料進行傳遞，而是把它發送和接收的包做了拆包、打包的封裝， 使得go-wx-gateway反向代理後面的業務實現大大的簡化了go-wx-gateway運行後，透過http與後端業務服務通訊，任何支援http服務的語言都可以實現業務代碼。 
go-wx-gateway ，微信公眾號服務的開發就是普通的web服務開發go-wx-gatewaygo-wx-gateway統一接管， go-wx-gateway會把使用者資訊、選單state值轉送給選單處理服務go-wx-gateway處理網頁授權，公眾號也可以指向自己所需要的服務，然後把得到的code轉給go-wx-gateway換取訪問用戶的openId獲取完整的用戶資訊。該方式參考設定資訊"sns-auth2"。go-wx-gateway和業務代碼間使用HTTP傳輸數據，數據的格式為JSON。 前提：已經安裝go 1.11.x以上、git、make
進入任一資料夾，執行指令
$ git clone https://github.com/rosbit/go-wx-gateway
$ cd go-wx-gateway
$ make編譯成功，會得到wx-gateway的執行程式。可以執行./wx-gateway -v顯示程式資訊。
Linux的二進位版本可以直接進入releases下載
是一個JSON
例子，可以透過sample.conf.json進行修改:
{
"listen-host" : " " ,
"listen-port" : 7080 ,
"services" : [
{
"name" : "一个名字，随便取" ,
"workerNum" : 5 ,
"timeout" : 0 ,
"wx-params" : {
"token" : "开发/服务器配置中的Token " ,
"app-id" : "开发/公众号开发信息中的AppId " ,
"app-secret" : "开发/公众号开发信息中的AppSecret " ,
"aes-key" : "开发/服务器配置中的EncodingAESKey。如果是明文传输，则该串为空或null "
},
"listen-endpoints" : {
"service-path" : " /wx --开发/服务器配置/服务器地址中的路径部分" ,
"redirect-path" : " /redirect --这个是微信网页授权用到的，设置菜单时都用这个路径，可选"
},
"msg-proxy-pass" : " http://yourhost.or.ip.here --这个地址指向消息/事件处理的服务，如果不处理可以为空" ,
"redirect-url" : " http://yourhost.or.ip/path/to/redirect --完全转发http请求，响应将返回微信服务号，可选" ,
"redirect-userinfo-flag" : "如果通过 snsapi_userinfo 获取参数，在redrect-url中加上特殊字符串参数，用于区分，比如 login。如果为空，使用 snsapi_base 方式获取用户参数"
},
{
"name" : "如果有其它的公众号服务，可以参考上面的信息配置" ,
"注意" : " listen-endpoints中的路径 不能 相同" ,
"视频号小店支持" : "如果是视频号小店，加上 " is-channels-ec " : true 配置项，其中的 " msg-proxy-pass " 配置的是接收视频号小店推送的事件"
}
],
"token-cache-dir" : "缓存access的根路径，这是可选的配置" ,
"common-endpoints" : {
"health-check" : " /health --这是可选的配置，用于http健康检查，该路由配置成内部可访问" ,
"wx-qr" : " /qr --这是可选的路由配置，可以配置成内部可访问的，用于生成微信二维码链接" ,
"wx-qr的参数说明" : " s=<服务名,对应services中的name>&t=temp|forever[&sceneid=<场景id>][&e=<t为temp时的有效秒数>] " ,
"wx-user" : " /user --这是可选的路由配置，可以配置成内部可访问的，用于获取用户信息，参数:s=<服务名>&o=<openId> " ,
"sns-auth2" : " /sns-auth2 -- 这是可选的路由配置，如果网页授权由其它服务接收，可以通过网页授权参数code获取用户信息" ,
"sns-auth2参数说明" : " s=<服务名,对应services中的name>&code=<网页授权得到的code>&[scope=userinfo|base|snsapi_userinfo|snsn_api_base] " ,
"short-url" : " /short-url -- 这是可选的路由配置，用于把长url生成短链接。【注】微信已经停止该服务" ,
"short-url参数说明" : "访问方法POST, POST body: s=<服务名,对应services中的name>&u=<url编码的长URL> " ,
"tmpl-msg" : " /tmpl-msg -- 这是可选的路由配置，用于发送模版消息" ,
"tmpl-msg参数说明" : "访问方法POST, POST body是JSON " ,
"tmpl-msg body例子" : { "s" : "服务名,对应services中的name " , "to" : "用户openid " , "tid" : "模版id " , "url" : "可选，跳转url " , "mp" :{ "说明" : "可选的小程序参数" , "appid" : "小程序appid " , "pagepath" : "页面路径" }, "data" :{ "模版数据key" : "数据" , "数据key2" : " ... " }},
"sign-jsapi" : " /sign-jsapi -- 这是可选的路由配置，用于生产jsapi签名" ,
"sign-jsapi参数说明" : "访问方法POST, POST body: s=<service-name-in-conf>&u=<url-calling-jsapi-in-urlencoding>，结果会返回noncestr, timestamp, signature等结果" ,
"channels-ec-order-detail" : " /channles-ec-order-detail -- 可选，用于获取视频号小店订单详情" ,
"channels-ec-order-detail参数说明" : " s=<服务名,对应services中的name>&o=<订单id> " ,
"channels-ec-refund-detail" : " /channels-ec-refund-detail -- 可选，用于获取视频号小店售后单详情" ,
"channels-ec-refund-detail参数说明" : " s=<服务名,对应services中的name>&o=<售后订单id> " ,
},
"dont-append-userinfo" : " true|false, 各种消息事件是否不增加用户信息，缺省是false，表示追加"
}$ CONF_FILE=./wx-gateway-conf.json ./wx-gateway如果沒有配置msg-proxy-pass ，則wx-gateway可以作為工具啟用开发/服务器配置，並且可以對關注公眾號的使用者透過文字方塊實現迴聲應答，是公眾號開發必備的偵錯工具。
與msg-proxy-pass的通訊
msg-porxy-pass配置的是URL位址前綴， wx-gateway會把訊息、事件類型加到後面合成完整的URL。比如:msg-proxy-pass設定的是http://wx.myhost.com/msghandlerwx-gateway收到用戶的文字訊息時，會把訊息轉寄給http://wx.myhost.com/msghandler/msg/textwx-gateway收到新用戶追蹤事件時，會把訊息轉寄給http://wx.myhost.com/msghandler/event/subscribemsg 、 event是轉發類型、 text 、 subscribe是具體的訊息或事件名稱，所有名稱都對應微信公眾平台對應的訊息POST ，所有的請求/回應結果都是JSON ，請求體的JSON是對微信公眾號API訊息的XML格式做了轉換，具體欄位仍然可以參考微信公眾號APImsg訊息名稱有text 、 image 、 voice 、 video 、 shortvideo 、 location 、 linkevent事件名稱有CLICK 、 VIEW 、 SCAN 、 subscribe 、 unsubscribe 、 location 、 LOCATION 、 pic_sysphoto 、 pic_photo_or_album 、 pic_weixin 、 scancode_waitmsg 、 scancode_push ISH MASSSmsg訊息請求/回應舉例，名稱texturl: <msg-proxy-pass>/msg/text
請求訊息體:
{
"ToUserName" : "公众号的id " ,
"FromUserName" : "发送消息的用户的openId " ,
"CreateTime" : 1556088649 ,
"MsgType" : " text " ,
"Content" : "用户发送的文本内容" ,
"MsgId" : " 22277834746191186 " ,
"说明" : "以上为必传信息，如果配置文件中dont-append-userinfo为false，则有下面的信息" ,
"userInfo" : {
"openid" : " " ,
"nickname" : " " ,
"headimgurl" : " " ,
"city" : " " , "province" : " " , "country" : " " ,
"sex" : 1 ,
"language" : " " ,
"等等" : "各种信息"
},
"userInfoError" : "如果取userInfo发生错误，则有错误信息，否则该值为空"
}回應
如果成功，一定是回覆200訊息，訊息體格式
{
"type" : " text " ,
"msg" : "需要返回给用户的消息内容"
}"type"可以是"voice"、"video"、"image"等，"msg"則是它們對應的"mediaId"
event訊息請求/回應舉例，名稱subscribe請求訊息體:
{
"ToUserName" : "公众号的id " ,
"FromUserName" : "关注公众号的用户的openId " ,
"CreateTime" : 1556088649 ,
"MsgType" : " event " ,
"Event" : " subscribe " ,
"EventKey" : " qrscene_场景ID(新关注) 或 场景ID(扫码) " ,
"Ticket" : "如果是二维码扫码，是二维码的票据" ,
"说明" : "以上为必传信息，如果配置文件中dont-append-userinfo为false，则有下面的信息" ,
"userInfo" : {
"openid" : " " ,
"nickname" : " " ,
"headimgurl" : " " ,
"city" : " " , "province" : " " , "country" : " " ,
"sex" : 1 ,
"language" : " " ,
"等等" : "各种信息"
},
"userInfoError" : "如果取userInfo发生错误，则有错误信息，否则该值为空"
}回應
與消息是一樣的
如果成功，一定是回覆200訊息，訊息體格式
{
"type" : " text " ,
"msg" : "需要返回给用户的消息内容"
}"type"可以是"voice"、"video"、"image"等，"msg"則是它們對應的"mediaId"
event訊息請求/回應舉例，名稱channels_ec_order_pay請求訊息體:
{
"ToUserName" : "视频号小店的id " ,
"FromUserName" : "在视频号小店购物的用户的openId " ,
"CreateTime" : 1556088649 ,
"MsgType" : " event " ,
"Event" : " channels_ec_order_pay " ,
"order_info" : {
"order_id" : 3705115058471208928 , // NOTE: 文档处是字符串，实际返回的整数
"pay_time" : 1658509200
}
}回應
與redirect-url的通訊
處理網頁授權請求。公眾號的相關配置請參考微信文件。回呼URL只需wx-gateway所在的域名
redirect-url配置的是一個URL，例如
redirect-url設定的是http://wx.myhost.com/menu/path/to/redirectwx-gateway接收網頁要求時，會把訊息轉寄給上面的URLPOST ，回應結果完全由轉送處理服務決定，它的HTTP回應結果將反映到公眾號瀏覽器為了讓wx-gateway收到選單點擊事件，要以公眾號網頁授權的格式寫URL:
https://open.weixin.qq.com/connect/oauth2/authorize?appid=在这里填公众号的AppId&redirect_uri=http%3A//wx.myhost.com/这是redirect-path配置的值&response_type=code&scope=snsapi_base&state=这个值用于区分菜单项#wechat_redirectwx-gateway才能收到選單事件，並透過code取得點擊選單的使用者的openId，並轉發給redirect-url請求redirect-url的請求訊息格式
{
"requestURI" : "转发请求的URI，这是微信服务器访问gateway的URI,可以根据实际情况做进一步判断" ,
"appId" : "公众号的AppId，如果同时处理多个公众号，可以用来区分来源" ,
"openId" : "点击菜单的用户的openId " ,
"state" : "在菜单配置中的state的值，用于区分菜单项" ,
"userInfo" : {
"subscribe" : 1 ,
"openid" : " " ,
"nickname" : " " ,
"sex" : 1 ,
"language" : " " ,
"province" : " " ,
"city" : " " ,
"country" : " " ,
"headimgurl" : " " ,
"subscribe_time" : 1386160805 ,
},
"userInfoError" : "请求userInfo时的错误信息，如果为空表示没有错误"
}所有的HTTP請求頭、Cookie都會轉寄給redirect-url ，它可以依照需求處理
回應結果訊息格式
redirect-url自主決定，包括
