通知栏图片、展开大图推送支持

Author: lizhijian

README.md

@@ -6,7 +6,12 @@
 
 ## 更新日志
 
+### [2021-11-11]V1.2.9.2021111_release
+
+* 增加通知栏图片，展开大图推送支持
+
 ### [2019-01-14]V1.2.8.20190114_release
+
 *  update log config
 
 ### [2018-11-06]V1.2.7.20181228_release
@@ -81,6 +86,7 @@
     * [回执类型（CallBackType）](#CallBackType_index)
     * [回执参数（ExtraParam）](#ExtraParam_index) 
 * [二.接口说明](#api_def_index) 
+    * [图片上传](#uploadImage_index)
     * [非任务推送](#UnTaskPush_index)      
          * [pushId通知栏消息推送(pushMessage)](#VarnishedMessage_push_index)   
          * [pushId透传消息推送(pushMessage)](#UnVarnishedMessage_push_index)
@@ -145,9 +151,11 @@ appId|Long|是|null|注册应用appId
 restrictedPackageNames|String[]|否|null|多包名配置【最长50】
 title|String|是|null|推送标题, 【字数限制1~32】
 content|String|是|null|推送内容, 【字数限制1~100】
-noticeBarType|int|否|0|通知栏样式(0, "标准"),(2, "安卓原生")【非必填，默认值为0】
-noticeExpandType|int|否|0|展开方式 (0, "标准"),(1, "文本")【非必填，默认值为0】
+noticeBarType|int|否|0|通知栏样式(0, "标准"),(1, "图片"),(2, "安卓原生")【非必填，默认值为0】
+noticeBarImgUrl|String|否|null|通知栏图片, 【noticeBarType为图片时，必填】
+noticeExpandType|int|否|0|展开方式 (0, "标准"),(1, "文本"),(2, "大图")【非必填，默认值为0】
 noticeExpandContent|String|否|null|展开内容, 【noticeExpandType为文本时，必填】
+noticeExpandImgUrl|String|否|null|展开大图url, 【noticeExpandType为大图时，必填】
 clickType|int|否|0|点击动作 (0,"打开应用"),(1,"打开应用页面"),(2,"打开URI页面"),(3, "应用客户端自定义")【非必填，默认值为0】
 url|String|否|null|URI页面地址, 【clickType为打开URI页面时，必填】
 parameters|JSONObject|否|null|透传参数 【JSON格式，非必填】
@@ -301,7 +309,59 @@ CALLBACK_TYPE|Enum|回执类型（(1-送达回执, 2-点击回执, 3-送达与
 
 
 # 接口说明 <a name="api_def_index"/>
+## 图片上传<a name="uploadImage_index"/>
+
+### 描述
+
+> 通知栏图片、展开大图使用的图片链接需要由此接口上传生成
+
+``` 
+注：上传的图片最多保留三天，请在需要时才上传
+```
+
+### uploadImage上传接口
+
+* 接口说明
+
+| 接口                                                         | 说明     |
+| ------------------------------------------------------------ | -------- |
+| public ResultPack<ImageInfo> uploadImage(long appId, int imgType, String imgUrl) | 上传图片 |
+
+* 参数说明
+
+| 参数名称 | 类型   | 必需 | 默认 | 描述         |
+| -------- | ------ | ---- | ---- | ------------ |
+| appId    | long   | 是   | null | 应用id       |
+| imgType  | int    | 是   | null | 图片使用类型 |
+| imgUrl   | String | 是   | null | 图片来源url  |
+
+* 返回值
+
+```
+ImageInfo
+imgType：图片类型
+imgUrl：推送时使用的url
+```
+
+* 示例
+
+```java
+/**
+ * 图片上传
+ */
+@Test
+public void testPicUpload()throws Exception{
+    String imgUrl = "";
+    IFlymePush push = new IFlymePush(APP_SECRET_KEY);
+    ResultPack<ImageInfo> ret = push.uploadImage(appId,ImageInfo.NOTICE_BAR_IMG,imgUrl);
+    System.out.println(ret.toString());
+}
+```
+
+
+
 ## 非任务推送 <a name="UnTaskPush_index"/>
+
 ### 描述
 > 向指定的pushId推送消息
 ```

pom.xml

@@ -5,7 +5,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.meizu.flyme</groupId>
     <artifactId>push-server-sdk</artifactId>
-    <version>1.2.8.20190114_release</version>
+    <version>1.2.9.20211111_release</version>
 
     <packaging>jar</packaging>
     <name>MeizuPushSDK</name>
@@ -19,6 +19,11 @@
     </properties>
 
     <developers>
+        <developer>
+            <id>meizupush</id>
+            <name>meizupush</name>
+            <email>meizupush@meizu.com</email>
+        </developer>
         <developer>
             <id>jasperxgwang</id>
             <name>jasperxgwang</name>
@@ -103,7 +108,7 @@
                     <plugin>
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-source-plugin</artifactId>
-                        <version>2.2.1</version>
+                        <version>3.2.1</version>
                         <executions>
                             <execution>
                                 <phase>package</phase>
@@ -124,12 +129,17 @@
                                 <goals>
                                     <goal>jar</goal>
                                 </goals>
+                                <configuration>
+                                    <additionalparam>-Xdoclint:none</additionalparam>
+                                </configuration>
                             </execution>
+
                         </executions>
                     </plugin>
                     <!-- GPG -->
                     <plugin>
                         <artifactId>maven-gpg-plugin</artifactId>
+                        <version>1.6</version>
                         <configuration>
                             <skip>false</skip>
                         </configuration>
@@ -147,11 +157,11 @@
             </build>
             <distributionManagement>
                 <snapshotRepository>
-                    <id>oss</id>
+                    <id>ossrh</id>
                     <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
                 </snapshotRepository>
                 <repository>
-                    <id>oss</id>
+                    <id>ossrh</id>
                     <url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
                 </repository>
             </distributionManagement>
@@ -164,18 +174,18 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-resources-plugin</artifactId>
-                <version>2.5</version>
+                <version>3.2.0</version>
                 <configuration>
                     <encoding>UTF-8</encoding>
                 </configuration>
             </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
-                <version>2.5.1</version>
+                <version>3.8.1</version>
                 <configuration>
-                    <source>1.6</source>
-                    <target>1.6</target>
+                    <source>1.8</source>
+                    <target>1.8</target>
                     <encoding>UTF-8</encoding>
                 </configuration>
             </plugin>

src/main/java/com/meizu/push/sdk/constant/SystemConstants.java

@@ -7,11 +7,16 @@ public class SystemConstants {
 
     public static final String CHAR_SET = "UTF-8";
 
-    public static final String SDK_VERSION = "1.2.8.20190114_release";
+    public static final String SDK_VERSION = "1.2.9.2021111_release";
 
     private static final String PUSH_HOST_NAME = "server-api-push.meizu.com";
     private static final String SUB_HOST_NAME = "api-push.meizu.com";
 
+
+    /**
+     * 推送服务：图片上传接口
+     */
+    public static final String PUSH_UPLOAD_IMAGE = "http://" + PUSH_HOST_NAME + "/garcia/api/server/push/uploadImg";
     /**
      * 推送服务:pushId推送接口（透传消息）
      */

src/main/java/com/meizu/push/sdk/server/IFlymePush.java

@@ -8,33 +8,19 @@
 import com.meizu.push.sdk.constant.SystemConstants;
 import com.meizu.push.sdk.server.constant.ResultPack;
 import com.meizu.push.sdk.server.model.HttpResult;
-import com.meizu.push.sdk.server.model.push.Message;
-import com.meizu.push.sdk.server.model.push.PushResult;
-import com.meizu.push.sdk.server.model.push.UnVarnishedMessage;
-import com.meizu.push.sdk.server.model.push.VarnishedMessage;
+import com.meizu.push.sdk.server.model.push.*;
 import com.meizu.push.sdk.server.model.statistics.DailyPushStatics;
 import com.meizu.push.sdk.server.model.statistics.TaskStatistics;
 import com.meizu.push.sdk.utils.CollectionUtils;
 import com.meizu.push.sdk.utils.DateUtils;
 import com.meizu.push.sdk.utils.HttpClient;
 import com.meizu.push.sdk.utils.StringUtils;
-import com.meizu.push.sdk.vo.AdvanceInfo;
-import com.meizu.push.sdk.vo.ClickTypeInfo;
-import com.meizu.push.sdk.vo.NoticeBarInfo;
-import com.meizu.push.sdk.vo.NoticeExpandInfo;
-import com.meizu.push.sdk.vo.NotificationType;
-import com.meizu.push.sdk.vo.PushTimeInfo;
-import com.meizu.push.sdk.vo.UnVarnishedMessageJson;
-import com.meizu.push.sdk.vo.VarnishedMessageJson;
+import com.meizu.push.sdk.vo.*;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.io.IOException;
-import java.util.ArrayList;
-import java.util.Date;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
+import java.util.*;
 
 /**
  * @author wangxinguo <wangxinguo@meizu.com>
@@ -56,6 +42,18 @@ public IFlymePush(String appSecret, boolean useSSL) {
         super(appSecret, useSSL);
     }
 
+
+    public ResultPack<ImageInfo> uploadImage(long appId, int imgType, String imgUrl) throws IOException {
+        if (appId == 0) {
+            return ResultPack.failed("appId is illegal");
+        }
+        if (imgType != ImageInfo.NOTICE_BAR_IMG && imgType != ImageInfo.NOTICE_EXPAND_IMG) {
+            return ResultPack.failed("imgType is illegal");
+        }
+
+        return uploadImage(appId, imgType, imgUrl, 0);
+    }
+
     /**
      * 通知栏推送 不重试
      *
@@ -229,8 +227,8 @@ public ResultPack<Long> getTaskId(PushType pushType, Message message) throws IOE
             }
             VarnishedMessage msgInfo = (VarnishedMessage) message;
 
-            NoticeBarInfo noticeBarInfo = new NoticeBarInfo(msgInfo.getNoticeBarType(), msgInfo.getTitle(), msgInfo.getContent());
-            NoticeExpandInfo noticeExpandInfo = new NoticeExpandInfo(msgInfo.getNoticeExpandType(), msgInfo.getNoticeExpandContent());
+            NoticeBarInfo noticeBarInfo = new NoticeBarInfo(msgInfo.getNoticeBarType(), msgInfo.getTitle(), msgInfo.getContent(), msgInfo.getNoticeBarImgUrl());
+            NoticeExpandInfo noticeExpandInfo = new NoticeExpandInfo(msgInfo.getNoticeExpandType(), msgInfo.getNoticeExpandContent(), msgInfo.getNoticeExpandImgUrl());
             ClickTypeInfo clickTypeInfo = new ClickTypeInfo(msgInfo.getClickType(), msgInfo.getUrl(), msgInfo.getParameters(), msgInfo.getActivity(), msgInfo.getCustomAttribute());
             PushTimeInfo pushTimeInfo = new PushTimeInfo(msgInfo.isOffLine(), msgInfo.getValidTime());
             NotificationType notificationType = new NotificationType(msgInfo.isVibrate(), msgInfo.isLights(), msgInfo.isSound());
@@ -383,8 +381,8 @@ public ResultPack<Long> pushToApp(PushType pushType, Message message) throws IOE
             }
             VarnishedMessage msgInfo = (VarnishedMessage) message;
 
-            NoticeBarInfo noticeBarInfo = new NoticeBarInfo(msgInfo.getNoticeBarType(), msgInfo.getTitle(), msgInfo.getContent());
-            NoticeExpandInfo noticeExpandInfo = new NoticeExpandInfo(msgInfo.getNoticeExpandType(), msgInfo.getNoticeExpandContent());
+            NoticeBarInfo noticeBarInfo = new NoticeBarInfo(msgInfo.getNoticeBarType(), msgInfo.getTitle(), msgInfo.getContent(), msgInfo.getNoticeBarImgUrl());
+            NoticeExpandInfo noticeExpandInfo = new NoticeExpandInfo(msgInfo.getNoticeExpandType(), msgInfo.getNoticeExpandContent(), msgInfo.getNoticeExpandImgUrl());
             ClickTypeInfo clickTypeInfo = new ClickTypeInfo(msgInfo.getClickType(), msgInfo.getUrl(), msgInfo.getParameters(), msgInfo.getActivity(), msgInfo.getCustomAttribute());
             String startTime = "";
             if (msgInfo.getStartTime() != null) {
@@ -478,8 +476,8 @@ public ResultPack<Long> pushToTag(PushType pushType, Message message, List<Strin
             }
             VarnishedMessage msgInfo = (VarnishedMessage) message;
 
-            NoticeBarInfo noticeBarInfo = new NoticeBarInfo(msgInfo.getNoticeBarType(), msgInfo.getTitle(), msgInfo.getContent());
-            NoticeExpandInfo noticeExpandInfo = new NoticeExpandInfo(msgInfo.getNoticeExpandType(), msgInfo.getNoticeExpandContent());
+            NoticeBarInfo noticeBarInfo = new NoticeBarInfo(msgInfo.getNoticeBarType(), msgInfo.getTitle(), msgInfo.getContent(), msgInfo.getNoticeBarImgUrl());
+            NoticeExpandInfo noticeExpandInfo = new NoticeExpandInfo(msgInfo.getNoticeExpandType(), msgInfo.getNoticeExpandContent(), msgInfo.getNoticeExpandImgUrl());
             ClickTypeInfo clickTypeInfo = new ClickTypeInfo(msgInfo.getClickType(), msgInfo.getUrl(), msgInfo.getParameters(), msgInfo.getActivity(), msgInfo.getCustomAttribute());
             String startTime = "";
             if (msgInfo.getStartTime() != null) {
@@ -610,6 +608,51 @@ public ResultPack<List<DailyPushStatics>> dailyPushStatics(long appId, Date star
         }
     }
 
+    private ResultPack<ImageInfo> uploadImage(long appId, int imgType, String imgUrl, int retries) throws IOException {
+        int attempt = 0;
+        ResultPack<ImageInfo> result;
+        int backoff = 1000;
+        boolean tryAgain;
+        do {
+            ++attempt;
+            logger.debug(String.format("attempt [%s] to uploadImage [%s]", attempt, imgUrl));
+            result = this.uploadImageNoRetry(appId, imgType, imgUrl);
+            tryAgain = result == null && attempt <= retries;
+            backoff = getBackoffTime(backoff, tryAgain);
+        } while (tryAgain);
+        if (result == null) {
+            throw new IOException(String.format("Could not send message after [%s] attempts", attempt));
+        } else {
+            return result;
+        }
+    }
+
+    private ResultPack<ImageInfo> uploadImageNoRetry(long appId, int imgType, String imgUrl) throws IOException {
+        String _url = SystemConstants.PUSH_UPLOAD_IMAGE;
+        StringBuilder body = newBody("pushIds", String.valueOf(appId));
+        addParameter(body, "appId", String.valueOf(appId));
+        addParameter(body, "imgType", String.valueOf(imgType));
+        addParameter(body, "imgUrl", imgUrl);
+
+        HttpResult httpResult = super.post(useSSL, _url, body.toString());
+        if (httpResult == null) {
+            return null;
+        }
+
+        String code = httpResult.getCode();
+        String msg = httpResult.getMessage();
+        String value = httpResult.getValue();
+        if (SUCCESS_CODE.equals(code)) {
+            try {
+                ImageInfo imageInfo = JSONObject.parseObject(value, ImageInfo.class);
+                return ResultPack.succeed(code, msg, imageInfo);
+            } catch (Exception e) {
+                return ResultPack.failed(code, String.format("ImageInfo转化异常,原始str:%s,msg:%s", value, e.getMessage()));
+            }
+        } else {
+            return ResultPack.failed(code, msg);
+        }
+    }
 
     private ResultPack<PushResult> pushMessage(UserType userType, PushType pushType, Message message, String targets, int retries) throws IOException {
         int attempt = 0;
@@ -675,8 +718,8 @@ private ResultPack<PushResult> pushMessageNoRetry(UserType userType, PushType pu
         } else if (PushType.STATUSBAR == pushType) {
             VarnishedMessage msgInfo = (VarnishedMessage) message;
 
-            NoticeBarInfo noticeBarInfo = new NoticeBarInfo(msgInfo.getNoticeBarType(), msgInfo.getTitle(), msgInfo.getContent());
-            NoticeExpandInfo noticeExpandInfo = new NoticeExpandInfo(msgInfo.getNoticeExpandType(), msgInfo.getNoticeExpandContent());
+            NoticeBarInfo noticeBarInfo = new NoticeBarInfo(msgInfo.getNoticeBarType(), msgInfo.getTitle(), msgInfo.getContent(), msgInfo.getNoticeBarImgUrl());
+            NoticeExpandInfo noticeExpandInfo = new NoticeExpandInfo(msgInfo.getNoticeExpandType(), msgInfo.getNoticeExpandContent(), msgInfo.getNoticeExpandImgUrl());
             ClickTypeInfo clickTypeInfo = new ClickTypeInfo(msgInfo.getClickType(), msgInfo.getUrl(), msgInfo.getParameters(), msgInfo.getActivity(), msgInfo.getCustomAttribute());
             PushTimeInfo pushTimeInfo = new PushTimeInfo(msgInfo.isOffLine(), msgInfo.getValidTime());
             NotificationType notificationType = new NotificationType(msgInfo.isVibrate(), msgInfo.isLights(), msgInfo.isSound());

src/main/java/com/meizu/push/sdk/server/IFlymePushSub.java

@@ -126,7 +126,6 @@ public ResultPack<AliasInfo> subscribeAlias(String pushId, String alias) throws
      * 取消别名订阅
      *
      * @param pushId
-     * @param alias
      * @return
      * @throws IOException
      */

src/main/java/com/meizu/push/sdk/server/model/push/ImageInfo.java

@@ -0,0 +1,40 @@
+package com.meizu.push.sdk.server.model.push;
+
+import java.io.Serializable;
+
+/**
+ * 上传图片结果
+ */
+public class ImageInfo implements Serializable {
+
+    public static int NOTICE_BAR_IMG = 0;// 通知栏图片 请上传100kb以内的图片 gif,jpg,bmp,png,jpeg
+    public static int NOTICE_EXPAND_IMG = 1; // 展开大图 请上传200kb以内的图片 gif,jpg,bmp,png,jpeg
+
+    private int imgType;
+    private String imgUrl;
+
+
+    public int getImgType() {
+        return imgType;
+    }
+
+    public void setImgType(int imgType) {
+        this.imgType = imgType;
+    }
+
+    public String getImgUrl() {
+        return imgUrl;
+    }
+
+    public void setImgUrl(String imgUrl) {
+        this.imgUrl = imgUrl;
+    }
+
+    @Override
+    public String toString() {
+        return "ImageInfo{" +
+                "imgType=" + imgType +
+                ", imgUrl='" + imgUrl + '\'' +
+                '}';
+    }
+}