!1018 新增小程序订阅消息相关接口

Merge pull request !1018 from puhui999/develop

!1018 新增小程序订阅消息相关接口
Merge pull request !1018 from puhui999/develop
芋道源码 · Gitee
2 parents 401de303 8054847b
Showing 12 changed files with 266 additions and 20 deletions
yudao-module-mall/yudao-module-trade-api/src/main/java/cn/iocoder/yudao/module/trade/enums/MessageTemplateConstants.java
yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/social/AppSocialUserController.java
yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/social/vo/AppSocialWxSubscribeTemplateRespVO.java
yudao-module-system/yudao-module-system-api/src/main/java/cn/iocoder/yudao/module/system/api/social/SocialClientApi.java
yudao-module-system/yudao-module-system-api/src/main/java/cn/iocoder/yudao/module/system/api/social/dto/SocialWxSubscribeMessageReqDTO.java
yudao-module-system/yudao-module-system-api/src/main/java/cn/iocoder/yudao/module/system/api/social/dto/SocialWxSubscribeTemplateRespDTO.java
yudao-module-system/yudao-module-system-api/src/main/java/cn/iocoder/yudao/module/system/enums/ErrorCodeConstants.java
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/api/social/SocialClientApiImpl.java
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/socail/SocialClientController.http
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/socail/SocialClientController.java
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/service/social/SocialClientService.java
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/service/social/SocialClientServiceImpl.java
@@ -13,4 +13,9 @@ public interface MessageTemplateConstants {
     String BROKERAGE_WITHDRAW_AUDIT_APPROVE = "brokerage_withdraw_audit_approve"; // 佣金提现（审核通过）
     String BROKERAGE_WITHDRAW_AUDIT_REJECT = "brokerage_withdraw_audit_reject"; // 佣金提现（审核不通过）
+    //======================= 订阅消息模版 =======================
+
+    String ORDER_AFTERSALE_CHANGE = "售后进度通知";
+    String MONEY_CHANGE = "充值成功通知";
+
 }
@@ -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.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.member.controller.app.social.vo.*;
 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));
+    }
+
 }
+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;
+
+}
 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.*;
 import cn.iocoder.yudao.module.system.enums.social.SocialTypeEnum;
 import jakarta.validation.Valid;
+import java.util.List;
+
 /**
  * 社交应用的 API 接口
  *
@@ -16,8 +16,8 @@ public interface SocialClientApi {
     /**
      * 获得社交平台的授权 URL
      *
-     * @param socialType 社交平台的类型 {@link SocialTypeEnum}
-     * @param userType 用户类型
+     * @param socialType  社交平台的类型 {@link SocialTypeEnum}
+     * @param userType    用户类型
      * @param redirectUri 重定向 URL
      * @return 社交平台的授权 URL
      */
@@ -27,7 +27,7 @@ public interface SocialClientApi {
      * 创建微信公众号 JS SDK 初始化所需的签名
      *
      * @param userType 用户类型
-     * @param url 访问的 URL 地址
+     * @param url      访问的 URL 地址
      * @return 签名
      */
     SocialWxJsapiSignatureRespDTO createWxMpJsapiSignature(Integer userType, String url);
@@ -35,7 +35,7 @@ public interface SocialClientApi {
     /**
      * 获得微信小程序的手机信息
      *
-     * @param userType 用户类型
+     * @param userType  用户类型
      * @param phoneCode 手机授权码
      * @return 手机信息
      */
@@ -49,4 +49,18 @@ public interface SocialClientApi {
      */
     byte[] getWxaQrcode(@Valid SocialWxQrcodeReqDTO reqVO);
+    /**
+     * 获得微信小程订阅模板
+     *
+     * @return 小程序订阅消息模版
+     */
+    List<SocialWxSubscribeTemplateRespDTO> getSubscribeTemplate();
+
+    /**
+     * 发送订阅消息
+     *
+     * @param reqDTO 请求
+     */
+    void sendSubscribeMessage(SocialWxSubscribeMessageReqDTO reqDTO);
+
 }
+package cn.iocoder.yudao.module.system.api.social.dto;
+
+import cn.iocoder.yudao.framework.common.core.KeyValue;
+import lombok.Data;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * 微信小程序订阅消息 Request DTO
+ *
+ * @author HUIHUI
+ */
+@Data
+public class SocialWxSubscribeMessageReqDTO {
+
+    /**
+     * 接收者（用户）的 openid.
+     * <pre>
+     * 参数：touser
+     * 是否必填： 是
+     * 描述： 接收者（用户）的 openid
+     * </pre>
+     */
+    private String toUser;
+
+    /**
+     * 所需下发的模板消息的id.
+     * <pre>
+     * 参数：template_id
+     * 是否必填： 是
+     * 描述： 所需下发的模板消息的id
+     * </pre>
+     */
+    private String templateId;
+
+    /**
+     * 点击模板卡片后的跳转页面，仅限本小程序内的页面.
+     * <pre>
+     * 参数：page
+     * 是否必填： 否
+     * 描述： 点击模板卡片后的跳转页面，仅限本小程序内的页面。支持带参数,（示例index?foo=bar）。该字段不填则模板无跳转。
+     * </pre>
+     */
+    private String page;
+
+    /**
+     * 跳转小程序类型：developer为开发版；trial为体验版；formal为正式版；默认为正式版
+     *
+     * 枚举 WxMaConstants.MiniProgramState
+     */
+    private String miniprogramState;
+
+    /**
+     * 进入小程序查看的语言类型，支持zh_CN(简体中文)、en_US(英文)、zh_HK(繁体中文)、zh_TW(繁体中文)，默认为zh_CN
+     *
+     * 枚举 WxMaConstants.MiniProgramLang
+     */
+    private String lang;
+
+    /**
+     * 模板内容，不填则下发空模板.
+     * <pre>
+     * 参数：data
+     * 是否必填： 是
+     * 描述： 模板内容，不填则下发空模板
+     * </pre>
+     */
+    private List<KeyValue<String, String>> messages;
+
+    public SocialWxSubscribeMessageReqDTO addData(String key, String value) {
+        if (messages == null) {
+            messages = new ArrayList<>();
+        }
+        messages.add(new KeyValue<>(key, value));
+        return this;
+    }
+
+}
+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;
+
+}
@@ -121,8 +121,10 @@ 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_UNIQUE = new ErrorCode(1_002_018_203, "社交客户端已存在配置");
+    ErrorCode SOCIAL_CLIENT_WEIXIN_MINI_APP_SUBSCRIBE_TEMPLATE_ERROR = new ErrorCode(1_002_018_202, "获得小程序订阅消息模版失败");
+    ErrorCode SOCIAL_CLIENT_WEIXIN_MINI_APP_SUBSCRIBE_MESSAGE_ERROR = 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 =========
@@ -2,15 +2,15 @@ package cn.iocoder.yudao.module.system.api.social;
 import cn.binarywang.wx.miniapp.bean.WxMaPhoneNumberInfo;
 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.*;
 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 +46,15 @@ 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);
+    }
+
+    @Override
+    public void sendSubscribeMessage(SocialWxSubscribeMessageReqDTO reqDTO) {
+        socialClientService.sendSubscribeMessage(reqDTO);
+    }
+
 }
+### 请求 /system/social-client/send-subscribe-message 接口 => 发送测试订阅消息
+POST {{baseUrl}}/system/social-client/send-subscribe-message
+Authorization: Bearer {{token}}
+#Authorization: Bearer test100
+tenant-id: {{adminTenentId}}
@@ -3,6 +3,7 @@ package cn.iocoder.yudao.module.system.controller.admin.socail;
 import cn.iocoder.yudao.framework.common.pojo.CommonResult;
 import cn.iocoder.yudao.framework.common.pojo.PageResult;
 import cn.iocoder.yudao.framework.common.util.object.BeanUtils;
+import cn.iocoder.yudao.module.system.api.social.dto.SocialWxSubscribeMessageReqDTO;
 import cn.iocoder.yudao.module.system.controller.admin.socail.vo.client.SocialClientPageReqVO;
 import cn.iocoder.yudao.module.system.controller.admin.socail.vo.client.SocialClientRespVO;
 import cn.iocoder.yudao.module.system.controller.admin.socail.vo.client.SocialClientSaveReqVO;
@@ -11,13 +12,12 @@ import cn.iocoder.yudao.module.system.service.social.SocialClientService;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.tags.Tag;
+import jakarta.annotation.Resource;
+import jakarta.validation.Valid;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.*;
-import jakarta.annotation.Resource;
-import jakarta.validation.Valid;
-
 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
 @Tag(name = "管理后台 - 社交客户端")
@@ -70,4 +70,16 @@ public class SocialClientController {
         return success(BeanUtils.toBean(pageResult, SocialClientRespVO.class));
     }
+    //======================= TODO 测试发送订阅消息 =======================
+
+    @PostMapping("/send-subscribe-message")
+    public void testSendSubscribeMessage() {
+        SocialWxSubscribeMessageReqDTO reqDTO = new SocialWxSubscribeMessageReqDTO().setLang("zh_CN")
+                .setMiniprogramState("developer").setTemplateId("W4ybDTIwCfKHtMKR7fSfx83DtmVKEeXQo3Ti7GCw4_4")
+                .setToUser("oKNkb4xxw2H135-MVPKtEMkumK08");
+        reqDTO.addData("character_string1", "11111111").addData("amount2", "6666").addData("time3", "2024-01-01 10:10:10")
+                .addData("phrase4", "成功");
+        socialClientService.sendSubscribeMessage(reqDTO);
+    }
+
 }
@@ -3,6 +3,7 @@ package cn.iocoder.yudao.module.system.service.social;
 import cn.binarywang.wx.miniapp.bean.WxMaPhoneNumberInfo;
 import cn.iocoder.yudao.framework.common.pojo.PageResult;
 import cn.iocoder.yudao.module.system.api.social.dto.SocialWxQrcodeReqDTO;
+import cn.iocoder.yudao.module.system.api.social.dto.SocialWxSubscribeMessageReqDTO;
 import cn.iocoder.yudao.module.system.controller.admin.socail.vo.client.SocialClientPageReqVO;
 import cn.iocoder.yudao.module.system.controller.admin.socail.vo.client.SocialClientSaveReqVO;
 import cn.iocoder.yudao.module.system.dal.dataobject.social.SocialClientDO;
@@ -10,6 +11,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 接口
@@ -69,6 +73,20 @@ public interface SocialClientService {
      */
     byte[] getWxaQrcode(SocialWxQrcodeReqDTO reqVO);
+    /**
+     * 获得微信小程订阅模板
+     *
+     * @return 微信小程订阅模板
+     */
+    List<TemplateInfo> getSubscribeTemplate();
+
+    /**
+     * 发送订阅消息
+     *
+     * @param reqDTO 请求
+     */
+    void sendSubscribeMessage(SocialWxSubscribeMessageReqDTO reqDTO);
+
     // =================== 客户端管理 ===================
     /**
 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.bean.WxMaSubscribeMessage;
 import cn.binarywang.wx.miniapp.config.impl.WxMaRedisBetterConfigImpl;
 import cn.hutool.core.bean.BeanUtil;
 import cn.hutool.core.lang.Assert;
@@ -15,6 +17,7 @@ import cn.iocoder.yudao.framework.common.util.cache.CacheUtils;
 import cn.iocoder.yudao.framework.common.util.http.HttpUtils;
 import cn.iocoder.yudao.framework.common.util.object.BeanUtils;
 import cn.iocoder.yudao.module.system.api.social.dto.SocialWxQrcodeReqDTO;
+import cn.iocoder.yudao.module.system.api.social.dto.SocialWxSubscribeMessageReqDTO;
 import cn.iocoder.yudao.module.system.controller.admin.socail.vo.client.SocialClientPageReqVO;
 import cn.iocoder.yudao.module.system.controller.admin.socail.vo.client.SocialClientSaveReqVO;
 import cn.iocoder.yudao.module.system.dal.dataobject.social.SocialClientDO;
@@ -36,6 +39,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 +50,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;
@@ -255,6 +260,32 @@ public class SocialClientServiceImpl implements SocialClientService {
         }
     }
+    @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);
+        }
+    }
+
+    @Override
+    public void sendSubscribeMessage(SocialWxSubscribeMessageReqDTO reqDTO) {
+        WxMaService service = getWxMaService(UserTypeEnum.MEMBER.getValue());
+        try {
+            WxMaSubscribeService subscribeService = service.getSubscribeService();
+            WxMaSubscribeMessage message = BeanUtils.toBean(reqDTO, WxMaSubscribeMessage.class);
+            reqDTO.getMessages().forEach(item-> message.addData(new WxMaSubscribeMessage.MsgData(item.getKey(), item.getValue())));
+            subscribeService.sendSubscribeMsg(message);
+        }catch (WxErrorException e) {
+            log.error("[sendSubscribeMessage][发送小程序订阅消息]", e);
+            throw exception(SOCIAL_CLIENT_WEIXIN_MINI_APP_SUBSCRIBE_MESSAGE_ERROR);
+        }
+    }
+
     /**
      * 获得 clientId + clientSecret 对应的 WxMpService 对象
      *