添加获得模板列表的接口方法，并重构模板消息相关类包结构 for issue #63

binarywang · binarywang · commit 6dc0481d1d0b · 2016-10-18T00:07:14.000+08:00
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpTemplateMsgService.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/WxMpTemplateMsgService.java
@@ -1,8 +1,11 @@
 package me.chanjar.weixin.mp.api;
 
+import java.util.List;
+
 import me.chanjar.weixin.common.exception.WxErrorException;
-import me.chanjar.weixin.mp.bean.WxMpIndustry;
-import me.chanjar.weixin.mp.bean.WxMpTemplateMessage;
+import me.chanjar.weixin.mp.bean.template.WxMpTemplate;
+import me.chanjar.weixin.mp.bean.template.WxMpTemplateIndustry;
+import me.chanjar.weixin.mp.bean.template.WxMpTemplateMessage;
 
 /**
  * <pre>
@@ -24,7 +27,7 @@ public interface WxMpTemplateMsgService {
    *
    * @return 是否成功
    */
-  boolean setIndustry(WxMpIndustry wxMpIndustry) throws WxErrorException;
+  boolean setIndustry(WxMpTemplateIndustry wxMpIndustry) throws WxErrorException;
 
   /***
    * <pre>
@@ -34,7 +37,7 @@ public interface WxMpTemplateMsgService {
    *
    * @return wxMpIndustry
    */
-  WxMpIndustry getIndustry() throws WxErrorException;
+  WxMpTemplateIndustry getIndustry() throws WxErrorException;
 
   /**
    * <pre>
@@ -53,8 +56,20 @@ public interface WxMpTemplateMsgService {
    * 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1433751277&token=&lang=zh_CN
    * 接口地址格式：https://api.weixin.qq.com/cgi-bin/template/api_add_template?access_token=ACCESS_TOKEN
    * </pre>
-   *@param shortTemplateId 模板库中模板的编号，有“TM**”和“OPENTMTM**”等形式
+   * @param shortTemplateId 模板库中模板的编号，有“TM**”和“OPENTMTM**”等形式
    * @return templateId 模板Id
    */
   String addTemplate(String shortTemplateId) throws WxErrorException;
+
+  /**
+   * <pre>
+   * 获取模板列表
+   * 获取已添加至帐号下所有模板列表，可在MP中查看模板列表信息，为方便第三方开发者，提供通过接口调用的方式来获取帐号下所有模板信息
+   * 详情请见: http://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1433751277&token=&lang=zh_CN
+   * 接口地址格式：https://api.weixin.qq.com/cgi-bin/template/get_all_private_template?access_token=ACCESS_TOKEN
+   * </pre>
+   * 
+   * @return templateId 模板Id
+   */
+  List<WxMpTemplate> getAllPrivateTemplate() throws WxErrorException;
 }
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/WxMpTemplateMsgServiceImpl.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/api/impl/WxMpTemplateMsgServiceImpl.java
@@ -1,14 +1,17 @@
 package me.chanjar.weixin.mp.api.impl;
 
+import java.util.List;
+
 import com.google.gson.JsonObject;
 import com.google.gson.JsonParser;
 
 import me.chanjar.weixin.common.bean.result.WxError;
 import me.chanjar.weixin.common.exception.WxErrorException;
 import me.chanjar.weixin.mp.api.WxMpService;
 import me.chanjar.weixin.mp.api.WxMpTemplateMsgService;
-import me.chanjar.weixin.mp.bean.WxMpIndustry;
-import me.chanjar.weixin.mp.bean.WxMpTemplateMessage;
+import me.chanjar.weixin.mp.bean.template.WxMpTemplate;
+import me.chanjar.weixin.mp.bean.template.WxMpTemplateIndustry;
+import me.chanjar.weixin.mp.bean.template.WxMpTemplateMessage;
 
 /**
  * <pre>
@@ -38,7 +41,7 @@ public String sendTemplateMsg(WxMpTemplateMessage templateMessage) throws WxErro
   }
 
   @Override
-  public boolean setIndustry(WxMpIndustry wxMpIndustry) throws WxErrorException {
+  public boolean setIndustry(WxMpTemplateIndustry wxMpIndustry) throws WxErrorException {
     if (null == wxMpIndustry.getPrimaryIndustry() || null == wxMpIndustry.getPrimaryIndustry().getId()
       || null == wxMpIndustry.getSecondIndustry() || null == wxMpIndustry.getSecondIndustry().getId()) {
       throw new IllegalArgumentException("行业Id不能为空，请核实");
@@ -50,10 +53,10 @@ public boolean setIndustry(WxMpIndustry wxMpIndustry) throws WxErrorException {
   }
 
   @Override
-  public WxMpIndustry getIndustry() throws WxErrorException {
+  public WxMpTemplateIndustry getIndustry() throws WxErrorException {
     String url = API_URL_PREFIX + "/get_industry";
     String responseContent = this.wxMpService.get(url, null);
-    return WxMpIndustry.fromJson(responseContent);
+    return WxMpTemplateIndustry.fromJson(responseContent);
   }
 
   @Override
@@ -70,4 +73,10 @@ public String addTemplate(String shortTemplateId) throws WxErrorException {
     throw new WxErrorException(WxError.fromJson(responseContent));
   }
 
+  @Override
+  public List<WxMpTemplate> getAllPrivateTemplate() throws WxErrorException {
+    String url = API_URL_PREFIX + "/get_all_private_template";
+    return WxMpTemplate.fromJson(this.wxMpService.get(url, null));
+  }
+
 }
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/template/WxMpTemplate.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/template/WxMpTemplate.java
@@ -0,0 +1,126 @@
+package me.chanjar.weixin.mp.bean.template;
+
+import java.util.List;
+
+import org.apache.commons.lang3.builder.ToStringBuilder;
+import org.apache.commons.lang3.builder.ToStringStyle;
+
+import com.google.gson.JsonParser;
+import com.google.gson.annotations.SerializedName;
+import com.google.gson.reflect.TypeToken;
+
+import me.chanjar.weixin.mp.util.json.WxMpGsonBuilder;
+
+/**
+ * <pre>
+ * 模板列表信息
+ * Created by Binary Wang on 2016-10-17.
+ * @author <a href="https://github.com/binarywang">binarywang(Binary Wang)</a>
+ * </pre>
+ */
+public class WxMpTemplate {
+
+  private static final JsonParser JSON_PARSER = new JsonParser();
+
+  public static List<WxMpTemplate> fromJson(String json) {
+    return WxMpGsonBuilder.create().fromJson(JSON_PARSER.parse(json).getAsJsonObject().get("template_list"),
+        new TypeToken<List<WxMpTemplate>>() {
+        }.getType());
+  }
+
+  @Override
+  public String toString() {
+    return ToStringBuilder.reflectionToString(this, ToStringStyle.MULTI_LINE_STYLE);
+  }
+  
+  /**
+   * template_id
+   * 模板ID
+   */
+  @SerializedName("template_id")
+  private String templateId;
+
+  /**
+   * title
+   * 模板标题
+   */
+  @SerializedName("title")
+  private String title;
+
+  /**
+   * primary_industry
+   * 模板所属行业的一级行业
+   */
+  @SerializedName("primary_industry")
+  private String primaryIndustry;
+
+  /**
+   * deputy_industry
+   * 模板所属行业的二级行业
+   */
+  @SerializedName("deputy_industry")
+  private String deputyIndustry;
+
+  /**
+   * content
+   * 模板内容
+   */
+  @SerializedName("content")
+  private String content;
+
+  /**
+   * example
+   * 模板示例
+   */
+  @SerializedName("example")
+  private String example;
+
+  public String getTemplateId() {
+    return templateId;
+  }
+
+  public void setTemplateId(String templateId) {
+    this.templateId = templateId;
+  }
+
+  public String getTitle() {
+    return title;
+  }
+
+  public void setTitle(String title) {
+    this.title = title;
+  }
+
+  public String getPrimaryIndustry() {
+    return primaryIndustry;
+  }
+
+  public void setPrimaryIndustry(String primaryIndustry) {
+    this.primaryIndustry = primaryIndustry;
+  }
+
+  public String getDeputyIndustry() {
+    return deputyIndustry;
+  }
+
+  public void setDeputyIndustry(String deputyIndustry) {
+    this.deputyIndustry = deputyIndustry;
+  }
+
+  public String getContent() {
+    return content;
+  }
+
+  public void setContent(String content) {
+    this.content = content;
+  }
+
+  public String getExample() {
+    return example;
+  }
+
+  public void setExample(String example) {
+    this.example = example;
+  }
+
+}
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/template/WxMpTemplateData.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/template/WxMpTemplateData.java
@@ -1,4 +1,4 @@
-package me.chanjar.weixin.mp.bean;
+package me.chanjar.weixin.mp.bean.template;
 
 import java.io.Serializable;
 
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/template/WxMpTemplateIndustry.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/template/WxMpTemplateIndustry.java
@@ -1,4 +1,4 @@
-package me.chanjar.weixin.mp.bean;
+package me.chanjar.weixin.mp.bean.template;
 
 
 import me.chanjar.weixin.mp.util.json.WxMpGsonBuilder;
@@ -10,15 +10,15 @@
 /**
  * @author miller
  */
-public class WxMpIndustry implements Serializable {
+public class WxMpTemplateIndustry implements Serializable {
   private static final long serialVersionUID = -7700398224795914722L;
   private Industry primaryIndustry;
   private Industry secondIndustry;
 
-  public WxMpIndustry() {
+  public WxMpTemplateIndustry() {
   }
 
-  public WxMpIndustry(Industry primaryIndustry, Industry secondIndustry) {
+  public WxMpTemplateIndustry(Industry primaryIndustry, Industry secondIndustry) {
     this.primaryIndustry = primaryIndustry;
     this.secondIndustry = secondIndustry;
   }
@@ -81,8 +81,8 @@ public String toString() {
     return ToStringBuilder.reflectionToString(this, ToStringStyle.MULTI_LINE_STYLE);
   }
 
-  public static WxMpIndustry fromJson(String json) {
-    return WxMpGsonBuilder.create().fromJson(json, WxMpIndustry.class);
+  public static WxMpTemplateIndustry fromJson(String json) {
+    return WxMpGsonBuilder.create().fromJson(json, WxMpTemplateIndustry.class);
   }
 
   public String toJson() {
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/template/WxMpTemplateMessage.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/template/WxMpTemplateMessage.java
@@ -1,4 +1,4 @@
-package me.chanjar.weixin.mp.bean;
+package me.chanjar.weixin.mp.bean.template;
 
 import java.io.Serializable;
 import java.util.ArrayList;
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/util/json/WxMpGsonBuilder.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/util/json/WxMpGsonBuilder.java
@@ -5,15 +5,13 @@
 
 import me.chanjar.weixin.mp.bean.WxMpCard;
 import me.chanjar.weixin.mp.bean.WxMpCustomMessage;
-import me.chanjar.weixin.mp.bean.WxMpIndustry;
 import me.chanjar.weixin.mp.bean.WxMpMassNews;
 import me.chanjar.weixin.mp.bean.WxMpMassOpenIdsMessage;
 import me.chanjar.weixin.mp.bean.WxMpMassPreviewMessage;
 import me.chanjar.weixin.mp.bean.WxMpMassTagMessage;
 import me.chanjar.weixin.mp.bean.WxMpMassVideo;
 import me.chanjar.weixin.mp.bean.WxMpMaterialArticleUpdate;
 import me.chanjar.weixin.mp.bean.WxMpMaterialNews;
-import me.chanjar.weixin.mp.bean.WxMpTemplateMessage;
 import me.chanjar.weixin.mp.bean.datacube.WxDataCubeUserCumulate;
 import me.chanjar.weixin.mp.bean.datacube.WxDataCubeUserSummary;
 import me.chanjar.weixin.mp.bean.result.WxMediaImgUploadResult;
@@ -31,6 +29,8 @@
 import me.chanjar.weixin.mp.bean.result.WxMpUser;
 import me.chanjar.weixin.mp.bean.result.WxMpUserBlacklistGetResult;
 import me.chanjar.weixin.mp.bean.result.WxMpUserList;
+import me.chanjar.weixin.mp.bean.template.WxMpTemplateIndustry;
+import me.chanjar.weixin.mp.bean.template.WxMpTemplateMessage;
 
 public class WxMpGsonBuilder {
 
@@ -68,7 +68,7 @@ public class WxMpGsonBuilder {
     INSTANCE.registerTypeAdapter(WxMpCard.class, new WxMpCardGsonAdapter());
     INSTANCE.registerTypeAdapter(WxMpMassPreviewMessage.class, new WxMpMassPreviewMessageGsonAdapter());
     INSTANCE.registerTypeAdapter(WxMediaImgUploadResult.class, new WxMediaImgUploadResultGsonAdapter());
-    INSTANCE.registerTypeAdapter(WxMpIndustry.class, new WxMpIndustryGsonAdapter());
+    INSTANCE.registerTypeAdapter(WxMpTemplateIndustry.class, new WxMpIndustryGsonAdapter());
     INSTANCE.registerTypeAdapter(WxMpUserBlacklistGetResult.class, new WxUserBlacklistGetResultGsonAdapter());
   }
 
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/util/json/WxMpIndustryGsonAdapter.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/util/json/WxMpIndustryGsonAdapter.java
@@ -2,17 +2,17 @@
 
 import com.google.gson.*;
 import me.chanjar.weixin.common.util.json.GsonHelper;
-import me.chanjar.weixin.mp.bean.WxMpIndustry;
+import me.chanjar.weixin.mp.bean.template.WxMpTemplateIndustry;
 
 import java.lang.reflect.Type;
 
 /**
  * @author miller
  */
 public class WxMpIndustryGsonAdapter
-    implements JsonSerializer<WxMpIndustry>, JsonDeserializer<WxMpIndustry> {
+    implements JsonSerializer<WxMpTemplateIndustry>, JsonDeserializer<WxMpTemplateIndustry> {
   @Override
-  public JsonElement serialize(WxMpIndustry wxMpIndustry, Type type,
+  public JsonElement serialize(WxMpTemplateIndustry wxMpIndustry, Type type,
       JsonSerializationContext jsonSerializationContext) {
     JsonObject json = new JsonObject();
     json.addProperty("industry_id1", wxMpIndustry.getPrimaryIndustry().getId());
@@ -21,10 +21,10 @@ public JsonElement serialize(WxMpIndustry wxMpIndustry, Type type,
   }
 
   @Override
-  public WxMpIndustry deserialize(JsonElement jsonElement, Type type,
+  public WxMpTemplateIndustry deserialize(JsonElement jsonElement, Type type,
       JsonDeserializationContext jsonDeserializationContext)
       throws JsonParseException {
-    WxMpIndustry wxMpIndustry = new WxMpIndustry();
+    WxMpTemplateIndustry wxMpIndustry = new WxMpTemplateIndustry();
     JsonObject primaryIndustry = jsonElement.getAsJsonObject()
         .get("primary_industry").getAsJsonObject();
     wxMpIndustry.setPrimaryIndustry(convertFromJson(primaryIndustry));
@@ -34,8 +34,8 @@ public WxMpIndustry deserialize(JsonElement jsonElement, Type type,
     return wxMpIndustry;
   }
 
-  private static WxMpIndustry.Industry convertFromJson(JsonObject json) {
-    WxMpIndustry.Industry industry = new WxMpIndustry.Industry();
+  private static WxMpTemplateIndustry.Industry convertFromJson(JsonObject json) {
+    WxMpTemplateIndustry.Industry industry = new WxMpTemplateIndustry.Industry();
     industry.setFirstClass(GsonHelper.getString(json, "first_class"));
     industry.setSecondClass(GsonHelper.getString(json, "second_class"));
     return industry;
diff --git a/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/util/json/WxMpTemplateMessageGsonAdapter.java b/weixin-java-mp/src/main/java/me/chanjar/weixin/mp/util/json/WxMpTemplateMessageGsonAdapter.java
@@ -12,8 +12,9 @@
 import com.google.gson.JsonObject;
 import com.google.gson.JsonSerializationContext;
 import com.google.gson.JsonSerializer;
-import me.chanjar.weixin.mp.bean.WxMpTemplateData;
-import me.chanjar.weixin.mp.bean.WxMpTemplateMessage;
+
+import me.chanjar.weixin.mp.bean.template.WxMpTemplateData;
+import me.chanjar.weixin.mp.bean.template.WxMpTemplateMessage;
 
 import java.lang.reflect.Type;
 
diff --git a/weixin-java-mp/src/test/java/me/chanjar/weixin/mp/api/impl/WxMpTemplateMsgServiceImplTest.java b/weixin-java-mp/src/test/java/me/chanjar/weixin/mp/api/impl/WxMpTemplateMsgServiceImplTest.java

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package me.chanjar.weixin.mp.bean;`
	`1`	`+package me.chanjar.weixin.mp.bean.template;`
`2`	`2`
`3`	`3`	`import java.io.Serializable;`
`4`	`4`