從零搭建開(kāi)發(fā)腳手架 使用WxJava快速接入微信公眾號(hào)
本文轉(zhuǎn)載自微信公眾號(hào)「Java大廠面試官」，作者laker。轉(zhuǎn)載本文請(qǐng)聯(lián)系Java大廠面試官公眾號(hào)。
- 環(huán)境準(zhǔn)備
- 1.申請(qǐng)公眾號(hào)測(cè)試賬號(hào)
- 2.外網(wǎng)服務(wù)準(zhǔn)備以及配置
- 3.常用開(kāi)發(fā)工具及網(wǎng)站
- 快速開(kāi)始
- 依賴導(dǎo)入
- 配置文件
- 服務(wù)接入認(rèn)證
- 常用功能
- 獲取關(guān)注用戶列表
- 獲取用戶信息
- 微信網(wǎng)頁(yè)授權(quán)
- 更新用戶備注名
- 創(chuàng)建自定義菜單
- 刪除自定義菜單
- 獲得自定義菜單
- 其他功能
- 總結(jié)
環(huán)境準(zhǔn)備
1.申請(qǐng)公眾號(hào)測(cè)試賬號(hào)
地址：https://mp.weixin.qq.com/debug/cgi-bin/sandbox?t=sandbox/login
申請(qǐng)公眾號(hào)及認(rèn)證流程較慢且繁瑣，可在測(cè)試賬號(hào)中體驗(yàn)并測(cè)試微信公眾號(hào)所有高級(jí)功能。
直接微信掃描就能申請(qǐng)個(gè)公眾測(cè)試賬號(hào)，非常方便快捷。
2.外網(wǎng)服務(wù)準(zhǔn)備以及配置
配置：
“注意: URL配置以及代碼中的RequestMapping中的對(duì)應(yīng)關(guān)系。
服務(wù)接口開(kāi)發(fā)：
用于驗(yàn)證服務(wù)接入和接口回調(diào)的。
參照快速開(kāi)始-服務(wù)接入認(rèn)證章節(jié)
3.常用開(kāi)發(fā)工具及網(wǎng)站
- 公眾號(hào)官網(wǎng)文檔
- 微信公眾平臺(tái)接口調(diào)試工具
- web開(kāi)發(fā)者工具
- 測(cè)試賬號(hào)申請(qǐng)
- 微信官方文檔
快速開(kāi)始
使用WxJava來(lái)快速開(kāi)發(fā)，它是微信開(kāi)發(fā) Java SDK，支持微信支付、開(kāi)放平臺(tái)、公眾號(hào)、企業(yè)號(hào)/企業(yè)微信、小程序等的后端開(kāi)發(fā)。
- Github:https://github.com/Wechat-Group/WxJava
- Gitee:https://gitee.com/binary/weixin-java-tools
依賴導(dǎo)入
非Spring Boot:
- <dependency>
- <groupId>com.github.binarywang</groupId>
- <artifactId>weixin-java-mp</artifactId>
- <version>4.0.0</version>
- </dependency>
Spring Boot：
- <dependency>
- <groupId>com.github.binarywang</groupId>
- <artifactId>wx-java-mp-spring-boot-starter</artifactId>
- <version>4.0.0</version>
- </dependency>
- 微信小程序：weixin-java-miniapp
- 微信支付：weixin-java-pay
- 微信開(kāi)放平臺(tái)：weixin-java-open
- 公眾號(hào)(包括訂閱號(hào)和服務(wù)號(hào))：weixin-java-mp
- 企業(yè)號(hào)/企業(yè)微信：weixin-java-cp
配置文件
- # 公眾號(hào)配置(必填)
- wx.mp.appId = appId
- wx.mp.secret = @secret
- wx.mp.token = @token
- wx.mp.aesKey = @aesKey
- # 存儲(chǔ)配置redis(可選)
- wx.mp.config-storage.type = Jedis # 配置類型: Memory(默認(rèn)), Jedis, RedisTemplate
- wx.mp.config-storage.key-prefix = wx # 相關(guān)redis前綴配置: wx(默認(rèn))
- wx.mp.config-storage.redis.host = 127.0.0.1
- wx.mp.config-storage.redis.port = 6379
- #單機(jī)和sentinel同時(shí)存在時(shí)，優(yōu)先使用sentinel配置
- #wx.mp.config-storage.redis.sentinel-ips=127.0.0.1:16379,127.0.0.1:26379
- #wx.mp.config-storage.redis.sentinel-name=mymaster
- # http客戶端配置
- wx.mp.config-storage.http-client-type=httpclient # http客戶端類型: HttpClient(默認(rèn)), OkHttp, JoddHttp
- wx.mp.config-storage.http-proxy-host=
- wx.mp.config-storage.http-proxy-port=
- wx.mp.config-storage.http-proxy-username=
- wx.mp.config-storage.http-proxy-password=
- # 公眾號(hào)地址host配置
- #wx.mp.hosts.api-host=http://proxy.com/
- #wx.mp.hosts.open-host=http://proxy.com/
- #wx.mp.hosts.mp-host=http://proxy.com/
服務(wù)接入認(rèn)證
- @Api(tags = "微信公眾號(hào)")
- @ApiSupport(order = 4)
- @RequestMapping("/wx")
- @RestController
- @Slf4j
- public class WxController {
- @Autowired
- WxMpService wxMpService;
- /**
- * 用戶配置 token和url時(shí)的服務(wù)認(rèn)證
- * url配置為：http://ip:port/wx
- * 如果接收不到微信服務(wù)的調(diào)用，把這個(gè)接口開(kāi)大點(diǎn)，不要限制GET等
- */
- @GetMapping
- @ApiOperationSupport(order = 1)
- @ApiOperation(value = "服務(wù)認(rèn)證")
- public String transfer(String signature, String timestamp, String nonce, String echostr) {
- log.info("接收到來(lái)自微信服務(wù)器的認(rèn)證消息：signature ：{}，timestamp：{}，nonce：{}，echostr：{}", signature, timestamp, nonce
- , echostr);
- if (!wxMpService.checkSignature(timestamp, nonce, signature)) {
- log.error("消息不合法");
- return "error";
- }
- return echostr;
- }
“這里的接口地址注意，上面再微信平臺(tái)配置的URL的對(duì)應(yīng)。
服務(wù)接入認(rèn)證流程圖：
到這里就接入成功了。
常用功能
獲取關(guān)注用戶列表
- String nextOpenid = null;// 可選，第一個(gè)拉取的OPENID，null為從頭開(kāi)始拉取
- WxMpUserList wxMpUserList = wxMpService.getUserService().userList(nextOpenid);
結(jié)果：
- {
- "total": 1,
- "count": 1,
- "openids": [
- "xxxx"
- ],
- "nextOpenid": "xxxx"
- }
獲取用戶信息
在關(guān)注者與公眾號(hào)產(chǎn)生消息交互后，公眾號(hào)可獲得關(guān)注者的OpenID(加密后的微信號(hào)，每個(gè)用戶對(duì)每個(gè)公眾號(hào)的OpenID是唯一的。對(duì)于不同公眾號(hào)，同一用戶的openid不同)。公眾號(hào)可通過(guò)本接口來(lái)根據(jù)OpenID獲取用戶基本信息，包括昵稱、頭像、性別、所在城市、語(yǔ)言和關(guān)注時(shí)間。
請(qǐng)注意，如果開(kāi)發(fā)者有在多個(gè)公眾號(hào)，或在公眾號(hào)、移動(dòng)應(yīng)用之間統(tǒng)一用戶帳號(hào)的需求，需要前往微信開(kāi)放平臺(tái)(open.weixin.qq.com)綁定公眾號(hào)后，才可利用UnionID機(jī)制來(lái)滿足上述需求。
其他場(chǎng)景獲取用戶信息可以參考微信網(wǎng)頁(yè)授權(quán)章節(jié)
- String lang = "zh_CN"; //語(yǔ)言 openId 可以從關(guān)注用戶列表接口來(lái)或者是用戶發(fā)送消息的fromuser
- WxMpUser user = wxMpService.getUserService().userInfo(openId, lang);
結(jié)果：
- {
- "subscribe": true,
- "openId": "xxx",
- "nickname": "laker",
- "sexDesc": "男",
- "sex": 1,
- "language": "zh_CN",
- "city": "合肥",
- "province": "安徽",
- "country": "中國(guó)",
- "headImgUrl": "http://xxx",
- "subscribeTime": 1618311163,
- "unionId": null,
- "remark": "",
- "groupId": 0,
- "tagIds": [],
- "privileges": null,
- "subscribeScene": "ADD_SCENE_QR_CODE",
- "qrScene": "0",
- "qrSceneStr": ""
- }
微信網(wǎng)頁(yè)授權(quán)
實(shí)現(xiàn)第三方微信登錄功能。
如果用戶在微信客戶端中訪問(wèn)第三方網(wǎng)頁(yè)，公眾號(hào)可以通過(guò)微信網(wǎng)頁(yè)授權(quán)機(jī)制，來(lái)獲取用戶基本信息，進(jìn)而實(shí)現(xiàn)業(yè)務(wù)邏輯。
文檔地址：https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_webpage_authorization.html
1.配置網(wǎng)頁(yè)授權(quán)回調(diào)域名
在微信公眾號(hào)請(qǐng)求用戶網(wǎng)頁(yè)授權(quán)之前，開(kāi)發(fā)者需要先到公眾平臺(tái)官網(wǎng)中的“開(kāi)發(fā) - 接口權(quán)限 - 網(wǎng)頁(yè)服務(wù) - 網(wǎng)頁(yè)帳號(hào) - 網(wǎng)頁(yè)授權(quán)獲取用戶基本信息”的配置選項(xiàng)中，修改授權(quán)回調(diào)域名。請(qǐng)注意，這里填寫的是域名(是一個(gè)字符串)，而不是URL，因此請(qǐng)勿加 http:// 等協(xié)議頭(即輸入：www.laker.com)。
注意事項(xiàng)：
- 沙盒號(hào)(測(cè)試號(hào))回調(diào)地址支持域名和ip，正式公眾號(hào)回調(diào)地址只支持域名并且域名需使用字母、數(shù)字及“-”的組合，須通過(guò)ICP備案的驗(yàn)證，不支持端口號(hào)及短鏈。
- 測(cè)試號(hào)：找到 網(wǎng)頁(yè)授權(quán)獲取用戶基本信息>點(diǎn)擊修改>設(shè)置域名
- 服務(wù)號(hào)：找到 開(kāi)發(fā)>接口權(quán)限>網(wǎng)頁(yè)授權(quán)獲取用戶基本信息>>點(diǎn)擊修改>設(shè)置域名
- 設(shè)置域名不要添加http:// 等協(xié)議頭
2.微信網(wǎng)頁(yè)授權(quán) - 流程時(shí)序圖
3.構(gòu)造網(wǎng)頁(yè)授權(quán)url
首先構(gòu)造網(wǎng)頁(yè)授權(quán)url，然后構(gòu)成超鏈接讓用戶點(diǎn)擊，例如構(gòu)建自定義菜單中的跳轉(zhuǎn)URL按鈕類型(VIEW)。
- WxMpService wxMpService = ...;
- String url = ...;
- wxMpService.getOauth2Service().buildAuthorizationUrl(url, WxConsts.OAuth2Scope.SNSAPI_USERINFO, null)
4.獲得用戶基本信息
當(dāng)用戶同意授權(quán)后，會(huì)回調(diào)所設(shè)置的url并把a(bǔ)uthorization code傳過(guò)來(lái)，然后用這個(gè)code獲得access token，其中也包含用戶的openid等信息。
- WxMpOAuth2AccessToken wxMpOAuth2AccessToken = wxMpService.getOAuth2Service().getAccessToken(code);
- WxMpUser wxMpUser = wxMpService.getOAuth2Service().getUserInfo(wxMpOAuth2AccessToken, null);
更新用戶備注名
- wxMpService.getUserService().userUpdateRemark(openid, "測(cè)試備注名");
創(chuàng)建自定義菜單
包括新增和修改，修改相當(dāng)于覆蓋之前的菜單。
- WxMenu wxMenu = new WxMenu();
- // 設(shè)置菜單
- wxMpService.getMenuService().menuCreate(wxMenu);
刪除自定義菜單
- wxMpService.getMenuService().menuDelete();
獲得自定義菜單
- WxMenu wxMenu = wxMpService.getMenuService().menuGet();
其他功能
可去wiki頁(yè)查看
- https://github.com/Wechat-Group/WxJava/wiki
- https://github.com/Wechat-Group/WxJava/wiki/%E5%85%AC%E4%BC%97%E5%8F%B7%E5%BC%80%E5%8F%91%E6%96%87%E6%A1%A3
總結(jié)
總體來(lái)說(shuō)集成還是比較順利，但是有幾個(gè)點(diǎn)還是要重點(diǎn)說(shuō)下：
環(huán)境準(zhǔn)備這個(gè)很重要，很多文章沒(méi)有說(shuō)清楚，都不知道開(kāi)始要準(zhǔn)備什么，這里看到需要一個(gè)外網(wǎng)能訪問(wèn)的服務(wù)和一個(gè)公眾號(hào)，公眾號(hào)可以直接使用測(cè)試賬號(hào)。
關(guān)于外網(wǎng)服務(wù)可以去百度內(nèi)網(wǎng)穿透，免費(fèi)的有很多直接拿來(lái)用就行。
配置服務(wù)接口認(rèn)證的URL，一定要是能具體到我們的接口的。
網(wǎng)頁(yè)授權(quán)填寫域名時(shí)，域名不要添加http:// 等協(xié)議頭 ，直接www.xxx.com 即可。
參考：
https://github.com/Wechat-Group/WxJava
微信官方文檔
