Merge pull request #33 from ZJUCJH/main

[update] 1.新增查询推送量和获取推送实时结果接口;2.报表相关接口反参解析问题修复;3.部分接口入参规范

Author: jianbin2001

CHANGES.md

@@ -1,11 +1,23 @@
 # Release Notes
 
+## 1.0.0.10
+
+### update
+
+* 新增查询推送量和获取推送实时结果接口
+* 报表相关接口反参解析问题修复
+* 部分接口入参规范
+
 ## 1.0.0.9
+
 ### update
+
 * 新增自定义回执字段SVIP功能
 
 ## 1.0.0.8
+
 ### update
+
 * ApiHelper和DefaultApiClient 缓存key支持设置自定义前缀，满足客户特殊使用场景
 * 完善参数和注释
 

README.md

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

pom.xml

@@ -7,7 +7,7 @@
     <groupId>com.getui.push</groupId>
     <artifactId>restful-sdk</artifactId>
     <packaging>jar</packaging>
-    <version>1.0.0.9</version>
+    <version>1.0.0.10</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/api/StatisticApi.java

@@ -4,6 +4,7 @@
 import com.getui.push.v2.sdk.anno.param.GtPathParam;
 import com.getui.push.v2.sdk.anno.param.GtQueryParam;
 import com.getui.push.v2.sdk.common.ApiResult;
+import com.getui.push.v2.sdk.dto.res.PushCountDTO;
 import com.getui.push.v2.sdk.dto.res.statistic.StatisticDTO;
 import com.getui.push.v2.sdk.dto.res.statistic.UserStatisticDTO;
 
@@ -72,4 +73,22 @@ public interface StatisticApi {
     @GtGet(uri = "/report/online_user")
     ApiResult<Map<String, Map<String, Integer>>> queryOnlineUserData();
 
+
+    /**
+     * 查询推送量
+     *
+     * @return
+     */
+    @GtGet(uri = "/report/push/count")
+    ApiResult<Map<String, Map<String, PushCountDTO>>> queryPushCountData();
+
+    /**
+     * 获取推送实时结果
+     *
+     * @param taskIds
+     * @return
+     */
+    @GtGet(uri = "/report/push/task/${taskid}/detail")
+    ApiResult<Map<String, Map<String, StatisticDTO>>> queryPushTaskDetailData(@GtPathParam Set<String> taskIds);
+
 }

src/main/java/com/getui/push/v2/sdk/api/UserApi.java

@@ -35,11 +35,11 @@ public interface UserApi {
     /**
      * 根据cid查询别名
      *
-     * @param cidList
+     * @param cid
      * @return
      */
     @GtGet(uri = "/user/alias/cid/")
-    ApiResult<AliasResDTO> queryAliasByCid(@GtPathParam Set<String> cidList);
+    ApiResult<AliasResDTO> queryAliasByCid(@GtPathParam String cid);
 
     /**
      * 根据别名查询cid

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.9";
+    String SDK_VERSION = "1.0.0.10";
     /**
      * 预置域名列表
      */

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

@@ -1,11 +1,14 @@
 package com.getui.push.v2.sdk.core;
 
 import com.getui.push.v2.sdk.IJson;
-import com.google.gson.FieldNamingPolicy;
-import com.google.gson.Gson;
-import com.google.gson.GsonBuilder;
+import com.getui.push.v2.sdk.dto.res.statistic.StatisticDTO;
+import com.google.gson.*;
 
 import java.lang.reflect.Type;
+import java.text.NumberFormat;
+import java.util.List;
+import java.util.Map;
+
 
 /**
  * create by getui on 2020/9/25
@@ -18,6 +21,37 @@ public class DefaultJson implements IJson {
     public static Gson createGson() {
         GsonBuilder gsonBuilder = new GsonBuilder();
         gsonBuilder.setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES);
+        gsonBuilder.registerTypeAdapter(Map.class, new JsonDeserializer<StatisticDTO>() {
+            @Override
+            public StatisticDTO deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context) throws JsonParseException {
+                StatisticDTO statisticDTO = new StatisticDTO();
+                JsonObject jo = json.getAsJsonObject();
+                for (Map.Entry<String, JsonElement> mx : jo.entrySet()) {
+                    String key = mx.getKey();
+                    JsonElement v = mx.getValue();
+                    if (v.isJsonArray()) {
+                        statisticDTO.put(key, context.deserialize(v, List.class));
+                    } else if (v.isJsonPrimitive()) {
+                        Object value = v.getAsString();
+                        try {
+                            Number numValue = NumberFormat.getInstance().parse((String) value);
+                            if (numValue != null && numValue.toString().equals(value)) {
+                                if (numValue instanceof Long && (Long) numValue <= Integer.MAX_VALUE && (Long) numValue >= Integer.MIN_VALUE) {
+                                    value = Integer.valueOf((String) value);
+                                } else {
+                                    value = numValue;
+                                }
+                            }
+                        } catch (Exception ignored) {
+                        }
+                        statisticDTO.put(key, value);
+                    } else if (v.isJsonObject()) {
+                        statisticDTO.put(key, context.deserialize(v, Map.class));
+                    }
+                }
+                return statisticDTO;
+            }
+        });
         return gsonBuilder.create();
     }
 

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

@@ -500,10 +500,14 @@ private String genFullUrl(String uri, String pathParams, List<String> queryParam
             host = host + uri;
         } else {
             host += uri;
-            if (host.endsWith("/")) {
-                host += pathParams;
+            if (Pattern.matches(".*\\$\\{.+}.*", host)) {
+                host = host.replaceAll("\\$\\{.+}", pathParams);
             } else {
-                host = host + "/" + pathParams;
+                if (host.endsWith("/")) {
+                    host += pathParams;
+                } else {
+                    host = host + "/" + pathParams;
+                }
             }
         }
         if (Utils.isEmpty(queryParams)) {

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

@@ -1,10 +1,6 @@
 package com.getui.push.v2.sdk.dto.req;
 
 import com.getui.push.v2.sdk.common.ApiException;
-import com.getui.push.v2.sdk.common.Assert;
-
-import java.util.HashSet;
-import java.util.Set;
 
 /**
  * create by getui on 2020/6/3
@@ -16,34 +12,25 @@ public class QueryAliasDTO implements BaseReqDTO {
     /**
      * 路径参数cid
      */
-    private Set<String> cidSet;
-
-    public QueryAliasDTO add(String cid) {
-        Assert.notBlank(cid, "cid");
-        if (cidSet == null) {
-            cidSet = new HashSet<String>();
-        }
-        cidSet.add(cid);
-        return this;
-    }
+    private String cid;
 
     @Override
     public void check() throws ApiException {
 
     }
 
-    public Set<String> getCidSet() {
-        return cidSet;
+    public String getCid() {
+        return cid;
     }
 
-    public void setCidSet(Set<String> cidSet) {
-        this.cidSet = cidSet;
+    public void setCid(String cid) {
+        this.cid = cid;
     }
 
     @Override
     public String toString() {
         return "QueryAliasDTO{" +
-                "cidSet=" + cidSet +
+                "cid='" + cid + '\'' +
                 '}';
     }
 }

src/main/java/com/getui/push/v2/sdk/dto/res/PushCountDTO.java

@@ -0,0 +1,78 @@
+package com.getui.push.v2.sdk.dto.res;
+
+import com.google.gson.annotations.SerializedName;
+
+/**
+ * @author getui
+ */
+public class PushCountDTO {
+
+    /**
+     * 单日可推送总量
+     */
+    @SerializedName("total_num")
+    private Integer totalNum;
+
+    /**
+     * 单日可推送剩余量
+     */
+    @SerializedName("remain_num")
+    private Integer remainNum;
+
+    /**
+     * 单日可推送请求量
+     * 仅vv返回该字段
+     */
+    @SerializedName("push_num")
+    private Integer pushNum;
+
+    /**
+     * 是否被限量
+     * 当日可推送总量使用完时，该字段更新true
+     */
+    @SerializedName("limit")
+    private Boolean limit;
+
+
+    public Integer getTotalNum() {
+        return totalNum;
+    }
+
+    public void setTotalNum(Integer totalNum) {
+        this.totalNum = totalNum;
+    }
+
+    public Integer getRemainNum() {
+        return remainNum;
+    }
+
+    public void setRemainNum(Integer remainNum) {
+        this.remainNum = remainNum;
+    }
+
+    public Integer getPushNum() {
+        return pushNum;
+    }
+
+    public void setPushNum(Integer pushNum) {
+        this.pushNum = pushNum;
+    }
+
+    public Boolean getLimit() {
+        return limit;
+    }
+
+    public void setLimit(Boolean limit) {
+        this.limit = limit;
+    }
+
+    @Override
+    public String toString() {
+        return "PushCountDTO{" +
+                "totalNum=" + totalNum +
+                ", remainNum=" + remainNum +
+                ", pushNum=" + pushNum +
+                ", limit=" + limit +
+                '}';
+    }
+}