├── README.md
├── pom.xml
├── robot-demo
    ├── pom.xml
    └── src
    │   └── main
    │       ├── java
    │           └── org
    │           │   └── mvnsearch
    │           │       └── wx
    │           │           └── web
    │           │               └── controllers
    │           │                   └── PortalController.java
    │       ├── resources
    │           ├── appContext-robot.xml
    │           ├── struts.properties
    │           ├── struts.xml
    │           └── struts2packages
    │           │   └── portal-package.xml
    │       └── webapp
    │           ├── WEB-INF
    │               ├── pages
    │               │   ├── weixin.jspx
    │               │   └── welcome.jsp
    │               ├── web.xml
    │               └── weixin-router.xml
    │           └── index.action
└── robot-sdk
    ├── pom.xml
    └── src
        ├── main
            └── java
            │   └── org
            │       └── mvnsearch
            │           └── wx
            │               ├── WeixinMessage.java
            │               ├── WeixinUtils.java
            │               ├── rewrite
            │                   ├── Conf.java
            │                   ├── NormalRewrittenUrl.java
            │                   ├── NormalRule.java
            │                   ├── RewrittenUrl.java
            │                   ├── Rule.java
            │                   ├── RuleChain.java
            │                   └── UrlRewriter.java
            │               └── servlet
            │                   ├── WeixinMessageContext.java
            │                   └── WexinRobotServlet.java
        └── test
            ├── java
                └── org
                │   └── mvnsearch
                │       └── wx
                │           ├── ConfTest.java
                │           └── WeixinMessageTest.java
            └── resources
                ├── weixin-robot-flow.puml
                └── weixin-router.xml


/README.md:
--------------------------------------------------------------------------------
 1 | Weixin robot Java
 2 | ========================================
 3 | 微信公共平台自动回复机器人的Java SDK，你可以使用SDK简单快速构建微信机器人。
 4 | 微信Robot Java借鉴了url rewrite的思想，url rewrite是根据url进行路由，而微信Robot则是根据消息类型和内容进行路由。
 5 | 整理的流程如下：
 6 | 
 7 | * WexinRobotServlet负责认证和微信消息接收
 8 | * 接收后进行XML解析，构建出 WeixinMessage对象，并注入到request的attribute中，名字为wxMsg
 9 | * 根据配置的路由参数，对微信消息进行匹配
10 | * 根据匹配的结果进行URL路由转发
11 | * 最后由处理的组件完成xml格式反馈的输出
12 | 
13 | 
14 | ### 如何使用
15 | 首先我们要在pom.xml中添加：
16 | 
17 |      <dependency>
18 |         <groupId>org.mvnsearch.wx</groupId>
19 |         <artifactId>wx-robot-sdk</artifactId>
20 |         <version>1.0.0</version>
21 |      </dependency>
22 | 
23 | 接下来就是修改web.xml添加Servlet负责接收微信公共平台发过来的消息：
24 | 
25 |         <servlet>
26 |             <servlet-name>WexinRobotServlet</servlet-name>
27 |             <servlet-class>org.mvnsearch.wx.servlet.WexinRobotServlet</servlet-class>
28 |             <init-param>
29 |                 <param-name>token</param-name>
30 |                 <param-value>yourTokenHere</param-value>
31 |             </init-param>
32 |             <init-param>
33 |                 <param-name>confFile</param-name>
34 |                 <param-value>/WEB-INF/weixin-router.xml</param-value>
35 |             </init-param>
36 |         </servlet>
37 | 
38 |         <!-- weixing -->
39 |         <servlet-mapping>
40 |             <servlet-name>WexinRobotServlet</servlet-name>
41 |             <url-pattern>/servlet/weixinrobot</url-pattern>
42 |         </servlet-mapping>
43 | 
44 | 其中token是指你在微信公共平台上的token，这里和其一致。接下来我们还需要设置servlet mapping，添加url-pattern，
45 | 然后将最终的url，如上述配置的 http://www.foobar.com/servlet/weixinrobot 作为微信公共平台接口配置中的URL。
46 | 接下来是在WEB-INF目录下创建一个weixin-router.xml的文件，完成信息的路由。
47 | 
48 | 接收到的消息如何路由到指定的组件处理，如Struts的Controller等，这里我们需要创建一个router文件，这里还是根据
49 | 消息的类型和内容进行转发，内容如下：
50 | 
51 |     <?xml version="1.0" encoding="utf-8"?>
52 | 
53 |     <weixinrobot>
54 | 
55 |         <rule>
56 |             <type>text</type>
57 |             <content>[\d]{11}</content>
58 |             <forward>/weixin2.wx</forward>
59 |         </rule>
60 | 
61 |         <rule>
62 |             <type>text</type>
63 |             <forward>/weixin.wx</forward>
64 |         </rule>
65 | 
66 |     </weixinrobot>
67 | 
68 | 上述的例子就是如果内容是手机号，交与/weixin2.wx这个URL处理。当然我们设置了一个默认的选项，如果text类型的消息没有任何
69 | 匹配，则由/weixin.wx处理。
70 | 
71 | 收到微信消息后，要给出消息反馈。微信公共平台的消息反馈是一个xml格式的数据，在Java的系统中，我们使用jspx输出接口，样例如下：
72 | 
73 |      <?xml version="1.0" encoding="UTF-8"?>
74 |      <xml>
75 |          <ToUserName>${wxMsg.sender}</ToUserName>
76 |          <FromUserName>${wxMsg.receiver}</FromUserName>
77 |          <CreateTime>${wxMsg.createdTime}</CreateTime>
78 |          <MsgType>text</MsgType>
79 |          <Content>${content}</Content>
80 |          <FuncFlag>0</FuncFlag>
81 |      </xml>
82 | 
83 | ### 编码
84 | 
85 | * 在代码中获取解析好的微信消息  WeixinMessage wxMsg = (WeixinMessage)request.getAttribute("wxMsg");
86 | 
87 | ### FAQ
88 | 
89 | * 如何调试： 由于微信服务器只能通知互联网IP和80端口，开发时你可以在你家中的ADSL拨号路由器上设置一下80转发，
90 | 然后微信服务器的消息通知就可以路由到你的笔记本上，方便你测试和开发。查看你的互联网Ip请访问 http://ip.mvnsearch.org
91 | * 参考样例清访问robot-demo Maven module
92 | 
93 | 


--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 3 |          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
 4 |     <modelVersion>4.0.0</modelVersion>
 5 |     <groupId>org.mvnsearch.wx</groupId>
 6 |     <artifactId>weixin-robot</artifactId>
 7 |     <packaging>pom</packaging>
 8 |     <version>1.0.0-SNAPSHOT</version>
 9 |     <modules>
10 |         <module>robot-sdk</module>
11 |         <module>robot-demo</module>
12 |     </modules>
13 |     <name>Weixin Robot Java Project</name>
14 |     <description>
15 |         微信公共平台自动回复机器人Java SDK
16 |     </description>
17 |     <inceptionYear>2013</inceptionYear>
18 |     <organization>
19 |         <name>MvnSearch</name>
20 |         <url>http://www.mvnsearch.org</url>
21 |     </organization>
22 |     <properties>
23 |         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
24 |     </properties>
25 |     <developers>
26 |         <developer>
27 |             <id>linux_china</id>
28 |             <name>Jacky Chan</name>
29 |             <email>libing.chen@gmail.com</email>
30 |             <url>http://weibo.com/linux2china</url>
31 |             <roles>
32 |                 <role>开发人员</role>
33 |             </roles>
34 |         </developer>
35 |     </developers>
36 |     <scm>
37 |         <connection>scm:git@github.com:linux-china/weixin-robot-java.git</connection>
38 |         <developerConnection>scm:git@github.com:linux-china/weixin-robot-java.git</developerConnection>
39 |         <url>https://github.com/linux-china/weixin-robot-java</url>
40 |     </scm>
41 |     <dependencies>
42 |         <!-- unit test-->
43 |         <dependency>
44 |             <groupId>junit</groupId>
45 |             <artifactId>junit</artifactId>
46 |             <version>3.8.2</version>
47 |             <scope>test</scope>
48 |         </dependency>
49 |     </dependencies>
50 | </project>


--------------------------------------------------------------------------------
/robot-demo/pom.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
  3 |          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4 |     <modelVersion>4.0.0</modelVersion>
  5 |     <parent>
  6 |         <artifactId>weixin-robot</artifactId>
  7 |         <groupId>org.mvnsearch.wx</groupId>
  8 |         <version>1.0.0-SNAPSHOT</version>
  9 |     </parent>
 10 |     <artifactId>robot-demo</artifactId>
 11 |     <version>1.0.0-SNAPSHOT</version>
 12 |     <packaging>war</packaging>
 13 |     <name>robot demo Maven Webapp</name>
 14 |     <properties>
 15 |         <struts2.version>2.3.15.1</struts2.version>
 16 |         <spring.version>3.2.2.RELEASE</spring.version>
 17 |     </properties>
 18 |     <dependencies>
 19 |         <dependency>
 20 |             <groupId>org.mvnsearch.wx</groupId>
 21 |             <artifactId>wx-robot-sdk</artifactId>
 22 |             <version>1.0.0-SNAPSHOT</version>
 23 |         </dependency>
 24 |         <!--JEE and Web related-->
 25 |         <dependency>
 26 |             <groupId>javax.servlet</groupId>
 27 |             <artifactId>servlet-api</artifactId>
 28 |             <version>3.0-alpha-1</version>
 29 |             <scope>provided</scope>
 30 |         </dependency>
 31 |         <dependency>
 32 |             <groupId>javax.servlet.jsp</groupId>
 33 |             <artifactId>jsp-api</artifactId>
 34 |             <version>2.2</version>
 35 |             <scope>provided</scope>
 36 |         </dependency>
 37 |         <!--spring framework-->
 38 |         <dependency>
 39 |             <groupId>org.springframework</groupId>
 40 |             <artifactId>spring-beans</artifactId>
 41 |             <version>${spring.version}</version>
 42 |         </dependency>
 43 |         <dependency>
 44 |             <groupId>org.springframework</groupId>
 45 |             <artifactId>spring-core</artifactId>
 46 |             <version>${spring.version}</version>
 47 |         </dependency>
 48 |         <dependency>
 49 |             <groupId>org.springframework</groupId>
 50 |             <artifactId>spring-context</artifactId>
 51 |             <version>${spring.version}</version>
 52 |         </dependency>
 53 |         <dependency>
 54 |             <groupId>org.springframework</groupId>
 55 |             <artifactId>spring-context-support</artifactId>
 56 |             <version>${spring.version}</version>
 57 |         </dependency>
 58 |         <dependency>
 59 |             <groupId>org.springframework</groupId>
 60 |             <artifactId>spring-aspects</artifactId>
 61 |             <version>${spring.version}</version>
 62 |         </dependency>
 63 |         <dependency>
 64 |             <groupId>org.springframework</groupId>
 65 |             <artifactId>spring-web</artifactId>
 66 |             <version>${spring.version}</version>
 67 |         </dependency>
 68 |         <dependency>
 69 |             <groupId>org.springframework</groupId>
 70 |             <artifactId>spring-aop</artifactId>
 71 |             <version>${spring.version}</version>
 72 |         </dependency>
 73 |         <!--Struts 2 related -->
 74 |         <dependency>
 75 |             <groupId>org.apache.struts</groupId>
 76 |             <artifactId>struts2-core</artifactId>
 77 |             <version>${struts2.version}</version>
 78 |         </dependency>
 79 |         <dependency>
 80 |             <groupId>org.apache.struts</groupId>
 81 |             <artifactId>struts2-spring-plugin</artifactId>
 82 |             <version>${struts2.version}</version>
 83 |             <exclusions>
 84 |                 <exclusion>
 85 |                     <groupId>org.springframework</groupId>
 86 |                     <artifactId>spring-beans</artifactId>
 87 |                 </exclusion>
 88 |                 <exclusion>
 89 |                     <groupId>org.springframework</groupId>
 90 |                     <artifactId>spring-context</artifactId>
 91 |                 </exclusion>
 92 |                 <exclusion>
 93 |                     <groupId>org.springframework</groupId>
 94 |                     <artifactId>spring-core</artifactId>
 95 |                 </exclusion>
 96 |                 <exclusion>
 97 |                     <groupId>org.springframework</groupId>
 98 |                     <artifactId>spring-web</artifactId>
 99 |                 </exclusion>
100 |             </exclusions>
101 |         </dependency>
102 |         <dependency>
103 |             <groupId>junit</groupId>
104 |             <artifactId>junit</artifactId>
105 |             <version>3.8.1</version>
106 |             <scope>test</scope>
107 |         </dependency>
108 |     </dependencies>
109 |     <build>
110 |         <finalName>robot-demo</finalName>
111 |     </build>
112 | </project>
113 | 


--------------------------------------------------------------------------------
/robot-demo/src/main/java/org/mvnsearch/wx/web/controllers/PortalController.java:
--------------------------------------------------------------------------------
 1 | package org.mvnsearch.wx.web.controllers;
 2 | 
 3 | import com.opensymphony.xwork2.ActionSupport;
 4 | import org.apache.struts2.interceptor.ServletRequestAware;
 5 | import org.mvnsearch.wx.WeixinMessage;
 6 | 
 7 | import javax.servlet.http.HttpServletRequest;
 8 | import java.util.Date;
 9 | 
10 | /**
11 |  * portal controller
12 |  *
13 |  * @author linux_china
14 |  */
15 | public class PortalController extends ActionSupport implements ServletRequestAware {
16 |     /**
17 |      * http servlet request
18 |      */
19 |     HttpServletRequest request;
20 | 
21 |     /**
22 |      * inject http servlet request
23 |      *
24 |      * @param httpServletRequest http servlet request
25 |      */
26 |     public void setServletRequest(HttpServletRequest httpServletRequest) {
27 |         this.request = httpServletRequest;
28 |     }
29 | 
30 |     /**
31 |      * project front page
32 |      *
33 |      * @return welcome page
34 |      */
35 |     public String index() {
36 |         return "index";
37 |     }
38 | 
39 |     /**
40 |      * 显示微信消息
41 |      *
42 |      * @return weixing response
43 |      */
44 |     public String weixin() {
45 |         WeixinMessage wxMsg = (WeixinMessage) request.getAttribute("wxMsg");
46 |         if (wxMsg == null) {
47 |             wxMsg = new WeixinMessage();
48 |             wxMsg.setSender("jacky");
49 |             wxMsg.setReceiver("leijuan");
50 |             wxMsg.setContent("txt");
51 |             wxMsg.setCreatedTime(new Date());
52 |             request.setAttribute("wxMsg", wxMsg);
53 |         }
54 |         request.setAttribute("content", "echo：" + wxMsg.getContent());
55 |         return "weixin";
56 |     }
57 | 
58 |     /**
59 |      * 显示微信消息2
60 |      *
61 |      * @return weixing response
62 |      */
63 |     public String weixin2() {
64 |         request.setAttribute("content", "weixin2");
65 |         return "weixin";
66 |     }
67 | }
68 | 


--------------------------------------------------------------------------------
/robot-demo/src/main/resources/appContext-robot.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="UTF-8"?>
2 | 
3 | <beans xmlns="http://www.springframework.org/schema/beans"
4 |        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5 |        xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.1.xsd">
6 | 
7 | </beans>


--------------------------------------------------------------------------------
/robot-demo/src/main/resources/struts.properties:
--------------------------------------------------------------------------------
 1 | struts.i18n.reload = true
 2 | struts.devMode = true
 3 | struts.configuration.xml.reload = true
 4 | struts.url.http.port = 80
 5 | struts.serve.static = true
 6 | struts.serve.static.browserCache = false
 7 | struts.objectFactory = spring
 8 | struts.objectFactory.spring.autoWire = name
 9 | struts.objectFactory.spring.useClassCache = true
10 | struts.locale = zh_CN
11 | struts.i18n.encoding = UTF-8
12 | struts.ui.theme = xhtml
13 | struts.enable.DynamicMethodInvocation = true
14 | struts.custom.i18n.resources = global
15 | struts.action.extension = action,do,jsn,wx
16 | struts.multipart.maxSize = 5242880


--------------------------------------------------------------------------------
/robot-demo/src/main/resources/struts.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <!DOCTYPE struts PUBLIC "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
 3 |         "http://struts.apache.org/dtds/struts-2.0.dtd">
 4 | 
 5 | <struts>
 6 |     <!-- Configuration for the site package. -->
 7 |     <package name="project-default" extends="struts-default" abstract="true">
 8 |         <interceptors>
 9 |             <interceptor-stack name="projectStack">
10 |                 <interceptor-ref name="paramsPrepareParamsStack"/>
11 |             </interceptor-stack>
12 |         </interceptors>
13 |         <default-interceptor-ref name="projectStack"/>
14 |     </package>
15 |     <include file="struts2packages/portal-package.xml"/>
16 | </struts>
17 | 


--------------------------------------------------------------------------------
/robot-demo/src/main/resources/struts2packages/portal-package.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <!DOCTYPE struts PUBLIC "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
 3 |         "http://struts.apache.org/dtds/struts-2.0.dtd">
 4 | 
 5 | <struts>
 6 |     <!-- struts 2.0 package for portal package-->
 7 |     <package namespace="/" name="portal-package" extends="project-default">
 8 |         <!-- portal actions -->
 9 |         <action name="*" class="org.mvnsearch.wx.web.controllers.PortalController" method="{1}">
10 |             <result name="index" type="dispatcher">/WEB-INF/pages/welcome.jsp</result>
11 |             <result name="weixin" type="dispatcher">/WEB-INF/pages/weixin.jspx</result>
12 |         </action>
13 |     </package>
14 | </struts>


--------------------------------------------------------------------------------
/robot-demo/src/main/webapp/WEB-INF/pages/weixin.jspx:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <xml>
 3 |     <ToUserName>${wxMsg.sender}</ToUserName>
 4 |     <FromUserName>${wxMsg.receiver}</FromUserName>
 5 |     <CreateTime>${wxMsg.createdTime}</CreateTime>
 6 |     <MsgType>text</MsgType>
 7 |     <Content>${content}</Content>
 8 |     <FuncFlag>0</FuncFlag>
 9 | </xml>
10 | 


--------------------------------------------------------------------------------
/robot-demo/src/main/webapp/WEB-INF/pages/welcome.jsp:
--------------------------------------------------------------------------------
 1 | <!doctype html>
 2 | <html lang="en-US">
 3 | <head>
 4 |     <meta charset="UTF-8">
 5 |     <title>Weixin Robot</title>
 6 | </head>
 7 | <body>
 8 | <h2>Weixin Robot Demo</h2>
 9 | </body>
10 | </html>
11 | 


--------------------------------------------------------------------------------
/robot-demo/src/main/webapp/WEB-INF/web.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8" ?>
 2 | 
 3 | <web-app xmlns="http://java.sun.com/xml/ns/javaee"
 4 |          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 5 |          xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
 6 |          version="3.0">
 7 | 
 8 |     <display-name>Weixin Robot Demo</display-name>
 9 | 
10 |     <context-param>
11 |         <param-name>contextConfigLocation</param-name>
12 |         <param-value>
13 |             classpath:/appContext-robot.xml
14 |         </param-value>
15 |     </context-param>
16 | 
17 |     <!--spring context loader listener-->
18 |     <listener>
19 |         <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
20 |     </listener>
21 | 
22 |     <servlet>
23 |         <servlet-name>WexinRobotServlet</servlet-name>
24 |         <servlet-class>org.mvnsearch.wx.servlet.WexinRobotServlet</servlet-class>
25 |         <init-param>
26 |             <param-name>token</param-name>
27 |             <param-value>nananjingdu</param-value>
28 |         </init-param>
29 |         <init-param>
30 |             <param-name>confFile</param-name>
31 |             <param-value>/WEB-INF/weixin-router.xml</param-value>
32 |         </init-param>
33 |     </servlet>
34 | 
35 |     <!-- weixing -->
36 |     <servlet-mapping>
37 |         <servlet-name>WexinRobotServlet</servlet-name>
38 |         <url-pattern>/servlet/weixinrobot</url-pattern>
39 |     </servlet-mapping>
40 | 
41 |     <filter>
42 |         <filter-name>struts</filter-name>
43 |         <filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter</filter-class>
44 |     </filter>
45 |     <!--filter pattern for Struts 2.1-->
46 |     <filter-mapping>
47 |         <filter-name>struts</filter-name>
48 |         <url-pattern>*.action</url-pattern>
49 |         <dispatcher>REQUEST</dispatcher>
50 |         <dispatcher>FORWARD</dispatcher>
51 |     </filter-mapping>
52 |     <filter-mapping>
53 |         <filter-name>struts</filter-name>
54 |         <url-pattern>*.wx</url-pattern>
55 |         <dispatcher>REQUEST</dispatcher>
56 |         <dispatcher>FORWARD</dispatcher>
57 |     </filter-mapping>
58 |     <welcome-file-list>
59 |         <welcome-file>index.action</welcome-file>
60 |     </welcome-file-list>
61 | 
62 |     <jsp-config>
63 |         <jsp-property-group>
64 |             <url-pattern>*.jsp</url-pattern>
65 |             <page-encoding>UTF-8</page-encoding>
66 |             <trim-directive-whitespaces>true</trim-directive-whitespaces>
67 |         </jsp-property-group>
68 |         <jsp-property-group>
69 |             <url-pattern>*.jspx</url-pattern>
70 |             <page-encoding>UTF-8</page-encoding>
71 |             <trim-directive-whitespaces>true</trim-directive-whitespaces>
72 |         </jsp-property-group>
73 |     </jsp-config>
74 | 
75 | </web-app>
76 | 


--------------------------------------------------------------------------------
/robot-demo/src/main/webapp/WEB-INF/weixin-router.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | 
 3 | <weixinrobot>
 4 | 
 5 |     <rule>
 6 |         <type>text</type>
 7 |         <content>[\d]{11}</content>
 8 |         <forward>/weixin2.wx</forward>
 9 |     </rule>
10 | 
11 |     <rule>
12 |         <type>text</type>
13 |         <forward>/weixin.wx</forward>
14 |     </rule>
15 | 
16 | </weixinrobot>


--------------------------------------------------------------------------------
/robot-demo/src/main/webapp/index.action:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/linux-china/weixin-robot-java/985b1f68c3b21fb2ae3607aac2554dd6380848d0/robot-demo/src/main/webapp/index.action


--------------------------------------------------------------------------------
/robot-sdk/pom.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
 3 |          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 4 |     <modelVersion>4.0.0</modelVersion>
 5 | 
 6 |     <groupId>org.mvnsearch.wx</groupId>
 7 |     <artifactId>wx-robot-sdk</artifactId>
 8 |     <version>1.0.0-SNAPSHOT</version>
 9 | 
10 |     <name>Weixin Robot Java SDK</name>
11 | 
12 |     <properties>
13 |         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
14 |     </properties>
15 |     <developers>
16 |         <developer>
17 |             <id>linux_china</id>
18 |             <name>Jacky Chan</name>
19 |             <email>libing.chen@gmail.com</email>
20 |             <url>http://weibo.com/linux2china</url>
21 |             <roles>
22 |                 <role>开发人员</role>
23 |             </roles>
24 |         </developer>
25 |     </developers>
26 |     <scm>
27 |         <connection>scm:git@github.com:linux-china/weixin-robot-java.git</connection>
28 |         <developerConnection>scm:git@github.com:linux-china/weixin-robot-java.git</developerConnection>
29 |         <url>https://github.com/linux-china/weixin-robot-java</url>
30 |     </scm>
31 | 
32 |     <dependencies>
33 |         <dependency>
34 |             <groupId>javax.servlet</groupId>
35 |             <artifactId>servlet-api</artifactId>
36 |             <version>2.5</version>
37 |             <scope>provided</scope>
38 |         </dependency>
39 |         <dependency>
40 |             <groupId>org.jdom</groupId>
41 |             <artifactId>jdom</artifactId>
42 |             <version>1.1.3</version>
43 |         </dependency>
44 |         <dependency>
45 |             <groupId>commons-codec</groupId>
46 |             <artifactId>commons-codec</artifactId>
47 |             <version>1.7</version>
48 |         </dependency>
49 |         <dependency>
50 |             <groupId>com.intellij</groupId>
51 |             <artifactId>annotations</artifactId>
52 |             <version>12.0</version>
53 |         </dependency>
54 |         <dependency>
55 |             <groupId>junit</groupId>
56 |             <artifactId>junit</artifactId>
57 |             <version>3.8.1</version>
58 |             <scope>test</scope>
59 |         </dependency>
60 |     </dependencies>
61 | </project>
62 | 


--------------------------------------------------------------------------------
/robot-sdk/src/main/java/org/mvnsearch/wx/WeixinMessage.java:
--------------------------------------------------------------------------------
  1 | package org.mvnsearch.wx;
  2 | 
  3 | import org.jetbrains.annotations.NotNull;
  4 | 
  5 | import java.util.Date;
  6 | 
  7 | /**
  8 |  * weixin message
  9 |  *
 10 |  * @author linux_china
 11 |  */
 12 | public class WeixinMessage {
 13 |     /**
 14 |      * text message
 15 |      */
 16 |     public static final String type_text = "text";
 17 |     /**
 18 |      * image message
 19 |      */
 20 |     public static final String type_image = "image";
 21 |     /**
 22 |      * location message
 23 |      */
 24 |     public static final String type_location = "location";
 25 |     /**
 26 |      * link message
 27 |      */
 28 |     public static final String type_link = "link";
 29 |     /**
 30 |      * news message
 31 |      */
 32 |     public static final String type_news = "news";
 33 |     /**
 34 |      * music message
 35 |      */
 36 |     public static final String type_music = "music";
 37 | 
 38 |     /**
 39 |      * subscribe message
 40 |      */
 41 |     public static final String type_subscribe = "subscribe";
 42 |     /**
 43 |      * unsubscribe message
 44 |      */
 45 |     public static final String type_unsubscribe = "unsubscribe";
 46 |     /**
 47 |      * click message
 48 |      */
 49 |     public static final String type_click = "click";
 50 |     /**
 51 |      * message id
 52 |      */
 53 |     private String id;
 54 |     /**
 55 |      * sender，微信号
 56 |      */
 57 |     private String sender;
 58 |     /**
 59 |      * receiver，微信号
 60 |      */
 61 |     private String receiver;
 62 |     /**
 63 |      * created timestamp
 64 |      */
 65 |     private Date createdTime;
 66 |     /**
 67 |      * type: text, image, location, link
 68 |      */
 69 |     private String type;
 70 |     /**
 71 |      * content, such as text, image url, link etc
 72 |      */
 73 |     private String content;
 74 | 
 75 |     public String getId() {
 76 |         return id;
 77 |     }
 78 | 
 79 |     public void setId(String id) {
 80 |         this.id = id;
 81 |     }
 82 | 
 83 |     public String getSender() {
 84 |         return sender;
 85 |     }
 86 | 
 87 |     public void setSender(String sender) {
 88 |         this.sender = sender;
 89 |     }
 90 | 
 91 |     public String getReceiver() {
 92 |         return receiver;
 93 |     }
 94 | 
 95 |     public void setReceiver(String receiver) {
 96 |         this.receiver = receiver;
 97 |     }
 98 | 
 99 |     public Date getCreatedTime() {
100 |         return createdTime;
101 |     }
102 | 
103 |     public void setCreatedTime(Date createdTime) {
104 |         this.createdTime = createdTime;
105 |     }
106 | 
107 |     public Long getCreatedSeconds() {
108 |         return this.createdTime.getTime() / 1000;
109 |     }
110 | 
111 |     public String getType() {
112 |         return type;
113 |     }
114 | 
115 |     public void setType(String type) {
116 |         this.type = type;
117 |     }
118 | 
119 |     public String getContent() {
120 |         return content;
121 |     }
122 | 
123 |     public void setContent(String content) {
124 |         this.content = content;
125 |     }
126 | 
127 |     /**
128 |      * fill message
129 |      *
130 |      * @param type    type
131 |      * @param content content
132 |      */
133 |     public void fill(String type, String content) {
134 |         this.type = type;
135 |         this.content = content;
136 |     }
137 | 
138 |     /**
139 |      * get reply message
140 |      *
141 |      * @return reply message
142 |      */
143 |     @NotNull
144 |     public WeixinMessage getReply() {
145 |         WeixinMessage reply = new WeixinMessage();
146 |         reply.setReceiver(this.sender);
147 |         reply.setSender(this.receiver);
148 |         reply.setCreatedTime(new Date());
149 |         return reply;
150 |     }
151 | 
152 |     /**
153 |      * get response xml
154 |      *
155 |      * @param type    type
156 |      * @param content content
157 |      * @return response xml
158 |      */
159 |     public String getResponseXml(String type, String content) {
160 |         String template = "<xml>\n" +
161 |                 "    <ToUserName><![CDATA[%s]]></ToUserName>\n" +
162 |                 "    <FromUserName><![CDATA[%s]]></FromUserName>\n" +
163 |                 "    <CreateTime>%s</CreateTime>\n" +
164 |                 "    <MsgType><![CDATA[%s]]></MsgType>\n" +
165 |                 "    <Content><![CDATA[%s]]></Content>\n" +
166 |                 "    <FuncFlag>0</FuncFlag>\n" +
167 |                 "</xml>";
168 |         return String.format(template, sender, receiver, String.valueOf(System.currentTimeMillis() / 1000), type, content);
169 |     }
170 | 
171 | }
172 | 


--------------------------------------------------------------------------------
/robot-sdk/src/main/java/org/mvnsearch/wx/WeixinUtils.java:
--------------------------------------------------------------------------------
 1 | package org.mvnsearch.wx;
 2 | 
 3 | import org.jdom.Document;
 4 | import org.jdom.Element;
 5 | import org.jdom.input.SAXBuilder;
 6 | 
 7 | import java.io.InputStream;
 8 | import java.io.StringReader;
 9 | import java.util.Date;
10 | 
11 | /**
12 |  * weixin utils
13 |  *
14 |  * @author linux_china
15 |  */
16 | public class WeixinUtils {
17 | 
18 |     /**
19 |      * parse xml to get weixin message
20 |      *
21 |      * @param xmlText xml text
22 |      * @return weixin message
23 |      * @throws Exception exception
24 |      */
25 |     public static WeixinMessage parseXML(String xmlText) throws Exception {
26 |         SAXBuilder saxBuilder = new SAXBuilder();
27 |         Document document = saxBuilder.build(new StringReader(xmlText));
28 |         return constructMsg(document);
29 |     }
30 | 
31 |     /**
32 |      * parse xml to get weixin message
33 |      *
34 |      * @param inputStream xml text
35 |      * @return weixin message
36 |      * @throws Exception exception
37 |      */
38 |     public static WeixinMessage parseXML(InputStream inputStream) throws Exception {
39 |         SAXBuilder saxBuilder = new SAXBuilder();
40 |         Document document = saxBuilder.build(inputStream);
41 |         return constructMsg(document);
42 |     }
43 | 
44 |     /**
45 |      * construct weixin message from xml document
46 |      *
47 |      * @param document xml document
48 |      * @return weixin message
49 |      */
50 |     private static WeixinMessage constructMsg(Document document) {
51 |         Element rootElement = document.getRootElement();
52 |         WeixinMessage msg = new WeixinMessage();
53 |         msg.setId(rootElement.getChildTextTrim("MsgId"));
54 |         msg.setReceiver(rootElement.getChildTextTrim("ToUserName"));
55 |         msg.setSender(rootElement.getChildTextTrim("FromUserName"));
56 |         msg.setType(rootElement.getChildTextTrim("MsgType"));
57 |         msg.setContent(rootElement.getChildTextTrim("Content"));
58 |         String createTime = rootElement.getChildTextTrim("CreateTime");
59 |         if (createTime != null) {
60 |             msg.setCreatedTime(new Date(Long.valueOf(createTime) * 1000));
61 |         }
62 |         //event message
63 |         if ("event".equals(msg.getType())) {
64 |             String event = rootElement.getChildText("EventKey");
65 |             String eventKey = rootElement.getChildText("EventKey");
66 |             msg.setType(event);
67 |             msg.setContent(eventKey);
68 |         }
69 |         return msg;
70 |     }
71 | }
72 | 


--------------------------------------------------------------------------------
/robot-sdk/src/main/java/org/mvnsearch/wx/rewrite/Conf.java:
--------------------------------------------------------------------------------
 1 | package org.mvnsearch.wx.rewrite;
 2 | 
 3 | import org.jdom.Document;
 4 | import org.jdom.Element;
 5 | import org.jdom.input.SAXBuilder;
 6 | 
 7 | import javax.servlet.ServletContext;
 8 | import java.io.InputStream;
 9 | import java.util.ArrayList;
10 | import java.util.List;
11 | 
12 | /**
13 |  * weixin robot configuration
14 |  *
15 |  * @author linux_china
16 |  */
17 | public class Conf {
18 |     /**
19 |      * rules
20 |      */
21 |     private List<Rule> rules = new ArrayList<Rule>();
22 | 
23 |     /**
24 |      * construct method
25 |      *
26 |      * @param path path
27 |      * @throws Exception exception
28 |      */
29 |     @SuppressWarnings("unchecked")
30 |     public Conf(ServletContext servletContext, String path) throws Exception {
31 |         InputStream inputStream;
32 |         if (path.startsWith("classpath:")) {
33 |             inputStream = this.getClass().getResourceAsStream(path.replace("classpath:", "/"));
34 |         } else {
35 |             inputStream = servletContext.getResourceAsStream(path);
36 |         }
37 |         SAXBuilder saxBuilder = new SAXBuilder();
38 |         Document document = saxBuilder.build(inputStream);
39 |         List<Element> ruleElements = document.getRootElement().getChildren("rule");
40 |         for (Element ruleElement : ruleElements) {
41 |             rules.add(new NormalRule(ruleElement.getChildTextTrim("type"), ruleElement.getChildTextTrim("content"), (ruleElement.getChildTextTrim("forward"))));
42 |         }
43 |     }
44 | 
45 |     /**
46 |      * get forward rules
47 |      *
48 |      * @return rules
49 |      */
50 |     public List<Rule> getRules() {
51 |         return rules;
52 |     }
53 | }
54 | 


--------------------------------------------------------------------------------
/robot-sdk/src/main/java/org/mvnsearch/wx/rewrite/NormalRewrittenUrl.java:
--------------------------------------------------------------------------------
 1 | package org.mvnsearch.wx.rewrite;
 2 | 
 3 | import javax.servlet.ServletException;
 4 | import javax.servlet.http.HttpServletRequest;
 5 | import javax.servlet.http.HttpServletResponse;
 6 | import java.io.IOException;
 7 | 
 8 | /**
 9 |  * normal rewrite url
10 |  *
11 |  * @author linux_china
12 |  */
13 | public class NormalRewrittenUrl implements RewrittenUrl {
14 |     /**
15 |      * target forward url
16 |      */
17 |     private String target;
18 | 
19 |     /**
20 |      * construct method
21 |      *
22 |      * @param target target url
23 |      */
24 |     public NormalRewrittenUrl(String target) {
25 |         this.target = target;
26 |     }
27 | 
28 |     /**
29 |      * get target url
30 |      *
31 |      * @return target url
32 |      */
33 |     public String getTarget() {
34 |         return this.target;
35 |     }
36 | 
37 |     /**
38 |      * execute rewrite
39 |      *
40 |      * @param request  http servlet request
41 |      * @param response http servlet response
42 |      * @return rewrite mark
43 |      * @throws ServletException servlet exception
44 |      * @throws IOException      IO exception
45 |      */
46 |     public boolean doRewrite(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
47 |         request.getRequestDispatcher(getTarget()).forward(request, response);
48 |         return true;
49 |     }
50 | }
51 | 


--------------------------------------------------------------------------------
/robot-sdk/src/main/java/org/mvnsearch/wx/rewrite/NormalRule.java:
--------------------------------------------------------------------------------
 1 | package org.mvnsearch.wx.rewrite;
 2 | 
 3 | import org.jetbrains.annotations.Nullable;
 4 | import org.mvnsearch.wx.WeixinMessage;
 5 | 
 6 | import javax.servlet.ServletException;
 7 | import javax.servlet.http.HttpServletRequest;
 8 | import javax.servlet.http.HttpServletResponse;
 9 | import java.io.IOException;
10 | import java.util.regex.Pattern;
11 | 
12 | /**
13 |  * normal rule
14 |  *
15 |  * @author linux_china
16 |  */
17 | public class NormalRule implements Rule {
18 |     /**
19 |      * type
20 |      */
21 |     private String type;
22 |     /**
23 |      * content
24 |      */
25 |     private String content;
26 |     /**
27 |      * regex pattern
28 |      */
29 |     private Pattern regexPattern;
30 |     /**
31 |      * forward
32 |      */
33 |     private String forward;
34 | 
35 |     /**
36 |      * construct method
37 |      *
38 |      * @param type    type
39 |      * @param content content
40 |      * @param forward forward
41 |      */
42 |     public NormalRule(String type, String content, String forward) {
43 |         this.type = type;
44 |         this.content = content;
45 |         if (content != null && !content.isEmpty()) {
46 |             this.regexPattern = Pattern.compile(content);
47 |         }
48 |         this.forward = forward;
49 |     }
50 | 
51 |     /**
52 |      * match weixin message?
53 |      *
54 |      * @param wxMsg    weixin message
55 |      * @param request  http servlet request
56 |      * @param response http servlet response
57 |      * @return rewritten url
58 |      * @throws IOException      io exception
59 |      * @throws ServletException servlet exception
60 |      */
61 |     @Nullable
62 |     public RewrittenUrl matches(WeixinMessage wxMsg, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException {
63 |         boolean matched = false;
64 |         if (type.equals(wxMsg.getType())) {
65 |             matched = regexPattern == null || regexPattern.matcher(wxMsg.getContent()).find();
66 |         }
67 |         return matched ? new NormalRewrittenUrl(forward) : null;
68 |     }
69 | }
70 | 


--------------------------------------------------------------------------------
/robot-sdk/src/main/java/org/mvnsearch/wx/rewrite/RewrittenUrl.java:
--------------------------------------------------------------------------------
 1 | package org.mvnsearch.wx.rewrite;
 2 | 
 3 | import javax.servlet.ServletException;
 4 | import javax.servlet.http.HttpServletRequest;
 5 | import javax.servlet.http.HttpServletResponse;
 6 | import java.io.IOException;
 7 | 
 8 | /**
 9 |  * rewritten url
10 |  *
11 |  * @author linux_china
12 |  */
13 | public interface RewrittenUrl {
14 |     /**
15 |      * get target url
16 |      *
17 |      * @return target url
18 |      */
19 |     public String getTarget();
20 | 
21 |     /**
22 |      * execute rewrite
23 |      *
24 |      * @param request  http servlet request
25 |      * @param response http servlet response
26 |      * @return rewrite mark
27 |      * @throws ServletException servlet exception
28 |      * @throws IOException      IO exception
29 |      */
30 |     public boolean doRewrite(HttpServletRequest request,
31 |                              HttpServletResponse response)
32 |             throws ServletException, IOException;
33 | }
34 | 


--------------------------------------------------------------------------------
/robot-sdk/src/main/java/org/mvnsearch/wx/rewrite/Rule.java:
--------------------------------------------------------------------------------
 1 | package org.mvnsearch.wx.rewrite;
 2 | 
 3 | import org.jetbrains.annotations.Nullable;
 4 | import org.mvnsearch.wx.WeixinMessage;
 5 | 
 6 | import javax.servlet.ServletException;
 7 | import javax.servlet.http.HttpServletRequest;
 8 | import javax.servlet.http.HttpServletResponse;
 9 | import java.io.IOException;
10 | import java.lang.reflect.InvocationTargetException;
11 | 
12 | /**
13 |  * rewrite rule
14 |  *
15 |  * @author linux_china
16 |  */
17 | public interface Rule {
18 |     /**
19 |      * match weixin message?
20 |      *
21 |      * @param wxMsg    weixin message
22 |      * @param request  http servlet request
23 |      * @param response http servlet response
24 |      * @return rewritten url
25 |      * @throws IOException               io exception
26 |      * @throws ServletException          servlet exception
27 |      */
28 |     @Nullable
29 |     public RewrittenUrl matches(WeixinMessage wxMsg,
30 |                                 final HttpServletRequest request,
31 |                                 final HttpServletResponse response)
32 |             throws IOException, ServletException;
33 | }
34 | 


--------------------------------------------------------------------------------
/robot-sdk/src/main/java/org/mvnsearch/wx/rewrite/RuleChain.java:
--------------------------------------------------------------------------------
 1 | package org.mvnsearch.wx.rewrite;
 2 | 
 3 | import org.mvnsearch.wx.WeixinMessage;
 4 | 
 5 | import javax.servlet.ServletException;
 6 | import javax.servlet.http.HttpServletRequest;
 7 | import javax.servlet.http.HttpServletResponse;
 8 | import java.io.IOException;
 9 | import java.lang.reflect.InvocationTargetException;
10 | import java.util.List;
11 | 
12 | /**
13 |  * rule chain
14 |  *
15 |  * @author linux_china
16 |  */
17 | public class RuleChain {
18 |     /**
19 |      * rules
20 |      */
21 |     private List<Rule> rules;
22 |     /**
23 |      * target
24 |      */
25 |     private RewrittenUrl rewrittenUrl;
26 | 
27 |     /**
28 |      * rule chain construct
29 |      *
30 |      * @param rules rules
31 |      */
32 |     public RuleChain(List<Rule> rules) {
33 |         this.rules = rules;
34 |     }
35 | 
36 |     /**
37 |      * process weixin message
38 |      *
39 |      * @param wxMsg    weixin message
40 |      * @param request  http servlet request
41 |      * @param response response
42 |      * @throws IOException               IO Exception
43 |      * @throws ServletException          servlet exception
44 |      * @throws InvocationTargetException invocation target exception
45 |      */
46 |     public void process(WeixinMessage wxMsg, HttpServletRequest request, HttpServletResponse response)
47 |             throws IOException, ServletException, InvocationTargetException {
48 |         doRules(wxMsg, request, response);
49 |     }
50 | 
51 |     /**
52 |      * iterated match in rules
53 |      *
54 |      * @param wxMsg    weixin message
55 |      * @param request  http servlet request
56 |      * @param response http servlet response
57 |      * @throws IOException      IO Exception
58 |      * @throws ServletException servlet exception
59 |      */
60 |     public void doRules(WeixinMessage wxMsg, HttpServletRequest request, HttpServletResponse response)
61 |             throws IOException, ServletException {
62 |         for (Rule rule : rules) {
63 |             RewrittenUrl rewrittenUrl = rule.matches(wxMsg, request, response);
64 |             if (rewrittenUrl != null) {
65 |                 this.rewrittenUrl = rewrittenUrl;
66 |                 return;
67 |             }
68 |         }
69 |     }
70 | 
71 |     /**
72 |      * get final rewritten request
73 |      *
74 |      * @return rewritten url
75 |      */
76 |     public RewrittenUrl getFinalRewrittenRequest() {
77 |         return this.rewrittenUrl;
78 |     }
79 | 
80 | }
81 | 


--------------------------------------------------------------------------------
/robot-sdk/src/main/java/org/mvnsearch/wx/rewrite/UrlRewriter.java:
--------------------------------------------------------------------------------
 1 | package org.mvnsearch.wx.rewrite;
 2 | 
 3 | import org.mvnsearch.wx.WeixinMessage;
 4 | 
 5 | import javax.servlet.ServletException;
 6 | import javax.servlet.http.HttpServletRequest;
 7 | import javax.servlet.http.HttpServletResponse;
 8 | import java.io.IOException;
 9 | import java.lang.reflect.InvocationTargetException;
10 | 
11 | /**
12 |  * url rewriter
13 |  *
14 |  * @author linux_china
15 |  */
16 | public class UrlRewriter {
17 |     /**
18 |      * rewriter configuration
19 |      */
20 |     private Conf conf;
21 | 
22 |     /**
23 |      * construct method
24 |      *
25 |      * @param conf rewriter configuration
26 |      */
27 |     public UrlRewriter(Conf conf) {
28 |         this.conf = conf;
29 |     }
30 | 
31 | 
32 |     /**
33 |      * Helpful for testing but otherwise, don't use.
34 |      */
35 |     public RewrittenUrl processRequest(WeixinMessage wxMsg,
36 |                                        final HttpServletRequest request,
37 |                                        final HttpServletResponse response)
38 |             throws IOException, ServletException, InvocationTargetException {
39 |         RuleChain chain = getNewChain(request);
40 |         chain.process(wxMsg, request, response);
41 |         return chain.getFinalRewrittenRequest();
42 |     }
43 | 
44 |     /**
45 |      * get new rule  chain
46 |      *
47 |      * @param request     http servlet request
48 |      * @return rule chain
49 |      */
50 |     private RuleChain getNewChain(final HttpServletRequest request) {
51 |         return new RuleChain(conf.getRules());
52 |     }
53 | 
54 | }
55 | 


--------------------------------------------------------------------------------
/robot-sdk/src/main/java/org/mvnsearch/wx/servlet/WeixinMessageContext.java:
--------------------------------------------------------------------------------
 1 | package org.mvnsearch.wx.servlet;
 2 | 
 3 | import org.mvnsearch.wx.WeixinMessage;
 4 | 
 5 | import java.util.Collections;
 6 | import java.util.HashMap;
 7 | import java.util.Map;
 8 | 
 9 | /**
10 |  * weixin message context
11 |  *
12 |  * @author linux_china
13 |  */
14 | @SuppressWarnings("unchecked")
15 | public class WeixinMessageContext {
16 |     /**
17 |      * empty map
18 |      */
19 |     private static Map<String, String> emptyMap = Collections.emptyMap();
20 |     /**
21 |      * thread local variable
22 |      */
23 |     private final static ThreadLocal<Map<String, Object>> threadLocal = new ThreadLocal<Map<String, Object>>() {
24 |         protected Map<String, Object> initialValue() {
25 |             return new HashMap<String, Object>();
26 |         }
27 |     };
28 | 
29 |     /**
30 |      * set query string
31 |      *
32 |      * @param queryString query string
33 |      */
34 |     public static void setQueryString(String queryString) {
35 |         if (queryString != null && queryString.contains("=")) {
36 |             Map<String, String> query = new HashMap<String, String>();
37 |             for (String pair : queryString.split("&")) {
38 |                 String[] parts = pair.split("=", 2);
39 |                 if (parts.length == 2 && !parts[1].isEmpty()) {
40 |                     query.put(parts[0], parts[1]);
41 |                 }
42 |             }
43 |             threadLocal.get().put("query", query);
44 |         }
45 |     }
46 | 
47 |     /**
48 |      * add query pair
49 |      *
50 |      * @param name  name
51 |      * @param value value
52 |      */
53 |     public void addQuery(String name, String value) {
54 |         Map<String, String> query = (Map<String, String>) threadLocal.get().get("query");
55 |         if (query == null) {
56 |             query = new HashMap<String, String>();
57 |             threadLocal.get().put("query", query);
58 |         }
59 |         query.put(name, value);
60 |     }
61 | 
62 |     /**
63 |      * get query
64 |      *
65 |      * @return query
66 |      */
67 |     public static Map<String, String> getQuery() {
68 |         Map<String, String> query = (Map<String, String>) threadLocal.get().get("query");
69 |         return query == null ? emptyMap : query;
70 |     }
71 | 
72 |     /**
73 |      * set weixin message
74 |      *
75 |      * @param message message
76 |      */
77 |     public static void setWeixinMessage(WeixinMessage message) {
78 |         threadLocal.get().put("message", message);
79 |     }
80 | 
81 |     /**
82 |      * get weixin message
83 |      *
84 |      * @return weixin message
85 |      */
86 |     public static WeixinMessage getWeixinMessage() {
87 |         return (WeixinMessage) threadLocal.get().get("message");
88 |     }
89 | 
90 |     /**
91 |      * clear context
92 |      */
93 |     public static void clear() {
94 |         threadLocal.remove();
95 |     }
96 | }
97 | 


--------------------------------------------------------------------------------
/robot-sdk/src/main/java/org/mvnsearch/wx/servlet/WexinRobotServlet.java:
--------------------------------------------------------------------------------
  1 | package org.mvnsearch.wx.servlet;
  2 | 
  3 | import org.apache.commons.codec.digest.DigestUtils;
  4 | import org.jetbrains.annotations.Nullable;
  5 | import org.mvnsearch.wx.WeixinMessage;
  6 | import org.mvnsearch.wx.WeixinUtils;
  7 | import org.mvnsearch.wx.rewrite.Conf;
  8 | import org.mvnsearch.wx.rewrite.RewrittenUrl;
  9 | import org.mvnsearch.wx.rewrite.UrlRewriter;
 10 | 
 11 | import javax.servlet.ServletConfig;
 12 | import javax.servlet.ServletException;
 13 | import javax.servlet.http.HttpServlet;
 14 | import javax.servlet.http.HttpServletRequest;
 15 | import javax.servlet.http.HttpServletResponse;
 16 | import java.io.IOException;
 17 | import java.io.PrintWriter;
 18 | import java.util.*;
 19 | 
 20 | /**
 21 |  * weixin robot servlet
 22 |  *
 23 |  * @author linux_china
 24 |  */
 25 | public class WexinRobotServlet extends HttpServlet {
 26 |     /**
 27 |      * token
 28 |      */
 29 |     private String token;
 30 |     /**
 31 |      * pass code，用于调试，不执行签名检查
 32 |      */
 33 |     private String passCode;
 34 |     /**
 35 |      * url rewriter
 36 |      */
 37 |     private UrlRewriter urlRewriter;
 38 | 
 39 |     /**
 40 |      * init config
 41 |      *
 42 |      * @param config servlet config
 43 |      * @throws ServletException servlet exception
 44 |      */
 45 |     public void init(ServletConfig config) throws ServletException {
 46 |         this.token = config.getInitParameter("token");
 47 |         this.passCode = config.getInitParameter("passCode");
 48 |         String confFile = config.getInitParameter("confFile");
 49 |         try {
 50 |             Conf conf = new Conf(config.getServletContext(), confFile);
 51 |             this.urlRewriter = new UrlRewriter(conf);
 52 |         } catch (Exception e) {
 53 |             e.printStackTrace();
 54 |         }
 55 |     }
 56 | 
 57 |     /**
 58 |      * 微信公共平台认证接口
 59 |      *
 60 |      * @param request  http servlet request
 61 |      * @param response http servlet response
 62 |      * @throws ServletException servlet exception
 63 |      * @throws IOException      io exception
 64 |      */
 65 |     public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
 66 |         String echostr = request.getParameter("echostr");
 67 |         response.setContentType("text/plain; charset=UTF-8");
 68 |         PrintWriter out = response.getWriter();
 69 |         if (checkSignature(request.getQueryString(), getToken())) {
 70 |             out.print(echostr);
 71 |         } else {
 72 |             out.print("false");
 73 |         }
 74 |         out.flush();
 75 |     }
 76 | 
 77 |     /**
 78 |      * 微信消息接收接口
 79 |      *
 80 |      * @param request  http servlet request
 81 |      * @param response http servlet response
 82 |      * @throws ServletException servlet exception
 83 |      * @throws IOException      io exception
 84 |      */
 85 |     public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
 86 |         //validate signature
 87 |         boolean valid = checkSignature(request.getQueryString(), getToken());
 88 |         if (valid) {
 89 |             try {
 90 |                 WeixinMessage wxMsg = WeixinUtils.parseXML(request.getInputStream());
 91 |                 doMessage(wxMsg, request, response);
 92 |             } catch (Exception e) {
 93 |                 response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
 94 |             } finally {
 95 |                 WeixinMessageContext.clear();
 96 |             }
 97 |         } else {
 98 |             send400(response);
 99 |         }
100 |     }
101 | 
102 |     /**
103 |      * 处理 weixin message
104 |      *
105 |      * @param wxMsg    weixin message
106 |      * @param request  http servlet request
107 |      * @param response http servlet response
108 |      * @throws Exception exception
109 |      */
110 |     public void doMessage(WeixinMessage wxMsg, HttpServletRequest request, HttpServletResponse response) throws Exception {
111 |         WeixinMessageContext.setWeixinMessage(wxMsg);
112 |         WeixinMessageContext.setQueryString(request.getQueryString());
113 |         response.setContentType("text/xml; charset=UTF-8");
114 |         request.setAttribute("wxMsg", wxMsg);
115 |         RewrittenUrl rewrittenUrl = urlRewriter.processRequest(wxMsg, request, response);
116 |         if (rewrittenUrl != null) {
117 |             rewrittenUrl.doRewrite(request, response);
118 |         }
119 |     }
120 | 
121 |     /**
122 |      * 验证签名
123 |      *
124 |      * @param queryString query string
125 |      * @return valid mark
126 |      */
127 |     public boolean checkSignature(String queryString, @Nullable String token) {
128 |         if (token == null || token.isEmpty() || queryString == null) return false;
129 |         //pass code check
130 |         if (passCode != null && queryString.contains(passCode)) return true;
131 |         Map<String, String> params = new HashMap<String, String>();
132 |         for (String pair : queryString.split("&")) {
133 |             String[] temp = pair.split("=", 2);
134 |             params.put(temp[0], temp[1]);
135 |         }
136 |         List<String> elements = new ArrayList<String>();
137 |         elements.add(params.get("timestamp"));
138 |         elements.add(params.get("nonce"));
139 |         elements.add(token);
140 |         Collections.sort(elements);
141 |         StringBuilder seed = new StringBuilder();
142 |         for (String link : elements) {
143 |             seed.append(link);
144 |         }
145 |         return DigestUtils.sha1Hex(seed.toString()).equals(params.get("signature"));
146 |     }
147 | 
148 |     /**
149 |      * get weixin call back token
150 |      *
151 |      * @return token
152 |      */
153 |     @Nullable
154 |     protected String getToken() {
155 |         return this.token;
156 |     }
157 | 
158 |     /**
159 |      * get query   from query string
160 |      *
161 |      * @param request http servlet request
162 |      * @return query object
163 |      */
164 |     protected Map<String, String> getQuery(HttpServletRequest request) {
165 |         String queryString = request.getQueryString();
166 |         if (queryString == null || !queryString.contains("=")) {
167 |             return Collections.emptyMap();
168 |         }
169 |         Map<String, String> query = new HashMap<String, String>();
170 |         for (String pair : queryString.split("&")) {
171 |             String[] parts = pair.split("=", 2);
172 |             if (parts.length == 2 && !parts[1].isEmpty()) {
173 |                 query.put(parts[0], parts[1]);
174 |             }
175 |         }
176 |         return query;
177 |     }
178 | 
179 |     /**
180 |      * send 400(bad request) response
181 |      *
182 |      * @param response response
183 |      */
184 |     public void send400(HttpServletResponse response) {
185 |         try {
186 |             response.sendError(400);
187 |         } catch (Exception ignore) {
188 | 
189 |         }
190 |     }
191 | }
192 | 


--------------------------------------------------------------------------------
/robot-sdk/src/test/java/org/mvnsearch/wx/ConfTest.java:
--------------------------------------------------------------------------------
 1 | package org.mvnsearch.wx;
 2 | 
 3 | import junit.framework.TestCase;
 4 | import org.mvnsearch.wx.rewrite.Conf;
 5 | import org.mvnsearch.wx.rewrite.Rule;
 6 | 
 7 | /**
 8 |  * conf test
 9 |  *
10 |  * @author linux_china
11 |  */
12 | public class ConfTest extends TestCase {
13 | 
14 |     /**
15 |      * test to construct conf
16 |      *
17 |      * @throws Exception exception
18 |      */
19 |     public void testConstructConf() throws Exception {
20 |         Conf conf = new Conf(null, "classpath:weixin-router.xml");
21 |         for (Rule rule : conf.getRules()) {
22 |             System.out.println(rule);
23 |         }
24 |     }
25 | }
26 | 


--------------------------------------------------------------------------------
/robot-sdk/src/test/java/org/mvnsearch/wx/WeixinMessageTest.java:
--------------------------------------------------------------------------------
 1 | package org.mvnsearch.wx;
 2 | 
 3 | import junit.framework.TestCase;
 4 | 
 5 | /**
 6 |  * weixin message test case
 7 |  *
 8 |  * @author linux_china
 9 |  */
10 | public class WeixinMessageTest extends TestCase {
11 | 
12 |     /**
13 |      * test to prse xml
14 |      *
15 |      * @throws Exception exception
16 |      */
17 |     public void testParseXML() throws Exception {
18 |         String msgXml = "<xml>\n" +
19 |                 "<ToUserName><![CDATA[gh_1ad0d508f75a]]></ToUserName>\n" +
20 |                 "<FromUserName><![CDATA[o7LbXjsg_wdw9TYYzek9FOy9x4yk]]></FromUserName>\n" +
21 |                 "<CreateTime>1365073034</CreateTime>\n" +
22 |                 "<MsgType><![CDATA[text]]></MsgType>\n" +
23 |                 "<Content><![CDATA[再发]]></Content>\n" +
24 |                 "<MsgId>5862944037781496076</MsgId>\n" +
25 |                 "</xml>";
26 |         WeixinMessage msg = WeixinUtils.parseXML(msgXml);
27 |         System.out.println(msg.getResponseXml("text", "我能帮助你什么？"));
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/robot-sdk/src/test/resources/weixin-robot-flow.puml:
--------------------------------------------------------------------------------
 1 | @startdot
 2 | digraph WeixRobotFlow {
 3 |   WeixinServer [style=rounded]
 4 |   WeixinRobotServlet [shape=box]
 5 |   WebFramework [shape=box]
 6 |   MessageRouter [shape=diamond]
 7 | 
 8 |   WeixinServer -> WeixinRobotServlet [style=bold,label="Message Post"];
 9 |   WeixinRobotServlet -> MessageRouter [label="Regex Router"]
10 |   MessageRouter -> WebFramework [label="Forward"]
11 |   WebFramework -> WeixinServer [label="Response"]
12 | }
13 | @enddot


--------------------------------------------------------------------------------
/robot-sdk/src/test/resources/weixin-router.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | 
 3 | <weixinrobot>
 4 | 
 5 |     <rule>
 6 |         <type>text</type>
 7 |         <content>^\d{13}$</content>
 8 |         <forward>/weixin.wx</forward>
 9 |     </rule>
10 | 
11 | </weixinrobot>


--------------------------------------------------------------------------------