微信消息部分開發-消息類和消息工具類

消息其實是由用戶發給你的公衆帳號的，消息先被微信平臺接收到，然後微信平臺會將該消息轉給你在開發模式接口配置中指定的URL地址。

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

/**
 * 請求消息基類（普通用戶 -> 公衆帳號）
 * @author bym @date 2018年7月4日
 */
public class BaseMessage {
	// 開發者微信號
	private String ToUserName;
	// 發送方帳號（一個OpenID）
	private String FromUserName;
	// 消息創建時間 （整型）
	private long CreateTime;
	// 消息類型
	private String MsgType;
	// 消息id，64位整型
	private long MsgId;
	
	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 long getMsgId() {
		return MsgId;
	}

	public void setMsgId(long msgId) {
		MsgId = msgId;
	}
}

請求消息之文本消息

/**
 * 文本消息
 * @author bym @date 2018年7月4日
 */
public class TextMessage extends BaseMessage {
	// 消息內容
	private String Content;

	public String getContent() {
		return Content;
	}

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

請求消息之圖片消息

/**
 * 圖片消息
 * @author bym @date 2018年7月4日
 */
public class ImageMessage extends BaseMessage {
	// 圖片鏈接
	private String PicUrl;

	public String getPicUrl() {
		return PicUrl;
	}

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

請求消息之地理位置消息

/**
 * 地理位置消息
 * @author bym @date 2018年7月4日
 */
public class LocationMessage extends BaseMessage {
	// 地理位置維度
	private String Location_X;
	// 地理位置經度
	private String Location_Y;
	// 地圖縮放大小
	private String Scale;
	// 地理位置信息
	private String Label;

	public String getLocation_X() {
		return Location_X;
	}

	public void setLocation_X(String location_X) {
		Location_X = location_X;
	}

	public String getLocation_Y() {
		return Location_Y;
	}

	public void setLocation_Y(String location_Y) {
		Location_Y = location_Y;
	}

	public String getScale() {
		return Scale;
	}

	public void setScale(String scale) {
		Scale = scale;
	}

	public String getLabel() {
		return Label;
	}

	public void setLabel(String label) {
		Label = label;
	}
}

請求消息之鏈接消息   

/**
 * 鏈接消息
 * @author bym @date 2018年7月4日
 */
public class LinkMessage extends BaseMessage {
	// 消息標題
	private String Title;
	// 消息描述
	private String Description;
	// 消息鏈接
	private String Url;

	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 getUrl() {
		return Url;
	}

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

請求消息之語音消息

/**
 * 語音消息
 * @author bym @date 2018年7月4日
 */
public class VoiceMessage extends BaseMessage {
	// 媒體ID
	private String MediaId;
	// 語音格式
	private String Format;
	// 語音識別結果，UTF8編碼
	private String Recognition;

	public String getMediaId() {
		return MediaId;
	}

	public void setMediaId(String mediaId) {
		MediaId = mediaId;
	}

	public String getFormat() {
		return Format;
	}

	public void setFormat(String format) {
		Format = format;
	}

	public String getRecognition() {
		return Recognition;
	}

	public void setRecognition(String recognition) {
		Recognition = recognition;
	}
}

請求消息之視頻消息

/**
 * 視頻消息
 * @author bym @date 2018年7月4日
 */
public class VideoMessage extends BaseMessage {
	// 視頻消息媒體id
	private String MediaId;
	// 視頻消息縮略圖的媒體id
	private String ThumbMediaId;

	public String getMediaId() {
		return MediaId;
	}

	public void setMediaId(String mediaId) {
		MediaId = mediaId;
	}

	public String getThumbMediaId() {
		return ThumbMediaId;
	}

	public void setThumbMediaId(String thumbMediaId) {
		ThumbMediaId = thumbMediaId;
	}
}

響應消息的基類

/**
 * 消息基類（公衆帳號 -> 普通用戶）
 * @author bym @date 2018年7月4日
 */
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;
		}
}

響應文本消息

/**
 * 文本消息
 * @author bym @date 2018年7月4日
 */
public class TextMessage extends BaseMessage {
	// 回覆的消息內容
	private String Content;

	public String getContent() {
		return Content;
	}

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

響應圖片消息

/**
 * 圖片消息
 * @author bym @date 2018年7月4日
 */
public class ImageMessage extends BaseMessage {
	// 圖片
	private Image Image;

	public Image getImage() {
		return Image;
	}

	public void setImage(Image image) {
		Image = image;
	}
}

圖片消息中Image類的定義

/**
 * 圖片model
 * @author bym @date 2018年7月4日
 */
public class Image {
	// 媒體文件id
	private String MediaId;

	public String getMediaId() {
		return MediaId;
	}

	public void setMediaId(String mediaId) {
		MediaId = mediaId;
	}
}

響應圖文消息

/**
 * 文本消息
 * @@author bym @date 2018年7月4日
 */
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類的定義

/**
 * 圖文model
 * @author bym @date 2018年7月4日
 */
public class Article {
	// 圖文消息名稱
	private String Title;
	// 圖文消息描述
	private String Description;
	// 圖片鏈接，支持JPG、PNG格式，較好的效果爲大圖640*320，小圖80*80
	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;
	}
}

響應語音消息

/**
 * 語音消息
 * @author bym @date 2018年7月4日
 */
public class VoiceMessage extends BaseMessage {
	// 語音
	private Voice Voice;

	public Voice getVoice() {
		return Voice;
	}

	public void setVoice(Voice voice) {
		Voice = voice;
	}
}

語音消息中Voice類的定義

/**
 * 語音model
 * @author bym @date 2018年7月4日
 */
public class Voice {
	// 媒體文件id
	private String MediaId;

	public String getMediaId() {
		return MediaId;
	}

	public void setMediaId(String mediaId) {
		MediaId = mediaId;
	}
}

響應音樂消息

/**
 * 音樂消息
 * @author bym @date 2018年7月4日
 */
public class MusicMessage extends BaseMessage {
	// 音樂
	private Music Music;

	public Music getMusic() {
		return Music;
	}

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

音樂消息中Music類的定義

/**
 * 音樂model
 * @author bym @date 2018年7月4日
 */
public class Music {
	// 音樂標題
	private String Title;
	// 音樂描述
	private String Description;
	// 音樂鏈接
	private String MusicUrl;
	// 高質量音樂鏈接，WIFI環境優先使用該鏈接播放音樂
	private String HQMusicUrl;
	// 縮略圖的媒體id，通過上傳多媒體文件得到的id
	private String ThumbMediaId;

	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;
	}

	public String getThumbMediaId() {
		return ThumbMediaId;
	}

	public void setThumbMediaId(String thumbMediaId) {
		ThumbMediaId = thumbMediaId;
	}
}

響應視頻消息

/**
 * 視頻消息
 * @author bym @date 2018年7月4日
 */
public class VideoMessage extends BaseMessage {
	// 視頻
	private Video Video;

	public Video getVideo() {
		return Video;
	}

	public void setVideo(Video video) {
		Video = video;
	}
}

視頻消息中Video類的定義

/**
 * 視頻model
 * @author bym @date 2018年7月4日
 */
public class Video {
	// 媒體文件id
	private String MediaId;
	// 縮略圖的媒體id
	private String ThumbMediaId;

	public String getMediaId() {
		return MediaId;
	}

	public void setMediaId(String mediaId) {
		MediaId = mediaId;
	}

	public String getThumbMediaId() {
		return ThumbMediaId;
	}

	public void setThumbMediaId(String thumbMediaId) {
		ThumbMediaId = thumbMediaId;
	}
}

解析請求消息

微信服務器會用doPost的方法將用戶信息發送給我們.前邊寫doGet的時候把doPost寫好了.

doPost方法有兩個參數，request中封裝了請求相關的所有內容，可以從request中取出微信服務器發來的消息；而通過response我們可以對接收到的消息進行響應，即發送消息。

那麼如何解析請求消息的問題也就轉化爲如何從request中得到微信服務器發送給我們的xml格式的消息了。這裏我們藉助於開源框架dom4j去解析xml（這裏使用的是dom4j-1.6.1.jar），然後將解析得到的結果存入HashMap，解析請求消息的方法如下：

	@SuppressWarnings("unchecked")
	public static Map<String, String> parseXml(HttpServletRequest request) throws Exception {
		
		Map<String, String> map = new HashMap<String, String>();

		
		InputStream inputStream = request.getInputStream();
		
		SAXReader reader = new SAXReader();
		Document document = reader.read(inputStream);
	
		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返回

這裏我們將採用開源框架xstream來實現Java類到xml的轉換（這裏使用的是xstream-1.3.1.jar），代碼如下：

private static XStream xstream = new XStream(new XppDriver() {
		public HierarchicalStreamWriter createWriter(Writer out) {
			return new PrettyPrintWriter(out) {
				
				boolean cdata = true;

				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);
					}
				}
			};
		}
	});

	
	public static String messageToXml(TextMessage textMessage) {
		xstream.alias("xml", textMessage.getClass());
		return xstream.toXML(textMessage);
	}

	public static String messageToXml(ImageMessage imageMessage) {
		xstream.alias("xml", imageMessage.getClass());
		return xstream.toXML(imageMessage);
	}

	
	public static String messageToXml(VoiceMessage voiceMessage) {
		xstream.alias("xml", voiceMessage.getClass());
		return xstream.toXML(voiceMessage);
	}

	
	public static String messageToXml(VideoMessage videoMessage) {
		xstream.alias("xml", videoMessage.getClass());
		return xstream.toXML(videoMessage);
	}

	
	public static String messageToXml(MusicMessage musicMessage) {
		xstream.alias("xml", musicMessage.getClass());
		return xstream.toXML(musicMessage);
	}

	
	public static String messageToXml(NewsMessage newsMessage) {
		XStream xstream = new XStream();
		xstream.alias("xml", newsMessage.getClass());
		xstream.alias("item", new Article().getClass());
		return xstream.toXML(newsMessage);
	}   
	
}

爲什要把數據放在CDATA中，xml CDATA有什麼用https://blog.csdn.net/u014401141/article/details/53453818

由於xstream框架本身並不支持CDATA塊的生成，writeText方法是對xtream做了擴展，使其支持在生成xml各元素值時添加CDATA塊。

消息處理工具的封裝

將消息相關的處理方法全部封裝到工具類MessageUtil中，該類的完整代碼如下：

/**
 * 
 * @author bym @date 2018年7月4日
 *
 */

public class MessageUtil {
	
	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_VOICE = "voice";
	
	public static final String REQ_MESSAGE_TYPE_VIDEO = "video";
	
	public static final String REQ_MESSAGE_TYPE_LOCATION = "location";
	
	public static final String REQ_MESSAGE_TYPE_LINK = "link";

	
	public static final String REQ_MESSAGE_TYPE_EVENT = "event";

	
	public static final String EVENT_TYPE_SUBSCRIBE = "subscribe";
	
	public static final String EVENT_TYPE_UNSUBSCRIBE = "unsubscribe";
	
	public static final String EVENT_TYPE_SCAN = "scan";
	
	public static final String EVENT_TYPE_LOCATION = "LOCATION";
	
	public static final String EVENT_TYPE_CLICK = "CLICK";

	
	public static final String RESP_MESSAGE_TYPE_TEXT = "text";
	
	public static final String RESP_MESSAGE_TYPE_IMAGE = "image";
	
	public static final String RESP_MESSAGE_TYPE_VOICE = "voice";
	
	public static final String RESP_MESSAGE_TYPE_VIDEO = "video";
	
	public static final String RESP_MESSAGE_TYPE_MUSIC = "music";
	
	public static final String RESP_MESSAGE_TYPE_NEWS = "news";

	@SuppressWarnings("unchecked")
	public static Map<String, String> parseXml(HttpServletRequest request) throws Exception {
		
		Map<String, String> map = new HashMap<String, String>();

		
		InputStream inputStream = request.getInputStream();
		
		SAXReader reader = new SAXReader();
		Document document = reader.read(inputStream);
	
		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;
	}

	private static XStream xstream = new XStream(new XppDriver() {
		public HierarchicalStreamWriter createWriter(Writer out) {
			return new PrettyPrintWriter(out) {
				
				boolean cdata = true;

				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);
					}
				}
			};
		}
	});

	
	public static String messageToXml(TextMessage textMessage) {
		xstream.alias("xml", textMessage.getClass());
		return xstream.toXML(textMessage);
	}

	public static String messageToXml(ImageMessage imageMessage) {
		xstream.alias("xml", imageMessage.getClass());
		return xstream.toXML(imageMessage);
	}

	
	public static String messageToXml(VoiceMessage voiceMessage) {
		xstream.alias("xml", voiceMessage.getClass());
		return xstream.toXML(voiceMessage);
	}

	
	public static String messageToXml(VideoMessage videoMessage) {
		xstream.alias("xml", videoMessage.getClass());
		return xstream.toXML(videoMessage);
	}

	
	public static String messageToXml(MusicMessage musicMessage) {
		xstream.alias("xml", musicMessage.getClass());
		return xstream.toXML(musicMessage);
	}

	
	public static String messageToXml(NewsMessage newsMessage) {
		XStream xstream = new XStream();
		xstream.alias("xml", newsMessage.getClass());
		xstream.alias("item", new Article().getClass());
		return xstream.toXML(newsMessage);
	}   
	
}