【新增】SYSTEM: 微信小程序订阅消息模版获取接口

yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/social/AppSocialUserController.java

@@ -5,10 +5,7 @@ import cn.iocoder.yudao.framework.common.enums.UserTypeEnum;
 import cn.iocoder.yudao.framework.common.pojo.CommonResult;
 import cn.iocoder.yudao.framework.common.util.object.BeanUtils;
 import cn.iocoder.yudao.framework.security.core.annotations.PreAuthenticated;
-import cn.iocoder.yudao.module.member.controller.app.social.vo.AppSocialUserBindReqVO;
+import cn.iocoder.yudao.module.member.controller.app.social.vo.*;
-import cn.iocoder.yudao.module.member.controller.app.social.vo.AppSocialUserRespVO;
-import cn.iocoder.yudao.module.member.controller.app.social.vo.AppSocialUserUnbindReqVO;
-import cn.iocoder.yudao.module.member.controller.app.social.vo.AppSocialWxQrcodeReqVO;
 import cn.iocoder.yudao.module.system.api.social.SocialClientApi;
 import cn.iocoder.yudao.module.system.api.social.SocialUserApi;
 import cn.iocoder.yudao.module.system.api.social.dto.SocialUserBindReqDTO;
@@ -23,6 +20,8 @@ import jakarta.validation.Valid;
 import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.*;
 
+import java.util.List;
+
 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
 import static cn.iocoder.yudao.framework.security.core.util.SecurityFrameworkUtils.getLoginUserId;
 
@@ -72,4 +71,10 @@ public class AppSocialUserController {
         return success(Base64.encode(wxQrcode));
     }
 
+    @GetMapping("/get-subscribe-template")
+    @Operation(summary = "获得微信小程订阅模板")
+    public CommonResult<List<AppSocialWxSubscribeTemplateRespVO>> getSubscribeTemplate() {
+        return success(BeanUtils.toBean(socialClientApi.getSubscribeTemplate(), AppSocialWxSubscribeTemplateRespVO.class));
+    }
+
 }

yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/social/vo/AppSocialWxSubscribeTemplateRespVO.java

@@ -0,0 +1,25 @@
+package cn.iocoder.yudao.module.member.controller.app.social.vo;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.Data;
+
+@Schema(description = "用户 APP - 获得小程序订阅模版 Response VO")
+@Data
+public class AppSocialWxSubscribeTemplateRespVO {
+
+    @Schema(description = "添加至账号下的模板 id，发送小程序订阅消息时所需", requiredMode = Schema.RequiredMode.REQUIRED, example = "9Aw5ZV1j9xdWTFEkqCpZ7mIBbSC34khK55OtzUPl0rU")
+    private String priTmplId;
+
+    @Schema(description = "模版标题", requiredMode = Schema.RequiredMode.REQUIRED, example = "订单支付通知")
+    private String title;
+
+    @Schema(description = "模版内容", requiredMode = Schema.RequiredMode.REQUIRED)
+    private String content;
+
+    @Schema(description = "模板内容示例", requiredMode = Schema.RequiredMode.REQUIRED, example = "下单时间:2016年8月8日")
+    private String example;
+
+    @Schema(description = "模版类型，2 为一次性订阅，3 为长期订阅", requiredMode = Schema.RequiredMode.REQUIRED, example = "2")
+    private Integer type;
+
+}

yudao-module-system/yudao-module-system-api/src/main/java/cn/iocoder/yudao/module/system/api/social/SocialClientApi.java

@@ -3,9 +3,12 @@ package cn.iocoder.yudao.module.system.api.social;
 import cn.iocoder.yudao.module.system.api.social.dto.SocialWxJsapiSignatureRespDTO;
 import cn.iocoder.yudao.module.system.api.social.dto.SocialWxPhoneNumberInfoRespDTO;
 import cn.iocoder.yudao.module.system.api.social.dto.SocialWxQrcodeReqDTO;
+import cn.iocoder.yudao.module.system.api.social.dto.SocialWxSubscribeTemplateRespDTO;
 import cn.iocoder.yudao.module.system.enums.social.SocialTypeEnum;
 import jakarta.validation.Valid;
 
+import java.util.List;
+
 /**
  * 社交应用的 API 接口
  *
@@ -16,8 +19,8 @@ public interface SocialClientApi {
     /**
      * 获得社交平台的授权 URL
      *
-     * @param socialType 社交平台的类型 {@link SocialTypeEnum}
+     * @param socialType  社交平台的类型 {@link SocialTypeEnum}
-     * @param userType 用户类型
+     * @param userType    用户类型
      * @param redirectUri 重定向 URL
      * @return 社交平台的授权 URL
      */
@@ -27,7 +30,7 @@ public interface SocialClientApi {
      * 创建微信公众号 JS SDK 初始化所需的签名
      *
      * @param userType 用户类型
-     * @param url 访问的 URL 地址
+     * @param url      访问的 URL 地址
      * @return 签名
      */
     SocialWxJsapiSignatureRespDTO createWxMpJsapiSignature(Integer userType, String url);
@@ -35,7 +38,7 @@ public interface SocialClientApi {
     /**
      * 获得微信小程序的手机信息
      *
-     * @param userType 用户类型
+     * @param userType  用户类型
      * @param phoneCode 手机授权码
      * @return 手机信息
      */
@@ -49,4 +52,11 @@ public interface SocialClientApi {
      */
     byte[] getWxaQrcode(@Valid SocialWxQrcodeReqDTO reqVO);
 
+    /**
+     * 获得微信小程订阅模板
+     *
+     * @return 小程序订阅消息模版
+     */
+    List<SocialWxSubscribeTemplateRespDTO> getSubscribeTemplate();
+
 }

yudao-module-system/yudao-module-system-api/src/main/java/cn/iocoder/yudao/module/system/api/social/dto/SocialWxSubscribeTemplateRespDTO.java

@@ -0,0 +1,39 @@
+package cn.iocoder.yudao.module.system.api.social.dto;
+
+import lombok.Data;
+
+
+/**
+ * 小程序订阅消息模版 Response DTO
+ *
+ * @author HUIHUI
+ */
+@Data
+public class SocialWxSubscribeTemplateRespDTO {
+
+    /**
+     * 添加至账号下的模板 id，发送小程序订阅消息时所需
+     */
+    private String priTmplId;
+
+    /**
+     * 模版标题
+     */
+    private String title;
+
+    /**
+     * 模版内容
+     */
+    private String content;
+
+    /**
+     * 模板内容示例
+     */
+    private String example;
+
+    /**
+     * 模版类型，2 为一次性订阅，3 为长期订阅
+     */
+    private Integer type;
+
+}

yudao-module-system/yudao-module-system-api/src/main/java/cn/iocoder/yudao/module/system/enums/ErrorCodeConstants.java

@@ -121,8 +121,9 @@ public interface ErrorCodeConstants {
 
     ErrorCode SOCIAL_CLIENT_WEIXIN_MINI_APP_PHONE_CODE_ERROR = new ErrorCode(1_002_018_200, "获得手机号失败");
     ErrorCode SOCIAL_CLIENT_WEIXIN_MINI_APP_QRCODE_ERROR = new ErrorCode(1_002_018_201, "获得小程序码失败");
-    ErrorCode SOCIAL_CLIENT_NOT_EXISTS = new ErrorCode(1_002_018_202, "社交客户端不存在");
+    ErrorCode SOCIAL_CLIENT_WEIXIN_MINI_APP_SUBSCRIBE_TEMPLATE_ERROR = new ErrorCode(1_002_018_202, "获得小程序订阅消息模版失败");
-    ErrorCode SOCIAL_CLIENT_UNIQUE = new ErrorCode(1_002_018_203, "社交客户端已存在配置");
+    ErrorCode SOCIAL_CLIENT_NOT_EXISTS = new ErrorCode(1_002_018_210, "社交客户端不存在");
+    ErrorCode SOCIAL_CLIENT_UNIQUE = new ErrorCode(1_002_018_211, "社交客户端已存在配置");
 
 
     // ========== OAuth2 客户端 1-002-020-000 =========

yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/api/social/SocialClientApiImpl.java

@@ -5,12 +5,15 @@ import cn.iocoder.yudao.framework.common.util.object.BeanUtils;
 import cn.iocoder.yudao.module.system.api.social.dto.SocialWxJsapiSignatureRespDTO;
 import cn.iocoder.yudao.module.system.api.social.dto.SocialWxPhoneNumberInfoRespDTO;
 import cn.iocoder.yudao.module.system.api.social.dto.SocialWxQrcodeReqDTO;
+import cn.iocoder.yudao.module.system.api.social.dto.SocialWxSubscribeTemplateRespDTO;
 import cn.iocoder.yudao.module.system.service.social.SocialClientService;
+import jakarta.annotation.Resource;
 import me.chanjar.weixin.common.bean.WxJsapiSignature;
+import me.chanjar.weixin.common.bean.subscribemsg.TemplateInfo;
 import org.springframework.stereotype.Service;
 import org.springframework.validation.annotation.Validated;
 
-import jakarta.annotation.Resource;
+import java.util.List;
 
 /**
  * 社交应用的 API 实现类
@@ -46,4 +49,10 @@ public class SocialClientApiImpl implements SocialClientApi {
         return socialClientService.getWxaQrcode(reqVO);
     }
 
+    @Override
+    public List<SocialWxSubscribeTemplateRespDTO> getSubscribeTemplate() {
+        List<TemplateInfo> subscribeTemplate = socialClientService.getSubscribeTemplate();
+        return BeanUtils.toBean(subscribeTemplate, SocialWxSubscribeTemplateRespDTO.class);
+    }
+
 }

yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/service/social/SocialClientService.java

@@ -10,6 +10,9 @@ import cn.iocoder.yudao.module.system.enums.social.SocialTypeEnum;
 import com.xingyuv.jushauth.model.AuthUser;
 import jakarta.validation.Valid;
 import me.chanjar.weixin.common.bean.WxJsapiSignature;
+import me.chanjar.weixin.common.bean.subscribemsg.TemplateInfo;
+
+import java.util.List;
 
 /**
  * 社交应用 Service 接口
@@ -109,4 +112,11 @@ public interface SocialClientService {
      */
     PageResult<SocialClientDO> getSocialClientPage(SocialClientPageReqVO pageReqVO);
 
+    /**
+     * 获得微信小程订阅模板
+     *
+     * @return 微信小程订阅模板
+     */
+    List<TemplateInfo> getSubscribeTemplate();
+
 }

yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/service/social/SocialClientServiceImpl.java

@@ -1,6 +1,7 @@
 package cn.iocoder.yudao.module.system.service.social;
 
 import cn.binarywang.wx.miniapp.api.WxMaService;
+import cn.binarywang.wx.miniapp.api.WxMaSubscribeService;
 import cn.binarywang.wx.miniapp.api.impl.WxMaServiceImpl;
 import cn.binarywang.wx.miniapp.bean.WxMaPhoneNumberInfo;
 import cn.binarywang.wx.miniapp.config.impl.WxMaRedisBetterConfigImpl;
@@ -36,6 +37,7 @@ import jakarta.annotation.Resource;
 import lombok.SneakyThrows;
 import lombok.extern.slf4j.Slf4j;
 import me.chanjar.weixin.common.bean.WxJsapiSignature;
+import me.chanjar.weixin.common.bean.subscribemsg.TemplateInfo;
 import me.chanjar.weixin.common.error.WxErrorException;
 import me.chanjar.weixin.common.redis.RedisTemplateWxRedisOps;
 import me.chanjar.weixin.mp.api.WxMpService;
@@ -46,6 +48,7 @@ import org.springframework.data.redis.core.StringRedisTemplate;
 import org.springframework.stereotype.Service;
 
 import java.time.Duration;
+import java.util.List;
 import java.util.Objects;
 
 import static cn.iocoder.yudao.framework.common.exception.util.ServiceExceptionUtil.exception;
@@ -364,4 +367,16 @@ public class SocialClientServiceImpl implements SocialClientService {
         return socialClientMapper.selectPage(pageReqVO);
     }
 
+    @Override
+    public List<TemplateInfo> getSubscribeTemplate() {
+        WxMaService service = getWxMaService(UserTypeEnum.MEMBER.getValue());
+        try {
+            WxMaSubscribeService subscribeService = service.getSubscribeService();
+            return subscribeService.getTemplateList();
+        }catch (WxErrorException e) {
+            log.error("[getSubscribeTemplate][获得小程序订阅消息模版]", e);
+            throw exception(SOCIAL_CLIENT_WEIXIN_MINI_APP_SUBSCRIBE_TEMPLATE_ERROR);
+        }
+    }
+
 }