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