Skip to content

🎨 【公众号】草稿箱能力支持图片文章类型 #3599

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
binarywang merged 1 commit into from
May 28, 2025
Merged

🎨 【公众号】草稿箱能力支持图片文章类型 #3599

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion weixin-java-common/src/main/java/me/chanjar/weixin/common/api/WxConsts.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,7 +431,7 @@ public static class EventType {
*/
public static final String WEAPP_AUDIT_FAIL = "weapp_audit_fail";


/**
* 小程序审核事件：审核延后
*/
Expand Down Expand Up @@ -622,4 +622,19 @@ public static class AppIdType {
*/
public static final String MINI_TYPE = "mini";
}

/**
* 新建文章类型
*/
@UtilityClass
public static class ArticleType {
/**
* 图文消息
*/
public static final String NEWS = "news";
/**
* 图片消息
*/
public static final String NEWS_PIC = "newspic";
}
}
24 changes: 22 additions & 2 deletions weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/draft/WxMpDraftArticles.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,13 @@
@NoArgsConstructor
@AllArgsConstructor
public class WxMpDraftArticles implements ToJson, Serializable {
/**
* 文章类型，分别有图文消息（news）、图片消息（newspic），不填默认为图文消息（news）
*
* @see me.chanjar.weixin.common.api.WxConsts.ArticleType
*/
@SerializedName("article_type")
private String articleType;
/**
* 标题
*/
Expand Down Expand Up @@ -78,18 +85,31 @@ public class WxMpDraftArticles implements ToJson, Serializable {
*/
@SerializedName("thumb_url")
private String thumbUrl;

/**
* 封面裁剪为2.35:1规格的坐标字段。以原始图片（thumb_media_id）左上角（0,0），右下角（1,1）建立平面坐标系，经过裁剪后的图片，其左上角所在的坐标即为（X1,Y1）,右下角所在的坐标则为（X2,Y2），用分隔符_拼接为X1_Y1_X2_Y2，每个坐标值的精度为不超过小数点后6位数字。示例见下图，图中(X1,Y1) 等于（0.1945,0）,(X2,Y2)等于（1,0.5236），所以请求参数值为0.1945_0_1_0.5236。
*/
@SerializedName("pic_crop_235_1")
private String picCrop2351;

/**
* 封面裁剪为1:1规格的坐标字段，裁剪原理同pic_crop_235_1，裁剪后的图片必须符合规格要求。
*/
@SerializedName("pic_crop_1_1")
private String picCrop11;
/**
* 图片消息里的图片相关信息，图片数量最多为20张，首张图片即为封面图
*/
@SerializedName("image_info")
private WxMpDraftImageInfo imageInfo;
/**
* 封面图裁剪信息
*/
@SerializedName("cover_info")
private WxMpDraftCoverInfo coverInfo;
/**
* 商品相关信息
*/
@SerializedName("product_info")
private WxMpDraftProductInfo productInfo;

public static WxMpDraftArticles fromJson(String json) {
return WxGsonBuilder.create().fromJson(json, WxMpDraftArticles.class);
Expand Down
53 changes: 53 additions & 0 deletions weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/draft/WxMpDraftCoverInfo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
package me.chanjar.weixin.mp.bean.draft;

import com.google.gson.annotations.SerializedName;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;
import me.chanjar.weixin.common.util.json.WxGsonBuilder;

import java.io.Serializable;
import java.util.List;

/**
* 草稿箱能力-图片消息里的封面裁剪信息
*
* @author 阿杆
* created on 2025/5/23
*/
@Data
@Builder
@Accessors(chain = true)
@NoArgsConstructor
@AllArgsConstructor
public class WxMpDraftCoverInfo implements Serializable {

private static final long serialVersionUID = -1676442833397632638L;

/**
* 封面裁剪信息，裁剪比例ratio支持：“1_1”，“16_9”,“2.35_1”。
* 以图片左上角（0,0），右下角（1,1）建立平面坐标系，经过裁剪后的图片，其左上角所在的坐标填入x1，y1参数，右下角所在的坐标填入x2，y2参数
*/
@SerializedName("crop_percent_list")
private List<CropPercent> cropPercentList;

public static WxMpDraftCoverInfo fromJson(String json) {
return WxGsonBuilder.create().fromJson(json, WxMpDraftCoverInfo.class);
}

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public static class CropPercent implements Serializable {
private static final long serialVersionUID = 8495528870408737871L;
private String ratio;
private String x1;
private String y1;
private String x2;
private String y2;
}

}
51 changes: 51 additions & 0 deletions weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/draft/WxMpDraftImageInfo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
package me.chanjar.weixin.mp.bean.draft;

import com.google.gson.annotations.SerializedName;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;
import me.chanjar.weixin.common.util.json.WxGsonBuilder;

import java.io.Serializable;
import java.util.List;

/**
* 草稿箱能力-图片消息里的图片相关信息
*
* @author 阿杆
* created on 2025/5/23
*/
@Data
@Builder
@Accessors(chain = true)
@NoArgsConstructor
@AllArgsConstructor
public class WxMpDraftImageInfo implements Serializable {

private static final long serialVersionUID = -1997245511033770476L;

/**
* 图片列表
*/
@SerializedName("image_list")
private List<ImageItem> imageList;

public static WxMpDraftImageInfo fromJson(String json) {
return WxGsonBuilder.create().fromJson(json, WxMpDraftImageInfo.class);
}

@Data
@NoArgsConstructor
@AllArgsConstructor
public static class ImageItem implements Serializable {
private static final long serialVersionUID = 4180558781166966752L;
/**
* 图片消息里的图片素材id（必须是永久MediaID）
*/
@SerializedName("image_media_id")
private String imageMediaId;
}

}
48 changes: 48 additions & 0 deletions weixin-java-mp/src/main/java/me/chanjar/weixin/mp/bean/draft/WxMpDraftProductInfo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
package me.chanjar.weixin.mp.bean.draft;

import com.google.gson.annotations.SerializedName;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;
import me.chanjar.weixin.common.util.json.WxGsonBuilder;

import java.io.Serializable;

/**
* 草稿箱能力-商品相关信息
*
* @author 阿杆
* created on 2025/5/23
*/
@Data
@Builder
@Accessors(chain = true)
@NoArgsConstructor
@AllArgsConstructor
public class WxMpDraftProductInfo implements Serializable {
private static final long serialVersionUID = 8637785998127610863L;

/**
* 文末插入商品相关信息
*/
@SerializedName("footer_product_info")
private FooterProductInfo footerProductInfo;

public static WxMpDraftProductInfo fromJson(String json) {
return WxGsonBuilder.create().fromJson(json, WxMpDraftProductInfo.class);
}

@Data
@NoArgsConstructor
@AllArgsConstructor
public static class FooterProductInfo {
/**
* 商品key
*/
@SerializedName("product_key")
private String productKey;
}

}
104 changes: 101 additions & 3 deletions weixin-java-mp/src/test/java/me/chanjar/weixin/mp/api/impl/WxMpDraftServiceImplTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package me.chanjar.weixin.mp.api.impl;

import com.google.inject.Inject;
import me.chanjar.weixin.common.api.WxConsts;
import me.chanjar.weixin.common.error.WxErrorException;
import me.chanjar.weixin.mp.api.WxMpService;
import me.chanjar.weixin.mp.api.test.ApiTestModule;
Expand All @@ -23,15 +24,15 @@
public class WxMpDraftServiceImplTest {

/**
* 1.先上传一个永久图片素材：me.chanjar.weixin.mp.api.impl.WxMpMaterialServiceImplTest.testUploadMaterial
* 1.先上传一个永久图片素材：{@link me.chanjar.weixin.mp.api.impl.WxMpMaterialServiceImplTest#testUploadMaterial}
* 2.后续图文需要设置一个永久素材id
*/
final String thumbMediaId = "zUUtT8ZYeXzZ4slFbtnAkh7Yd-f45DbFoF9ERzVC6s4";
final String thumbMediaId = "-V3dxNv-eyJlImuJjWrmaTPt76BS6jHrL6-cGBlFPaXxAuv0qeJYV2p6Ezirr0zS";

/**
* 新增草稿后返回的id，后续查询、修改、删除，获取等需要使用
*/
final String mediaId = "zUUtT8ZYeXzZ4slFbtnAkpgGKyqnTsjtUvMdVBRWJVk";
final String mediaId = "-V3dxNv-eyJlImuJjWrmaZLwMkTKfDEhzq5NURU02H-k1qHMJ0lh9p0UU46w3rbd";

@Inject
protected WxMpService wxService;
Expand Down Expand Up @@ -114,6 +115,7 @@ public void testListDraft() throws WxErrorException {
,"total_count":1,"item_count":1}

*/
System.out.println(draftList);
assertThat(draftList).isNotNull();
}

Expand All @@ -124,5 +126,101 @@ public void testCountDraft() throws WxErrorException {
assertThat(countDraft).isNotNull();
}

//-----以下是图片类型草稿测试

/**
* 先上传一个永久图片素材：{@link me.chanjar.weixin.mp.api.impl.WxMpMaterialServiceImplTest#testUploadMaterial}
* 这里的图片，使用的是 mm.jpeg
*/
@Test
public void testAddDraftPic() throws WxErrorException {
List<WxMpDraftArticles> draftArticleList = new ArrayList<>();
ArrayList<WxMpDraftImageInfo.ImageItem> imageItems = new ArrayList<>();
imageItems.add(new WxMpDraftImageInfo.ImageItem(thumbMediaId));

ArrayList<WxMpDraftCoverInfo.CropPercent> cropPercents = new ArrayList<>();
cropPercents.add(new WxMpDraftCoverInfo.CropPercent("1_1", "0.1", "0", "1", "0.9"));

WxMpDraftArticles draftArticle = WxMpDraftArticles.builder()
.articleType(WxConsts.ArticleType.NEWS_PIC)
.title("新建图片草稿")
.content("图片消息的具体内容")
// 打开评论、所有人可评论
.needOpenComment(1).onlyFansCanComment(0)
.imageInfo(WxMpDraftImageInfo.builder().imageList(imageItems).build())
.coverInfo(WxMpDraftCoverInfo.builder().cropPercentList(cropPercents).build())
.productInfo(WxMpDraftProductInfo.builder().footerProductInfo(new WxMpDraftProductInfo.FooterProductInfo("")).build())
.build();
draftArticleList.add(draftArticle);

WxMpAddDraft addDraft = WxMpAddDraft.builder().articles(draftArticleList).build();
String mediaId = this.wxService.getDraftService().addDraft(addDraft);
System.out.println(mediaId);
assertThat(mediaId).isNotNull();
}

@Test
public void testGetDraftPic() throws WxErrorException {
final WxMpDraftInfo draftInfo = this.wxService.getDraftService().getDraft(mediaId);
assertThat(draftInfo).isNotNull();
System.out.println(draftInfo.toJson());
// 【响应数据】：{
// "news_item": [
// {
// "article_type": "newspic",
// "title": "新建图片草稿",
// "content": "图片消息的具体内容",
// "thumb_media_id": "-V3dxNv-eyJlImuJjWrmaTPt76BS6jHrL6-cGBlFPaXxAuv0qeJYV2p6Ezirr0zS",
// "need_open_comment": 1,
// "only_fans_can_comment": 0,
// "url": "http://mp.weixin.qq.com/s?__biz=MzkyNTg4NDM1NA==&tempkey=MTMyM18rUktkOHFIQm5Kd3U5Rk1yS2NRYWtyZWUyNDNwS2MxZTZ3VXBKTkVScExpUFdGYzN2X0IzOEl1NGxEMGFpYld6NmdvbE9UUzlyYUdiVklvWTQ2YlRzSkkzQlpWMEZpcG9JRWp5LWZCVVNoWURodUlfWnE4VWZVQnlPd2VaUkg5SGREYUd3TW1wQkhlbTFuenBvRzFIbUxhMEJVbEo0Z3oyd2tnSGJBfn4%3D&chksm=423e8b9e75490288e8388c9ee91d6dad462bbce654742edd316622ab2b2fcfc593a4db58577b#rd",
// "thumb_url": "http://mmbiz.qpic.cn/sz_mmbiz_jpg/s7FE7rYN42QgPuJeXX9MfNuJBiaoalrWv8fj4AEqnK0WBM3KzqS0DsqHIW4epA3cx1PGjpco87BTssgQibvSNBIQ/0?wx_fmt=jpeg",
// "image_info": {
// "image_list": [
// {
// "image_media_id": "-V3dxNv-eyJlImuJjWrmaTPt76BS6jHrL6-cGBlFPaXxAuv0qeJYV2p6Ezirr0zS"
// }
// ]
// }
// }
// ]
// }
}

@Test
public void testUpdateDraftPic() throws WxErrorException {
ArrayList<WxMpDraftImageInfo.ImageItem> imageItems = new ArrayList<>();
imageItems.add(new WxMpDraftImageInfo.ImageItem(thumbMediaId));
ArrayList<WxMpDraftCoverInfo.CropPercent> cropPercents = new ArrayList<>();
cropPercents.add(new WxMpDraftCoverInfo.CropPercent("1_1", "0.3", "0", "1", "0.7"));

WxMpDraftArticles draftArticle = WxMpDraftArticles.builder()
.articleType(WxConsts.ArticleType.NEWS_PIC)
.title("修改图片草稿")
.content("修改后的图片消息的具体内容")
// 打开评论、所有人可评论
.needOpenComment(1).onlyFansCanComment(0)
.imageInfo(WxMpDraftImageInfo.builder().imageList(imageItems).build())
.coverInfo(WxMpDraftCoverInfo.builder().cropPercentList(cropPercents).build())
.productInfo(WxMpDraftProductInfo.builder().footerProductInfo(new WxMpDraftProductInfo.FooterProductInfo("")).build())
.build();

WxMpUpdateDraft updateDraft = WxMpUpdateDraft.builder()
.mediaId(mediaId)
.index(0)
.articles(draftArticle)
.build();
Boolean updateDraftResult = this.wxService.getDraftService().updateDraft(updateDraft);
assertThat(updateDraftResult).isTrue();
}

@Test
public void testDelDraftPic() throws WxErrorException {
Boolean delDraftResult = this.wxService.getDraftService().delDraft(mediaId);
System.out.println(delDraftResult);
// 【响应数据】：{"errcode":0,"errmsg":"ok"}
assertThat(delDraftResult).isTrue();
}

}