👽 注释、文档

README.md

@@ -103,7 +103,7 @@ authRequest.login("code");
 |  <img src="https://gitee.com/yadong.zhang/static/raw/master/JustAuth/alipay.png" width="20">  |  [AuthAlipayRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthAlipayRequest.java)  |  <a href="https://alipay.open.taobao.com/docs/doc.htm?spm=a219a.7629140.0.0.336d4b70GUKXOl&treeId=193&articleId=105809&docType=1" target="_blank">参考文档</a> |
 |  <img src="https://gitee.com/yadong.zhang/static/raw/master/JustAuth/qq.png" width="20">  |  [AuthQqRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthQqRequest.java)  |  <a href="http://wiki.connect.qq.com/" target="_blank">参考文档</a>  |
 |  <img src="https://gitee.com/yadong.zhang/static/raw/master/JustAuth/csdn.png" width="20">  |  [AuthCsdnRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthCsdnRequest.java)  |  待续 |
-|  <img src="https://gitee.com/yadong.zhang/static/raw/master/JustAuth/wechats.png" width="20">  |  [AuthWeChatRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthCsdnRequest.java)   |  待续  |
+|  <img src="https://gitee.com/yadong.zhang/static/raw/master/JustAuth/wechats.png" width="20">  |  [AuthWeChatRequest](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/request/AuthCsdnRequest.java)   |  <a href="https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&t=resource/res_list&verify=1&id=open1419316505&token=&lang=zh_CN" target="_blank">参考文档</a>  |
 
 ## 后续开发计划
 

src/main/java/me/zhyd/oauth/config/AuthConfig.java

@@ -6,6 +6,8 @@ import lombok.Getter;
 import lombok.NoArgsConstructor;
 
 /**
+ * JustAuth配置类
+ *
  * @author yadong.zhang (yadong.zhang0415(a)gmail.com)
  * @version 1.0
  * @since 1.8
@@ -15,8 +17,17 @@ import lombok.NoArgsConstructor;
 @NoArgsConstructor
 @AllArgsConstructor
 public class AuthConfig {
+
+    /**
+     * 客户端id：对应个平台的appKey
+     */
     private String clientId;
+
+    /**
+     * 客户端Secret：对应个平台的appSecret
+     */
     private String clientSecret;
+
     /**
      * 登录成功后的回调地址
      */

src/main/java/me/zhyd/oauth/consts/ApiUrl.java

@@ -360,14 +360,29 @@ public enum ApiUrl {
         }
     };
 
+    /**
+     * 授权的api
+     */
     public abstract String authorize();
 
+    /**
+     * 获取accessToken的api
+     */
     public abstract String accessToken();
 
+    /**
+     * 获取用户信息的api
+     */
     public abstract String userInfo();
 
+    /**
+     * 取消授权的api
+     */
     public abstract String revoke();
 
+    /**
+     * 刷新授权的api
+     */
     public abstract String refresh();
 
 }

src/main/java/me/zhyd/oauth/model/AuthUserGender.java

 package me.zhyd.oauth.model;
 
+import java.util.Arrays;
+
 /**
  * @author yadong.zhang (yadong.zhang0415(a)gmail.com)
  * @version 1.0
@@ -19,10 +21,12 @@ public enum AuthUserGender {
         if (code == null) {
             return UNKNOW;
         }
-        if ("m".equals(code) || "男".equals(code) || "1".equals(code) || "male".equalsIgnoreCase(code) || "F".equalsIgnoreCase(code)) {
+        String[] males = {"m", "男", "1", "male", "F"};
+        if (Arrays.asList(males).contains(code)) {
             return MALE;
         }
-        if ("f".equals(code) || "女".equals(code) || "0".equals(code) || "female".equalsIgnoreCase(code)) {
+        String[] females = {"f", "女", "0", "female"};
+        if (Arrays.asList(females).contains(code)) {
             return FEMALE;
         }
         return UNKNOW;

src/test/java/me/zhyd/oauth/AuthRequestTest.java

@@ -116,6 +116,19 @@ public class AuthRequestTest {
         authRequest.login("code");
     }
 
+    @Test
+    public void qqTest() {
+        AuthRequest authRequest = new AuthQqRequest(AuthConfig.builder()
+                .clientId("clientId")
+                .clientSecret("clientSecret")
+                .redirectUri("redirectUri")
+                .build());
+        // 返回授权页面，可自行调整
+        String url = authRequest.authorize();
+        // 授权登录后会返回一个code，用这个code进行登录
+        AuthResponse login = authRequest.login("code");
+    }
+
     @Test
     public void wechatTest() {
         AuthRequest authRequest = new AuthWeChatRequest(AuthConfig.builder()