Merge pull request #27 from lexiLiu/1.0.0.8

[update]

Author: jianbin2001

CHANGES.md

@@ -1,5 +1,10 @@
 # Release Notes
 
+## 1.0.0.8
+### update
+* ApiHelper和DefaultApiClient 缓存key支持设置自定义前缀，满足客户特殊使用场景
+* 完善参数和注释
+
 ## 1.0.0.7
 ### Fix
 * 修复超时重试http连接未释放问题

README.md

@@ -22,7 +22,7 @@
     <dependency>
         <groupId>com.getui.push</groupId>
         <artifactId>restful-sdk</artifactId>
-        <version>1.0.0.7</version>
+        <version>1.0.0.8</version>
     </dependency>
 ```
 

pom.xml

@@ -7,7 +7,7 @@
     <groupId>com.getui.push</groupId>
     <artifactId>restful-sdk</artifactId>
     <packaging>jar</packaging>
-    <version>1.0.0.7</version>
+    <version>1.0.0.8</version>
     <url>https://github.com/GetuiLaboratory/getui-pushapi-java-client-v2</url>
     <name>Getui Push API Java Client</name>
     <description>Getui's officially supported Java client library for accessing Getui APIs.</description>

src/main/java/com/getui/push/v2/sdk/ApiHelper.java

@@ -8,8 +8,8 @@
 import com.getui.push.v2.sdk.core.client.DefaultApiClient;
 import com.getui.push.v2.sdk.core.factory.GtApiProxyFactory;
 
-import java.util.HashMap;
 import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
 
 /**
  * create by getui on 2020/6/7
@@ -22,7 +22,7 @@ public class ApiHelper {
 
     private static final Object BUILD_LOCK = new Object();
 
-    private static final Map<String, ApiHelper> apiHelperCache = new HashMap<String, ApiHelper>(4);
+    private static final Map<String, ApiHelper> apiHelperCache = new ConcurrentHashMap<String, ApiHelper>(4);
 
     /**
      * @param configuration 配置信息类
@@ -62,6 +62,11 @@ public static ApiHelper build(GtApiConfiguration configuration, IJson json) {
         }
     }
 
+    /**
+     * 删除缓存，并关闭守护线程，不影响已创建的Api的使用
+     *
+     * @param configuration
+     */
     public static void close(GtApiConfiguration configuration) {
         Assert.notNull(configuration, "configuration");
         configuration.check();

src/main/java/com/getui/push/v2/sdk/common/Config.java

@@ -13,4 +13,5 @@ public class Config {
     public static final Charset ISO_8859_1 = Charset.forName("ISO-8859-1");
     public static final Charset UTF_8 = Charset.forName("UTF-8");
     public final static String CHECK_HEALTH_DATA_SWITCH_KEY = GtApiConfiguration.CHECK_HEALTH_DATA_SWITCH_KEY;
+    public static final String AUTH_URI = "/auth";
 }

src/main/java/com/getui/push/v2/sdk/common/http/GtHttpClient.java

@@ -131,8 +131,12 @@ private String doRequest(HttpUriRequest request, int tryTimes) {
             response = httpclient.execute(request);
             final StatusLine statusLine = response.getStatusLine();
             code = statusLine.getStatusCode();
+            String responseBody = "";
             // toString内部回收connection
-            String responseBody = EntityUtils.toString(response.getEntity());
+            HttpEntity entity = response.getEntity();
+            if (entity != null) {
+                responseBody = EntityUtils.toString(entity);
+            }
             if (code == HttpURLConnection.HTTP_OK ||
                     code == HttpURLConnection.HTTP_BAD_REQUEST ||
                     code == HttpURLConnection.HTTP_UNAUTHORIZED ||

src/main/java/com/getui/push/v2/sdk/core/Configs.java

@@ -13,7 +13,7 @@ public interface Configs {
 
     String HEADER_DOMAIN_HASH_KEY = "domainHash";
     String HEADER_OPEN_STABLE_DOMAIN = "openStableDomain";
-    String SDK_VERSION = "1.0.0.7";
+    String SDK_VERSION = "1.0.0.8";
     /**
      * 预置域名列表
      */

src/main/java/com/getui/push/v2/sdk/core/client/DefaultApiClient.java

@@ -6,7 +6,9 @@
 import com.getui.push.v2.sdk.common.ApiException;
 import com.getui.push.v2.sdk.common.ApiResult;
 import com.getui.push.v2.sdk.common.Assert;
+import com.getui.push.v2.sdk.common.Config;
 import com.getui.push.v2.sdk.common.http.HttpManager;
+import com.getui.push.v2.sdk.common.type.TypeReference;
 import com.getui.push.v2.sdk.common.util.Utils;
 import com.getui.push.v2.sdk.core.Configs;
 import com.getui.push.v2.sdk.core.domain.RasDomainBO;
@@ -24,6 +26,7 @@
 import java.security.InvalidParameterException;
 import java.util.*;
 import java.util.concurrent.*;
+import java.util.regex.Pattern;
 
 /**
  * 1. 管理token
@@ -107,6 +110,8 @@ public static DefaultApiClient build(GtApiConfiguration apiConfiguration, IJson
                 while (iterator.hasNext()) {
                     Map.Entry<String, DefaultApiClient> entry = iterator.next();
                     if (entry.getKey().startsWith(prefixOfKey)) {
+                        // 缓存更新之前校验应用信息是否正确
+                        checkAppInfo(apiConfiguration, json);
                         defaultApiClient = entry.getValue();
                         defaultApiClient.apiConfiguration = apiConfiguration;
                         iterator.remove();
@@ -121,6 +126,42 @@ public static DefaultApiClient build(GtApiConfiguration apiConfiguration, IJson
         return defaultApiClient;
     }
 
+    final static Pattern HIDE_MASTER_SECRET_PATTERN = Pattern.compile("(.{3}).+(.{3})");
+
+    static void checkAppInfo(GtApiConfiguration configuration, IJson json) {
+        DefaultApiClient client = null;
+        try {
+            GtApiConfiguration apiConfiguration = new GtApiConfiguration();
+            apiConfiguration.setAppId(configuration.getAppId());
+            apiConfiguration.setAppKey(configuration.getAppKey());
+            apiConfiguration.setMasterSecret(configuration.getMasterSecret());
+            apiConfiguration.setDomain(configuration.getDomain());
+            apiConfiguration.setOpenCheckHealthDataSwitch(false);
+            apiConfiguration.setOpenAnalyseStableDomainSwitch(false);
+            apiConfiguration.setTrustSSL(configuration.isTrustSSL());
+            apiConfiguration.setProxyConfig(configuration.getProxyConfig());
+
+            client = new DefaultApiClient(apiConfiguration, json);
+            final String fullUrl = client.genFullUrl(Config.AUTH_URI, null, null);
+            AuthDTO authDTO = AuthDTO.build(apiConfiguration.getAppKey(), apiConfiguration.getMasterSecret());
+            String result = client.httpManager.syncHttps(fullUrl, "POST", null, json.toJson(authDTO), client.CONTENT_TYPE);
+            ApiResult<TokenDTO> apiResult = json.fromJson(result, new TypeReference<ApiResult<TokenDTO>>() {
+            }.getType());
+            if (!apiResult.isSuccess()) {
+                String hideSecret = HIDE_MASTER_SECRET_PATTERN.matcher(apiConfiguration.getMasterSecret()).replaceAll("$1********************$2");
+                log.error("check app info failed. appId: {}, appKey: {}, masterSecret: {}, result: {}",
+                        apiConfiguration.getAppId(), apiConfiguration.getAppKey(), hideSecret, apiResult);
+                throw new RuntimeException("check app info failed. please check app info. appId: "
+                        + apiConfiguration.getAppId() + ", appKey: " + apiConfiguration.getAppKey()
+                        + ", masterSecret: " + hideSecret);
+            }
+        } finally {
+            if (client != null) {
+                client.close();
+            }
+        }
+    }
+
     private DefaultApiClient(GtApiConfiguration apiConfiguration, IJson json) {
         if (apiConfiguration == null) {
             throw new ApiException("apiConfiguration cannot be null.", true);

src/main/java/com/getui/push/v2/sdk/core/factory/GtApiProxyFactory.java

@@ -121,7 +121,13 @@ public void close() {
         cache.remove(this.defaultApiClient);
     }
 
+    /**
+     * HTTP请求的参数
+     */
     public static class ApiParam {
+        /**
+         * 基础参数，从方法注解中解析
+         */
         private final BaseParam baseParam;
         /**
          * 路径参数

src/main/java/com/getui/push/v2/sdk/dto/req/AudienceDTO.java

@@ -21,6 +21,11 @@ public class AudienceDTO {
      */
     private boolean isAsync;
 
+    /**
+     * 是否返回别名详情,返回别名详情的前提：is_async=false
+     */
+    private boolean needAliasDetail;
+
     public Audience getAudience() {
         return audience;
     }
@@ -45,12 +50,21 @@ public void setAsync(boolean async) {
         isAsync = async;
     }
 
+    public boolean isNeedAliasDetail() {
+        return needAliasDetail;
+    }
+
+    public void setNeedAliasDetail(boolean needAliasDetail) {
+        this.needAliasDetail = needAliasDetail;
+    }
+
     @Override
     public String toString() {
         return "AudienceDTO{" +
                 "audience=" + audience +
                 ", taskid='" + taskid + '\'' +
                 ", isAsync=" + isAsync +
+                ", needAliasDetail=" + needAliasDetail +
                 '}';
     }
 }