Refactored msg json structure - from and to

Author: Javen

src/main/java/cn/jpush/api/im/model/BaseMessage.java

@@ -0,0 +1,31 @@
+package cn.jpush.api.im.model;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+
+public abstract class BaseMessage {
+    protected static final Logger LOG = LoggerFactory.getLogger(BaseMessage.class);
+	
+    protected static Gson _gson = new GsonBuilder().excludeFieldsWithoutExposeAnnotation().create();
+	
+	protected MsgType msgType;
+	
+	protected BaseMessage(MsgType msgType) {
+		this.msgType = msgType;
+	}
+
+	public String toJson() {
+		return _gson.toJson(this);
+	}
+	
+	
+	public static enum MsgType {
+		text, 
+		voice,
+		image
+	}
+	
+}

src/main/java/cn/jpush/api/im/model/ImMessage.java

@@ -3,36 +3,73 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import cn.jpush.api.im.model.BaseMessage.MsgType;
+
 import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
 import com.google.gson.JsonElement;
-import com.google.gson.JsonObject;
-import com.google.gson.JsonParser;
 import com.google.gson.JsonSyntaxException;
+import com.google.gson.annotations.Expose;
+import com.google.gson.annotations.SerializedName;
 
-public abstract class ImMessage {
+/**
+ * Message container
+ *
+ */
+public class ImMessage {
     protected static final Logger LOG = LoggerFactory.getLogger(ImMessage.class);
 
-	private static final String KEY_MSG_TYPE = "msg_type";
 	private static final int CURRENT_VERSION = 1;
 
-	protected static Gson _gson = new Gson();
-	protected static JsonParser _jsonParser = new JsonParser();
+	private static Gson _gson = new GsonBuilder().excludeFieldsWithoutExposeAnnotation().create();
 
-	protected int version;
-	protected String targetType;
-	protected String targetId;
-	protected String targetName;
-	protected String fromType;
-	protected String fromId;
-	protected String fromName;
-	protected int createTime;
-	protected String extras;
-	protected MsgType msgType;
+	@Expose
+	private int version;
+	
+	@Expose
+	@SerializedName("target_type")
+	private String targetType;
+	
+	@Expose
+	@SerializedName("target_id")
+	private String targetId;
+	
+	@Expose
+	@SerializedName("target_name")
+	private String targetName;
+	
+	@Expose 
+	@SerializedName("from_type")
+	private String fromType;
+	
+	@Expose
+	@SerializedName("from_id")
+	private String fromId;
+	
+	@Expose
+	@SerializedName("from_name")
+	private String fromName;
+	
+	@Expose
+	@SerializedName("create_time")
+	private int createTime;
+	
+	@Expose 
+	private String extras;
 
+	@Expose
+	@SerializedName("msg_type")
+	private MsgType msgType;
+	
+	@Expose
+	@SerializedName("msg_body")
+	private JsonElement msgBody;
+	
+	private BaseMessage baseMessage;
 
 	protected ImMessage(String targetType, String targetId, String targetName,
 			String fromType, String fromId, String fromName,
-			MsgType msgType, String extras) {
+			String extras, BaseMessage message) {
 
 		this.version = CURRENT_VERSION;
 		this.createTime = (int) (System.currentTimeMillis() / 1000);
@@ -45,100 +82,105 @@ protected ImMessage(String targetType, String targetId, String targetName,
 		this.fromId = fromId;
 		this.fromName = fromName;
 
-		this.msgType = msgType;
 		this.extras = extras;
+		
+		this.msgType = message.msgType;
+		this.baseMessage = message;
+	}
+	
+	public static Builder newBuilder() {
+		return new Builder();
 	}
 
 	public String toJson() {
+		this.msgBody = _gson.toJsonTree(baseMessage);
 		return _gson.toJson(this);
 	}
 
 
 	public static ImMessage fromJson(String json) throws Exception {
-		MsgType type = null;
-		JsonElement root = null;
+		ImMessage imMessage = null;
 		try {
-			root = _jsonParser.parse(json);
-			if (!root.isJsonObject()) {
-				throw new Exception("The msg json root should be a JsonObject.");
-			}
-			JsonObject rootOjbect = root.getAsJsonObject();
-			Object typeObject = rootOjbect.get(KEY_MSG_TYPE);
-			if (null == typeObject) {
-				throw new Exception("Invalid IM msg json - msg_type is required.");
-			}
-			
-			String typeString = rootOjbect.get(KEY_MSG_TYPE).getAsString();
-			type = MsgType.valueOf(typeString);
-			if (null == type) {
-				throw new Exception("Invalid IM message - unknown msg_type - " + typeString);
-			}
-			
+			imMessage = _gson.fromJson(json, ImMessage.class);
 		} catch (JsonSyntaxException e) {
-			throw new Exception("Invalid json");
+			throw new Exception("Not a valid json.");
 		}
 
+		MsgType type = imMessage.msgType;
+		JsonElement msgBody = imMessage.msgBody;
+		
+		if (null == type || null == msgBody) {
+			throw new Exception("msgType and msgBody should not be null.");
+		}
+		
+		// maybe add more param check
+		
+		BaseMessage baseMessage = null;
+		
 		switch (type) {
 			case text:
-				return _gson.fromJson(root, TextMessage.class);
+				baseMessage = _gson.fromJson(msgBody, TextMessage.class);
+				break;
+				
 			case voice:
-				return _gson.fromJson(root, VoiceMessage.class);
+				baseMessage = _gson.fromJson(msgBody, VoiceMessage.class);
+				break;
+				
 			case image:
-				return _gson.fromJson(root, ImageMessage.class);
+				baseMessage = _gson.fromJson(msgBody, ImageMessage.class);
+				break;
+				
 			default:
 				new Exception("Unknown IM message type.");
-				return null;
 		}
+		
+		imMessage.baseMessage = baseMessage;
+		return imMessage;
 	}
 
 
-	protected abstract static class Builder<T extends ImMessage, B extends Builder<T, B>> {
-		private B theBuilder;
+	public static class Builder {
 
-		protected String targetType;
-		protected String targetId;
-		protected String targetName;
-		protected String fromType;
-		protected String fromId;
-		protected String fromName;
-		protected String extras;
-		protected MsgType msgType;
+		private String targetType;
+		private String targetId;
+		private String targetName;
+		private String fromType;
+		private String fromId;
+		private String fromName;
+		private String extras;
 
-		public Builder() {
-			this.theBuilder = getThis();
-		}
-		
-		public B setTarget(String type, String id, String name) {
+		private MsgType msgType;
+		private BaseMessage baseMessage;
+
+		public Builder setTarget(String type, String id, String name) {
 			this.targetType = type;
 			this.targetId = id;
 			this.targetName = name;
-			return theBuilder;
+			return this;
 		}
 
-		public B setFrom(String type, String id, String name) {
+		public Builder setFrom(String type, String id, String name) {
 			this.fromType = type;
-			this.fromName = name;
 			this.fromId = id;
-			return theBuilder;
+			this.fromName = name;
+			return this;
 		}
 
-		public B setExtras(String extras) {
+		public Builder setExtras(String extras) {
 			this.extras = extras;
-			return theBuilder;
-		}		
+			return this;
+		}
 
-		public abstract T build();
-		protected abstract B getThis();
-	}
-	
-	
-	
-
-	
-	public enum MsgType {
-		text, 
-		voice,
-		image
+		public Builder setMessage(BaseMessage message) {
+			this.baseMessage = message;
+			return this;
+		}
+		
+		public ImMessage build() {
+			return new ImMessage(targetType, targetId, targetName, 
+					fromType, fromId, fromName, 
+					extras, baseMessage);
+		}
 	}
 
 }

src/main/java/cn/jpush/api/im/model/ImageMessage.java

@@ -1,20 +1,16 @@
 package cn.jpush.api.im.model;
 
+import com.google.gson.annotations.Expose;
+
 public class ImageMessage extends MediaMessage {
-	protected int width;
-	protected int height;
-	protected String imgLink;
-	
+	@Expose private int width;
+	@Expose private int height;
+	@Expose private String imgLink;
 
-	private ImageMessage(String targetType, String targetId, String targetName,
-			String fromType, String fromId, String fromName,
-			String mediaId, long mediaCrc32, String format,
-			String extras, int width, int height, String imgLink) {
+	private ImageMessage(String mediaId, long mediaCrc32, String format,
+			int width, int height, String imgLink) {
 
-		super(targetType, targetId, targetName, 
-				fromType, fromId, fromName, 
-				MsgType.image, extras, 
-				mediaId, mediaCrc32, format);
+		super(MsgType.image, mediaId, mediaCrc32, format);
 
 		this.width = width;
 		this.height = height;
@@ -30,6 +26,7 @@ public static class Builder extends MediaMessage.Builder<ImageMessage, ImageMess
 		private int height;
 		private String imgLink;
 
+		@Override
 		protected Builder getThis() {
 			return this;
 		}
@@ -48,11 +45,8 @@ public Builder setImgLink(String imgLink) {
 
 		@Override
 		public ImageMessage build() {
-			
-			return new ImageMessage(targetType, targetId, targetName, 
-					fromType, fromId, fromName, 
-					mediaId, mediaCrc32, format, 
-					extras, width, height, imgLink);
+			return new ImageMessage(mediaId, mediaCrc32, format, 
+					width, height, imgLink);
 		}
 
 	}

src/main/java/cn/jpush/api/im/model/MediaMessage.java

@@ -1,34 +1,34 @@
 package cn.jpush.api.im.model;
 
+import com.google.gson.annotations.Expose;
 
-public abstract class MediaMessage extends ImMessage {
-	protected String mediaId;
-	protected long mediaCrc32;
-	protected String format;
+
+public abstract class MediaMessage extends BaseMessage {
+	@Expose protected String mediaId;
+	@Expose protected long mediaCrc32;
+	@Expose protected String format;
 
-	protected MediaMessage(String targetType, String targetId, String targetName,
-			String fromType, String fromId, String fromName,
-			MsgType msgType, String extras, 
+	protected MediaMessage(MsgType msgType, 
 			String mediaId, long mediaCrc32, String format) {
-		
-		super(targetType, targetId, targetName, 
-				fromType, fromId, fromName, 
-				msgType, extras);
+		super(msgType);
 
 		this.mediaId = mediaId;
 		this.mediaCrc32 = mediaCrc32;
 		this.format = format;
 	}
 
 
-	protected static abstract class Builder<T extends MediaMessage, B extends MediaMessage.Builder<T, B>>
-			extends ImMessage.Builder<T, B> {
+	protected static abstract class Builder<T extends MediaMessage, B extends MediaMessage.Builder<T, B>> {
 		private B theBuilder;
 
 		protected String mediaId;
 		protected long mediaCrc32;
 		protected String format;
 
+		protected abstract B getThis();
+		
+		protected abstract T build();
+		
 		public Builder() {
 			this.theBuilder = getThis();
 		}