微信公众平台java开发详解（工程代码+解析）

时间：2024-11-23 13:05:07

原文：http://blog.****.net/pamchen/article/details/38718947

说明：
本次的教程主要是对微信公众平台开发者模式的讲解，网络上很多类似文章，但很多都让初学微信开发的人一头雾水，所以总结自己的微信开发经验，将微信开发的整个过程系统的列出，并对主要代码进行讲解分析，让初学者尽快上手。

在阅读本文之前，应对微信公众平台的官方开发文档有所了解，知道接收和发送的都是xml格式的数据。另外，在做内容回复时用到了图灵机器人的api接口，这是一个自然语言解析的开放平台，可以帮我们解决整个微信开发过程中最困难的问题，此处不多讲，下面会有其详细的调用方式。

1.1 在登录微信官方平台之后，开启开发者模式，此时需要我们填写url和token，所谓url就是我们自己服务器的接口，用WechatServlet.java来实现，相关解释已经在注释中说明，代码如下：

  1. package demo.servlet;
  2. import java.io.BufferedReader;
  3. import java.io.IOException;
  4. import java.io.InputStream;
  5. import java.io.InputStreamReader;
  6. import java.io.OutputStream;
  7. import javax.servlet.ServletException;
  8. import javax.servlet.http.HttpServlet;
  9. import javax.servlet.http.HttpServletRequest;
  10. import javax.servlet.http.HttpServletResponse;
  11. import demo.process.WechatProcess;
  12. /**
  13. * 微信服务端收发消息接口
  14. *
  15. * @author pamchen-1
  16. *
  17. */
  18. public class WechatServlet extends HttpServlet {
  19. /**
  20. * The doGet method of the servlet. <br>
  21. *
  22. * This method is called when a form has its tag value method equals to get.
  23. *
  24. * @param request
  25. *            the request send by the client to the server
  26. * @param response
  27. *            the response send by the server to the client
  28. * @throws ServletException
  29. *             if an error occurred
  30. * @throws IOException
  31. *             if an error occurred
  32. */
  33. public void doGet(HttpServletRequest request, HttpServletResponse response)
  34. throws ServletException, IOException {
  35. request.setCharacterEncoding("UTF-8");
  36. response.setCharacterEncoding("UTF-8");
  37. /** 读取接收到的xml消息 */
  38. StringBuffer sb = new StringBuffer();
  39. InputStream is = request.getInputStream();
  40. InputStreamReader isr = new InputStreamReader(is, "UTF-8");
  41. BufferedReader br = new BufferedReader(isr);
  42. String s = "";
  43. while ((s = br.readLine()) != null) {
  44. sb.append(s);
  45. }
  46. String xml = sb.toString(); //次即为接收到微信端发送过来的xml数据
  47. String result = "";
  48. /** 判断是否是微信接入激活验证，只有首次接入验证时才会收到echostr参数，此时需要把它直接返回 */
  49. String echostr = request.getParameter("echostr");
  50. if (echostr != null && echostr.length() > 1) {
  51. result = echostr;
  52. } else {
  53. //正常的微信处理流程
  54. result = new WechatProcess().processWechatMag(xml);
  55. }
  56. try {
  57. OutputStream os = response.getOutputStream();
  58. os.write(result.getBytes("UTF-8"));
  59. os.flush();
  60. os.close();
  61. } catch (Exception e) {
  62. e.printStackTrace();
  63. }
  64. }
  65. /**
  66. * The doPost method of the servlet. <br>
  67. *
  68. * This method is called when a form has its tag value method equals to
  69. * post.
  70. *
  71. * @param request
  72. *            the request send by the client to the server
  73. * @param response
  74. *            the response send by the server to the client
  75. * @throws ServletException
  76. *             if an error occurred
  77. * @throws IOException
  78. *             if an error occurred
  79. */
  80. public void doPost(HttpServletRequest request, HttpServletResponse response)
  81. throws ServletException, IOException {
  82. doGet(request, response);
  83. }
  84. }

1.2 相应的web.xml配置信息如下，在生成WechatServlet.java的同时，可自动生成web.xml中的配置。前面所提到的url处可以填写例如：http;//服务器地址/项目名/wechat.do

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <web-app version="2.5"
  3. xmlns="http://java.sun.com/xml/ns/javaee"
  4. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  5. xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
  6. http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
  7. <servlet>
  8. <description>This is the description of my J2EE component</description>
  9. <display-name>This is the display name of my J2EE component</display-name>
  10. <servlet-name>WechatServlet</servlet-name>
  11. <servlet-class>demo.servlet.WechatServlet</servlet-class>
  12. </servlet>
  13. <servlet-mapping>
  14. <servlet-name>WechatServlet</servlet-name>
  15. <url-pattern>/wechat.do</url-pattern>
  16. </servlet-mapping>
  17. <welcome-file-list>
  18. <welcome-file>index.jsp</welcome-file>
  19. </welcome-file-list>
  20. </web-app>

1.3 通过以上代码，我们已经实现了微信公众平台开发的框架，即开通开发者模式并成功接入、接收消息和发送消息这三个步骤。

下面就讲解其核心部分——解析接收到的xml数据，并以文本类消息为例，通过图灵机器人api接口实现智能回复。

2.1 首先看一下整体流程处理代码，包括：xml数据处理、调用图灵api、封装返回的xml数据。

  1. package demo.process;
  2. import java.util.Date;
  3. import demo.entity.ReceiveXmlEntity;
  4. /**
  5. * 微信xml消息处理流程逻辑类
  6. * @author pamchen-1
  7. *
  8. */
  9. public class WechatProcess {
  10. /**
  11. * 解析处理xml、获取智能回复结果（通过图灵机器人api接口）
  12. * @param xml 接收到的微信数据
  13. * @return  最终的解析结果（xml格式数据）
  14. */
  15. public String processWechatMag(String xml){
  16. /** 解析xml数据 */
  17. ReceiveXmlEntity xmlEntity = new ReceiveXmlProcess().getMsgEntity(xml);
  18. /** 以文本消息为例，调用图灵机器人api接口，获取回复内容 */
  19. String result = "";
  20. if("text".endsWith(xmlEntity.getMsgType())){
  21. result = new TulingApiProcess().getTulingResult(xmlEntity.getContent());
  22. }
  23. /** 此时，如果用户输入的是“你好”，在经过上面的过程之后，result为“你也好”类似的内容
  24. *  因为最终回复给微信的也是xml格式的数据，所有需要将其封装为文本类型返回消息
  25. * */
  26. result = new FormatXmlProcess().formatXmlAnswer(xmlEntity.getFromUserName(), xmlEntity.getToUserName(), result);
  27. return result;
  28. }
  29. }

2.2 解析接收到的xml数据，此处有两个类，ReceiveXmlEntity.java和ReceiveXmlProcess.java，通过反射的机制动态调用实体类中的set方法，可以避免很多重复的判断，提高代码效率，代码如下：

  1. package demo.entity;
  2. /**
  3. * 接收到的微信xml实体类
  4. * @author pamchen-1
  5. *
  6. */
  7. public class ReceiveXmlEntity {
  8. private String ToUserName="";
  9. private String FromUserName="";
  10. private String CreateTime="";
  11. private String MsgType="";
  12. private String MsgId="";
  13. private String Event="";
  14. private String EventKey="";
  15. private String Ticket="";
  16. private String Latitude="";
  17. private String Longitude="";
  18. private String Precision="";
  19. private String PicUrl="";
  20. private String MediaId="";
  21. private String Title="";
  22. private String Description="";
  23. private String Url="";
  24. private String Location_X="";
  25. private String Location_Y="";
  26. private String Scale="";
  27. private String Label="";
  28. private String Content="";
  29. private String Format="";
  30. private String Recognition="";
  31. public String getRecognition() {
  32. return Recognition;
  33. }
  34. public void setRecognition(String recognition) {
  35. Recognition = recognition;
  36. }
  37. public String getFormat() {
  38. return Format;
  39. }
  40. public void setFormat(String format) {
  41. Format = format;
  42. }
  43. public String getContent() {
  44. return Content;
  45. }
  46. public void setContent(String content) {
  47. Content = content;
  48. }
  49. public String getLocation_X() {
  50. return Location_X;
  51. }
  52. public void setLocation_X(String locationX) {
  53. Location_X = locationX;
  54. }
  55. public String getLocation_Y() {
  56. return Location_Y;
  57. }
  58. public void setLocation_Y(String locationY) {
  59. Location_Y = locationY;
  60. }
  61. public String getScale() {
  62. return Scale;
  63. }
  64. public void setScale(String scale) {
  65. Scale = scale;
  66. }
  67. public String getLabel() {
  68. return Label;
  69. }
  70. public void setLabel(String label) {
  71. Label = label;
  72. }
  73. public String getTitle() {
  74. return Title;
  75. }
  76. public void setTitle(String title) {
  77. Title = title;
  78. }
  79. public String getDescription() {
  80. return Description;
  81. }
  82. public void setDescription(String description) {
  83. Description = description;
  84. }
  85. public String getUrl() {
  86. return Url;
  87. }
  88. public void setUrl(String url) {
  89. Url = url;
  90. }
  91. public String getPicUrl() {
  92. return PicUrl;
  93. }
  94. public void setPicUrl(String picUrl) {
  95. PicUrl = picUrl;
  96. }
  97. public String getMediaId() {
  98. return MediaId;
  99. }
  100. public void setMediaId(String mediaId) {
  101. MediaId = mediaId;
  102. }
  103. public String getEventKey() {
  104. return EventKey;
  105. }
  106. public void setEventKey(String eventKey) {
  107. EventKey = eventKey;
  108. }
  109. public String getTicket() {
  110. return Ticket;
  111. }
  112. public void setTicket(String ticket) {
  113. Ticket = ticket;
  114. }
  115. public String getLatitude() {
  116. return Latitude;
  117. }
  118. public void setLatitude(String latitude) {
  119. Latitude = latitude;
  120. }
  121. public String getLongitude() {
  122. return Longitude;
  123. }
  124. public void setLongitude(String longitude) {
  125. Longitude = longitude;
  126. }
  127. public String getPrecision() {
  128. return Precision;
  129. }
  130. public void setPrecision(String precision) {
  131. Precision = precision;
  132. }
  133. public String getEvent() {
  134. return Event;
  135. }
  136. public void setEvent(String event) {
  137. Event = event;
  138. }
  139. public String getMsgId() {
  140. return MsgId;
  141. }
  142. public void setMsgId(String msgId) {
  143. MsgId = msgId;
  144. }
  145. public String getToUserName() {
  146. return ToUserName;
  147. }
  148. public void setToUserName(String toUserName) {
  149. ToUserName = toUserName;
  150. }
  151. public String getFromUserName() {
  152. return FromUserName;
  153. }
  154. public void setFromUserName(String fromUserName) {
  155. FromUserName = fromUserName;
  156. }
  157. public String getCreateTime() {
  158. return CreateTime;
  159. }
  160. public void setCreateTime(String createTime) {
  161. CreateTime = createTime;
  162. }
  163. public String getMsgType() {
  164. return MsgType;
  165. }
  166. public void setMsgType(String msgType) {
  167. MsgType = msgType;
  168. }
  169. }
  1. package demo.process;
  2. import java.lang.reflect.Field;
  3. import java.lang.reflect.Method;
  4. import java.util.Iterator;
  5. import org.dom4j.Document;
  6. import org.dom4j.DocumentHelper;
  7. import org.dom4j.Element;
  8. import demo.entity.ReceiveXmlEntity;
  9. /**
  10. * 解析接收到的微信xml，返回消息对象
  11. * @author pamchen-1
  12. *
  13. */
  14. public class ReceiveXmlProcess {
  15. /**
  16. * 解析微信xml消息
  17. * @param strXml
  18. * @return
  19. */
  20. public ReceiveXmlEntity getMsgEntity(String strXml){
  21. ReceiveXmlEntity msg = null;
  22. try {
  23. if (strXml.length() <= 0 || strXml == null)
  24. return null;
  25. // 将字符串转化为XML文档对象
  26. Document document = DocumentHelper.parseText(strXml);
  27. // 获得文档的根节点
  28. Element root = document.getRootElement();
  29. // 遍历根节点下所有子节点
  30. Iterator<?> iter = root.elementIterator();
  31. // 遍历所有结点
  32. msg = new ReceiveXmlEntity();
  33. //利用反射机制，调用set方法
  34. //获取该实体的元类型
  35. Class<?> c = Class.forName("demo.entity.ReceiveXmlEntity");
  36. msg = (ReceiveXmlEntity)c.newInstance();//创建这个实体的对象
  37. while(iter.hasNext()){
  38. Element ele = (Element)iter.next();
  39. //获取set方法中的参数字段（实体类的属性）
  40. Field field = c.getDeclaredField(ele.getName());
  41. //获取set方法，field.getType())获取它的参数数据类型
  42. Method method = c.getDeclaredMethod("set"+ele.getName(), field.getType());
  43. //调用set方法
  44. method.invoke(msg, ele.getText());
  45. }
  46. } catch (Exception e) {
  47. // TODO: handle exception
  48. System.out.println("xml 格式异常: "+ strXml);
  49. e.printStackTrace();
  50. }
  51. return msg;
  52. }
  53. }

2.3 调用图灵机器人api接口，获取智能回复内容：

  1. package demo.process;
  2. import java.io.IOException;
  3. import java.io.UnsupportedEncodingException;
  4. import java.net.URLEncoder;
  5. import org.apache.http.HttpResponse;
  6. import org.apache.http.client.ClientProtocolException;
  7. import org.apache.http.client.methods.HttpGet;
  8. import org.apache.http.impl.client.HttpClients;
  9. import org.apache.http.util.EntityUtils;
  10. import org.json.JSONException;
  11. import org.json.JSONObject;
  12. /**
  13. * 调用图灵机器人api接口，获取智能回复内容
  14. * @author pamchen-1
  15. *
  16. */
  17. public class TulingApiProcess {
  18. /**
  19. * 调用图灵机器人api接口，获取智能回复内容，解析获取自己所需结果
  20. * @param content
  21. * @return
  22. */
  23. public String getTulingResult(String content){
  24. /** 此处为图灵api接口，参数key需要自己去注册申请，先以11111111代替 */
  25. String apiUrl = "http://www.tuling123.com/openapi/api?key=11111111&info=";
  26. String param = "";
  27. try {
  28. param = apiUrl+URLEncoder.encode(content,"utf-8");
  29. } catch (UnsupportedEncodingException e1) {
  30. // TODO Auto-generated catch block
  31. e1.printStackTrace();
  32. } //将参数转为url编码
  33. /** 发送httpget请求 */
  34. HttpGet request = new HttpGet(param);
  35. String result = "";
  36. try {
  37. HttpResponse response = HttpClients.createDefault().execute(request);
  38. if(response.getStatusLine().getStatusCode()==200){
  39. result = EntityUtils.toString(response.getEntity());
  40. }
  41. } catch (ClientProtocolException e) {
  42. e.printStackTrace();
  43. } catch (IOException e) {
  44. e.printStackTrace();
  45. }
  46. /** 请求失败处理 */
  47. if(null==result){
  48. return "对不起，你说的话真是太高深了……";
  49. }
  50. try {
  51. JSONObject json = new JSONObject(result);
  52. //以code=100000为例，参考图灵机器人api文档
  53. if(100000==json.getInt("code")){
  54. result = json.getString("text");
  55. }
  56. } catch (JSONException e) {
  57. // TODO Auto-generated catch block
  58. e.printStackTrace();
  59. }
  60. return result;
  61. }
  62. }

2.4 将结果封装为微信规定的xml格式，并返回给1.1中创建的servlet接口。

  1. package demo.process;
  2. import java.util.Date;
  3. /**
  4. * 封装最终的xml格式结果
  5. * @author pamchen-1
  6. *
  7. */
  8. public class FormatXmlProcess {
  9. /**
  10. * 封装文字类的返回消息
  11. * @param to
  12. * @param from
  13. * @param content
  14. * @return
  15. */
  16. public String formatXmlAnswer(String to, String from, String content) {
  17. StringBuffer sb = new StringBuffer();
  18. Date date = new Date();
  19. sb.append("<xml><ToUserName><![CDATA[");
  20. sb.append(to);
  21. sb.append("]]></ToUserName><FromUserName><![CDATA[");
  22. sb.append(from);
  23. sb.append("]]></FromUserName><CreateTime>");
  24. sb.append(date.getTime());
  25. sb.append("</CreateTime><MsgType><![CDATA[text]]></MsgType><Content><![CDATA[");
  26. sb.append(content);
  27. sb.append("]]></Content><FuncFlag>0</FuncFlag></xml>");
  28. return sb.toString();
  29. }
  30. }

总结，以上便是微信公众平台开发的全部流程，整体来看并不复杂，要非常感谢图灵机器人提供的api接口，帮我们解决了智能回复这一高难度问题。其他类型的消息处理与示例中类似，有兴趣的开发者可以联系我进行交流学习，希望本文对大家有所帮助。

本问中的代码示例已经上传到了****的个人资源中，有需要的可以去下载：http://download.****.net/detail/pamchen/7793979

相关文章