me.chanjar.weixin.mp.api

类 WxMpMessageRouter

java.lang.Object

me.chanjar.weixin.mp.api.WxMpMessageRouter

public class WxMpMessageRouter
extends Object

 微信消息路由器，通过代码化的配置，把来自微信的消息交给handler处理

 说明：
 1. 配置路由规则时要按照从细到粗的原则，否则可能消息可能会被提前处理
 2. 默认情况下消息只会被处理一次，除非使用 WxMpMessageRouterRule.next()
 3. 规则的结束必须用WxMpMessageRouterRule.end()或者WxMpMessageRouterRule.next()，否则不会生效

 使用方法：
 WxMpMessageRouter router = new WxMpMessageRouter();
 router
   .rule()
       .msgType("MSG_TYPE").event("EVENT").eventKey("EVENT_KEY").content("CONTENT")
       .interceptor(interceptor, ...).handler(handler, ...)
   .end()
   .rule()
       // 另外一个匹配规则
   .end()
 ;

 // 将WxXmlMessage交给消息路由器
 router.route(message);

 

作者:

Daniel Qian

字段概要

字段

限定符和类型	字段和说明
protected org.slf4j.Logger	log

构造器概要

构造器

构造器和说明
WxMpMessageRouter(WxMpService wxMpService)
WxMpMessageRouter(WxMpService wxMpService, ExecutorService executorService) 使用自定义的 ExecutorService

方法概要

限定符和类型	方法和说明
protected boolean	isMsgDuplicated(WxMpXmlMessage wxMessage)
WxMpXmlOutMessage	route(WxMpXmlMessage wxMessage)
WxMpXmlOutMessage	route(WxMpXmlMessage wxMessage, Map<String,Object> context) 处理微信消息
WxMpXmlOutMessage	route(WxMpXmlMessage wxMessage, Map<String,Object> context, WxMpService wxMpService) 处理微信消息
WxMpMessageRouterRule	rule() 开始一个新的Route规则
protected void	sessionEndAccess(WxMpXmlMessage wxMessage) 对session的访问结束
void	setExceptionHandler(WxErrorExceptionHandler exceptionHandler) 设置自定义的WxErrorExceptionHandler 如果不调用该方法，默认使用 LogExceptionHandler
void	setExecutorService(ExecutorService executorService) 设置自定义的 ExecutorService 如果不调用该方法，默认使用 Executors.newFixedThreadPool(100)
void	setMessageDuplicateChecker(WxMessageDuplicateChecker messageDuplicateChecker) 设置自定义的 WxMessageDuplicateChecker 如果不调用该方法，默认使用 WxMessageInMemoryDuplicateChecker
void	setSessionManager(WxSessionManager sessionManager) 设置自定义的WxSessionManager 如果不调用该方法，默认使用 StandardSessionManager
void	shutDownExecutorService() 如果使用默认的 ExecutorService，则系统退出前，应该调用该方法。

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

log

protected final org.slf4j.Logger log

构造器详细资料

WxMpMessageRouter

public WxMpMessageRouter(WxMpService wxMpService)

WxMpMessageRouter

public WxMpMessageRouter(WxMpService wxMpService,
                         ExecutorService executorService)

 使用自定义的 ExecutorService
 

方法详细资料

shutDownExecutorService

public void shutDownExecutorService()

 如果使用默认的 ExecutorService，则系统退出前，应该调用该方法。
 

setExecutorService

public void setExecutorService(ExecutorService executorService)

 设置自定义的 ExecutorService
 如果不调用该方法，默认使用 Executors.newFixedThreadPool(100)
 

setMessageDuplicateChecker

public void setMessageDuplicateChecker(WxMessageDuplicateChecker messageDuplicateChecker)

 设置自定义的 WxMessageDuplicateChecker
 如果不调用该方法，默认使用 WxMessageInMemoryDuplicateChecker
 

setSessionManager

public void setSessionManager(WxSessionManager sessionManager)

 设置自定义的WxSessionManager
 如果不调用该方法，默认使用 StandardSessionManager
 

setExceptionHandler

public void setExceptionHandler(WxErrorExceptionHandler exceptionHandler)

 设置自定义的WxErrorExceptionHandler
 如果不调用该方法，默认使用 LogExceptionHandler
 

rule

public WxMpMessageRouterRule rule()

开始一个新的Route规则

route

public WxMpXmlOutMessage route(WxMpXmlMessage wxMessage,
                               Map<String,Object> context)

处理微信消息

route

public WxMpXmlOutMessage route(WxMpXmlMessage wxMessage,
                               Map<String,Object> context,
                               WxMpService wxMpService)

处理微信消息

route

public WxMpXmlOutMessage route(WxMpXmlMessage wxMessage)

isMsgDuplicated

protected boolean isMsgDuplicated(WxMpXmlMessage wxMessage)

sessionEndAccess

protected void sessionEndAccess(WxMpXmlMessage wxMessage)

对session的访问结束