一、背景介绍
这周期的项目需求中需要做一个引导用户关注微信公众号的功能,但是引导用户关注的前提是需要实时获取当前用户是否已经关注微信公众号,如果光看官方文档还是对于一些小伙伴来说比较无从下手,所以我来分享以下我做的过程中遇到的问题以及解决思路。
二、思路&方案
站在巨人的肩膀上:
做之前先阅读了微信公众号官方文档:关注/取消关注事件 | 微信开放文档
前提条件:
- 公网域名或IP
- 开通80或443端口
- 微信公众号的AppId和AppSecret必须认证
流程:
- 编写一个验签的接口,这个接口的目的是让微信服务器调用这个接口进行服务校验
- 公众号后台进行服务器配置
- 关注/取消关注事件接口。当用户对公众号进行关注或取消关注的时候会把这个事件推送到开发者在后台配置的url中,把消息返回给用户进行自定义的使用
三、过程
第一步、编写服务端与微信端建立连接的接口(GET请求)
思想:开发者提交信息后微信服务器会发功一个GET请求到你配置的这个接口,微信用你设置的token和你代码中的token进行对比,验证服务器的可用性
①、接收服务器请求
@Api("公众号")
@RestController
public class Controller {
@Autowired
private GzhService gzhService;
private static final Logger log = LogManager.getLogger(Controller.class);
private static final String TOKEN = "szbk";
public Controller() {
}
@GetMapping({"/serverCheck"})
public void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException,
NoSuchAlgorithmException {
//接收微信服务器发送请求时传递过来的参数
//signature 微信加密签名,signature结合了开发者填写的token参数和请求中的timestamp参数、nonce参数。
//timestamp 时间戳
//nonce 随机数
//echostr 随机字符串
String signature = request.getParameter("signature");
String timestamp = request.getParameter("timestamp");
String nonce = request.getParameter("nonce");
String echostr = request.getParameter("echostr");
log.info("\n接收到来自微信服务器的认证消息:[{}, {}, {}, {}]", signature, timestamp, nonce, echostr);
//校验signature,timestamp,nonce,echostr这四个参数是否字符串为空或为null,是返回true,反之
if (StringUtils.isAnyBlank(new CharSequence[]{signature, timestamp, nonce, echostr})) {
throw new IllegalArgumentException("请求参数非法,请核实!");
} else {
String signatureCheck = getSHA1("szbk", timestamp, nonce);
log.info("\n加密后的signatureCheck = {}", signatureCheck);
if (signatureCheck.equals(signature)) {
log.info("\n接入成功");
PrintWriter out = response.getWriter();
out.print(echostr);
out.flush();
out.close();
}
}
}
}
②、SHA1加密
将token、timestamp、nonce三个参数拼接成一个字符串进行sha1加密,之后会将加密后的字符串和singnature进行对比,一样则标识请求时来自微信,否则接入失败
//SHA1加密
public static String getSHA1(String token, String timestamp, String nonce) {
try {
String[] array = new String[]{token, timestamp, nonce};
StringBuffer sb = new StringBuffer();
Arrays.sort(array);
for (int i = 0; i < 3; ++i) {
sb.append(array[i]);
}
String str = sb.toString();
//获取加密对象
MessageDigest md = MessageDigest.getInstance("SHA-1");
//获取字符串字节数组
md.update(str.getBytes());
//加密
byte[] digest = md.digest();
StringBuffer hexstr = new StringBuffer();
String shaHex = "";
//处理加密结果
for (int i = 0; i < digest.length; ++i) {
shaHex = Integer.toHexString(digest[i] & 255);
if (shaHex.length() < 2) {
hexstr.append(0);
}
hexstr.append(shaHex);
}
return hexstr.toString();
} catch (Exception var11) {
var11.printStackTrace();
return token;
}
}
第二步、编写关注/取消关注事件接口(POST请求)
思想:微信会实时监控公众号用户的指定操作,然后通过这个接口通知(调用这个接口返回信息)给你(服务器)
@PostMapping("/checkToken")
public void checkTokenPost(HttpServletRequest request, HttpServletResponse response) {
try {
request.setCharacterEncoding("UTF-8");
response.setCharacterEncoding("UTF-8");
Map<String, String> requestMap = WxMessageUtil.parseXml(request);
log.info("解析====>{}", request);
String messageType = requestMap.get("MsgType");
log.info("微信类型===>{}", messageType);
String eventType = requestMap.get("Event");
// 发送方帐号(open_id)
String openid = requestMap.get("FromUserName");
// 公众帐号
String toUserName = requestMap.get("ToUserName");
// 消息类型
String msgType = requestMap.get("MsgType");
if (messageType.equals(WxMessageType.EVENT.getCode())) {
//判断消息类型是否是事件消息类型
log.info("公众号====>事件消息");
log.info("openid:" + openid);
log.info("Event:" + eventType);
if (eventType.equals(WxEeventType.SUBSCRIBE.getCode())) {
log.info("公众号====>新用户关注");
// 获取接口调用凭证
String accessTokenStr = "https://api.weixin.qq.com/cgi-bin/token?" +
"grant_type=client_credential" + "&appid=" + "wxXXXXXXXX" + "&secret=" + "f97XXXXXXXX";
String tokenStr = HttpUtil.get(accessTokenStr);
cn.hutool.json.JSONObject object = JSONUtil.parseObj(tokenStr);
String accessToken = object.get("access_token").toString();
// 构建获取用户的基本信息
String buffer = "https://api.weixin.qq.com/cgi-bin/user/info?" +
"access_token=" + accessToken +
"&openid=" + openid + "&lang=zh_CN";
String wxUserString = HttpUtil.get(buffer);
log.info("获取用户信息===>{}", wxUserString);
JSONObject jsonObject = JSONUtil.parseObj(wxUserString);
} else if (eventType.equals(WxEeventType.UNSUBSCRIBE.getCode())) {
log.info("公众号====>用户取消关注");
} else {
log.info("微信类型===>{}", messageType);
log.info("公众号===>其他");
}
} else if (messageType.equals(WxMessageType.TEXT.getCode())) {
log.info("用户输入文本信息");
// 响应消息
PrintWriter out = response.getWriter();
TextMessage textMessage = new TextMessage();
textMessage.setFromUserName(openid);
textMessage.setToUserName(toUserName);
textMessage.setMsgType(msgType);
textMessage.setCreateTime(System.currentTimeMillis());
textMessage.setContent("欢迎您");
String message = WxMessageUtil.textMessageToXml(textMessage);
log.info("message==>{}",message);
out.println(message);
// 关闭流
out.close();
}
} catch (Exception e) {
log.error(e.getMessage());
}
}
注意:两个接口对外提供的接口名要保持一致!!!
第三步、微信公众平台接口调试工具测试
为了方便测试先使用了微信提供的【微信公众平台接口调试工具】,如果测试的没有问题了在进行公众号后台服务器的配置
URL(服务器接口地址):确保接口能够调通,端口地址可以是80或443,我在做的过程中给接口服务原本配置的是6688接口,但是放到服务器上一直出现访问失败的原因,后来把服务器的80端口开通了就能访问通了
第四步、验证结果
- 把写的接口项目打成jar包放在服务器上
- 在公众号进行关注或取消关注操作
- 查看log文件
在log文件我们发现刚才对公众号的操作都被实时打印到了文件中,这样我们就可以根据这个事件完成对应的业务了
通过第四步的测试说明我们写的接口没有问题,此时我们就可以在公众号后台进行服务器配置了,当然如果你确保你写的接口没有问题也可以直接在公众号后台配置,省略生面测试步骤,下面是配置流程
第五步、填写公众号后台服务器配置
URL(服务器接口地址):确保接口能够调通,端口地址可以是80或443,我在做的过程中给接口服务原本配置的是6688接口,但是放到服务器上一直出现访问失败的原因,后来把服务器的80端口开通了就能访问通了
Token(令牌):用户可以自定义设置,但是需要和上一步在接口中设置的token保持一致,否则验证也无法通过。(注意:这里的Token不是微信的Access_Token)
EncodingAESKey(消息加密密钥):可以自定义生成
消息加密方式:为了测试方便我先选择了明文模式,但是如果你们实际项目中用为了保证安全性可以设置加密级别更好的模式
我们点击提交,如果显示成功则说明验证通过,微信就是实时监听微信公众号用户关注/取消关注的操作,并且将结果转发到我们刚才配置的服务器地址上
四、总结
在接触没有做过的事物之前站在巨人肩膀上(官方文档)可以帮助我们更快速了解,网上资料千千万,我们还要具备选择的能力,否则就是大海捞针。希望这篇文章能帮助到你!