Skip to content

rosbit/go-wx-gateway

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits

common-endpoints

common-endpoints

 
 

conf

conf

 
 

handlers

handlers

 
 

LICENSE

LICENSE

 
 

Makefile

Makefile

 
 

README.md

README.md

 
 

go.mod

go.mod

 
 

go.sum

go.sum

 
 

main.go

main.go

 
 

make.inc

make.inc

 
 

router.go

router.go

 
 

sample.conf.json

sample.conf.json

 
 

wx-gateway.png

wx-gateway.png

 
 

Repository files navigation

通用微信公众号网关服务

  1. go-wx-gateway是基于go-wx-api的实现的微信公众号网关服务。
  2. 类比nginx是HTTP的反向代理程序，go-wx-gateway是微信公众号平台API接口的反向代理程序
  3. go-wx-gateway不是简单地把微信公众号API相关的数据进行传递，而是把它发送和接收的包做了拆包、打包的封装， 使得go-wx-gateway反向代理后面的业务实现大大的简化了
  4. go-wx-gateway运行后，通过http与后端业务服务通讯，任何支持http服务的语言都可以实现业务代码。

架构图

架构图

  1. 有了go-wx-gateway，微信公众号服务的开发就是普通的web服务开发
  2. 微信公众号服务主要处理两类数据流：
    • 消息/事件处理: 包括文本输入、图片上传、二维码扫描等等
    • 微信网页授权: 任何微信网页授权的处理都可以指向go-wx-gateway
      • 比如公众号菜单可以指向一个网页授权URL，让go-wx-gateway统一接管，go-wx-gateway会把用户信息、菜单state值转发给菜单处理服务
    • 如果不想让go-wx-gateway处理网页授权，公众号也可以指向自己所需要的服务，然后把得到的code转给go-wx-gateway换取访问用户的 openId获取完整的用户信息。该方式参考配置信息"sns-auth2"。
  3. go-wx-gateway和业务代码间使用HTTP传输数据，数据的格式为JSON。

下载、编译方法

  1. 前提：已经安装go 1.11.x及以上、git、make

  2. 进入任一文件夹，执行命令

    $ git clone https://github.com/rosbit/go-wx-gateway
$ cd go-wx-gateway
$ make

  3. 编译成功，会得到wx-gateway的可执行程序。可以执行./wx-gateway -v显示程序信息。

  4. Linux的二进制版本可以直接进入releases下载

运行方法

  1. 环境变量
    • CONF_FILE: 指明配置的路径，格式见下文
  2. 配置文件格式

    • 是一个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，表示追加"
}
  3. 运行wx-gateway
    • $ CONF_FILE=./wx-gateway-conf.json ./wx-gateway

与业务代码间的通讯

  1. 如果没有配置msg-proxy-pass，则wx-gateway可以作为工具启用开发/服务器配置，并可以对关注公众号 的用户通过文本框实现回声应答，是公众号开发必备的调试工具。

  2. 与msg-proxy-pass的通讯

    • msg-porxy-pass配置的是一个URL地址前缀，wx-gateway会把消息、事件类型加到后面合成完整的URL。比如:
      • msg-proxy-pass配置的是http://wx.myhost.com/msghandler
      • 当wx-gateway收到用户的文本消息时，则会把消息转发给http://wx.myhost.com/msghandler/msg/text
      • 当wx-gateway收到新用户关注事件时，则会把消息转发给http://wx.myhost.com/msghandler/event/subscribe
    • 上例中，msg、event是转发类型、text、subscribe是具体的消息或事件名称，所有名称都对应微信公众平台对应的消息
    • 所有HTTP请求都是POST，所有的请求/响应结果都是JSON，请求体的JSON是对微信公众号API消息的XML格式做了转换，具体字段仍然可以参考微信公众号API
    • msg消息名称有text、image、voice、video、shortvideo、location、link
    • event事件名称有CLICK、VIEW、SCAN、subscribe、unsubscribe、location、LOCATION、pic_sysphoto、pic_photo_or_album、pic_weixin、scancode_waitmsg、scancode_push、MASSSENDJOBFINISH、TEMPLATESENDJOBFINISH
    • msg消息请求/响应举例，名称text

      • url: <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
    }
}

      • 响应

        • 随意

  3. 与redirect-url的通讯

    • 处理网页授权请求。公众号的相关配置请参考微信文档。回调URL只需wx-gateway所在的域名

    • redirect-url配置的是一个URL，比如

      • redirect-url配置的是http://wx.myhost.com/menu/path/to/redirect
      • 当wx-gateway接收到网页请求时，则会把消息转发给上面的URL
      • HTTP请求的方法是POST，响应结果完全由转发处理服务决定，它的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_redirect
      • 只有配置正确wx-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自主决定，包括
      • 设置响应头、设置Cookie
      • 或者跳转到另外的URL
      • 响应内容会直接输出到公众号浏览器

About

微信公众号/服务号/视频号小店事件推送反向代理网关

Topics

nginx golang service gateway reverse-proxy weixin wechat go-wx-api

Resources

Readme

License

MIT license
Activity

Stars

31 stars

Watchers

1 watching

Forks

12 forks
Report repository

Releases 6

Linux executable Latest
Aug 2, 2021
+ 5 releases

Packages

No packages published

Languages