微信公眾帳號開發教程第6篇-消息及消息處理工具的封裝

 

本篇內容主要講解如何將微信公眾平台定義的消息及消息相關的操作封裝成工具類，方面后期的使用  官方文檔

 

接下來要做的就是將消息請求、回復中定義的消息進行封裝，建立與之對應的Java類（Java是一門面向對象的編程語言，封裝后使用起來更方便），下面的請求消息是指消息推送中定義的消息，響應消息指消息回復中定義的消息。

消息的基類

把消息推送中定義的所有消息都有的字段提取出來，封裝成一個基類，這些公有的字段包括：ToUserName（開發者微信號）、FromUserName（發送方帳號，OPEN_ID）、CreateTime（消息的創建時間）、MsgType（消息類型）、MsgId（消息ID），封裝后基類

package com.javen.course.message.resp;

/**
 * 響應消息的基類
 * 消息基類（公眾帳號 -> 普通用戶）
 * @author Javen
 * @Email [e-mail]
 *
 */
public class BaseMessage {
    // 接收方帳號（收到的OpenID）
    private String ToUserName;
    // 開發者微信號
    private String FromUserName;
    // 消息創建時間 （整型）
    private long CreateTime;
    // 消息類型（text/music/news）
    private String MsgType;
    // 位0x0001被標志時，星標剛收到的消息
    private int FuncFlag;

    public String getToUserName() {
        return ToUserName;
    }

    public void setToUserName(String toUserName) {
        ToUserName = toUserName;
    }

    public String getFromUserName() {
        return FromUserName;
    }

    public void setFromUserName(String fromUserName) {
        FromUserName = fromUserName;
    }

    public long getCreateTime() {
        return CreateTime;
    }

    public void setCreateTime(long createTime) {
        CreateTime = createTime;
    }

    public String getMsgType() {
        return MsgType;
    }

    public void setMsgType(String msgType) {
        MsgType = msgType;
    }

    public int getFuncFlag() {
        return FuncFlag;
    }

    public void setFuncFlag(int funcFlag) {
        FuncFlag = funcFlag;
    }
}

消息之文本消息

 

package com.javen.course.message.resp;

/**
 * 文本消息
 * @author Javen
 * @Email [e-mail]
 *
 */
public class TextMessage extends BaseMessage {
    // 回復的消息內容
    private String Content;

    public String getContent() {
        return Content;
    }

    public void setContent(String content) {
        Content = content;
    }
}

消息之地理位置消息

package com.javen.course.message.resp;

/**
 * 響應消息的基類
 * 消息基類（公眾帳號 -> 普通用戶）
 * @author Javen
 * @Email [e-mail]
 *
 */
public class BaseMessage {
    // 接收方帳號（收到的OpenID）
    private String ToUserName;
    // 開發者微信號
    private String FromUserName;
    // 消息創建時間 （整型）
    private long CreateTime;
    // 消息類型（text/music/news）
    private String MsgType;
    // 位0x0001被標志時，星標剛收到的消息
    private int FuncFlag;

    public String getToUserName() {
        return ToUserName;
    }

    public void setToUserName(String toUserName) {
        ToUserName = toUserName;
    }

    public String getFromUserName() {
        return FromUserName;
    }

    public void setFromUserName(String fromUserName) {
        FromUserName = fromUserName;
    }

    public long getCreateTime() {
        return CreateTime;
    }

    public void setCreateTime(long createTime) {
        CreateTime = createTime;
    }

    public String getMsgType() {
        return MsgType;
    }

    public void setMsgType(String msgType) {
        MsgType = msgType;
    }

    public int getFuncFlag() {
        return FuncFlag;
    }

    public void setFuncFlag(int funcFlag) {
        FuncFlag = funcFlag;
    }
}

消息之圖文消息

 

package com.javen.course.message.resp;

import java.util.List;

/**
 * 圖文消息
 * @author Javen
 * @Email [e-mail]
 *
 */
public class NewsMessage extends BaseMessage {
    // 圖文消息個數，限制為10條以內
    private int ArticleCount;
    // 多條圖文消息信息，默認第一個item為大圖
    private List<Article> Articles;

    public int getArticleCount() {
        return ArticleCount;
    }

    public void setArticleCount(int articleCount) {
        ArticleCount = articleCount;
    }

    public List<Article> getArticles() {
        return Articles;
    }

    public void setArticles(List<Article> articles) {
        Articles = articles;
    }
}

圖文消息中Article類的實體

 

package com.javen.course.message.resp;

/**
 * 圖文消息中Article類的定義
 * @author Javen
 * @Email [e-mail]
 *
 */
public class Article {
    // 圖文消息名稱
    private String Title;
    // 圖文消息描述
    private String Description;
    // 圖片鏈接，支持JPG、PNG格式，較好的效果為大圖640*320，小圖80*80，限制圖片鏈接的域名需要與開發者填寫的基本資料中的Url一致
    private String PicUrl;
    // 點擊圖文消息跳轉鏈接
    private String Url;

    public String getTitle() {
        return Title;
    }

    public void setTitle(String title) {
        Title = title;
    }

    public String getDescription() {
        return null == Description ? "" : Description;
    }

    public void setDescription(String description) {
        Description = description;
    }

    public String getPicUrl() {
        return null == PicUrl ? "" : PicUrl;
    }

    public void setPicUrl(String picUrl) {
        PicUrl = picUrl;
    }

    public String getUrl() {
        return null == Url ? "" : Url;
    }

    public void setUrl(String url) {
        Url = url;
    }

}

 

 消息之音樂消息

 

package com.javen.course.message.resp;

/**
 * 音樂消息  響應消息之音樂消息
 * @author Javen
 * @Email [e-mail]
 *
 */
public class MusicMessage extends BaseMessage {
    // 音樂
    private Music Music;

    public Music getMusic() {
        return Music;
    }

    public void setMusic(Music music) {
        Music = music;
    }
}

音樂消息中Music類的實體

 

package com.javen.course.message.resp;

/**
 *  音樂消息中Music類的定義
 * @author Javen
 * @Email [e-mail]
 *
 */
public class Music {
    // 音樂名稱
    private String Title;
    // 音樂描述
    private String Description;
    // 音樂鏈接
    private String MusicUrl;
    // 高質量音樂鏈接，WIFI環境優先使用該鏈接播放音樂
    private String HQMusicUrl;

    public String getTitle() {
        return Title;
    }

    public void setTitle(String title) {
        Title = title;
    }

    public String getDescription() {
        return Description;
    }

    public void setDescription(String description) {
        Description = description;
    }

    public String getMusicUrl() {
        return MusicUrl;
    }

    public void setMusicUrl(String musicUrl) {
        MusicUrl = musicUrl;
    }

    public String getHQMusicUrl() {
        return HQMusicUrl;
    }

    public void setHQMusicUrl(String musicUrl) {
        HQMusicUrl = musicUrl;
    }

}

 

 

 

 解析請求消息

 微信服務器會將用戶的請求通過doPost方法發送給我們，回顧接入成為開發者

微信公眾帳號開發教程第4篇-----開發模式啟用及接口配置Java

 

@Override
protected void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        // TODO 消息的接收、處理、響應  
    }

 

 

 解析微信發來的請求（XML）

這里我們借助於開源框架dom4j去解析xml（這里使用的是dom4j-1.6.1.jar），然后將解析得到的結果存入HashMap

 

如何將響應消息轉換成xml返回

這里我們將采用開源框架xstream來實現Java類到xml的轉換（這里使用的是xstream-1.3.1.jar）

消息處理類型的封裝

以上代碼如下:

package com.javen.course.util;

import java.io.InputStream;
import java.io.Writer;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;

import org.dom4j.Document;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;


import com.javen.course.message.resp.Article;
import com.javen.course.message.resp.MusicMessage;
import com.javen.course.message.resp.NewsMessage;
import com.javen.course.message.resp.TextMessage;
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;

/**
 * 消息工具類
 * @author Javen
 * @Email [e-mail]
 */
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";

    /**
     * 事件類型：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";
    
    /**
     * 事件類型：scan(用戶已關注時的事件推送)
     */
    public static final String EVENT_TYPE_SCAN = "SCAN";

    /**
     * 解析微信發來的請求（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();
        inputStream = null;

        return map;
    }

    /**
     * 文本消息對象轉換成xml
     * 
     * @param textMessage 文本消息對象   XStream是一個Java對象和XML相互轉換的工具
     * @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塊
     * 
     */
    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, Class clazz) {
                    super.startNode(name, clazz);
                }

                protected void writeText(QuickWriter writer, String text) {
                    if (cdata) {
                        writer.write("<![CDATA[");
                        writer.write(text);
                        writer.write("]]>");
                    } else {
                        writer.write(text);
                    }
                }
            };
        }
    });
}

到這里關於消息及消息處理工具的封裝基本完成，其實就是對請求消息/響應消息建立了與之對應的Java類、對xml消息進行解析、將響應消息的Java對象轉換成xml

 

我的微信公眾賬號 人臉識別、音樂點播、在線翻譯、天氣查詢、公交查詢、周公解夢、星座運勢、手機歸屬地查詢、聊天嘮嗑等

 

 

歡迎加入群：347245650   345531810 進行討論相互交流  我的微信號：572839485

我的微信公眾賬號  我的微社區歡迎關注 索取源碼←請點擊