微信模块代码增加注释

src/main/java/com/uas/platform/b2c/common/weixin/contoller/WeChatController.java

@@ -31,6 +31,12 @@ public class WeChatController {
     @Autowired
     private WeChatService weChatService;
 
+    /**
+     * 与微信服务器接口配置
+     * @param model
+     * @param request
+     * @param response
+     */
     @RequestMapping(value = "/check", method = RequestMethod.GET)
     public void wenxinCheck(Model model, HttpServletRequest request, HttpServletResponse response) {
         // 微信加密签名
@@ -77,7 +83,7 @@ public class WeChatController {
      * 用户微信授权成功返回接口
      * @param code 用于获取AccessToken
      * @param state 获取code的state参数
-     * @return
+     * @return 微信用户信息
      */
     @RequestMapping(value = "/getWxUserInfo", method = RequestMethod.GET)
     public ModelMap getWxUserInfo(String code,String state) {

src/main/java/com/uas/platform/b2c/common/weixin/model/base/WeChatConstant.java

@@ -9,8 +9,17 @@ package com.uas.platform.b2c.common.weixin.model.base;
  */
 public class WeChatConstant {
 
+    /**
+     * 编码类型
+     */
     public static final String DEFAULT_CHARACTER_ENCODING = "UTF-8";
+    /**
+     * get 请求
+     */
     public static final String GET_METHOD = "GET";
+    /**
+     * post 请求
+     */
 	public static final String POST_METHOD = "POST";
 
 }

src/main/java/com/uas/platform/b2c/common/weixin/model/req/AuthCodeParams.java

@@ -19,12 +19,46 @@ import java.util.TreeMap;
 public class AuthCodeParams extends AbstractParams {
 	
 	private static final long serialVersionUID = 6313379843885615765L;
-	public static final String SCOPE_SNSAPIBASE = "snsapi_base"; // snsapi_base(不需要弹出授权页面,只能获取openid)
-	public static final String SCOPE_SNSPAIUSERINFO = "snsapi_userinfo"; // 弹出授权页面(获取用户基本信息)
+	/**
+	 * snsapi_base(不需要弹出授权页面,只能获取openid)
+	 */
+	public static final String SCOPE_SNSAPIBASE = "snsapi_base";
+
+	/**
+	 * 弹出授权页面(获取用户基本信息)
+	 */
+	public static final String SCOPE_SNSPAIUSERINFO = "snsapi_userinfo";
+
+	/**
+	 * 网站应用仅填写 snsapi_login
+	 */
+	public static final String SCOPE_SNSPAILOGIN = "snsapi_login";
+	/**
+	 * 应用 appid
+	 */
 	private String appid;
-	private String redirect_uri; // 使用urlencode对链接进行处理
+
+	/**
+	 * 重定向连接,使用urlencode对链接进行处理
+	 */
+	private String redirect_uri;
+
+	/**
+	 * 响应类型，固定为 code
+	 */
 	private String response_type = "code";
+
+	/**
+	 * 应用授权作用域
+	 */
 	private String scope;
+
+	/**
+	 * 用于保持请求和回调的状态，授权请求后原样带回给第三方。
+	 * 该参数可用于防止csrf攻击（跨站请求伪造攻击），
+	 * 建议第三方带上该参数，
+	 * 可设置为简单的随机数加session进行校验
+	 */
 	private String state;
 
 	public AuthCodeParams() {
@@ -45,6 +79,7 @@ public class AuthCodeParams extends AbstractParams {
 	 * 
 	 * @return
 	 */
+	@Override
 	public Map<String, String> getParams() throws UnsupportedEncodingException {
 		Map<String, String> params = new TreeMap<String, String>();
 		params.put("appid", this.appid);

src/main/java/com/uas/platform/b2c/common/weixin/model/req/AuthTokenParams.java

@@ -15,9 +15,18 @@ import java.util.TreeMap;
 public class AuthTokenParams extends AbstractParams {
 	
 	private static final long serialVersionUID = 4652953400751046159L;
-	private String appid; //公众号的唯一标识
-	private String secret; //公众号的appsecret
-	private String code; //填写第一步获取的code参数
+	/**
+	 * 公众号的唯一标识
+	 */
+	private String appid;
+	/**
+	 * 公众号的appsecret
+	 */
+	private String secret;
+	/**
+	 * 填写第一步获取的code参数
+	 */
+	private String code;
 	private String grant_type = "authorization_code";
 
 	public AuthTokenParams() {
@@ -42,6 +51,7 @@ public class AuthTokenParams extends AbstractParams {
 	 * 参数组装
 	 * @return
 	 */
+	@Override
 	public Map<String, String> getParams() {
 		Map<String, String> params = new TreeMap<String, String>();
 		params.put("appid", this.appid);

src/main/java/com/uas/platform/b2c/common/weixin/model/req/AuthUserParams.java

@@ -15,9 +15,18 @@ import java.util.TreeMap;
 public class AuthUserParams extends AbstractParams {
 
 	private static final long serialVersionUID = 66535717787322321L;
-	
+	/**
+	 * 网页授权接口调用凭证,注意：此access_token与基础支持的access_token不同
+	 */
 	private String accessToken;
+
+	/**
+	 * 用户的唯一标识
+	 */
 	private String openid;
+	/**
+	 * 国家地区语言版本，zh_CN 简体，zh_TW 繁体，en 英语
+	 */
 	private String lang;
 
 	public AuthUserParams() {
@@ -59,6 +68,7 @@ public class AuthUserParams extends AbstractParams {
 	 * 参数组装
 	 * @return
 	 */
+	@Override
 	public Map<String, String> getParams() {
 		Map<String, String> params = new TreeMap<String, String>();
 		params.put("access_token", this.accessToken);

src/main/java/com/uas/platform/b2c/common/weixin/model/req/RefreshAuthTokenParams.java

@@ -16,8 +16,17 @@ import java.util.TreeMap;
 public class RefreshAuthTokenParams extends AbstractParams {
 
 	private static final long serialVersionUID = -1748872326563685295L;
+	/**
+	 * 公众号的唯一标识
+	 */
 	private String appid;
+	/**
+	 * 填写为refresh_token
+	 */
 	private String grant_type = "refresh_token";
+	/**
+	 * 填写通过access_token获取到的refresh_token参数
+	 */
 	private String refresh_token;
 
 	public RefreshAuthTokenParams(String appid, String grant_type, String refresh_token) {
@@ -32,6 +41,7 @@ public class RefreshAuthTokenParams extends AbstractParams {
 	 * 
 	 * @return
 	 */
+	@Override
 	public Map<String, String> getParams() {
 		Map<String, String> params = new TreeMap<String, String>();
 		params.put("appid", this.appid);

src/main/java/com/uas/platform/b2c/common/weixin/model/req/WechatTemplateMsg.java

@@ -10,13 +10,25 @@ import java.util.TreeMap;
  */
 public class WechatTemplateMsg {
 
-	private String touser; //接收者openid
+	/**
+	 * 接收者openid
+	 */
+	private String touser;
 
-	private String template_id; //模板ID
+	/**
+	 * 模板ID
+	 */
+	private String template_id;
 
-	private String url; //模板跳转链接
+	/**
+	 * 模板跳转链接
+	 */
+	private String url;
 
-	private TreeMap<String, TreeMap<String, String>> data; //data数据
+	/**
+	 * data数据
+	 */
+	private TreeMap<String, TreeMap<String, String>> data;
 
 	public String getTouser() {
 		return touser;

src/main/java/com/uas/platform/b2c/common/weixin/model/resp/AccessToken.java

@@ -8,9 +8,13 @@ package com.uas.platform.b2c.common.weixin.model.resp;
  * 
  */
 public class AccessToken {
-	// 获取到的凭证
+	/**
+	 * 获取到的凭证
+	 */
 	private String access_token;
-	// 凭证有效时间，单位：秒
+	/**
+	 * 凭证有效时间，单位：秒
+	 */
 	private int expires_in;
 
 	public String getAccess_token() {

src/main/java/com/uas/platform/b2c/common/weixin/model/resp/AuthAccessToken.java

@@ -9,9 +9,21 @@ package com.uas.platform.b2c.common.weixin.model.resp;
  */
 public class AuthAccessToken extends AccessToken {
 
-	private String refresh_token; // 用户刷新access_token
-	private String openid; // 用户唯一标识，请注意，在未关注公众号时，用户访问公众号的网页，也会产生一个用户和公众号唯一的OpenID
-	private String scope; // 用户授权的作用域，使用逗号（,）分隔
+	/**
+	 * 用户刷新access_token
+	 */
+	private String refresh_token;
+
+	/**
+	 * 用户唯一标识，请注意，在未关注公众号时，
+	 * 用户访问公众号的网页，也会产生一个用户和公众号唯一的OpenID
+	 */
+	private String openid;
+
+	/**
+	 * 用户授权的作用域，使用逗号（,）分隔
+	 */
+	private String scope;
 
 	public String getRefresh_token() {
 		return refresh_token;

src/main/java/com/uas/platform/b2c/common/weixin/model/resp/AuthUserInfo.java

@@ -9,23 +9,43 @@ import java.util.List;
  *
  */
 public class AuthUserInfo {
-	// 用户标识
+	/**
+	 * 用户标识
+	 */
 	private String openid;
-	// 用户昵称
+	/**
+	 * 用户昵称
+	 */
 	private String nickname;
-	// 性别(1是男性,2是女性,0是未知)
+
+	/**
+	 * 性别(1是男性,2是女性,0是未知)
+	 */
 	private String sex;
-	// 国家
+
+	/**
+	 * 国家
+	 */
 	private String country;
-	// 省份
+	/**
+	 * 省份
+	 */
 	private String province;
-	// 城市
+	/**
+	 * 城市
+	 */
 	private String city;
-	// 用户头像链接
+	/**
+	 * 用户头像链接
+	 */
 	private String headimgurl;
-	// 用户特权信息
+	/**
+	 * 用户特权信息
+	 */
 	private List<String> privilege;
-	// 只有在用户将公众号绑定到微信开放平台帐号后，才会出现该字段
+	/**
+	 * 只有在用户将公众号绑定到微信开放平台帐号后，才会出现该字段
+ 	 */
 	private String unionid;
 
 	public String getOpenid() {

src/main/java/com/uas/platform/b2c/common/weixin/model/resp/TemplateMsgResult.java

@@ -8,9 +8,18 @@ package com.uas.platform.b2c.common.weixin.model.resp;
  */
 public class TemplateMsgResult {
 
-	private Long msgid; // 消息id(发送模板消息)
-	private Integer errcode; // 状态
-	private String errmsg; //信息
+	/**
+	 * 消息id(发送模板消息)
+	 */
+	private Long msgid;
+	/**
+	 * 状态
+	 */
+	private Integer errcode;
+	/**
+	 * 信息
+	 */
+	private String errmsg;
 
 	public Long getMsgid() {
 		return msgid;

src/main/java/com/uas/platform/b2c/common/weixin/service/impl/WeChatServiceImpl.java

@@ -183,6 +183,12 @@ public class WeChatServiceImpl implements WeChatService{
         return userInfo;
     }
 
+    /**
+     * 获取用户信息
+     * @param accessToken
+     * @param openId
+     * @return
+     */
     private AuthUserInfo getUserInfo(String accessToken, String openId) {
         // 返回国家地区语言版本，zh_CN 简体，zh_TW 繁体，en 英语
         AuthUserParams authUserParams = new AuthUserParams(accessToken, openId, "zh_CN");
@@ -193,7 +199,7 @@ public class WeChatServiceImpl implements WeChatService{
 
     /**
      * 获取调用api所需的access_token
-     * @exception Exception 获取 access_token 失败抛出异常
+     *
      */
     private String getAccessToken () {
         String access_token = (String) redisTemplate.opsForValue().get("WX_ACCESS_TOKEN");