Signed-off-by: vcdemon <345280563@qq.com>

Author: itfvck

wechat-web/src/main/java/com/itfvck/wechatframework/web/service/WechatDefaultService.java

@@ -5,6 +5,12 @@
 
 import com.itfvck.wechatframework.web.support.WechatSupport;
 
+/**
+ * 微信默认消息处理中心
+ * 
+ * @author lidong
+ *
+ */
 public class WechatDefaultService extends WechatSupport {
     static Logger logger = LoggerFactory.getLogger(WechatDefaultService.class);
 

wechat-web/src/main/java/com/itfvck/wechatframework/web/servlet/WechatDefaultDispatcherServlet.java

@@ -14,10 +14,19 @@
 import com.itfvck.wechatframework.core.common.WechatParam;
 import com.itfvck.wechatframework.core.util.SignatureUtil;
 
+/**
+ * 默认微信消息请求入口
+ * 
+ * @author
+ *
+ */
 public class WechatDefaultDispatcherServlet extends WechatFrameworkServlet {
     private static final long serialVersionUID = -9199915074190263799L;
     static Logger logger = LoggerFactory.getLogger(WechatDefaultDispatcherServlet.class);
 
+    /**
+     * 微信接入验证请求入口
+     */
     protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
         WechatParam params = new WechatParam(request);
         logger.info("GET params：" + params.toString());
@@ -42,6 +51,9 @@ protected void doGet(HttpServletRequest request, HttpServletResponse response) t
         }
     }
 
+    /**
+     * 微信消息接收入口
+     */
     protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
         WechatParam params = new WechatParam(request);
         logger.info("POST params：" + params.toString());

wechat-web/src/main/java/com/itfvck/wechatframework/web/servlet/WechatFrameworkServlet.java

@@ -9,6 +9,12 @@
 import com.itfvck.wechatframework.web.service.WechatDefaultService;
 import com.itfvck.wechatframework.web.support.WechatSupport;
 
+/**
+ * 默认servlet初始化层
+ * 
+ * @author
+ *
+ */
 public abstract class WechatFrameworkServlet extends HttpServlet {
     private static Logger logger = LoggerFactory.getLogger(WechatFrameworkServlet.class);
     private static final long serialVersionUID = -3673669864159664378L;
@@ -21,6 +27,9 @@ public void init() throws ServletException {
         logger.info("消息处理中心服务器:" + wechat);
     }
 
+    /**
+     * 初始化微信消息处理器对象，第一步初始化自定义消息处理器，初始化失败则采用默认消息处理器
+     */
     private void initWechatServer() {
         try {
             wechat = (WechatSupport) Class.forName(this.getInitParameter(CLAZZ_NAME), true, Thread.currentThread().getContextClassLoader()).newInstance();
@@ -31,6 +40,11 @@ private void initWechatServer() {
         }
     }
 
+    /**
+     * 获取消息处理器对象
+     * 
+     * @return
+     */
     public WechatSupport getWechatService() {
         return wechat;
     }

wechat-web/src/main/java/com/itfvck/wechatframework/web/support/WechatDispatcher.java

@@ -12,8 +12,23 @@
 import com.itfvck.wechatframework.core.responseMsg.WechatResponse;
 import com.itfvck.wechatframework.core.util.XmlHelper;
 
+/**
+ * 微信服务器与用户消息转发控制中心
+ * 
+ * @author
+ *
+ */
 abstract class WechatDispatcher {
 
+    /**
+     * 微信服务器消息入口
+     * 
+     * @param request
+     * @param conf
+     * @param params
+     * @return 返回处理后的消息
+     * @throws Exception
+     */
     public String service(HttpServletRequest request, WechatConfig conf, WechatParam params) throws Exception {
         WechatRequest wechatRequest = XmlHelper.toObj(XmlHelper.parseXml(request, conf, params));
         String xml = null;
@@ -31,16 +46,11 @@ public String service(HttpServletRequest request, WechatConfig conf, WechatParam
     }
 
     /**
-     * @Description 普通消息分发
-     * @param requestMap
-     * @param baseConf
-     * @param params
+     * 普通消息分发中心
+     * 
+     * @param wechatRequest
      * @return
      * @throws Exception
-     * @CreationDate 2016年5月28日 下午1:29:02
-     * @Author itfvck(itfvck@itfvck.com)
-     * @UpdateDate
-     * @UpdateAuthor
      */
     private String dispatchMessage(WechatRequest wechatRequest) throws Exception {
         // 消息类型
@@ -76,15 +86,11 @@ private String dispatchMessage(WechatRequest wechatRequest) throws Exception {
     }
 
     /**
-     * @Description 事件消息分发
+     * 事件消息分发中心
+     * 
      * @param wechatRequest
-     * @param baseConf
-     * @param params
      * @return
-     * @CreationDate 2016年5月28日 下午1:29:14
-     * @Author itfvck(itfvck@itfvck.com)
-     * @UpdateDate
-     * @UpdateAuthor
+     * @throws Exception
      */
     private String dispatchEvent(WechatRequest wechatRequest) throws Exception {
         // 事件推送
@@ -148,22 +154,23 @@ private String dispatchEvent(WechatRequest wechatRequest) throws Exception {
     }
 
     /**
-     * @Description 获取微信消息的请求消息对象
+     * 将返回消息对象格式化为微信服务器所需要的XML格式字符串
+     * 
      * @param wechatRequest
-     * @param baseConf
-     * @param params
-     * @return WechatRequest 请求消息对象
-     * @see WechatRequest 请求消息对象
-     * @throws Exception
-     * @CreationDate 2016年5月29日 上午12:49:03
-     * @Author itfvck(itfvck@itfvck.com)
-     * @UpdateDate
-     * @UpdateAuthor
+     * @param wechatResponse
+     * @return
      */
     protected String formatWechatResponse(WechatRequest wechatRequest, WechatResponse wechatResponse) {
         return XmlHelper.toXML(setWechatResponseBase(wechatRequest, wechatResponse));
     }
 
+    /**
+     * 设置返回消息对象的基础数据
+     * 
+     * @param wechatRequest
+     * @param response
+     * @return
+     */
     private WechatResponse setWechatResponseBase(WechatRequest wechatRequest, WechatResponse response) {
         // 发送方帐号, 公告号将要向该号发送回复消息
         // 开发者微信帐号

wechat-web/src/main/java/com/itfvck/wechatframework/web/support/WechatSupport.java

@@ -9,6 +9,12 @@
 import com.itfvck.wechatframework.core.requestMsg.WechatRequest;
 import com.itfvck.wechatframework.core.responseMsg.WechatResponse;
 
+/**
+ * 微信消息处理中心，用户可继承该类以便实现业务定制
+ * 
+ * @author
+ *
+ */
 public abstract class WechatSupport extends WechatDispatcher {
     static Logger logger = LoggerFactory.getLogger(WechatSupport.class);