go-wx-gateway
go-wx-api를 기반으로 구현된 WeChat 공개 계정 게이트웨이 서비스입니다.go-wx-gateway
WeChat 공식 계정 플랫폼의 API 인터페이스용 역방향 프록시 프로그램입니다.go-wx-gateway
단순히 WeChat 공용 계정 API와 관련된 데이터를 전송하는 것이 아니라 보내고 받는 패킷을 압축 해제하고 패키징하므로 go-wx-gateway
역방향 프록시 뒤에 있는 비즈니스를 크게 단순화할 수 있습니다.go-wx-gateway
실행된 후 http를 통해 백엔드 비즈니스 서비스와 통신하며, http 서비스를 지원하는 모든 언어는 비즈니스 코드를 구현할 수 있습니다. go-wx-gateway
사용하면 WeChat 공개 계정 서비스의 개발은 일반 웹 서비스의 개발과 같습니다.go-wx-gateway
를 가리킬 수 있습니다.go-wx-gateway
통합 관리를 맡도록 할 수 있으며, go-wx-gateway
사용자 정보와 메뉴 상태 값을 메뉴 처리 서비스에 전달합니다.go-wx-gateway
웹페이지 승인을 처리하지 않으려면 공용 계정에서 필요한 서비스를 가리킨 다음 획득한 코드를 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의 바이너리 버전은 릴리스에서 직접 다운로드할 수 있습니다.
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/msghandler
에서 구성됩니다.wx-gateway
사용자의 문자 메시지를 받으면 해당 메시지를 http://wx.myhost.com/msghandler/msg/text
로 전달합니다.wx-gateway
새로운 사용자의 주의 이벤트를 수신하면 메시지를 http://wx.myhost.com/msghandler/event/subscribe
로 전달합니다.msg
및 event
전달 유형이고 text
및 subscribe
특정 메시지 또는 이벤트 이름에 해당합니다. WeChat 공개 플랫폼에 해당하는 이름입니다.POST
이고 모든 요청/응답 결과는 JSON
입니다. 요청 본문의 JSON은 WeChat 공식 계정 API 메시지의 XML 형식에서 변환됩니다. 특정 필드의 경우 여전히 WeChat 공식 계정 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-프록시-패스>/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
을 사용한 통신
웹페이지 인증 요청을 처리합니다. 공개 계정의 관련 구성은 WeChat 설명서를 참조하세요. 콜백 URL에는 wx-gateway
라는 도메인 이름만 필요합니다.
redirect-url
다음과 같은 URL을 구성합니다.
redirect-url
구성은 http://wx.myhost.com/menu/path/to/redirect
입니다.wx-gateway
웹페이지 요청을 받으면 위의 URL로 메시지를 전달합니다.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
올바르게 구성되어야만 메뉴 이벤트를 수신하고, 코드를 통해 메뉴를 클릭한 사용자의 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 요청 헤더와 쿠키는 필요에 따라 처리될 수 있는 redirect-url
로 전달됩니다.
응답 결과 메시지 형식
redirect-url
에 의해 결정됩니다.