微信小程序开发记录(三)--消息推送
前面通过code到微信服务器换取到了微信用户身份openid,将微信和已存在的平台账号关联起来。关联起来后,就可以做自己想做的操作了。但有时候需要小程序自动回复客户的问题,也就是微信的消息推送功能了。这里针对开发者服务器接收消息推送讲一讲,云函数接收消息推送就不多说了,自己去微信公众平台看API。
消息推送–开发者服务器接收消息推送
开发者需要按照如下步骤完成:
- 填写服务器配置
- 验证服务器地址的有效性
- 接收消息和事件,实现业务逻辑
填写服务器配置
登录小程序后台后,在「开发」-「开发设置」-「消息推送」中,管理员扫码启用消息服务,填写服务器地址(URL)、令牌(Token) 和 消息加密密钥(EncodingAESKey)等信息。
- URL: 开发者用来接收微信消息和事件的接口 URL。开发者所填写的URL 必须以 http:// 或 https:// 开头,分别支持80 端口和 443 端口。
- Token: 可由开发者可以任意填写,用作生成签名(该 Token 会和接口 URL 中包含的 Token 进行比对,从而验证安全性)。
- EncodingAESKey: 由开发者手动填写或随机生成,将用作消息体加解密密钥。
同时,开发者可选择消息加解密方式:明文模式(默认)、兼容模式和安全模式。可以选择消息数据格式:XML 格式(默认)或 JSON 格式。
验证服务器地址的有效性
开发者点击提交按钮,模式的选择与服务器配置在提交成功后都会立即生效。但是怎么提交成功呢??直接点提交就行了吗?并不是这样的,微信会验证开发者填写的URL是否正确,正确才能提交成功,保存设置。
微信服务器会发送一个GET请求到填写的服务器地址URL,就是上面填写的URL。这个请求就是用来验证开发者填写的URL是否正确的,如果不正确就无法提交成功。注意这个请求只和URL和Token有关。而EncodingAESKey和加密方式、数据格式是为后面服务器用来将加密后的原文进行解密准备的。
微信服务器将发送GET请求到填写的服务器地址URL上,GET请求携带参数如下表所示:
参数 | 描述 |
---|---|
signature | 微信加密签名,signature结合了开发者填写的token参数和请求中的timestamp参数、nonce参数。 |
timestamp | 时间戳 |
nonce | 随机数 |
echostr | 随机字符串 |
实质上是微信对开发者填写的服务器地址URL发出GET请求,这个get请求带有四个参数,signature 是由微信结合开发者填写的Token、还有同时传过来的timestamp参数、nonce参数加密生成的一个字符串。开发者在填写的URL接口的逻辑中将自己填写的Token、还有接收到的timestamp参数、nonce参数这三个参数进行加密,加密后获取的字符串与signature 对比,一样的话就返回传过来的echostr参数,表示接入成功,否则返回空或其他,表示接入失败。微信接收到返回值,如果是echostr参数,那么就可以提交成功,保存消息推送配置。如果不是,则在Token(令牌)一行会显示“Token校验失败,请检查确认”。
加密/校验流程如下(来自微信公众平台API):
- 将token、timestamp、nonce三个参数进行字典序排序
- 将三个参数字符串拼接成一个字符串进行sha1加密
- 开发者获得加密后的字符串可与signature对比,若校验成功则原样返回echostr,表示接入成功,否则接入失败
Controller 微信小程序消息验证和配置
/**
* 开放接口--微信小程序消息验证和配置
* @return
*/
@ResponseBody
@ApiOperation(value="微信小程序消息验证和配置", response = SimpleMessage.class)
@RequestMapping(value = "/message" ,method = RequestMethod.GET)
public String getProcess(HttpServletRequest request, HttpServletResponse response) {
return weChatCustomerService.getProcess(request,response);
}
ServiceImpl 逻辑实现
import java.security.MessageDigest;
/**
* 微信小程序消息验证和配置
* @param request
* @param response
* @return
*/
@Override
public String getProcess(HttpServletRequest request, HttpServletResponse response) {
// 微信加密签名
String signature = request.getParameter("signature");
// 时间戳
String timestamp = request.getParameter("timestamp");
// 随机数
String nonce = request.getParameter("nonce");
// 随机字符串
String echostr = request.getParameter("echostr");
// 通过检验signature对请求进行校验,若校验成功则原样返回echostr,表示接入成功,否则接入失败
if (this.checkSignature(signature, timestamp, nonce)) {
return echostr;
}
return null;
}
/**
* 工具--通过检验signature对请求进行校验,若校验成功则原样返回echostr,表示接入成功,否则接入失败
* @param signature
* @param timestamp
* @param nonce
* @return
*/
private boolean checkSignature(String signature, String timestamp, String nonce) {
String[] arr = new String[] {
messageToken, timestamp, nonce };//messageToken为常值,就是开发者自己填写的Token(令牌)
// 将token、timestamp、nonce三个参数进行字典序排序
Arrays.sort(arr);
StringBuilder content = new StringBuilder();
for (int i = 0; i < arr.length; i++) {
content.append(arr[i]);
}
MessageDigest md = null;
String tmpStr = null;
try {
md = MessageDigest.getInstance("SHA-1");
// 将三个参数字符串拼接成一个字符串进行sha1加密
byte[] digest = md.digest(content.toString().getBytes());
tmpStr = byteToStr(digest);
} catch (Exception e) {
e.printStackTrace();
}
content = null;
// 将sha1加密后的字符串可与signature对比,标识该请求来源于微信
return tmpStr != null ? tmpStr.equals(signature.toUpperCase()) : false;
}
/**
* 工具--将字节数组转换为十六进制字符串
* @author 13
* @param byteArray
* @return
*/
private static String byteToStr(byte[] byteArray) {
String strDigest = "";
for (int i = 0; i < byteArray.length; i++) {
strDigest += byteToHexStr(byteArray[i]);
}
return strDigest;
}
/**
* 工具--将字节转换为十六进制字符串
* @author 13
* @param mByte
* @return
*/
private static String byteToHexStr(byte mByte) {
char[] Digit = {
'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A',
'B', 'C', 'D', 'E', 'F' };
char[] tempArr = new char[2];
tempArr[0] = Digit[(mByte >>> 4) & 0X0F];
tempArr[1] = Digit[mByte & 0X0F];
String s = new String(tempArr);
return s;
}
接收消息和事件,实现业务逻辑
当验证服务器地址的有效性后,提交消息推送配置即成功。之后只要当用户操作引发事件推送时(如用户向小程序客服发送消息、或者进入会话等情况),微信服务器会将消息(或事件)的数据包以 POST 请求发送到开发者配置的 URL,开发者可以依据自身业务逻辑进行响应。这里请求的还是之前开发者配置的URL,只是由GET请求变成了POST请求。
微信服务器在将用户的消息发给开发者服务器地址后,微信服务器在五秒内收不到响应会断掉连接,并且重新发起请求,总共重试三次。如果在调试中,发现用户无法收到响应的消息,可以检查是否消息处理超时。这里的重试三次,可能造成开发者服务器连续接到多次的相同请求,所以还需要进行消息的排重。关于重试的消息排重,有 msgid 的消息推荐使用 msgid 排重。事件类型消息推荐使用 FromUserName + CreateTime 排重。
服务器收到请求必须做出下述回复,这样微信服务器才不会对此作任何处理,并且不会发起重试,否则,将出现严重的错误提示。详见下面说明:
- 直接回复success(推荐方式)
- 直接回复空串(指字节长度为0的空字符串,而不是结构体中content字段的内容为空)
- 若接口文档有指定返回内容,应按文档说明返回
对于客服消息,一旦遇到以下情况,微信会在小程序会话中向用户下发系统提示“该小程序客服暂时无法提供服务,请稍后再试”:
- 开发者在5秒内未回复任何内容
- 开发者回复了异常数据
如果开发者希望增强安全性,可以在开发者中心处开启消息加密,这样,用户发给小程序的消息以及小程序被动回复用户消息都会继续加密。
看下图就知