go-wx-gateway
ist ein WeChat-Gateway-Dienst für öffentliche Konten, der auf Basis von go-wx-api implementiert wird.go-wx-gateway
ein Reverse-Proxy-Programm für die API-Schnittstelle der offiziellen Kontoplattform WeChat.go-wx-gateway
überträgt nicht einfach die Daten im Zusammenhang mit der WeChat-API für öffentliche Konten, sondern entpackt und verpackt die gesendeten und empfangenen Pakete, sodass das Geschäft hinter dem go-wx-gateway
-Reverse-Proxy erheblich vereinfacht werden kanngo-wx-gateway
ausgeführt wurde, kommuniziert es über http mit dem Back-End-Geschäftsdienst, und jede Sprache, die den HTTP-Dienst unterstützt, kann Geschäftscode implementieren. go-wx-gateway
ist die Entwicklung öffentlicher WeChat-Kontodienste die Entwicklung gewöhnlicher Webdienste.go-wx-gateway
verweisengo-wx-gateway
die einheitliche Verwaltung übernehmen lassen. go-wx-gateway
leitet die Benutzerinformationen und den Menüstatuswert an den Menüverarbeitungsdienst weiter.go-wx-gateway
die Webseitenautorisierung übernimmt, kann das öffentliche Konto auch auf den von Ihnen benötigten Dienst verweisen und dann den erhaltenen Code go-wx-gateway
übertragen, um im Gegenzug auf die openId des Benutzers zuzugreifen und die Vollständigkeit zu erhalten Benutzerinformationen. Informationen zu dieser Methode finden Sie in den Konfigurationsinformationen „sns-auth2“.go-wx-gateway
und Geschäftscode wird HTTP verwendet. Das Datenformat ist JSON. Voraussetzung: go 1.11.x und höher, git, make wurden installiert
Geben Sie einen beliebigen Ordner ein und führen Sie den Befehl aus
$ git clone https://github.com/rosbit/go-wx-gateway
$ cd go-wx-gateway
$ make
Wenn die Kompilierung erfolgreich ist, wird das ausführbare Programm von wx-gateway
abgerufen. Sie können ./wx-gateway -v
ausführen, um Programminformationen anzuzeigen.
Die Binärversion von Linux kann direkt von Releases heruntergeladen werden.
ist ein JSON
Beispiel, kann über sample.conf.json
geändert werden:
{
"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
Wenn msg-proxy-pass
nicht konfiguriert ist, kann wx-gateway
als Tool zum Aktivieren开发/服务器配置
verwendet werden und Echo-Antworten über Textfelder für Benutzer implementieren, die öffentlichen Konten folgen. Es ist ein wichtiges Debugging-Tool für öffentliche Konten Entwicklung.
Kommunikation mit msg-proxy-pass
msg-porxy-pass
wird mit einem URL-Adresspräfix konfiguriert wx-gateway
fügt am Ende die Nachricht und den Ereignistyp hinzu, um eine vollständige URL zu bilden. Zum Beispiel:msg-proxy-pass
wird unter http://wx.myhost.com/msghandler
konfiguriertwx-gateway
die Textnachricht des Benutzers empfängt, leitet es die Nachricht an http://wx.myhost.com/msghandler/msg/text
weiterwx-gateway
das Aufmerksamkeitsereignis eines neuen Benutzers empfängt, leitet es die Nachricht an http://wx.myhost.com/msghandler/event/subscribe
weitermsg
und event
Weiterleitungstypen, text
und subscribe
sind spezifische Nachrichten- oder Ereignisnamen. Alle Namen entsprechen den Nachrichten, die der öffentlichen WeChat-Plattform entsprechen.POST
und alle Anfrage-/Antwortergebnisse sind JSON
. Das JSON-Format des Anfragetextes wird aus dem XML-Format der offiziellen WeChat-Konto-API-Nachricht konvertiert. Für bestimmte Felder können Sie weiterhin auf die offizielle WeChat-Konto-API verweisen.msg
gehören Text , Bild , Sprache , Video , Kurzvideo , Standort und Linkevent
Ereignisnamen gehören CLICK , VIEW , SCAN , subscribe , unsubscribe , location , LOCATION , pic_sysphoto , pic_photo_or_album , pic_weixin , scancode_waitmsg , scancode_push , MASSSENDJOBFINISH , TEMPLATESENDJOBFINISHmsg
für eine Nachrichtenanforderung/-antwort, text
URL: <msg-proxy-pass>/msg/text
Nachrichtentext anfordern:
{
"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发生错误,则有错误信息,否则该值为空"
}
Antwort
Bei Erfolg muss es sich um eine Antwortnachricht mit 200 Nachrichten im Nachrichtentextformat handeln
{
"type" : " text " ,
"msg" : "需要返回给用户的消息内容"
}
„Typ“ kann „Sprache“, „Video“, „Bild“ usw. sein, und „msg“ ist die entsprechende „mediaId“.
event
, Name subscribe
Nachrichtentext anfordern:
{
"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发生错误,则有错误信息,否则该值为空"
}
Antwort
Identisch mit Nachricht
Bei Erfolg muss es sich um eine Antwortnachricht mit 200 Nachrichten im Nachrichtentextformat handeln
{
"type" : " text " ,
"msg" : "需要返回给用户的消息内容"
}
„Typ“ kann „Sprache“, „Video“, „Bild“ usw. sein, und „msg“ ist die entsprechende „mediaId“.
event
, Name channels_ec_order_pay
Nachrichtentext der Anfrage:
{
"ToUserName" : "视频号小店的id " ,
"FromUserName" : "在视频号小店购物的用户的openId " ,
"CreateTime" : 1556088649 ,
"MsgType" : " event " ,
"Event" : " channels_ec_order_pay " ,
"order_info" : {
"order_id" : 3705115058471208928 , // NOTE: 文档处是字符串,实际返回的整数
"pay_time" : 1658509200
}
}
Antwort
Kommunikation mit redirect-url
Behandeln Sie Autorisierungsanfragen für Webseiten. Informationen zur entsprechenden Konfiguration des öffentlichen Kontos finden Sie in der WeChat-Dokumentation. Die Rückruf-URL benötigt nur den Domänennamen von wx-gateway
redirect-url
konfiguriert eine URL, z
redirect-url
Konfiguration lautet http://wx.myhost.com/menu/path/to/redirect
wx-gateway
eine Webseitenanfrage empfängt, leitet es die Nachricht an die oben genannte URL weiter.POST
. Das Antwortergebnis wird vollständig vom Weiterleitungsverarbeitungsdienst bestimmt. Sein HTTP-Antwortergebnis wird im öffentlichen Kontobrowser wiedergegeben. Damit wx-gateway
Menüklickereignisse empfangen kann, muss die URL in dem von der offiziellen Konto-Webseite autorisierten Format geschrieben werden:
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_redirect
wx-gateway
richtig konfiguriert ist, kann es Menüereignisse empfangen, die openId des Benutzers, der auf das Menü geklickt hat, über Code abrufen und an redirect-url
Anforderungsnachrichtenformat zum Anfordern 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时的错误信息,如果为空表示没有错误"
}
Alle HTTP-Anfrageheader und Cookies werden an redirect-url
weitergeleitet, die je nach Bedarf verarbeitet werden kann
Format der Antwortergebnisnachricht
redirect-url
bestimmt, einschließlich