Skip to content

Commit cdda57d

Browse files
committed
🎨 binarywang#1646 企业微信第三方应用(服务商)模块重构实现,并提供Router、Interceptor、Handler等接口
1 parent e00320d commit cdda57d

14 files changed

Lines changed: 686 additions & 40 deletions

File tree

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,17 @@
11
package me.chanjar.weixin.common.util;
22

3+
import lombok.extern.slf4j.Slf4j;
34
import me.chanjar.weixin.common.api.WxErrorExceptionHandler;
45
import me.chanjar.weixin.common.error.WxErrorException;
5-
import org.slf4j.Logger;
6-
import org.slf4j.LoggerFactory;
7-
86

7+
/**
8+
* @author Daniel Qian
9+
*/
10+
@Slf4j
911
public class LogExceptionHandler implements WxErrorExceptionHandler {
10-
11-
private Logger log = LoggerFactory.getLogger(WxErrorExceptionHandler.class);
12-
1312
@Override
1413
public void handle(WxErrorException e) {
15-
16-
this.log.error("Error happens", e);
17-
14+
log.error("Error happens", e);
1815
}
1916

2017
}

‎weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpServiceOnTpImpl.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import lombok.RequiredArgsConstructor;
44
import me.chanjar.weixin.common.bean.WxAccessToken;
55
import me.chanjar.weixin.common.error.WxErrorException;
6-
import me.chanjar.weixin.cp.api.WxCpTpService;
6+
import me.chanjar.weixin.cp.tp.service.WxCpTpService;
77

88
/**
99
* <pre>

‎weixin-java-cp/src/main/java/me/chanjar/weixin/cp/message/WxCpMessageRouter.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package me.chanjar.weixin.cp.message;
22

3+
import com.google.common.util.concurrent.ThreadFactoryBuilder;
34
import lombok.extern.slf4j.Slf4j;
45
import me.chanjar.weixin.common.api.WxErrorExceptionHandler;
56
import me.chanjar.weixin.common.api.WxMessageDuplicateChecker;
@@ -17,10 +18,7 @@
1718
import java.util.HashMap;
1819
import java.util.List;
1920
import java.util.Map;
20-
import java.util.concurrent.ExecutionException;
21-
import java.util.concurrent.ExecutorService;
22-
import java.util.concurrent.Executors;
23-
import java.util.concurrent.Future;
21+
import java.util.concurrent.*;
2422

2523
/**
2624
* <pre>
@@ -70,7 +68,9 @@ public class WxCpMessageRouter {
7068
*/
7169
public WxCpMessageRouter(WxCpService wxCpService) {
7270
this.wxCpService = wxCpService;
73-
this.executorService = Executors.newFixedThreadPool(DEFAULT_THREAD_POOL_SIZE);
71+
ThreadFactory namedThreadFactory = new ThreadFactoryBuilder().setNameFormat("WxCpMessageRouter-pool-%d").build();
72+
this.executorService = new ThreadPoolExecutor(DEFAULT_THREAD_POOL_SIZE, DEFAULT_THREAD_POOL_SIZE,
73+
0L, TimeUnit.MILLISECONDS, new LinkedBlockingQueue<>(), namedThreadFactory);
7474
this.messageDuplicateChecker = new WxMessageInMemoryDuplicateChecker();
7575
this.sessionManager = wxCpService.getSessionManager();
7676
this.exceptionHandler = new LogExceptionHandler();
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
package me.chanjar.weixin.cp.tp.message;
2+
3+
import me.chanjar.weixin.common.error.WxErrorException;
4+
import me.chanjar.weixin.common.session.WxSessionManager;
5+
import me.chanjar.weixin.cp.bean.message.WxCpXmlMessage;
6+
import me.chanjar.weixin.cp.bean.message.WxCpXmlOutMessage;
7+
import me.chanjar.weixin.cp.tp.service.WxCpTpService;
8+
9+
import java.util.Map;
10+
11+
/**
12+
* 处理微信推送消息的处理器接口
13+
*
14+
* @author Daniel Qian
15+
*/
16+
public interface WxCpTpMessageHandler {
17+
18+
/**
19+
* Handle wx cp xml out message.
20+
*
21+
* @param wxMessage the wx message
22+
* @param context 上下文,如果handler或interceptor之间有信息要传递,可以用这个
23+
* @param wxCpService the wx cp service
24+
* @param sessionManager the session manager
25+
* @return xml格式的消息 ,如果在异步规则里处理的话,可以返回null
26+
* @throws WxErrorException the wx error exception
27+
*/
28+
WxCpXmlOutMessage handle(WxCpXmlMessage wxMessage,
29+
Map<String, Object> context,
30+
WxCpTpService wxCpService,
31+
WxSessionManager sessionManager) throws WxErrorException;
32+
33+
}
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
package me.chanjar.weixin.cp.tp.message;
2+
3+
import me.chanjar.weixin.common.error.WxErrorException;
4+
import me.chanjar.weixin.common.session.WxSessionManager;
5+
import me.chanjar.weixin.cp.bean.message.WxCpXmlMessage;
6+
import me.chanjar.weixin.cp.tp.service.WxCpTpService;
7+
8+
import java.util.Map;
9+
10+
/**
11+
* 微信消息拦截器,可以用来做验证
12+
*
13+
* @author Daniel Qian
14+
*/
15+
public interface WxCpTpMessageInterceptor {
16+
17+
/**
18+
* 拦截微信消息
19+
*
20+
* @param wxMessage the wx message
21+
* @param context 上下文,如果handler或interceptor之间有信息要传递,可以用这个
22+
* @param wxCpService the wx cp service
23+
* @param sessionManager the session manager
24+
* @return true代表OK ,false代表不OK
25+
* @throws WxErrorException the wx error exception
26+
*/
27+
boolean intercept(WxCpXmlMessage wxMessage,
28+
Map<String, Object> context,
29+
WxCpTpService wxCpService,
30+
WxSessionManager sessionManager) throws WxErrorException;
31+
32+
}
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
package me.chanjar.weixin.cp.tp.message;
2+
3+
import me.chanjar.weixin.cp.bean.message.WxCpXmlMessage;
4+
5+
/**
6+
* 消息匹配器,用在消息路由的时候
7+
*
8+
* @author Daniel Qian
9+
*/
10+
public interface WxCpTpMessageMatcher {
11+
12+
/**
13+
* 消息是否匹配某种模式
14+
*
15+
* @param message the message
16+
* @return the boolean
17+
*/
18+
boolean match(WxCpXmlMessage message);
19+
20+
}
Lines changed: 235 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,235 @@
1+
package me.chanjar.weixin.cp.tp.message;
2+
3+
import com.google.common.util.concurrent.ThreadFactoryBuilder;
4+
import lombok.extern.slf4j.Slf4j;
5+
import me.chanjar.weixin.common.api.WxErrorExceptionHandler;
6+
import me.chanjar.weixin.common.api.WxMessageDuplicateChecker;
7+
import me.chanjar.weixin.common.api.WxMessageInMemoryDuplicateChecker;
8+
import me.chanjar.weixin.common.session.InternalSession;
9+
import me.chanjar.weixin.common.session.InternalSessionManager;
10+
import me.chanjar.weixin.common.session.WxSessionManager;
11+
import me.chanjar.weixin.common.util.LogExceptionHandler;
12+
import me.chanjar.weixin.cp.bean.message.WxCpXmlMessage;
13+
import me.chanjar.weixin.cp.bean.message.WxCpXmlOutMessage;
14+
import me.chanjar.weixin.cp.message.WxCpMessageRouterRule;
15+
import me.chanjar.weixin.cp.tp.service.WxCpTpService;
16+
import org.apache.commons.lang3.StringUtils;
17+
18+
import java.util.ArrayList;
19+
import java.util.HashMap;
20+
import java.util.List;
21+
import java.util.Map;
22+
import java.util.concurrent.*;
23+
24+
/**
25+
* <pre>
26+
* 微信消息路由器,通过代码化的配置,把来自微信的消息交给handler处理
27+
*
28+
* 说明:
29+
* 1. 配置路由规则时要按照从细到粗的原则,否则可能消息可能会被提前处理
30+
* 2. 默认情况下消息只会被处理一次,除非使用 {@link WxCpMessageRouterRule#next()}
31+
* 3. 规则的结束必须用{@link WxCpMessageRouterRule#end()}或者{@link WxCpMessageRouterRule#next()},否则不会生效
32+
*
33+
* 使用方法:
34+
* WxCpMessageRouter router = new WxCpMessageRouter();
35+
* router
36+
* .rule()
37+
* .msgType("MSG_TYPE").event("EVENT").eventKey("EVENT_KEY").content("CONTENT")
38+
* .interceptor(interceptor, ...).handler(handler, ...)
39+
* .end()
40+
* .rule()
41+
* // 另外一个匹配规则
42+
* .end()
43+
* ;
44+
*
45+
* // 将WxXmlMessage交给消息路由器
46+
* router.route(message);
47+
*
48+
* </pre>
49+
*
50+
* @author Daniel Qian
51+
*/
52+
@Slf4j
53+
public class WxCpTpMessageRouter {
54+
private static final int DEFAULT_THREAD_POOL_SIZE = 100;
55+
private final List<WxCpTpMessageRouterRule> rules = new ArrayList<>();
56+
57+
private final WxCpTpService wxCpService;
58+
59+
private ExecutorService executorService;
60+
61+
private WxMessageDuplicateChecker messageDuplicateChecker;
62+
63+
private WxSessionManager sessionManager;
64+
65+
private WxErrorExceptionHandler exceptionHandler;
66+
67+
/**
68+
* 构造方法.
69+
*/
70+
public WxCpTpMessageRouter(WxCpTpService wxCpService) {
71+
this.wxCpService = wxCpService;
72+
ThreadFactory namedThreadFactory = new ThreadFactoryBuilder().setNameFormat("WxCpTpMessageRouter-pool-%d").build();
73+
this.executorService = new ThreadPoolExecutor(DEFAULT_THREAD_POOL_SIZE, DEFAULT_THREAD_POOL_SIZE,
74+
0L, TimeUnit.MILLISECONDS, new LinkedBlockingQueue<>(), namedThreadFactory);
75+
this.messageDuplicateChecker = new WxMessageInMemoryDuplicateChecker();
76+
this.sessionManager = wxCpService.getSessionManager();
77+
this.exceptionHandler = new LogExceptionHandler();
78+
}
79+
80+
/**
81+
* <pre>
82+
* 设置自定义的 {@link ExecutorService}
83+
* 如果不调用该方法,默认使用 Executors.newFixedThreadPool(100)
84+
* </pre>
85+
*/
86+
public void setExecutorService(ExecutorService executorService) {
87+
this.executorService = executorService;
88+
}
89+
90+
/**
91+
* <pre>
92+
* 设置自定义的 {@link WxMessageDuplicateChecker}
93+
* 如果不调用该方法,默认使用 {@link WxMessageInMemoryDuplicateChecker}
94+
* </pre>
95+
*/
96+
public void setMessageDuplicateChecker(WxMessageDuplicateChecker messageDuplicateChecker) {
97+
this.messageDuplicateChecker = messageDuplicateChecker;
98+
}
99+
100+
/**
101+
* <pre>
102+
* 设置自定义的{@link WxSessionManager}
103+
* 如果不调用该方法,默认使用 {@link me.chanjar.weixin.common.session.StandardSessionManager}
104+
* </pre>
105+
*/
106+
public void setSessionManager(WxSessionManager sessionManager) {
107+
this.sessionManager = sessionManager;
108+
}
109+
110+
/**
111+
* <pre>
112+
* 设置自定义的{@link WxErrorExceptionHandler}
113+
* 如果不调用该方法,默认使用 {@link LogExceptionHandler}
114+
* </pre>
115+
*/
116+
public void setExceptionHandler(WxErrorExceptionHandler exceptionHandler) {
117+
this.exceptionHandler = exceptionHandler;
118+
}
119+
120+
List<WxCpTpMessageRouterRule> getRules() {
121+
return this.rules;
122+
}
123+
124+
/**
125+
* 开始一个新的Route规则.
126+
*/
127+
public WxCpTpMessageRouterRule rule() {
128+
return new WxCpTpMessageRouterRule(this);
129+
}
130+
131+
/**
132+
* 处理微信消息.
133+
*/
134+
public WxCpXmlOutMessage route(final WxCpXmlMessage wxMessage, final Map<String, Object> context) {
135+
if (isMsgDuplicated(wxMessage)) {
136+
// 如果是重复消息,那么就不做处理
137+
return null;
138+
}
139+
140+
final List<WxCpTpMessageRouterRule> matchRules = new ArrayList<>();
141+
// 收集匹配的规则
142+
for (final WxCpTpMessageRouterRule rule : this.rules) {
143+
if (rule.test(wxMessage)) {
144+
matchRules.add(rule);
145+
if (!rule.isReEnter()) {
146+
break;
147+
}
148+
}
149+
}
150+
151+
if (matchRules.size() == 0) {
152+
return null;
153+
}
154+
155+
WxCpXmlOutMessage res = null;
156+
final List<Future> futures = new ArrayList<>();
157+
for (final WxCpTpMessageRouterRule rule : matchRules) {
158+
// 返回最后一个非异步的rule的执行结果
159+
if (rule.isAsync()) {
160+
futures.add(
161+
this.executorService.submit(() -> {
162+
rule.service(wxMessage, context, WxCpTpMessageRouter.this.wxCpService, WxCpTpMessageRouter.this.sessionManager, WxCpTpMessageRouter.this.exceptionHandler);
163+
})
164+
);
165+
} else {
166+
res = rule.service(wxMessage, context, this.wxCpService, this.sessionManager, this.exceptionHandler);
167+
// 在同步操作结束,session访问结束
168+
log.debug("End session access: async=false, sessionId={}", wxMessage.getFromUserName());
169+
sessionEndAccess(wxMessage);
170+
}
171+
}
172+
173+
if (futures.size() > 0) {
174+
this.executorService.submit(() -> {
175+
for (Future future : futures) {
176+
try {
177+
future.get();
178+
log.debug("End session access: async=true, sessionId={}", wxMessage.getFromUserName());
179+
// 异步操作结束,session访问结束
180+
sessionEndAccess(wxMessage);
181+
} catch (InterruptedException e) {
182+
log.error("Error happened when wait task finish", e);
183+
Thread.currentThread().interrupt();
184+
} catch (ExecutionException e) {
185+
log.error("Error happened when wait task finish", e);
186+
}
187+
}
188+
});
189+
}
190+
return res;
191+
}
192+
193+
/**
194+
* 处理微信消息.
195+
*/
196+
public WxCpXmlOutMessage route(final WxCpXmlMessage wxMessage) {
197+
return this.route(wxMessage, new HashMap<>(2));
198+
}
199+
200+
private boolean isMsgDuplicated(WxCpXmlMessage wxMessage) {
201+
StringBuilder messageId = new StringBuilder();
202+
if (wxMessage.getMsgId() == null) {
203+
messageId.append(wxMessage.getCreateTime())
204+
.append("-").append(StringUtils.trimToEmpty(String.valueOf(wxMessage.getAgentId())))
205+
.append("-").append(wxMessage.getFromUserName())
206+
.append("-").append(StringUtils.trimToEmpty(wxMessage.getEventKey()))
207+
.append("-").append(StringUtils.trimToEmpty(wxMessage.getEvent()));
208+
} else {
209+
messageId.append(wxMessage.getMsgId())
210+
.append("-").append(wxMessage.getCreateTime())
211+
.append("-").append(wxMessage.getFromUserName());
212+
}
213+
214+
if (StringUtils.isNotEmpty(wxMessage.getUserId())) {
215+
messageId.append("-").append(wxMessage.getUserId());
216+
}
217+
218+
if (StringUtils.isNotEmpty(wxMessage.getChangeType())) {
219+
messageId.append("-").append(wxMessage.getChangeType());
220+
}
221+
222+
return this.messageDuplicateChecker.isDuplicate(messageId.toString());
223+
}
224+
225+
/**
226+
* 对session的访问结束.
227+
*/
228+
private void sessionEndAccess(WxCpXmlMessage wxMessage) {
229+
InternalSession session = ((InternalSessionManager) this.sessionManager).findSession(wxMessage.getFromUserName());
230+
if (session != null) {
231+
session.endAccess();
232+
}
233+
234+
}
235+
}

0 commit comments

Comments
 (0)