前言
这篇博客主要目的是总结微信的消息传输和回复,后端程序需要识别不同的消息类型,并作出回复,相关代码也只是原有大牛的基础上改进的,并没有做过多的创新。
微信消息传输
先对微信的数据传输做一个简单的说明,其实这个一张图就可以搞定
这个图来自这篇博客:http://www.cnblogs.com/xdp-gacl/p/5151857.html ,其实只要说明一点,微信用户在发消息给公众号后台服务器的时候,中间会有一个微信服务器做为中转,其中消息的发送格式都为xml格式。
准备工作
已经完成token认证(上一篇博客中是用php完成的token认证)需要明确的是,在配置了token,之后需要在测试公众号中修改接口配置信息,这里配置的接口配置信息,就是用户访问公众号的请求路径。
完成配置之后,就开始码代码了
后台代码
建立一个maven项目,在自己实践的过程中,遇到了一个用maven架构建立webapp失败的问题,删了库中的jar包,插件,折腾了好久都没解决,后来决定换方式,建立一个maven空项目,然后将这个空项目标记为web项目,终于解决问题。具体操作可以见这篇博客:idea将普通maven项目转成web项目。当然还有其他方法,在线构建spring boot项目也是可以的,这个看自己吧。我这里依旧采用比较传统的方法。
1、CoreServlet代码
package com.learn.web.servlet;
import com.learn.service.CoreService;
import com.learn.util.SignUtil;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.Map;
/**
* author : liman
* create time : 2018/9/5
* QQ:657271181
* e-mail:[email protected]
*/
@WebServlet(urlPatterns = "/CoreServlet")
public class CoreServlet extends HttpServlet {
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
// 将请求、响应的编码均设置为UTF-8(防止中文乱码)
request.setCharacterEncoding("UTF-8");
response.setCharacterEncoding("UTF-8");
System.out.println("===================开始消息的处理==================");
System.out.println(request.getContextPath());
Map<String, String[]> parameterMap = request.getParameterMap();
System.out.println("请求参数列表");
for(Map.Entry<String,String[]> entity: parameterMap.entrySet()){
System.out.println(entity.getKey());
for(String str:entity.getValue()){
System.out.print(str+" ");
}
System.out.println();
}
String respMessage = "";
try{
// 调用核心业务类接收消息、处理消息
respMessage = CoreService.processRequest(request);
System.out.println(respMessage);
}catch (Exception e){
e.printStackTrace();
}
response.getWriter().println(respMessage);
}
protected void doGet(HttpServletRequest request, HttpServletResponse response) {
// 微信加密签名
String signature = request.getParameter("signature");
// 时间戳
String timestamp = request.getParameter("timestamp");
// 随机数
String nonce = request.getParameter("nonce");
// 随机字符串
String echostr = request.getParameter("echostr");
PrintWriter out = null;
try {
out = response.getWriter();
} catch (IOException e) {
e.printStackTrace();
}
// 通过检验signature对请求进行校验,若校验成功则原样返回echostr,表示接入成功,否则接入失败
if (SignUtil.checkSignature(signature, timestamp, nonce)) {
out.print(echostr);
}
out.close();
}
}
需要知道一点的是:微信公众号在token校验的时候发送的是get请求,但是其他操作都是post请求,因此CoreServlet中的doPost就是承接所有客户端的请求。
其中的CoreService.processRequest(request)就是处理各种请求
2、CoreService的代码
package com.learn.service;
import com.learn.message.response.TextMessage;
import com.learn.message.MessageUtil;
import javax.servlet.http.HttpServletRequest;
import java.util.Date;
import java.util.Map;
/**
* author : liman
* create time : 2018/9/5
* QQ:657271181
* e-mail:[email protected]
*/
public class CoreService {
/**
* 消息预处理
* @param request
* @return
*/
public static String processRequest(HttpServletRequest request) {
String respMessage = null;
try {
// 默认返回的文本消息内容
String respContent = "请求处理异常,请稍候尝试!";
System.out.println("==============开始消息xml解析============");
// xml请求解析
Map<String, String> requestMap = MessageUtil.parseXml(request);
// 发送方帐号(open_id)
String fromUserName = requestMap.get("FromUserName");
// 公众帐号
String toUserName = requestMap.get("ToUserName");
// 消息类型
String msgType = requestMap.get("MsgType");
// 回复文本消息
TextMessage textMessage = new TextMessage();
textMessage.setToUserName(fromUserName);
textMessage.setFromUserName(toUserName);
textMessage.setCreateTime(new Date().getTime());
textMessage.setMsgType(MessageUtil.RESP_MESSAGE_TYPE_TEXT);
textMessage.setFuncFlag(0);
// 文本消息
if (msgType.equals(MessageUtil.REQ_MESSAGE_TYPE_TEXT)) {
respContent = "您发送的是文本消息!";
}
// 图片消息
else if (msgType.equals(MessageUtil.REQ_MESSAGE_TYPE_IMAGE)) {
respContent = "您发送的是图片消息!";
}
// 地理位置消息
else if (msgType.equals(MessageUtil.REQ_MESSAGE_TYPE_LOCATION)) {
respContent = "您发送的是地理位置消息!";
}
// 链接消息
else if (msgType.equals(MessageUtil.REQ_MESSAGE_TYPE_LINK)) {
respContent = "您发送的是链接消息!";
}
// 音频消息
else if (msgType.equals(MessageUtil.REQ_MESSAGE_TYPE_VOICE)) {
respContent = "您发送的是音频消息!";
}
//视频消息
else if(msgType.equals(MessageUtil.REQ_MESSAGE_TYPE_VIDEO)){
respContent="居然敢给我发小视频!";
}
// 事件推送
else if (msgType.equals(MessageUtil.REQ_MESSAGE_TYPE_EVENT)) {
// 事件类型
String eventType = requestMap.get("Event");
// 订阅
if (eventType.equals(MessageUtil.EVENT_TYPE_SUBSCRIBE)) {
respContent = "谢谢您的关注!";
}
// 取消订阅
else if (eventType.equals(MessageUtil.EVENT_TYPE_UNSUBSCRIBE)) {
// TODO 取消订阅后用户再收不到公众号发送的消息,因此不需要回复消息
}
// 自定义菜单点击事件
else if (eventType.equals(MessageUtil.EVENT_TYPE_CLICK)) {
// TODO 自定义菜单权没有开放,暂不处理该类消息
}
}
textMessage.setContent(respContent);
respMessage = MessageUtil.textMessageToXml(textMessage);
} catch (Exception e) {
e.printStackTrace();
}
return respMessage;
}
}
一看见各种if else语句就头疼,这个是后面需要优化的点。这里还有一个优化点是:所有的消息都以文本方式回复,没有涉及到复杂的消息回复。
其中有两个方法需要明确:MessageUtil.parseXml(request),这个是将请求消息的XML数据转化成Map类型。textMessageToXML(textMessage)这个只是以文本消息的回复。所以这里只用到了将text类信息转换成xml文档。
3、MessageUtil的代码
package com.learn.message;
import com.learn.message.response.TextMessage;
import com.learn.message.response.Article;
import com.learn.message.response.MusicMessage;
import com.learn.message.response.NewsMessage;
import com.thoughtworks.xstream.XStream;
import com.thoughtworks.xstream.core.util.QuickWriter;
import com.thoughtworks.xstream.io.HierarchicalStreamWriter;
import com.thoughtworks.xstream.io.xml.PrettyPrintWriter;
import com.thoughtworks.xstream.io.xml.XppDriver;
import org.dom4j.Document;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;
import javax.servlet.http.HttpServletRequest;
import java.io.InputStream;
import java.io.Writer;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* author : liman
* create time : 2018/9/5
* QQ:657271181
* e-mail:[email protected]
*/
public class MessageUtil {
/**
* 返回消息类型:文本
*/
public static final String RESP_MESSAGE_TYPE_TEXT = "text";
/**
* 返回消息类型:音乐
*/
public static final String RESP_MESSAGE_TYPE_MUSIC = "music";
/**
* 返回消息类型:图文
*/
public static final String RESP_MESSAGE_TYPE_NEWS = "news";
/**
* 请求消息类型:文本
*/
public static final String REQ_MESSAGE_TYPE_TEXT = "text";
/**
* 请求消息类型:图片
*/
public static final String REQ_MESSAGE_TYPE_IMAGE = "image";
/**
* 请求消息类型:链接
*/
public static final String REQ_MESSAGE_TYPE_LINK = "link";
/**
* 请求消息类型:地理位置
*/
public static final String REQ_MESSAGE_TYPE_LOCATION = "location";
/**
* 请求消息类型:音频
*/
public static final String REQ_MESSAGE_TYPE_VOICE = "voice";
/**
* 请求消息类型:推送
*/
public static final String REQ_MESSAGE_TYPE_EVENT = "event";
/**
* 请求消息类型:视频
*/
public static final String REQ_MESSAGE_TYPE_VIDEO = "video";
/**
* 事件类型:subscribe(订阅)
*/
public static final String EVENT_TYPE_SUBSCRIBE = "subscribe";
/**
* 事件类型:unsubscribe(取消订阅)
*/
public static final String EVENT_TYPE_UNSUBSCRIBE = "unsubscribe";
/**
* 事件类型:CLICK(自定义菜单点击事件)
*/
public static final String EVENT_TYPE_CLICK = "CLICK";
/**
* 解析微信发来的请求(XML)
*
* @param request
* @return
* @throws Exception
*/
@SuppressWarnings("unchecked")
public static Map<String, String> parseXml(HttpServletRequest request) throws Exception {
// 将解析结果存储在HashMap中
Map<String, String> map = new HashMap<String, String>();
// 从request中取得输入流
InputStream inputStream = request.getInputStream();
// 读取输入流
SAXReader reader = new SAXReader();
Document document = reader.read(inputStream);
// 得到xml根元素
Element root = document.getRootElement();
// 得到根元素的所有子节点
List<Element> elementList = root.elements();
// 遍历所有子节点
for (Element e : elementList)
map.put(e.getName(), e.getText());
// 释放资源
inputStream.close();
return map;
}
/**
* 文本消息对象转换成xml
*
* @param textMessage 文本消息对象
* @return xml
*/
public static String textMessageToXml(TextMessage textMessage) {
xstream.alias("xml", textMessage.getClass());
return xstream.toXML(textMessage);
}
/**
* 音乐消息对象转换成xml
*
* @param musicMessage 音乐消息对象
* @return xml
*/
public static String musicMessageToXml(MusicMessage musicMessage) {
xstream.alias("xml", musicMessage.getClass());
return xstream.toXML(musicMessage);
}
/**
* 图文消息对象转换成xml
*
* @param newsMessage 图文消息对象
* @return xml
*/
public static String newsMessageToXml(NewsMessage newsMessage) {
xstream.alias("xml", newsMessage.getClass());
xstream.alias("item", new Article().getClass());
return xstream.toXML(newsMessage);
}
/**
* 扩展xstream,使其支持CDATA块
*
* @date 2013-05-19
*/
private static XStream xstream = new XStream(new XppDriver() {
public HierarchicalStreamWriter createWriter(Writer out) {
return new PrettyPrintWriter(out) {
// 对所有xml节点的转换都增加CDATA标记
boolean cdata = true;
@SuppressWarnings("unchecked")
public void startNode(String name) {
super.startNode(name);
}
protected void writeText(QuickWriter writer, String text) {
if (cdata) {
writer.write("<![CDATA[");
writer.write(text);
writer.write("]]>");
} else {
writer.write(text);
}
}
};
}
});
}
4、各种消息类型的封装
这个在网上都有,腾讯官方文档也给出了各种消息类型,这里不再详细介绍,参考如下博客:各种微信消息介绍。
测试结果
基本所有消息都能识别,后面会学习不同的回复消息。有时间优化一下代码,学习为主。
完整代码地址:https://github.com/liman657/weChatPub
总结:
其实这个实例比较简单,但是耗费了将近一天的时间,后来才发现,是在消息类实体中将一些属性的首字母小写了,而微信xml数据包中的属性首字母都是大写,导致在封装响应消息的时候出现未知错误,所以才有了上面图中一大堆的公众号提供服务异常。消息实体bean中属性名称要一一对应,大小写也要一致