#193 增加小程序模块weixin-java-miniapp，支持小程序后台开发

weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/message/WxMaMessageHandler.java

@@ -0,0 +1,20 @@
+package cn.binarywang.wx.miniapp.message;
+
+import cn.binarywang.wx.miniapp.api.WxMaService;
+import cn.binarywang.wx.miniapp.bean.WxMaMessage;
+import me.chanjar.weixin.common.exception.WxErrorException;
+import me.chanjar.weixin.common.session.WxSessionManager;
+
+import java.util.Map;
+
+/**
+ * 处理小程序推送消息的处理器接口
+ *
+ * @author <a href="https://github.com/binarywang">Binary Wang</a>
+ */
+public interface WxMaMessageHandler {
+
+  void handle(WxMaMessage message, Map<String, Object> context,
+              WxMaService service, WxSessionManager sessionManager) throws WxErrorException;
+
+}

weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/message/WxMaMessageInterceptor.java

@@ -0,0 +1,28 @@
+package cn.binarywang.wx.miniapp.message;
+
+import cn.binarywang.wx.miniapp.api.WxMaService;
+import cn.binarywang.wx.miniapp.bean.WxMaMessage;
+import me.chanjar.weixin.common.exception.WxErrorException;
+import me.chanjar.weixin.common.session.WxSessionManager;
+
+import java.util.Map;
+
+/**
+ * 微信消息拦截器，可以用来做验证
+ *
+ * @author <a href="https://github.com/binarywang">Binary Wang</a>
+ */
+public interface WxMaMessageInterceptor {
+
+  /**
+   * 拦截微信消息
+   *
+   * @param context        上下文，如果handler或interceptor之间有信息要传递，可以用这个
+   * @return true代表OK，false代表不OK
+   */
+  boolean intercept(WxMaMessage wxMessage,
+                    Map<String, Object> context,
+                    WxMaService wxMaService,
+                    WxSessionManager sessionManager) throws WxErrorException;
+
+}

weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/message/WxMaMessageMatcher.java

@@ -0,0 +1,17 @@
+package cn.binarywang.wx.miniapp.message;
+
+import cn.binarywang.wx.miniapp.bean.WxMaMessage;
+
+/**
+ * 消息匹配器，用在消息路由的时候
+ *
+ * @author <a href="https://github.com/binarywang">Binary Wang</a>
+ */
+public interface WxMaMessageMatcher {
+
+  /**
+   * 消息是否匹配某种模式
+   */
+  boolean match(WxMaMessage message);
+
+}

weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/message/WxMaMessageRouter.java

@@ -0,0 +1,176 @@
+package cn.binarywang.wx.miniapp.message;
+
+import cn.binarywang.wx.miniapp.api.WxMaService;
+import cn.binarywang.wx.miniapp.bean.WxMaMessage;
+import me.chanjar.weixin.common.api.WxErrorExceptionHandler;
+import me.chanjar.weixin.common.api.WxMessageDuplicateChecker;
+import me.chanjar.weixin.common.api.WxMessageInMemoryDuplicateChecker;
+import me.chanjar.weixin.common.session.InternalSession;
+import me.chanjar.weixin.common.session.InternalSessionManager;
+import me.chanjar.weixin.common.session.StandardSessionManager;
+import me.chanjar.weixin.common.session.WxSessionManager;
+import me.chanjar.weixin.common.util.LogExceptionHandler;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import java.util.concurrent.Future;
+
+/**
+ * @author <a href="https://github.com/binarywang">Binary Wang</a>
+ */
+public class WxMaMessageRouter {
+  private static final int DEFAULT_THREAD_POOL_SIZE = 100;
+  private final Logger log = LoggerFactory.getLogger(WxMaMessageRouter.class);
+  private final List<WxMaMessageRouterRule> rules = new ArrayList<>();
+
+  private final WxMaService wxMaService;
+
+  private ExecutorService executorService;
+
+  private WxMessageDuplicateChecker messageDuplicateChecker;
+
+  private WxSessionManager sessionManager;
+
+  private WxErrorExceptionHandler exceptionHandler;
+
+  public WxMaMessageRouter(WxMaService wxMaService) {
+    this.wxMaService = wxMaService;
+    this.executorService = Executors.newFixedThreadPool(DEFAULT_THREAD_POOL_SIZE);
+    this.messageDuplicateChecker = new WxMessageInMemoryDuplicateChecker();
+    this.sessionManager = new StandardSessionManager();
+    this.exceptionHandler = new LogExceptionHandler();
+  }
+
+  /**
+   * <pre>
+   * 设置自定义的 {@link ExecutorService}
+   * 如果不调用该方法，默认使用 Executors.newFixedThreadPool(100)
+   * </pre>
+   */
+  public void setExecutorService(ExecutorService executorService) {
+    this.executorService = executorService;
+  }
+
+  /**
+   * <pre>
+   * 设置自定义的 {@link me.chanjar.weixin.common.api.WxMessageDuplicateChecker}
+   * 如果不调用该方法，默认使用 {@link me.chanjar.weixin.common.api.WxMessageInMemoryDuplicateChecker}
+   * </pre>
+   */
+  public void setMessageDuplicateChecker(WxMessageDuplicateChecker messageDuplicateChecker) {
+    this.messageDuplicateChecker = messageDuplicateChecker;
+  }
+
+  /**
+   * <pre>
+   * 设置自定义的{@link me.chanjar.weixin.common.session.WxSessionManager}
+   * 如果不调用该方法，默认使用 {@link me.chanjar.weixin.common.session.StandardSessionManager}
+   * </pre>
+   */
+  public void setSessionManager(WxSessionManager sessionManager) {
+    this.sessionManager = sessionManager;
+  }
+
+  /**
+   * <pre>
+   * 设置自定义的{@link me.chanjar.weixin.common.api.WxErrorExceptionHandler}
+   * 如果不调用该方法，默认使用 {@link me.chanjar.weixin.common.util.LogExceptionHandler}
+   * </pre>
+   */
+  public void setExceptionHandler(WxErrorExceptionHandler exceptionHandler) {
+    this.exceptionHandler = exceptionHandler;
+  }
+
+  List<WxMaMessageRouterRule> getRules() {
+    return this.rules;
+  }
+
+  /**
+   * 开始一个新的Route规则
+   */
+  public WxMaMessageRouterRule rule() {
+    return new WxMaMessageRouterRule(this);
+  }
+
+  /**
+   * 处理微信消息
+   */
+  public void route(final WxMaMessage wxMessage, final Map<String, Object> context) {
+    final List<WxMaMessageRouterRule> matchRules = new ArrayList<>();
+    // 收集匹配的规则
+    for (final WxMaMessageRouterRule rule : this.rules) {
+      if (rule.test(wxMessage)) {
+        matchRules.add(rule);
+        if (!rule.isReEnter()) {
+          break;
+        }
+      }
+    }
+
+    if (matchRules.size() == 0) {
+      return;
+    }
+
+    final List<Future<?>> futures = new ArrayList<>();
+    for (final WxMaMessageRouterRule rule : matchRules) {
+      // 返回最后一个非异步的rule的执行结果
+      if (rule.isAsync()) {
+        futures.add(
+          this.executorService.submit(new Runnable() {
+            @Override
+            public void run() {
+              rule.service(wxMessage, context, WxMaMessageRouter.this.wxMaService, WxMaMessageRouter.this.sessionManager, WxMaMessageRouter.this.exceptionHandler);
+            }
+          })
+        );
+      } else {
+        rule.service(wxMessage, context, this.wxMaService, this.sessionManager, this.exceptionHandler);
+        // 在同步操作结束，session访问结束
+        this.log.debug("End session access: async=false, sessionId={}", wxMessage.getFromUser());
+        sessionEndAccess(wxMessage);
+      }
+    }
+
+    if (futures.size() > 0) {
+      this.executorService.submit(new Runnable() {
+        @Override
+        public void run() {
+          for (Future<?> future : futures) {
+            try {
+              future.get();
+              WxMaMessageRouter.this.log.debug("End session access: async=true, sessionId={}", wxMessage.getFromUser());
+              // 异步操作结束，session访问结束
+              sessionEndAccess(wxMessage);
+            } catch (InterruptedException | ExecutionException e) {
+              WxMaMessageRouter.this.log.error("Error happened when wait task finish", e);
+            }
+          }
+        }
+      });
+    }
+
+  }
+
+  public void route(final WxMaMessage wxMessage) {
+    this.route(wxMessage, new HashMap<String, Object>());
+  }
+
+  /**
+   * 对session的访问结束
+   */
+  protected void sessionEndAccess(WxMaMessage wxMessage) {
+
+    InternalSession session = ((InternalSessionManager) this.sessionManager).findSession(wxMessage.getFromUser());
+    if (session != null) {
+      session.endAccess();
+    }
+
+  }
+}

weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/message/WxMaMessageRouterRule.java

@@ -0,0 +1,316 @@
+package cn.binarywang.wx.miniapp.message;
+
+import cn.binarywang.wx.miniapp.api.WxMaService;
+import cn.binarywang.wx.miniapp.bean.WxMaMessage;
+import me.chanjar.weixin.common.api.WxErrorExceptionHandler;
+import me.chanjar.weixin.common.exception.WxErrorException;
+import me.chanjar.weixin.common.session.WxSessionManager;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.regex.Pattern;
+
+/**
+ * @author <a href="https://github.com/binarywang">Binary Wang</a>
+ */
+public class WxMaMessageRouterRule {
+
+  private final WxMaMessageRouter routerBuilder;
+
+  private boolean async = true;
+
+  private String fromUser;
+
+  private String msgType;
+
+  private String event;
+
+  private String eventKey;
+
+  private String content;
+
+  private String rContent;
+
+  private WxMaMessageMatcher matcher;
+
+  private boolean reEnter = false;
+
+  private List<WxMaMessageHandler> handlers = new ArrayList<>();
+
+  private List<WxMaMessageInterceptor> interceptors = new ArrayList<>();
+
+  public WxMaMessageRouterRule(WxMaMessageRouter routerBuilder) {
+    this.routerBuilder = routerBuilder;
+  }
+
+  /**
+   * 设置是否异步执行，默认是true
+   */
+  public WxMaMessageRouterRule async(boolean async) {
+    this.async = async;
+    return this;
+  }
+
+  /**
+   * 如果msgType等于某值
+   */
+  public WxMaMessageRouterRule msgType(String msgType) {
+    this.msgType = msgType;
+    return this;
+  }
+
+  /**
+   * 如果event等于某值
+   */
+  public WxMaMessageRouterRule event(String event) {
+    this.event = event;
+    return this;
+  }
+
+  /**
+   * 如果eventKey等于某值
+   */
+  public WxMaMessageRouterRule eventKey(String eventKey) {
+    this.eventKey = eventKey;
+    return this;
+  }
+
+  /**
+   * 如果content等于某值
+   */
+  public WxMaMessageRouterRule content(String content) {
+    this.content = content;
+    return this;
+  }
+
+  /**
+   * 如果content匹配该正则表达式
+   */
+  public WxMaMessageRouterRule rContent(String regex) {
+    this.rContent = regex;
+    return this;
+  }
+
+  /**
+   * 如果fromUser等于某值
+   */
+  public WxMaMessageRouterRule fromUser(String fromUser) {
+    this.fromUser = fromUser;
+    return this;
+  }
+
+  /**
+   * 如果消息匹配某个matcher，用在用户需要自定义更复杂的匹配规则的时候
+   */
+  public WxMaMessageRouterRule matcher(WxMaMessageMatcher matcher) {
+    this.matcher = matcher;
+    return this;
+  }
+
+  /**
+   * 设置微信消息拦截器
+   */
+  public WxMaMessageRouterRule interceptor(WxMaMessageInterceptor interceptor) {
+    return interceptor(interceptor, (WxMaMessageInterceptor[]) null);
+  }
+
+  /**
+   * 设置微信消息拦截器
+   */
+  public WxMaMessageRouterRule interceptor(WxMaMessageInterceptor interceptor, WxMaMessageInterceptor... otherInterceptors) {
+    this.interceptors.add(interceptor);
+    if (otherInterceptors != null && otherInterceptors.length > 0) {
+      for (WxMaMessageInterceptor i : otherInterceptors) {
+        this.interceptors.add(i);
+      }
+    }
+    return this;
+  }
+
+  /**
+   * 设置微信消息处理器
+   */
+  public WxMaMessageRouterRule handler(WxMaMessageHandler handler) {
+    return handler(handler, (WxMaMessageHandler[]) null);
+  }
+
+  /**
+   * 设置微信消息处理器
+   */
+  public WxMaMessageRouterRule handler(WxMaMessageHandler handler, WxMaMessageHandler... otherHandlers) {
+    this.handlers.add(handler);
+    if (otherHandlers != null && otherHandlers.length > 0) {
+      for (WxMaMessageHandler i : otherHandlers) {
+        this.handlers.add(i);
+      }
+    }
+    return this;
+  }
+
+  /**
+   * 规则结束，代表如果一个消息匹配该规则，那么它将不再会进入其他规则
+   */
+  public WxMaMessageRouter end() {
+    this.routerBuilder.getRules().add(this);
+    return this.routerBuilder;
+  }
+
+  /**
+   * 规则结束，但是消息还会进入其他规则
+   */
+  public WxMaMessageRouter next() {
+    this.reEnter = true;
+    return end();
+  }
+
+  /**
+   * 将微信自定义的事件修正为不区分大小写,
+   * 比如框架定义的事件常量为click，但微信传递过来的却是CLICK
+   */
+  protected boolean test(WxMaMessage wxMessage) {
+    return
+      (this.fromUser == null || this.fromUser.equals(wxMessage.getFromUser()))
+        &&
+        (this.msgType == null || this.msgType.toLowerCase().equals((wxMessage.getMsgType() == null ? null : wxMessage.getMsgType().toLowerCase())))
+        &&
+        (this.event == null || this.event.toLowerCase().equals((wxMessage.getEvent() == null ? null : wxMessage.getEvent().toLowerCase())))
+        &&
+        (this.content == null || this.content
+          .equals(wxMessage.getContent() == null ? null : wxMessage.getContent().trim()))
+        &&
+        (this.rContent == null || Pattern
+          .matches(this.rContent, wxMessage.getContent() == null ? "" : wxMessage.getContent().trim()))
+        &&
+        (this.matcher == null || this.matcher.match(wxMessage))
+      ;
+  }
+
+  /**
+   * 处理微信推送过来的消息
+   *
+   * @return true 代表继续执行别的router，false 代表停止执行别的router
+   */
+  protected void service(WxMaMessage wxMessage,
+                         Map<String, Object> context,
+                         WxMaService wxMaService,
+                         WxSessionManager sessionManager,
+                         WxErrorExceptionHandler exceptionHandler) {
+    if (context == null) {
+      context = new HashMap<>();
+    }
+
+    try {
+      // 如果拦截器不通过
+      for (WxMaMessageInterceptor interceptor : this.interceptors) {
+        if (!interceptor.intercept(wxMessage, context, wxMaService, sessionManager)) {
+          return;
+        }
+      }
+
+      // 交给handler处理
+      for (WxMaMessageHandler handler : this.handlers) {
+        // 返回最后handler的结果
+        if (handler == null) {
+          continue;
+        }
+        handler.handle(wxMessage, context, wxMaService, sessionManager);
+      }
+    } catch (WxErrorException e) {
+      exceptionHandler.handle(e);
+    }
+  }
+
+  public WxMaMessageRouter getRouterBuilder() {
+    return this.routerBuilder;
+  }
+
+  public boolean isAsync() {
+    return this.async;
+  }
+
+  public void setAsync(boolean async) {
+    this.async = async;
+  }
+
+  public String getFromUser() {
+    return this.fromUser;
+  }
+
+  public void setFromUser(String fromUser) {
+    this.fromUser = fromUser;
+  }
+
+  public String getMsgType() {
+    return this.msgType;
+  }
+
+  public void setMsgType(String msgType) {
+    this.msgType = msgType;
+  }
+
+  public String getEvent() {
+    return this.event;
+  }
+
+  public void setEvent(String event) {
+    this.event = event;
+  }
+
+  public String getEventKey() {
+    return this.eventKey;
+  }
+
+  public void setEventKey(String eventKey) {
+    this.eventKey = eventKey;
+  }
+
+  public String getContent() {
+    return this.content;
+  }
+
+  public void setContent(String content) {
+    this.content = content;
+  }
+
+  public String getrContent() {
+    return this.rContent;
+  }
+
+  public void setrContent(String rContent) {
+    this.rContent = rContent;
+  }
+
+  public WxMaMessageMatcher getMatcher() {
+    return this.matcher;
+  }
+
+  public void setMatcher(WxMaMessageMatcher matcher) {
+    this.matcher = matcher;
+  }
+
+  public boolean isReEnter() {
+    return this.reEnter;
+  }
+
+  public void setReEnter(boolean reEnter) {
+    this.reEnter = reEnter;
+  }
+
+  public List<WxMaMessageHandler> getHandlers() {
+    return this.handlers;
+  }
+
+  public void setHandlers(List<WxMaMessageHandler> handlers) {
+    this.handlers = handlers;
+  }
+
+  public List<WxMaMessageInterceptor> getInterceptors() {
+    return this.interceptors;
+  }
+
+  public void setInterceptors(List<WxMaMessageInterceptor> interceptors) {
+    this.interceptors = interceptors;
+  }
+}