4.2　消息结构的封装 - 4.2.1　封装请求消息 - 《微信公众平台应用开发：方法、技巧与案例》

4.2.1　封装请求消息

4.2.1　封装请求消息

当微信用户向公众账号发送消息时，微信服务器会将消息以XML格式通过POST方式发送到我们填写的URL（公众账号服务器的入口）上，开发者文档的“接收普通消息”中定义了每种请求消息的结构，如图4-5所示。

4.2.1　封装请求消息 - 图1

图4-5　接收普通消息

1.请求消息基类

为了减少代码冗余，我们将每种类型的请求消息都包含的参数提取出来封装成消息基类，这些参数包括：ToUserName、FromUserName、CreateTime、MsgType和MsgId。参数的描述如表4-1所示。

表4-1　请求消息公有的参数描述

4.2.1　封装请求消息 - 图2

表4-1中参数的详细说明如下。

●ToUserName是公众账号的原始微信号（原始ID），格式为ghxxxxxxxxxxxx（gh加上12位的字母、数字组合），可以在公众平台的账号信息中看到账号的原始ID。在公众平台发展初期，可以通过原始ID实现一键关注公众账号，后来由于种种原因原始ID的作用逐渐被弱化。

●FromUserName又称为OpenID，是一个类似于 "o5T57jihAcQVTgzbNvBx1m4jKk8s "的字符串，并不是用户的微信号。对于同一个公众账号，用户的OpenID是固定不变的，因此通过OpenID能够唯一标识一个用户。但对于不同的公众账号，同一个用户的OpenID是不一样的。

●CreateTime是一个整型的时间，它表示从1970年1月1日0时0分0秒至消息创建时所间隔的秒数。

●MsgType表示消息类型，公众账号服务器通过它来判断用户发送的是哪种类型的消息。其中，text表示文本消息，image表示图片消息，voice表示语音消息，video表示视频消息，location表示地理位置消息，link表示链接消息。

请求消息基类的代码如下：

/**
 * 请求消息基类（普通用户 -> 公众账号）
 * 
 * @author liufeng
 * @date 2013-09-11
 */
public class BaseMessage {
  // 开发者微信号
  private String ToUserName;
  // 发送方账号（一个OpenID）
  private String FromUserName;
  // 消息创建时间 （整型）
  private long CreateTime;
  // 消息类型（text/image/location/link/voice）
  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;
  }
}

2.文本消息

当用户向公众账号发送一段文字时，微信服务器会向公众账号服务器发送如下格式的消息：

<xml>
  <ToUserName><![CDATA[toUser]]></ToUserName>
  <FromUserName><![CDATA[fromUser]]></FromUserName> 
  <CreateTime>1348831860</CreateTime>
  <MsgType><![CDATA[text]]></MsgType>
  <Content><![CDATA[this is a test]]></Content>
  <MsgId>1234567890123456</MsgId>
</xml>

其中，Content表示文本消息的内容。文本消息类需要继承基类BaseMessage，代码如下：

/**
 * 文本消息
 * 
 * @author liufeng
 * @date 2013-09-11
 */
public class TextMessage extends BaseMessage {
  // 消息内容
  private String Content;
 
  public String getContent() {
      return Content;
  }
 
  public void setContent(String content) {
      Content = content;
  }
}

3.图片消息

当用户通过选择相册照片或者拍摄照片的方式向公众账号发送一张图片，微信服务器会向公众账号服务器发送如下格式的消息：

<xml>
  <ToUserName><![CDATA[toUser]]></ToUserName>
  <FromUserName><![CDATA[fromUser]]></FromUserName>
  <CreateTime>1348831860</CreateTime>
  <MsgType><![CDATA[image]]></MsgType>
  <PicUrl><![CDATA[this is a url]]></PicUrl>
  <MsgId>1234567890123456</MsgId>
</xml>

其中，PicUrl表示图片链接，开发者可以通过该链接从微信服务器上下载用户发送的图片。图片消息类的代码如下：

/**
 * 图片消息
 * 
 * @author liufeng
 * @date 2013-09-11
 */
public class ImageMessage extends BaseMessage {
  // 图片链接
  private String PicUrl;
 
  public String getPicUrl() {
      return PicUrl;
  }
 
  public void setPicUrl(String picUrl) {
      PicUrl = picUrl;
  }
}

4.语音消息

当用户向公众账号发送语音时，公众账号服务器会收到如下格式的消息：

<xml>
  <ToUserName><![CDATA[toUser]]></ToUserName>
  <FromUserName><![CDATA[fromUser]]></FromUserName>
  <CreateTime>1357290913</CreateTime>
  <MsgType><![CDATA[voice]]></MsgType>
  <MediaId><![CDATA[media_id]]></MediaId>
  <Format><![CDATA[Format]]></Format>
  <Recognition><![CDATA[腾讯微信团队]]></Recognition>
  <MsgId>1234567890123456</MsgId>
</xml>

语音消息中的主要参数描述如表4-2所示。

表4-2　语音消息的主要参数描述

4.2.1　封装请求消息 - 图3

语音消息类的代码如下：

/**
 * 语音消息
 * 
 * @author liufeng
 * @date 2013-09-11
 */
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;
  }
}

5.视频消息

当用户向公众账号发送视频消息时，公众账号服务器会收到如下格式的消息：

<xml>
  <ToUserName><![CDATA[toUser]]></ToUserName>
  <FromUserName><![CDATA[fromUser]]></FromUserName>
  <CreateTime>1357290913</CreateTime>
  <MsgType><![CDATA[video]]></MsgType>
  <MediaId><![CDATA[media_id]]></MediaId>
  <ThumbMediaId><![CDATA[thumb_media_id]]></ThumbMediaId>
  <MsgId>1234567890123456</MsgId>
</xml>

视频消息中的主要参数描述如表4-3所示。

表4-3　视频消息的主要参数描述

4.2.1　封装请求消息 - 图4

视频消息类的代码如下：

/**
 * 视频消息
 * 
 * @author liufeng
 * @date 2013-09-11
 */
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;
  }
}

6.地理位置消息

当用户向公众账号发送地理位置信息时，公众账号服务器会收到如下格式的消息：

<xml>
  <ToUserName><![CDATA[toUser]]></ToUserName>
  <FromUserName><![CDATA[fromUser]]></FromUserName>
  <CreateTime>1351776360</CreateTime>
  <MsgType><![CDATA[location]]></MsgType>
  <Location_X>23.134521</Location_X>
  <Location_Y>113.358803</Location_Y>
  <Scale>20</Scale>
  <Label><![CDATA[位置信息]]></Label>
  <MsgId>1234567890123456</MsgId>
</xml>

地理位置消息中的主要参数描述如表4-4所示。

表4-4　地理位置消息的主要参数描述

4.2.1　封装请求消息 - 图5

地理位置消息类的代码如下：

/**
 * 地理位置消息
 * 
 * @author liufeng
 * @date 2013-09-11
 */
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;
  }
}

7.链接消息

当用户向公众账号发送网页链接时，公众账号服务器会收到如下格式的消息：

<xml>
  <ToUserName><![CDATA[toUser]]></ToUserName>
  <FromUserName><![CDATA[fromUser]]></FromUserName>
  <CreateTime>1351776360</CreateTime>
  <MsgType><![CDATA[link]]></MsgType>
  <Title><![CDATA[公众平台官网链接]]></Title>
  <Description><![CDATA[公众平台官网链接]]></Description>
  <Url><![CDATA[url]]></Url>
  <MsgId>1234567890123456</MsgId>
</xml>

链接消息中的主要参数描述如表4-5所示。

表4-5　链接消息的主要参数描述

4.2.1　封装请求消息 - 图6

说明　微信目前的版本（v5.1.0）还不支持用户向公众账号发送链接消息，链接消息只能发给朋友或微信群。链接消息的发送方法：通过微信内置浏览器打开网页，点击右上角分享按钮，选择“发送给朋友”，会弹出最近聊天的朋友和微信群列表，选择一个目标，点击“发送”即可向对方发送一条链接消息。对方在收到链接消息时，能够看到网页的标题和链接，点击链接消息会通过微信内置浏览器访问该网页。

链接消息类的代码如下：

/**
 * 链接消息
 * 
 * @author liufeng
 * @date 2013-09-11
 */
 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;
   }
}

4.2.1 封装请求消息

4.2.1 封装请求消息

1.请求消息基类

2.文本消息

3.图片消息

4.语音消息

5.视频消息

6.地理位置消息

7.链接消息

4.2.1　封装请求消息

4.2.1　封装请求消息