🎨 【企业微信】添加AttachmentBuilder，可以更方便的创建新客户欢迎语的附件信息

Coco-king · web-flow · commit 6e96d7cf552d · 2023-03-29T16:19:13.000+08:00
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Attachment.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Attachment.java
@@ -34,48 +34,53 @@ public class Attachment implements Serializable {
    *
    * @param image the image
    */
-  public void setImage(Image image) {
+  public Attachment setImage(Image image) {
     this.image = image;
     this.msgType = WxCpConsts.WelcomeMsgType.IMAGE;
+    return this;
   }
 
   /**
    * Sets link.
    *
    * @param link the link
    */
-  public void setLink(Link link) {
+  public Attachment setLink(Link link) {
     this.link = link;
     this.msgType = WxCpConsts.WelcomeMsgType.LINK;
+    return this;
   }
 
   /**
    * Sets mini program.
    *
    * @param miniProgram the mini program
    */
-  public void setMiniProgram(MiniProgram miniProgram) {
+  public Attachment setMiniProgram(MiniProgram miniProgram) {
     this.miniProgram = miniProgram;
     this.msgType = WxCpConsts.WelcomeMsgType.MINIPROGRAM;
+    return this;
   }
 
   /**
    * Sets video.
    *
    * @param video the video
    */
-  public void setVideo(Video video) {
+  public Attachment setVideo(Video video) {
     this.video = video;
     this.msgType = WxCpConsts.WelcomeMsgType.VIDEO;
+    return this;
   }
 
   /**
    * Sets file.
    *
    * @param file the file
    */
-  public void setFile(File file) {
+  public Attachment setFile(File file) {
     this.file = file;
     this.msgType = WxCpConsts.WelcomeMsgType.FILE;
+    return this;
   }
 }
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/AttachmentBuilder.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/AttachmentBuilder.java
@@ -0,0 +1,40 @@
+package me.chanjar.weixin.cp.bean.external.msg;
+
+import lombok.Builder;
+
+/**
+ * @author codecrab
+ */
+public class AttachmentBuilder {
+
+  @Builder(builderClassName = "ImageBuilder", builderMethodName = "imageBuilder")
+  private static Attachment image(String mediaId, String picUrl) {
+    Image image = new Image().setMediaId(mediaId).setPicUrl(picUrl);
+    return new Attachment().setImage(image);
+  }
+
+  @Builder(builderClassName = "VideoBuilder", builderMethodName = "videoBuilder")
+  private static Attachment video(String mediaId) {
+    Video video = new Video().setMediaId(mediaId);
+    return new Attachment().setVideo(video);
+  }
+
+  @Builder(builderClassName = "FileBuilder", builderMethodName = "fileBuilder")
+  private static Attachment file(String mediaId) {
+    File file = new File().setMediaId(mediaId);
+    return new Attachment().setFile(file);
+  }
+
+  @Builder(builderClassName = "LinkBuilder", builderMethodName = "linkBuilder")
+  private static Attachment link(String title, String url, String picUrl, String desc) {
+    Link link = new Link().setTitle(title).setPicUrl(picUrl).setUrl(url).setDesc(desc);
+    return new Attachment().setLink(link);
+  }
+
+  @Builder(builderClassName = "MiniProgramBuilder", builderMethodName = "miniProgramBuilder")
+  private static Attachment miniProgram(String title, String picMediaId, String appId, String page) {
+    MiniProgram miniProgram = new MiniProgram().setTitle(title).setPicMediaId(picMediaId).setAppid(appId).setPage(page);
+    return new Attachment().setMiniProgram(miniProgram);
+  }
+
+}
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/File.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/File.java
@@ -2,6 +2,7 @@
 
 import com.google.gson.annotations.SerializedName;
 import lombok.Data;
+import lombok.experimental.Accessors;
 
 import java.io.Serializable;
 
@@ -11,6 +12,7 @@
  * @author <a href="https://github.com/binarywang">Binary Wang</a> created on  2021-08-23
  */
 @Data
+@Accessors(chain = true)
 public class File implements Serializable {
   private static final long serialVersionUID = 2794189478198329090L;
 
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Image.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Image.java
@@ -2,6 +2,7 @@
 
 import com.google.gson.annotations.SerializedName;
 import lombok.Data;
+import lombok.experimental.Accessors;
 
 import java.io.Serializable;
 
@@ -11,6 +12,7 @@
  * @author <a href="https://github.com/binarywang">Binary Wang</a> created on  2020-08-16
  */
 @Data
+@Accessors(chain = true)
 public class Image implements Serializable {
   private static final long serialVersionUID = -606286372867787121L;
 
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Link.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Link.java
@@ -2,6 +2,7 @@
 
 import com.google.gson.annotations.SerializedName;
 import lombok.Data;
+import lombok.experimental.Accessors;
 
 import java.io.Serializable;
 
@@ -11,6 +12,7 @@
  * @author <a href="https://github.com/binarywang">Binary Wang</a> created on  2020-08-16
  */
 @Data
+@Accessors(chain = true)
 public class Link implements Serializable {
   private static final long serialVersionUID = -8041816740881163875L;
   private String title;
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Location.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Location.java
@@ -1,13 +1,15 @@
 package me.chanjar.weixin.cp.bean.external.msg;
 
 import lombok.Data;
+import lombok.experimental.Accessors;
 
 /**
  * &#22320;&#29702;&#20301;&#32622;
  *
  * @author leiin  created on  2021-10-29
  */
 @Data
+@Accessors(chain = true)
 public class Location {
   private String latitude;
   private String longitude;
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/MiniProgram.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/MiniProgram.java
@@ -2,6 +2,7 @@
 
 import com.google.gson.annotations.SerializedName;
 import lombok.Data;
+import lombok.experimental.Accessors;
 
 import java.io.Serializable;
 
@@ -11,6 +12,7 @@
  * @author <a href="https://github.com/binarywang">Binary Wang</a> created on  2020-08-16
  */
 @Data
+@Accessors(chain = true)
 public class MiniProgram implements Serializable {
   private static final long serialVersionUID = 4242074162638170679L;
 
diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Video.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/external/msg/Video.java
@@ -2,6 +2,7 @@
 
 import com.google.gson.annotations.SerializedName;
 import lombok.Data;
+import lombok.experimental.Accessors;
 
 import java.io.Serializable;
 
@@ -11,6 +12,7 @@
  * @author pg  created on  2021-6-21
  */
 @Data
+@Accessors(chain = true)
 public class Video implements Serializable {
   private static final long serialVersionUID = -6048642921382867138L;
   @SerializedName("media_id")
diff --git a/weixin-java-cp/src/test/java/me/chanjar/weixin/cp/api/impl/WxCpExternalContactServiceImplTest.java b/weixin-java-cp/src/test/java/me/chanjar/weixin/cp/api/impl/WxCpExternalContactServiceImplTest.java
@@ -10,14 +10,18 @@
 import me.chanjar.weixin.cp.bean.external.contact.WxCpExternalContactBatchInfo;
 import me.chanjar.weixin.cp.bean.external.contact.WxCpExternalContactInfo;
 import me.chanjar.weixin.cp.bean.external.msg.Attachment;
+import me.chanjar.weixin.cp.bean.external.msg.AttachmentBuilder;
 import me.chanjar.weixin.cp.bean.external.msg.Image;
 import me.chanjar.weixin.cp.bean.external.msg.Video;
 import org.apache.commons.lang3.time.DateFormatUtils;
 import org.testng.annotations.Guice;
 import org.testng.annotations.Test;
 import org.testng.collections.CollectionUtils;
 
-import java.util.*;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Date;
+import java.util.List;
 
 import static org.testng.Assert.assertNotNull;
 
@@ -419,6 +423,7 @@ public void testOnjobTransferGroupChat() throws WxErrorException {
     System.out.println(result);
     assertNotNull(result);
   }
+
   /**
    * Test get user behavior statistic.
    */
@@ -466,6 +471,33 @@ public void testSendWelcomeMsg() throws WxErrorException {
       .build());
   }
 
+  /**
+   * Test send welcome msg. use AttachmentBuilder
+   *
+   * @throws WxErrorException the wx error exception
+   */
+  @Test
+  public void testSendWelcomeMsg2() throws WxErrorException {
+
+    Attachment imageAttachment = AttachmentBuilder.imageBuilder().mediaId("123123").build();
+    Attachment videoAttachment = AttachmentBuilder.videoBuilder().mediaId("video_media_id").build();
+    Attachment miniProgramAttachment = AttachmentBuilder.miniProgramBuilder()
+      .title("title")
+      .picMediaId("123123123")
+      .appId("wxcxxxxxxxxxxx")
+      .page("https://")
+      .build();
+
+    List<Attachment> attachments = new ArrayList<>();
+    attachments.add(imageAttachment);
+    attachments.add(videoAttachment);
+    attachments.add(miniProgramAttachment);
+    this.wxCpService.getExternalContactService().sendWelcomeMsg(WxCpWelcomeMsg.builder()
+      .welcomeCode("abc")
+      .attachments(attachments)
+      .build());
+  }
+
   /**
    * Test update remark.
    *

Original file line number	Diff line number	Diff line change
`@@ -34,48 +34,53 @@ public class Attachment implements Serializable {`
`34`	`34`	`*`
`35`	`35`	`* @param image the image`
`36`	`36`	`*/`
`37`		`- public void setImage(Image image) {`
	`37`	`+ public Attachment setImage(Image image) {`
`38`	`38`	`this.image = image;`
`39`	`39`	`this.msgType = WxCpConsts.WelcomeMsgType.IMAGE;`
	`40`	`+ return this;`
`40`	`41`	`}`
`41`	`42`
`42`	`43`	`/**`
`43`	`44`	`* Sets link.`
`44`	`45`	`*`
`45`	`46`	`* @param link the link`
`46`	`47`	`*/`
`47`		`- public void setLink(Link link) {`
	`48`	`+ public Attachment setLink(Link link) {`
`48`	`49`	`this.link = link;`
`49`	`50`	`this.msgType = WxCpConsts.WelcomeMsgType.LINK;`
	`51`	`+ return this;`
`50`	`52`	`}`
`51`	`53`
`52`	`54`	`/**`
`53`	`55`	`* Sets mini program.`
`54`	`56`	`*`
`55`	`57`	`* @param miniProgram the mini program`
`56`	`58`	`*/`
`57`		`- public void setMiniProgram(MiniProgram miniProgram) {`
	`59`	`+ public Attachment setMiniProgram(MiniProgram miniProgram) {`
`58`	`60`	`this.miniProgram = miniProgram;`
`59`	`61`	`this.msgType = WxCpConsts.WelcomeMsgType.MINIPROGRAM;`
	`62`	`+ return this;`
`60`	`63`	`}`
`61`	`64`
`62`	`65`	`/**`
`63`	`66`	`* Sets video.`
`64`	`67`	`*`
`65`	`68`	`* @param video the video`
`66`	`69`	`*/`
`67`		`- public void setVideo(Video video) {`
	`70`	`+ public Attachment setVideo(Video video) {`
`68`	`71`	`this.video = video;`
`69`	`72`	`this.msgType = WxCpConsts.WelcomeMsgType.VIDEO;`
	`73`	`+ return this;`
`70`	`74`	`}`
`71`	`75`
`72`	`76`	`/**`
`73`	`77`	`* Sets file.`
`74`	`78`	`*`
`75`	`79`	`* @param file the file`
`76`	`80`	`*/`
`77`		`- public void setFile(File file) {`
	`81`	`+ public Attachment setFile(File file) {`
`78`	`82`	`this.file = file;`
`79`	`83`	`this.msgType = WxCpConsts.WelcomeMsgType.FILE;`
	`84`	`+ return this;`
`80`	`85`	`}`
`81`	`86`	`}`