這篇文章主要介紹了Java微信公眾平臺之消息管理的示例分析,具有一定借鑒價值,感興趣的朋友可以參考下,希望大家閱讀完這篇文章之后大有收獲,下面讓小編帶著大家一起了解一下。
Java微信公眾平臺開發之消息管理,一定要先看下官方文檔
微信消息管理分為接收普通消息、接收事件推送、發送消息(被動回復)、客服消息、群發消息、模板消息這幾部分
一、接收普通消息
當普通微信用戶向公眾賬號發消息時,微信服務器將POST消息的XML數據包到開發者填寫的URL上。
關于MsgId,官方給出解釋,相當于每個消息ID,關于重試的消息排重,推薦使用msgid排重。微信服務器在五秒內收不到響應會斷掉連接,并且重新發起請求,總共重試三次。
比如文本消息的Xml示例
<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>
其他的消息去官方文檔查看,簡單封裝如下
消息抽象基類AbstractMsg.java
package com.phil.wechat.msg.model.req;
import java.io.Serializable;
/**
* 基礎消息類
*
* @author phil
*
*/
public abstract class AbstractMsg implements Serializable {
private static final long serialVersionUID = -6244277633057415731L;
private String ToUserName; // 開發者微信號
private String FromUserName; // 發送方帳號(一個OpenID)
private String MsgType = SetMsgType(); // 消息類型 例如 /text/image
private long CreateTime; // 消息創建時間 (整型)
private long MsgId; // 消息id,64位整型
/**
* 消息類型
*
* @return
*/
public abstract String SetMsgType();
}文本消息TextMsg.java
package com.phil.wechat.msg.model.req;
/**
* 文本消息
* @author phil
* @date 2017年6月30日
*
*/
public class TextMsg extends AbstractMsg {
private static final long serialVersionUID = -1764016801417503409L;
private String Content; // 文本消息
@Override
public String SetMsgType() {
return "text";
}
}其他的依樣畫葫蘆......
二、被動回復用戶消息
微信服務器在將用戶的消息發給公眾號的開發者服務器地址(開發者中心處配置)后,微信服務器在五秒內收不到響應會斷掉連接,并且重新發起請求,總共重試三次,如果在調試中,發現用戶無法收到響應的消息,可以檢查是否消息處理超時。假如服務器無法保證在五秒內處理并回復,可以直接回復空串,微信服務器不會對此作任何處理,并且不會發起重試。
如果出現“該公眾號暫時無法提供服務,請稍后再試”,原因有兩個
開發者在5秒內未回復任何內容
開發者回復了異常數據
比如回復的文本消息Xml示例
<xml> <ToUserName><![CDATA[toUser]]></ToUserName> <FromUserName><![CDATA[fromUser]]></FromUserName> <CreateTime>12345678</CreateTime> <MsgType><![CDATA[text]]></MsgType> <Content><![CDATA[你好]]></Content> </xml>
簡單封裝下
回復消息抽象基類RespAbstractMsg.java
package com.phil.wechat.msg.model.resp;
import java.io.Serializable;
/**
* 消息基類(公眾帳號 -> 普通用戶)
*
* @author phil
*
*/
public abstract class RespAbstractMsg{
// 接收方帳號(收到的OpenID)
private String ToUserName;
// 開發者微信號
private String FromUserName;
// 消息創建時間 (整型)
private long CreateTime;
// 消息類型(text/music/news)
private String MsgType = setMsgType(); // 消息類型
public abstract String setMsgType();
}回復文本消息RespTextMsg.java
package com.phil.wechat.msg.model.resp;
/**
* 回復圖片消息
*
* @author phil
* @data 2017年3月26日
*
*/
public class RespImageMsg extends RespAbstractMsg {
private Image Image;
@Override
public String setMsgType() {
return "image";
}
/**
*
* @author phil
* @date 2017年7月19日
*
*/
public class Image {
// 通過素材管理中的接口上傳多媒體文件,得到的id。
private String MediaId;
public String getMediaId() {
return MediaId;
}
public void setMediaId(String mediaId) {
MediaId = mediaId;
}
}
}其他消息類型依樣畫葫蘆......
三、消息的處理
掌握xml解析
package com.phil.wechat.msg.controller;
import java.io.IOException;
import java.io.InputStream;
import java.util.Map;
import java.util.Objects;
import org.apache.commons.lang3.StringUtils;
import org.dom4j.DocumentException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import com.phil.modules.config.WechatConfig;
import com.phil.modules.util.MsgUtil;
import com.phil.modules.util.SignatureUtil;
import com.phil.modules.util.XmlUtil;
import com.phil.wechat.base.controller.BaseController;
import com.phil.wechat.base.result.WechatResult;
import com.phil.wechat.msg.model.req.BasicMsg;
import com.phil.wechat.msg.model.resp.RespAbstractMsg;
import com.phil.wechat.msg.model.resp.RespNewsMsg;
import com.phil.wechat.msg.service.WechatMsgService;
/**
* @author phil
* @date 2017年9月19日
*
*/
@Controller
@RequestMapping("/wechat")
public class WechatMsgController extends BaseController {
private Logger logger = LoggerFactory.getLogger(this.getClass());
@Autowired
private WechatMsgService wechatMsgService;
/**
* 校驗信息是否是從微信服務器發出,處理消息
* @param out
* @throws IOException
*/
@RequestMapping(value = "/handler", method = { RequestMethod.GET, RequestMethod.POST })
public void processPost() throws Exception {
this.getRequest().setCharacterEncoding("UTF-8");
this.getResponse().setCharacterEncoding("UTF-8");
boolean ispost = Objects.equals("POST", this.getRequest().getMethod().toUpperCase());
if (ispost) {
logger.debug("接入成功,正在處理邏輯");
String respXml = defaultMsgDisPose(this.getRequest().getInputStream());//processRequest(request, response);
if (StringUtils.isNotBlank(respXml)) {
this.getResponse().getWriter().write(respXml);
}
} else {
String signature = this.getRequest().getParameter("signature");
// 時間戳
String timestamp = this.getRequest().getParameter("timestamp");
// 隨機數
String nonce = this.getRequest().getParameter("nonce");
// 通過檢驗signature對請求進行校驗,若校驗成功則原樣返回echostr,表示接入成功,否則接入失敗
if (SignatureUtil.checkSignature(signature, timestamp, nonce)) {
// 隨機字符串
String echostr = this.getRequest().getParameter("echostr");
logger.debug("接入成功,echostr {}", echostr);
this.getResponse().getWriter().write(echostr);
}
}
}
/**
* 默認處理方法
* @param input
* @return
* @throws Exception
* @throws DocumentException
*/
private String defaultMsgDisPose(InputStream inputStream) throws Exception {
String result = null;
if (inputStream != null) {
Map<String, String> params = XmlUtil.parseStreamToMap(inputStream);
if (params != null && params.size() > 0) {
BasicMsg msgInfo = new BasicMsg();
String createTime = params.get("CreateTime");
String msgId = params.get("MsgId");
msgInfo.setCreateTime((createTime != null && !"".equals(createTime)) ? Integer.parseInt(createTime) : 0);
msgInfo.setFromUserName(params.get("FromUserName"));
msgInfo.setMsgId((msgId != null && !"".equals(msgId)) ? Long.parseLong(msgId) : 0);
msgInfo.setToUserName(params.get("ToUserName"));
WechatResult resultObj = coreHandler(msgInfo, params);
if(resultObj == null){ //
return null;
}
boolean success = resultObj.isSuccess(); //如果 為true,則表示返回xml文件, 直接轉換即可,否則按類型
if (success) {
result = resultObj.getObject().toString();
} else {
int type = resultObj.getType(); // 這里規定 1 圖文消息 否則直接轉換
if (type == WechatResult.NEWSMSG) {
RespNewsMsg newsMsg = (RespNewsMsg) resultObj.getObject();
result = MsgUtil.newsMsgToXml(newsMsg);
} else {
RespAbstractMsg basicMsg = (RespAbstractMsg) resultObj.getObject();
result = MsgUtil.msgToXml(basicMsg);
}
}
} else {
result = "msg is wrong";
}
}
return result;
}
/**
* 核心處理
*
* @param msg
* 消息基類
* @param params
* xml 解析出來的 數據
* @return
*/
private WechatResult coreHandler(BasicMsg msg, Map<String, String> params) {
WechatResult result = null;
String msgType = params.get("MsgType");
if (StringUtils.isEmpty(msgType)) {
switch (msgType) {
case WechatConfig.REQ_MESSAGE_TYPE_TEXT: // 文本消息
result = wechatMsgService.textMsg(msg, params);
break;
case WechatConfig.REQ_MESSAGE_TYPE_IMAGE: // 圖片消息
result = wechatMsgService.imageMsg(msg, params);
break;
case WechatConfig.REQ_MESSAGE_TYPE_LINK: // 鏈接消息
result = wechatMsgService.linkMsg(msg, params);
break;
case WechatConfig.REQ_MESSAGE_TYPE_LOCATION: // 地理位置
result = wechatMsgService.locationMsg(msg, params);
break;
case WechatConfig.REQ_MESSAGE_TYPE_VOICE: // 音頻消息
result = wechatMsgService.voiceMsg(msg, params);
break;
case WechatConfig.REQ_MESSAGE_TYPE_SHORTVIDEO: // 短視頻消息
result = wechatMsgService.shortvideo(msg, params);
break;
case WechatConfig.REQ_MESSAGE_TYPE_VIDEO: // 視頻消息
result = wechatMsgService.videoMsg(msg, params);
break;
case WechatConfig.REQ_MESSAGE_TYPE_EVENT: // 事件消息
String eventType = params.get("Event"); //
if (eventType != null && !"".equals(eventType)) {
switch (eventType) {
case WechatConfig.EVENT_TYPE_SUBSCRIBE:
result = wechatMsgService.subscribe(msg, params);
break;
case WechatConfig.EVENT_TYPE_UNSUBSCRIBE:
result = wechatMsgService.unsubscribe(msg, params);
break;
case WechatConfig.EVENT_TYPE_SCAN:
result = wechatMsgService.scan(msg, params);
break;
case WechatConfig.EVENT_TYPE_LOCATION:
result = wechatMsgService.eventLocation(msg, params);
break;
case WechatConfig.EVENT_TYPE_CLICK:
result = wechatMsgService.eventClick(msg, params);
break;
case WechatConfig.EVENT_TYPE_VIEW:
result = wechatMsgService.eventView(msg, params);
break;
case WechatConfig.KF_CREATE_SESSION:
result = wechatMsgService.kfCreateSession(msg, params);
break;
case WechatConfig.KF_CLOSE_SESSION:
result = wechatMsgService.kfCloseSession(msg, params);
break;
case WechatConfig.KF_SWITCH_SESSION:
result = wechatMsgService.kfSwitchSession(msg, params);
break;
default:
wechatMsgService.eventDefaultReply(msg, params);
break;
}
}
break;
default:
wechatMsgService.defaultMsg(msg, params);
}
}
return result;
}
}感謝你能夠認真閱讀完這篇文章,希望小編分享的“Java微信公眾平臺之消息管理的示例分析”這篇文章對大家有幫助,同時也希望大家多多支持億速云,關注億速云行業資訊頻道,更多相關知識等著你來學習!
免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。