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

构造器概要

构造器

构造器和说明
WxMpMessageRouter(WxMpService wxMpService) Instantiates a new Wx mp message router.
WxMpMessageRouter(WxMpService wxMpService, ExecutorService executorService) 使用自定义的 ExecutorService.

方法概要

限定符和类型	方法和说明
protected boolean	isMsgDuplicated(WxMpXmlMessage wxMessage)
WxMpXmlOutMessage	route(String appid, WxMpXmlMessage wxMessage) Route wx mp xml out message.
WxMpXmlOutMessage	route(String appid, WxMpXmlMessage wxMessage, Map<String,Object> context) 处理不同appid微信消息
WxMpXmlOutMessage	route(WxMpXmlMessage wxMessage) Route wx mp xml out message.
WxMpXmlOutMessage	route(WxMpXmlMessage wxMessage, Map<String,Object> context) 处理微信消息.
WxMpXmlOutMessage	route(WxMpXmlMessage wxMessage, Map<String,Object> context, WxMpService wxMpService) 处理微信消息.
WxMpMessageRouterRule	rule() 开始一个新的Route规则.
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() 系统退出前，应该调用该方法
void	shutDownExecutorService(Integer second) 系统退出前，应该调用该方法，增加了超时时间检测

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

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

构造器详细资料

WxMpMessageRouter

public WxMpMessageRouter(WxMpService wxMpService)

Instantiates a new Wx mp message router.

参数:

wxMpService - the wx mp service

WxMpMessageRouter

public WxMpMessageRouter(WxMpService wxMpService,
                         ExecutorService executorService)

使用自定义的 ExecutorService.

参数:

wxMpService - the wx mp service

executorService - the executor service

方法详细资料

shutDownExecutorService

public void shutDownExecutorService()

系统退出前，应该调用该方法

shutDownExecutorService

public void shutDownExecutorService(Integer second)

系统退出前，应该调用该方法，增加了超时时间检测

参数:

second - the second

setExecutorService

public void setExecutorService(ExecutorService executorService)

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

参数:

executorService - the executor service

setMessageDuplicateChecker

public void setMessageDuplicateChecker(WxMessageDuplicateChecker messageDuplicateChecker)

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

参数:

messageDuplicateChecker - the message duplicate checker

setSessionManager

public void setSessionManager(WxSessionManager sessionManager)

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

参数:

sessionManager - the session manager

setExceptionHandler

public void setExceptionHandler(WxErrorExceptionHandler exceptionHandler)

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

参数:

exceptionHandler - the exception handler

rule

public WxMpMessageRouterRule rule()

开始一个新的Route规则.

返回:

the wx mp message router rule

route

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

处理微信消息.

参数:

wxMessage - the wx message

context - the context

返回:

the wx mp xml out message

route

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

处理不同appid微信消息

参数:

appid - the appid

wxMessage - the wx message

context - the context

返回:

the wx mp xml out message

route

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

处理微信消息.

参数:

wxMessage - the wx message

context - the context

wxMpService - the wx mp service

返回:

the wx mp xml out message

route

public WxMpXmlOutMessage route(WxMpXmlMessage wxMessage)

Route wx mp xml out message.

参数:

wxMessage - the wx message

返回:

the wx mp xml out message

route

public WxMpXmlOutMessage route(String appid,
                               WxMpXmlMessage wxMessage)

Route wx mp xml out message.

参数:

appid - the appid

wxMessage - the wx message

返回:

the wx mp xml out message

isMsgDuplicated

protected boolean isMsgDuplicated(WxMpXmlMessage wxMessage)