🎨 #3006 【公众号】模板消息发送接口增加字段client_msg_id

Author: zhongjichuan

weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/template/WxMpTemplateMessage.java

@@ -52,6 +52,11 @@ public class WxMpTemplateMessage implements Serializable {
    */
   private MiniProgram miniProgram;
 
+  /**
+   * 防重入id.
+   */
+  private String clientMsgId;
+
   /**
    * 模板数据.
    */

weixin-java-mp/src/main/java/me/chanjar/weixin/mp/util/json/WxMpTemplateMessageGsonAdapter.java

@@ -1,15 +1,18 @@
 package me.chanjar.weixin.mp.util.json;
 
-import java.lang.reflect.Type;
-
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
 import com.google.gson.JsonSerializationContext;
 import com.google.gson.JsonSerializer;
 import me.chanjar.weixin.mp.bean.template.WxMpTemplateData;
 import me.chanjar.weixin.mp.bean.template.WxMpTemplateMessage;
+import org.apache.commons.lang3.StringUtils;
+
+import java.lang.reflect.Type;
+
 
 /**
+ * 模板消息转Json类型转换器
  * @author chanjarster
  */
 public class WxMpTemplateMessageGsonAdapter implements JsonSerializer<WxMpTemplateMessage> {
@@ -19,6 +22,9 @@ public JsonElement serialize(WxMpTemplateMessage message, Type typeOfSrc, JsonSe
     JsonObject messageJson = new JsonObject();
     messageJson.addProperty("touser", message.getToUser());
     messageJson.addProperty("template_id", message.getTemplateId());
+    if (StringUtils.isNotBlank(message.getClientMsgId())) {
+      messageJson.addProperty("client_msg_id", message.getClientMsgId());
+    }
     if (message.getUrl() != null) {
       messageJson.addProperty("url", message.getUrl());
     }

weixin-java-mp/src/test/java/me/chanjar/weixin/mp/bean/template/WxMpTemplateMessageTest.java

@@ -19,14 +19,14 @@ public void testToJson() {
       .templateId("ngqIpbwh8bUfcSsECmogfXcV14J0tQlEpBO27izEYtY")
       .miniProgram(new WxMpTemplateMessage.MiniProgram("xiaochengxuappid12345", "index?foo=bar",true))
       .url("http://weixin.qq.com/download")
+      .clientMsgId("MSG_000001")
       .build();
 
     tm.addData(
       new WxMpTemplateData("first", "haahah", "#FF00FF"));
     tm.addData(
       new WxMpTemplateData("remark", "heihei", "#FF00FF"));
-
-    assertEquals(tm.toJson(), "{\"touser\":\"OPENID\",\"template_id\":\"ngqIpbwh8bUfcSsECmogfXcV14J0tQlEpBO27izEYtY\",\"url\":\"http://weixin.qq.com/download\",\"miniprogram\":{\"appid\":\"xiaochengxuappid12345\",\"pagepath\":\"index?foo=bar\"},\"data\":{\"first\":{\"value\":\"haahah\",\"color\":\"#FF00FF\"},\"remark\":{\"value\":\"heihei\",\"color\":\"#FF00FF\"}}}");
+    assertEquals(tm.toJson(), "{\"touser\":\"OPENID\",\"template_id\":\"ngqIpbwh8bUfcSsECmogfXcV14J0tQlEpBO27izEYtY\",\"client_msg_id\":\"MSG_000001\",\"url\":\"http://weixin.qq.com/download\",\"miniprogram\":{\"appid\":\"xiaochengxuappid12345\",\"path\":\"index?foo=bar\"},\"data\":{\"first\":{\"value\":\"haahah\",\"color\":\"#FF00FF\"},\"remark\":{\"value\":\"heihei\",\"color\":\"#FF00FF\"}}}");
   }
 
 }