微信公眾號開發（二）識別訊息型別

謎一樣的Coder發表於2018-09-06
型別

前言

這篇部落格主要目的是總結微信的訊息傳輸和回覆，後端程式需要識別不同的訊息型別，並作出回覆，相關程式碼也只是原有大牛的基礎上改進的，並沒有做過多的創新。

微信訊息傳輸

先對微信的資料傳輸做一個簡單的說明，其實這個一張圖就可以搞定

這個圖來自這篇部落格：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:liman65727@sina.com
 */
@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:liman65727@sina.com
 */
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:liman65727@sina.com
 */
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中屬性名稱要一一對應，大小寫也要一致

相關文章