Add payload length checking methods.

Author: Javen

src/cn/jpush/api/push/model/PushPayload.java

@@ -1,12 +1,16 @@
 package cn.jpush.api.push.model;
 
 import cn.jpush.api.push.model.audience.Audience;
+import cn.jpush.api.push.model.notification.AndroidNotification;
+import cn.jpush.api.push.model.notification.IosNotification;
 import cn.jpush.api.push.model.notification.Notification;
+import cn.jpush.api.push.model.notification.PlatformNotification;
 
 import com.google.common.base.Preconditions;
 import com.google.gson.Gson;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
+import com.google.gson.JsonPrimitive;
 
 /**
  * The object you should build for sending a push.
@@ -23,7 +27,10 @@ public class PushPayload implements PushModel {
     private static final String NOTIFICATION = "notification";
     private static final String MESSAGE = "message";
     private static final String OPTIONS = "options";
-
+    
+    private static final int MAX_GLOBAL_ENTITY_LENGTH = 1200;  // Definition acording to JPush Docs
+    private static final int MAX_IOS_PAYLOAD_LENGTH = 220;  // Definition acording to JPush Docs
+    
     private static Gson _gson = new Gson();
 
     private final Platform platform;
@@ -114,9 +121,52 @@ public JsonElement toJSON() {
         if (null != options) {
             json.add(OPTIONS, options.toJSON());
         }
+                
         return json;
     }
 
+    public boolean isGlobalExceedLength() {
+        int messageLength = 0;
+        JsonObject payload = (JsonObject) this.toJSON();
+        if (payload.has(MESSAGE)) {
+            JsonObject message = payload.getAsJsonObject(MESSAGE);
+            messageLength = message.toString().getBytes().length;
+        }
+        if (!payload.has(NOTIFICATION)) {
+            // only mesage
+            return messageLength > MAX_GLOBAL_ENTITY_LENGTH;
+        } else {
+            JsonObject notification = payload.getAsJsonObject(NOTIFICATION);
+            if (notification.has(AndroidNotification.NOTIFICATION_ANDROID)) {
+                JsonObject android = notification.getAsJsonObject(AndroidNotification.NOTIFICATION_ANDROID);
+                int androidLength = android.toString().getBytes().length;
+                return (androidLength + messageLength) > MAX_GLOBAL_ENTITY_LENGTH;
+            }
+        }
+        return false;
+    }
+    
+    public boolean isIosExceedLength() {
+        JsonObject payload = (JsonObject) this.toJSON();
+        if (payload.has(NOTIFICATION)) {
+            JsonObject notification = payload.getAsJsonObject(NOTIFICATION);
+            if (notification.has(IosNotification.NOTIFICATION_IOS)) {
+                JsonObject ios = notification.getAsJsonObject(IosNotification.NOTIFICATION_IOS);
+                return ios.toString().getBytes().length > MAX_IOS_PAYLOAD_LENGTH;
+            } else {
+                if (notification.has(PlatformNotification.ALERT)) {
+                    String alert = notification.get(PlatformNotification.ALERT).getAsString();
+                    JsonObject ios = new JsonObject();
+                    ios.add("alert", new JsonPrimitive(alert));
+                    return ios.toString().getBytes().length > MAX_IOS_PAYLOAD_LENGTH;
+                } else {
+                    // No iOS Payload
+                }
+            }
+        }
+        return false;
+    }
+    
     @Override
     public String toString() {
         return _gson.toJson(toJSON());

src/cn/jpush/api/push/model/notification/AndroidNotification.java

@@ -9,7 +9,7 @@
 import com.google.gson.JsonPrimitive;
 
 public class AndroidNotification extends PlatformNotification {
-    private static final String NOTIFICATION_ANDROID = "android";
+    public static final String NOTIFICATION_ANDROID = "android";
 
     private static final String TITLE = "title";
     private static final String BUILDER_ID = "builder_id";

src/cn/jpush/api/push/model/notification/IosNotification.java

@@ -2,17 +2,15 @@
 
 import java.util.Map;
 
-import cn.jpush.api.push.model.notification.AndroidNotification.Builder;
-
 import com.google.common.base.Preconditions;
 import com.google.common.collect.ImmutableMap;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
 import com.google.gson.JsonPrimitive;
 
 public class IosNotification extends PlatformNotification {
-    private static final String NOTIFICATION_IOS = "ios";
-    
+    public static final String NOTIFICATION_IOS = "ios";
+        
     private static final String DEFAULT_SOUND = "";
     private static final int BADGE_UNDEFINED = -1;
     private static final int DEFAULT_BADGE = 1;

src/cn/jpush/api/push/model/notification/PlatformNotification.java

@@ -56,7 +56,7 @@ public JsonElement toJSON() {
         if (null != extras || null != numberExtras || null != booleanExtras) {
             json.add(EXTRAS, extrasObject);
         }
-
+        
         return json;
     }
 

test/cn/jpush/api/push/model/OptionsTest.java

@@ -1,6 +1,5 @@
 package cn.jpush.api.push.model;
 
-
 import org.junit.Assert;
 import org.junit.Test;
 

test/cn/jpush/api/push/model/PushPayloadTest.java

@@ -5,6 +5,7 @@
 
 import cn.jpush.api.common.ServiceHelper;
 import cn.jpush.api.push.model.audience.Audience;
+import cn.jpush.api.push.model.notification.IosNotification;
 import cn.jpush.api.push.model.notification.Notification;
 
 import com.google.gson.JsonObject;
@@ -97,7 +98,58 @@ public void testMessage() {
 
         Assert.assertEquals("", json, payload.toJSON());
     }
+    
+    @Test
+    public void testGlobalExceed() {
+        PushPayload payload = PushPayload.newBuilder()
+                .setPlatform(Platform.all())
+                .setAudience(Audience.all())
+                .setMessage(Message.content(LONG_TEXT_2))
+                .build();
+        Assert.assertTrue("Should exceed", payload.isGlobalExceedLength());
+    }
 
+    @Test
+    public void testIosExceed() {
+        PushPayload payload = PushPayload.newBuilder()
+                .setPlatform(Platform.all())
+                .setAudience(Audience.all())
+                .setNotification(Notification.alert(LONG_TEXT_1))
+                .build();
+        Assert.assertTrue("Should exceed", payload.isIosExceedLength());
+    }
+
+    @Test
+    public void testIosExceed2() {
+        PushPayload payload = PushPayload.newBuilder()
+                .setPlatform(Platform.all())
+                .setAudience(Audience.all())
+                .setNotification(Notification.newBuilder().addPlatformNotification(
+                        IosNotification.alert(LONG_TEXT_1)).build())
+                .build();
+        Assert.assertTrue("Should exceed", payload.isIosExceedLength());
+    }
+
+    
+    
+    
+    private static final String LONG_TEXT_1 = ""
+            + "极光推送，使得开发者可以即时地向其应用程序的用户推送通知或者消息，"
+            + "与用户保持互动，从而有效地提高留存率，提升用户体验。平台提供整合了Android推送、iOS推送的统一推送服务。";
+    private static final String LONG_TEXT_2 = ""
+            + "通过极光推送服务，主动、及时地向您的用户发起交互，向其推送聊天消息、日程提醒、活动预告、进度提示、动态更新等。"
+            + "精准的目标用户和有价值的推送内容可以提升用户忠诚度，提高留存率与收入。"
+            + "客户端 SDK 采用自定义的协议保持长连接，电量、流量消耗都很少。 "
+            + "服务端先进技术架构，高并发可扩展性的云服务，经受过几亿用户的考验，"
+            + "完全省去应用开发者自己维护长连接的设备和人力的成本投入。"
+            + "简单的SDK集成方式，使开发商可以快速部署，更专注主营业务。灵活的推送入接入，"
+            + "同时支持网站上直接推送，也提供 消息推送和送达统计的 API调用。 "
+            + "清晰的统计图表，直观的跟踪推送带来的效果。"
+            + "下载并集成 SDK 接入极光推送服务。极光推送提供了 Android，iOS，Windows Phone以及 PhoneGap 的客户端 SDK。"
+            + "同时也开放多种语言实现的服务端 SDK，方便开发者调用 API 进行推送。"
+            + "本 Wiki 是极光推送 (JPush) 产品的开发者文档网站。"
+            + "极光推送所有技术文档都在本 Wiki 里，没有别的提供渠道。同时，我们也在不断地补充、完善文档。"
+            + "这些文档包括这样几种类型：常见问题、入门指南、API定义、教程等。";
 }