feat：新增获取小程序码相关接口

puhui999
1 parent 52c86cd2
Showing 10 changed files with 219 additions and 25 deletions
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/AppSocialWxQrcodeReqVO.java
yudao-module-system/yudao-module-system-api/src/main/java/cn/iocoder/yudao/module/system/api/social/SocialUserApi.java
yudao-module-system/yudao-module-system-api/src/main/java/cn/iocoder/yudao/module/system/api/social/dto/SocialWxQrcodeReqDTO.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/SocialUserApiImpl.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
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/service/social/SocialUserService.java
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/service/social/SocialUserServiceImpl.java
@@ -7,18 +7,21 @@ 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.system.api.social.SocialUserApi;
 import cn.iocoder.yudao.module.system.api.social.dto.SocialUserBindReqDTO;
 import cn.iocoder.yudao.module.system.api.social.dto.SocialUserRespDTO;
 import cn.iocoder.yudao.module.system.api.social.dto.SocialUserUnbindReqDTO;
+import cn.iocoder.yudao.module.system.api.social.dto.SocialWxQrcodeReqDTO;
+import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.tags.Tag;
-import io.swagger.v3.oas.annotations.Operation;
+import jakarta.annotation.Resource;
+import jakarta.validation.Valid;
 import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.*;
-import jakarta.annotation.Resource;
-import jakarta.validation.Valid;
+import java.util.Base64;
 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
 import static cn.iocoder.yudao.framework.security.core.util.SecurityFrameworkUtils.getLoginUserId;
@@ -60,4 +63,13 @@ public class AppSocialUserController {
         return success(BeanUtils.toBean(socialUser, AppSocialUserRespVO.class));
     }
+    @PostMapping("/wxacode")
+    @Operation(summary = "获得微信小程序码")
+    @PreAuthenticated
+    public CommonResult<String> getWxQrcode(@RequestBody @Valid AppSocialWxQrcodeReqVO reqVO) {
+        byte[] wxQrcode = socialUserApi.getWxQrcode(BeanUtils.toBean(reqVO, SocialWxQrcodeReqDTO.class).setUserId(getLoginUserId())
+                .setUserType(UserTypeEnum.MEMBER.getValue()).setSocialType(reqVO.getType()));
+        return success(Base64.getEncoder().encodeToString(wxQrcode));
+    }
+
 }
+package cn.iocoder.yudao.module.member.controller.app.social.vo;
+
+import cn.iocoder.yudao.framework.common.validation.InEnum;
+import cn.iocoder.yudao.module.system.enums.social.SocialTypeEnum;
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.NotEmpty;
+import jakarta.validation.constraints.NotNull;
+import lombok.Data;
+
+@Schema(description = "用户 APP - 获得获取小程序码 Request VO")
+@Data
+public class AppSocialWxQrcodeReqVO {
+
+    private static String SCENE = "1011"; // 默认场景值 1011 扫描二维码
+    private static String ENV_VERSION = "develop"; // 小程序版本。正式版为 "release"，体验版为 "trial"，开发版为 "develop"
+    private static Integer WIDTH = 430; // 二维码宽度
+    private static Boolean AUTO_COLOR = true; // 默认true 自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调
+    private static Boolean CHECK_PATH = true; // 默认true 检查 page 是否存在
+    private static Boolean IS_HYALINE = true; // 是否需要透明底色， is_hyaline 为true时，生成透明底色的小程序码
+
+    /**
+     * 最大32个可见字符，只支持数字，大小写英文以及部分特殊字符：!#$&'()*+,/:;=?@-._~， 其它字符请自行编码为合法字符
+     * （因不支持%，中文无法使用 urlencode 处理，请使用其他编码方式）
+     */
+    @Schema(description = "场景值/页面参数", requiredMode = Schema.RequiredMode.REQUIRED, example = "1001")
+    private String scene = SCENE;
+    /**
+     * 页面路径
+     */
+    @Schema(description = "页面路径", requiredMode = Schema.RequiredMode.REQUIRED, example = "pages/goods/index")
+    @NotEmpty(message = "页面路径不能为空")
+    private String path;
+    /**
+     * 要打开的小程序版本。默认是开发版。
+     */
+    @Schema(description = "小程序版本", requiredMode = Schema.RequiredMode.REQUIRED, example = "develop")
+    private String envVersion = ENV_VERSION;
+    /**
+     * 二维码宽度
+     */
+    @Schema(description = "二维码宽度", requiredMode = Schema.RequiredMode.REQUIRED, example = "430")
+    private Integer width = WIDTH;
+    /**
+     * 默认true 自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调
+     */
+    @Schema(description = "是/否自动配置线条颜色", requiredMode = Schema.RequiredMode.REQUIRED, example = "true")
+    private Boolean isAutoColor = AUTO_COLOR;
+    /**
+     * 默认true 检查 page 是否存在，为 true 时 page 必须是已经发布的小程序存在的页面（否则报错）；
+     * 为 false 时允许小程序未发布或者 page 不存在，但 page 有数量上限（60000个）请勿滥用
+     */
+    @Schema(description = "是/否检查 page 是否存在", requiredMode = Schema.RequiredMode.REQUIRED, example = "true")
+    private Boolean isCheckPath = CHECK_PATH;
+    /**
+     * 是否需要透明底色， is_hyaline 为true时，生成透明底色的小程序码
+     */
+    @Schema(description = "是/否需要透明底色", requiredMode = Schema.RequiredMode.REQUIRED, example = "true")
+    private Boolean isHyaline = IS_HYALINE;
+
+    @Schema(description = "社交平台的类型，参见 SocialTypeEnum 枚举值", requiredMode = Schema.RequiredMode.REQUIRED, example = "10")
+    @InEnum(SocialTypeEnum.class)
+    @NotNull(message = "社交平台的类型不能为空")
+    private Integer type;
+
+}
@@ -4,7 +4,7 @@ import cn.iocoder.yudao.framework.common.exception.ServiceException;
 import cn.iocoder.yudao.module.system.api.social.dto.SocialUserBindReqDTO;
 import cn.iocoder.yudao.module.system.api.social.dto.SocialUserRespDTO;
 import cn.iocoder.yudao.module.system.api.social.dto.SocialUserUnbindReqDTO;
-
+import cn.iocoder.yudao.module.system.api.social.dto.SocialWxQrcodeReqDTO;
 import jakarta.validation.Valid;
 /**
@@ -32,8 +32,8 @@ public interface SocialUserApi {
     /**
      * 获得社交用户，基于 userId
      *
-     * @param userType 用户类型
-     * @param userId 用户编号
+     * @param userType   用户类型
+     * @param userId     用户编号
      * @param socialType 社交平台的类型
      * @return 社交用户
      */
@@ -44,12 +44,20 @@ public interface SocialUserApi {
      *
      * 在认证信息不正确的情况下，也会抛出 {@link ServiceException} 业务异常
      *
-     * @param userType 用户类型
+     * @param userType   用户类型
      * @param socialType 社交平台的类型
-     * @param code 授权码
-     * @param state state
+     * @param code       授权码
+     * @param state      state
      * @return 社交用户
      */
     SocialUserRespDTO getSocialUserByCode(Integer userType, Integer socialType, String code, String state);
+    /**
+     * 获得小程序二维码
+     *
+     * @param reqVO 请求信息
+     * @return 小程序二维码
+     */
+    byte[] getWxQrcode(@Valid SocialWxQrcodeReqDTO reqVO);
+
 }
+package cn.iocoder.yudao.module.system.api.social.dto;
+
+import cn.iocoder.yudao.framework.common.enums.UserTypeEnum;
+import cn.iocoder.yudao.framework.common.validation.InEnum;
+import cn.iocoder.yudao.module.system.enums.social.SocialTypeEnum;
+import jakarta.validation.constraints.NotEmpty;
+import jakarta.validation.constraints.NotNull;
+import lombok.Data;
+
+@Data
+public class SocialWxQrcodeReqDTO {
+
+    /**
+     * 用户编号
+     */
+    @NotNull(message = "用户编号不能为空")
+    private Long userId;
+    /**
+     * 用户类型
+     */
+    @InEnum(UserTypeEnum.class)
+    @NotNull(message = "用户类型不能为空")
+    private Integer userType;
+
+    /**
+     * 社交平台的类型
+     */
+    @InEnum(SocialTypeEnum.class)
+    @NotNull(message = "社交平台的类型不能为空")
+    private Integer socialType;
+
+    /**
+     * 最大32个可见字符，只支持数字，大小写英文以及部分特殊字符：!#$&'()*+,/:;=?@-._~， 其它字符请自行编码为合法字符
+     * （因不支持%，中文无法使用 urlencode 处理，请使用其他编码方式）
+     */
+    private String scene;
+    /**
+     * 页面路径
+     */
+    @NotEmpty(message = "页面路径不能为空")
+    private String path;
+    /**
+     * 要打开的小程序版本。默认是开发版。
+     */
+    private String envVersion;
+    /**
+     * 二维码宽度
+     */
+    private Integer width;
+    /**
+     * 默认true 自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调
+     */
+    private Boolean isAutoColor;
+    /**
+     * 默认true 检查 page 是否存在，为 true 时 page 必须是已经发布的小程序存在的页面（否则报错）；
+     * 为 false 时允许小程序未发布或者 page 不存在，但 page 有数量上限（60000个）请勿滥用
+     */
+    private Boolean isCheckPath;
+    /**
+     * 是否需要透明底色， is_hyaline 为true时，生成透明底色的小程序码
+     */
+    private Boolean isHyaline;
+
+}
@@ -120,8 +120,10 @@ public interface ErrorCodeConstants {
     ErrorCode SOCIAL_USER_NOT_FOUND = new ErrorCode(1_002_018_001, "社交授权失败，找不到对应的用户");
     ErrorCode SOCIAL_CLIENT_WEIXIN_MINI_APP_PHONE_CODE_ERROR = new ErrorCode(1_002_018_200, "获得手机号失败");
-    ErrorCode SOCIAL_CLIENT_NOT_EXISTS = new ErrorCode(1_002_018_201, "社交客户端不存在");
-    ErrorCode SOCIAL_CLIENT_UNIQUE = new ErrorCode(1_002_018_202, "社交客户端已存在配置");
+    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, "社交客户端已存在配置");
+
     // ========== OAuth2 客户端 1-002-020-000 =========
     ErrorCode OAUTH2_CLIENT_NOT_EXISTS = new ErrorCode(1_002_020_000, "OAuth2 客户端不存在");
@@ -3,6 +3,7 @@ package cn.iocoder.yudao.module.system.api.social;
 import cn.iocoder.yudao.module.system.api.social.dto.SocialUserBindReqDTO;
 import cn.iocoder.yudao.module.system.api.social.dto.SocialUserRespDTO;
 import cn.iocoder.yudao.module.system.api.social.dto.SocialUserUnbindReqDTO;
+import cn.iocoder.yudao.module.system.api.social.dto.SocialWxQrcodeReqDTO;
 import cn.iocoder.yudao.module.system.service.social.SocialUserService;
 import org.springframework.stereotype.Service;
 import org.springframework.validation.annotation.Validated;
@@ -42,4 +43,9 @@ public class SocialUserApiImpl implements SocialUserApi {
        return socialUserService.getSocialUserByCode(userType, socialType, code, state);
     }
+    @Override
+    public byte[] getWxQrcode(SocialWxQrcodeReqDTO reqVO) {
+        return socialUserService.getWxQrcode(reqVO);
+    }
+
 }
@@ -2,14 +2,14 @@ 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.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;
 import cn.iocoder.yudao.module.system.enums.social.SocialTypeEnum;
 import com.xingyuv.jushauth.model.AuthUser;
-import me.chanjar.weixin.common.bean.WxJsapiSignature;
-
 import jakarta.validation.Valid;
+import me.chanjar.weixin.common.bean.WxJsapiSignature;
 /**
  * 社交应用 Service 接口
@@ -21,8 +21,8 @@ public interface SocialClientService {
     /**
      * 获得社交平台的授权 URL
      *
-     * @param socialType 社交平台的类型 {@link SocialTypeEnum}
-     * @param userType 用户类型
+     * @param socialType  社交平台的类型 {@link SocialTypeEnum}
+     * @param userType    用户类型
      * @param redirectUri 重定向 URL
      * @return 社交平台的授权 URL
      */
@@ -32,9 +32,9 @@ public interface SocialClientService {
      * 请求社交平台，获得授权的用户
      *
      * @param socialType 社交平台的类型
-     * @param userType 用户类型
-     * @param code 授权码
-     * @param state 授权 state
+     * @param userType   用户类型
+     * @param code       授权码
+     * @param state      授权 state
      * @return 授权的用户
      */
     AuthUser getAuthUser(Integer socialType, Integer userType, String code, String state);
@@ -45,7 +45,7 @@ public interface SocialClientService {
      * 创建微信公众号的 JS SDK 初始化所需的签名
      *
      * @param userType 用户类型
-     * @param url 访问的 URL 地址
+     * @param url      访问的 URL 地址
      * @return 签名
      */
     WxJsapiSignature createWxMpJsapiSignature(Integer userType, String url);
@@ -55,12 +55,20 @@ public interface SocialClientService {
     /**
      * 获得微信小程序的手机信息
      *
-     * @param userType 用户类型
+     * @param userType  用户类型
      * @param phoneCode 手机授权码
      * @return 手机信息
      */
     WxMaPhoneNumberInfo getWxMaPhoneNumberInfo(Integer userType, String phoneCode);
+    /**
+     * 获得小程序二维码
+     *
+     * @param reqVO 请求信息
+     * @return 小程序二维码
+     */
+    byte[] getWxQrcode(SocialWxQrcodeReqDTO reqVO);
+
     // =================== 客户端管理 ===================
     /**
@@ -13,6 +13,7 @@ import cn.iocoder.yudao.framework.common.pojo.PageResult;
 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.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;
@@ -139,7 +140,7 @@ public class SocialClientServiceImpl implements SocialClientService {
      * 构建 AuthRequest 对象，支持多租户配置
      *
      * @param socialType 社交类型
-     * @param userType 用户类型
+     * @param userType   用户类型
      * @return AuthRequest 对象
      */
     @VisibleForTesting
@@ -196,7 +197,7 @@ public class SocialClientServiceImpl implements SocialClientService {
     /**
      * 创建 clientId + clientSecret 对应的 WxMpService 对象
      *
-     * @param clientId 微信公众号 appId
+     * @param clientId     微信公众号 appId
      * @param clientSecret 微信公众号 secret
      * @return WxMpService 对象
      */
@@ -227,6 +228,19 @@ public class SocialClientServiceImpl implements SocialClientService {
         }
     }
+    @Override
+    public byte[] getWxQrcode(SocialWxQrcodeReqDTO reqVO) {
+        WxMaService service = getWxMaService(reqVO.getUserType());
+        try {
+            return service.getQrcodeService().createWxaCodeUnlimitBytes(reqVO.getScene(), reqVO.getPath(),
+                    reqVO.getIsCheckPath(), reqVO.getEnvVersion(), reqVO.getWidth(), reqVO.getIsAutoColor(),
+                    null, reqVO.getIsHyaline());
+        } catch (WxErrorException e) {
+            log.error("[getWxQrcode][reqVO({})) 获得小程序码失败]", reqVO, e);
+            throw exception(SOCIAL_CLIENT_WEIXIN_MINI_APP_QRCODE_ERROR);
+        }
+    }
+
     /**
      * 获得 clientId + clientSecret 对应的 WxMpService 对象
      *
@@ -248,7 +262,7 @@ public class SocialClientServiceImpl implements SocialClientService {
     /**
      * 创建 clientId + clientSecret 对应的 WxMaService 对象
      *
-     * @param clientId 微信小程序 appId
+     * @param clientId     微信小程序 appId
      * @param clientSecret 微信小程序 secret
      * @return WxMaService 对象
      */
@@ -310,8 +324,8 @@ public class SocialClientServiceImpl implements SocialClientService {
      *
      * 原因是，不同端（userType）选择某个社交登录（socialType）时，需要通过 {@link #buildAuthRequest(Integer, Integer)} 构建对应的请求
      *
-     * @param id 编号
-     * @param userType 用户类型
+     * @param id         编号
+     * @param userType   用户类型
      * @param socialType 社交类型
      */
     private void validateSocialClientUnique(Long id, Integer userType, Integer socialType) {
@@ -4,6 +4,7 @@ import cn.iocoder.yudao.framework.common.exception.ServiceException;
 import cn.iocoder.yudao.framework.common.pojo.PageResult;
 import cn.iocoder.yudao.module.system.api.social.dto.SocialUserBindReqDTO;
 import cn.iocoder.yudao.module.system.api.social.dto.SocialUserRespDTO;
+import cn.iocoder.yudao.module.system.api.social.dto.SocialWxQrcodeReqDTO;
 import cn.iocoder.yudao.module.system.controller.admin.socail.vo.user.SocialUserPageReqVO;
 import cn.iocoder.yudao.module.system.dal.dataobject.social.SocialUserDO;
 import cn.iocoder.yudao.module.system.enums.social.SocialTypeEnum;
@@ -86,4 +87,12 @@ public interface SocialUserService {
      */
     PageResult<SocialUserDO> getSocialUserPage(SocialUserPageReqVO pageReqVO);
+    /**
+     * 获得小程序二维码
+     *
+     * @param reqVO 请求信息
+     * @return 小程序二维码
+     */
+    byte[] getWxQrcode(SocialWxQrcodeReqDTO reqVO);
+
 }
@@ -6,6 +6,7 @@ import cn.iocoder.yudao.framework.common.exception.ServiceException;
 import cn.iocoder.yudao.framework.common.pojo.PageResult;
 import cn.iocoder.yudao.module.system.api.social.dto.SocialUserBindReqDTO;
 import cn.iocoder.yudao.module.system.api.social.dto.SocialUserRespDTO;
+import cn.iocoder.yudao.module.system.api.social.dto.SocialWxQrcodeReqDTO;
 import cn.iocoder.yudao.module.system.controller.admin.socail.vo.user.SocialUserPageReqVO;
 import cn.iocoder.yudao.module.system.dal.dataobject.social.SocialUserBindDO;
 import cn.iocoder.yudao.module.system.dal.dataobject.social.SocialUserDO;
@@ -170,4 +171,9 @@ public class SocialUserServiceImpl implements SocialUserService {
         return socialUserMapper.selectPage(pageReqVO);
     }
+    @Override
+    public byte[] getWxQrcode(SocialWxQrcodeReqDTO reqVO) {
+        return socialClientService.getWxQrcode(reqVO);
+    }
+
 }