feat(user-invite-codes): 新增用户邀请码管理功能

- 新增邀请码实体、Mapper、Service及Controller全套接口
- 支持邀请码分页查询、保存及详情展示
- 新增USER_INVITE_CODES_NOT_EXISTS错误码
- 租户模块补充上级返点比例字段 upstreamRebateRatio
This commit is contained in:
2025-12-29 14:15:04 +08:00
parent 128f840f7e
commit 553feba55d
14 changed files with 558 additions and 0 deletions

View File

@@ -0,0 +1,104 @@
package com.yolo.keyboard.controller.admin.userinvitecodes;
import org.springframework.web.bind.annotation.*;
import jakarta.annotation.Resource;
import org.springframework.validation.annotation.Validated;
import org.springframework.security.access.prepost.PreAuthorize;
import io.swagger.v3.oas.annotations.tags.Tag;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.Operation;
import jakarta.validation.constraints.*;
import jakarta.validation.*;
import jakarta.servlet.http.*;
import java.util.*;
import java.io.IOException;
import com.yolo.keyboard.framework.common.pojo.PageParam;
import com.yolo.keyboard.framework.common.pojo.PageResult;
import com.yolo.keyboard.framework.common.pojo.CommonResult;
import com.yolo.keyboard.framework.common.util.object.BeanUtils;
import static com.yolo.keyboard.framework.common.pojo.CommonResult.success;
import com.yolo.keyboard.framework.excel.core.util.ExcelUtils;
import com.yolo.keyboard.framework.apilog.core.annotation.ApiAccessLog;
import static com.yolo.keyboard.framework.apilog.core.enums.OperateTypeEnum.*;
import com.yolo.keyboard.controller.admin.userinvitecodes.vo.*;
import com.yolo.keyboard.dal.dataobject.userinvitecodes.KeyboardUserInviteCodesDO;
import com.yolo.keyboard.service.userinvitecodes.KeyboardUserInviteCodesService;
@Tag(name = "管理后台 - 用户生成的邀请码表,用于邀请新用户注册/安装并建立邀请关系")
@RestController
@RequestMapping("/keyboard/user-invite-codes")
@Validated
public class KeyboardUserInviteCodesController {
@Resource
private KeyboardUserInviteCodesService userInviteCodesService;
@PostMapping("/create")
@Operation(summary = "创建用户生成的邀请码表,用于邀请新用户注册/安装并建立邀请关系")
@PreAuthorize("@ss.hasPermission('keyboard:user-invite-codes:create')")
public CommonResult<Long> createUserInviteCodes(@Valid @RequestBody KeyboardUserInviteCodesSaveReqVO createReqVO) {
return success(userInviteCodesService.createUserInviteCodes(createReqVO));
}
@PutMapping("/update")
@Operation(summary = "更新用户生成的邀请码表,用于邀请新用户注册/安装并建立邀请关系")
@PreAuthorize("@ss.hasPermission('keyboard:user-invite-codes:update')")
public CommonResult<Boolean> updateUserInviteCodes(@Valid @RequestBody KeyboardUserInviteCodesSaveReqVO updateReqVO) {
userInviteCodesService.updateUserInviteCodes(updateReqVO);
return success(true);
}
@DeleteMapping("/delete")
@Operation(summary = "删除用户生成的邀请码表,用于邀请新用户注册/安装并建立邀请关系")
@Parameter(name = "id", description = "编号", required = true)
@PreAuthorize("@ss.hasPermission('keyboard:user-invite-codes:delete')")
public CommonResult<Boolean> deleteUserInviteCodes(@RequestParam("id") Long id) {
userInviteCodesService.deleteUserInviteCodes(id);
return success(true);
}
@DeleteMapping("/delete-list")
@Parameter(name = "ids", description = "编号", required = true)
@Operation(summary = "批量删除用户生成的邀请码表,用于邀请新用户注册/安装并建立邀请关系")
@PreAuthorize("@ss.hasPermission('keyboard:user-invite-codes:delete')")
public CommonResult<Boolean> deleteUserInviteCodesList(@RequestParam("ids") List<Long> ids) {
userInviteCodesService.deleteUserInviteCodesListByIds(ids);
return success(true);
}
@GetMapping("/get")
@Operation(summary = "获得用户生成的邀请码表,用于邀请新用户注册/安装并建立邀请关系")
@Parameter(name = "id", description = "编号", required = true, example = "1024")
@PreAuthorize("@ss.hasPermission('keyboard:user-invite-codes:query')")
public CommonResult<KeyboardUserInviteCodesRespVO> getUserInviteCodes(@RequestParam("id") Long id) {
KeyboardUserInviteCodesDO userInviteCodes = userInviteCodesService.getUserInviteCodes(id);
return success(BeanUtils.toBean(userInviteCodes, KeyboardUserInviteCodesRespVO.class));
}
@GetMapping("/page")
@Operation(summary = "获得用户生成的邀请码表,用于邀请新用户注册/安装并建立邀请关系分页")
@PreAuthorize("@ss.hasPermission('keyboard:user-invite-codes:query')")
public CommonResult<PageResult<KeyboardUserInviteCodesRespVO>> getUserInviteCodesPage(@Valid KeyboardUserInviteCodesPageReqVO pageReqVO) {
PageResult<KeyboardUserInviteCodesDO> pageResult = userInviteCodesService.getUserInviteCodesPage(pageReqVO);
return success(BeanUtils.toBean(pageResult, KeyboardUserInviteCodesRespVO.class));
}
@GetMapping("/export-excel")
@Operation(summary = "导出用户生成的邀请码表,用于邀请新用户注册/安装并建立邀请关系 Excel")
@PreAuthorize("@ss.hasPermission('keyboard:user-invite-codes:export')")
@ApiAccessLog(operateType = EXPORT)
public void exportUserInviteCodesExcel(@Valid KeyboardUserInviteCodesPageReqVO pageReqVO,
HttpServletResponse response) throws IOException {
pageReqVO.setPageSize(PageParam.PAGE_SIZE_NONE);
List<KeyboardUserInviteCodesDO> list = userInviteCodesService.getUserInviteCodesPage(pageReqVO).getList();
// 导出 Excel
ExcelUtils.write(response, "用户生成的邀请码表,用于邀请新用户注册/安装并建立邀请关系.xls", "数据", KeyboardUserInviteCodesRespVO.class,
BeanUtils.toBean(list, KeyboardUserInviteCodesRespVO.class));
}
}

View File

@@ -0,0 +1,49 @@
package com.yolo.keyboard.controller.admin.userinvitecodes.vo;
import lombok.*;
import java.util.*;
import io.swagger.v3.oas.annotations.media.Schema;
import com.yolo.keyboard.framework.common.pojo.PageParam;
import org.springframework.format.annotation.DateTimeFormat;
import java.time.LocalDateTime;
import static com.yolo.keyboard.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
@Schema(description = "管理后台 - 用户生成的邀请码表,用于邀请新用户注册/安装并建立邀请关系分页 Request VO")
@Data
public class KeyboardUserInviteCodesPageReqVO extends PageParam {
@Schema(description = "邀请码字符串,对外展示,唯一")
private String code;
@Schema(description = "邀请码所属用户ID邀请人", example = "14170")
private Long ownerUserId;
@Schema(description = "邀请码状态1=启用0=停用", example = "2")
private Short status;
@Schema(description = "邀请码创建时间")
private LocalDateTime createdAt;
@Schema(description = "邀请码过期时间NULL表示永久有效")
private LocalDateTime expiresAt;
@Schema(description = "邀请码最大可使用次数NULL表示不限次数")
private Integer maxUses;
@Schema(description = "邀请码已使用次数", example = "25037")
private Integer usedCount;
@Schema(description = "邀请码所属系统用户ID邀请人", example = "20047")
private Long systemUserId;
@Schema(description = "邀请码所属租户", example = "17355")
private Long ownerTenantId;
@Schema(description = "邀请码所属系统用户", example = "772")
private Long owenrSystemUserId;
@Schema(description = "邀请码类型", example = "1")
private String inviteType;
}

View File

@@ -0,0 +1,63 @@
package com.yolo.keyboard.controller.admin.userinvitecodes.vo;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.*;
import java.util.*;
import org.springframework.format.annotation.DateTimeFormat;
import java.time.LocalDateTime;
import cn.idev.excel.annotation.*;
@Schema(description = "管理后台 - 用户生成的邀请码表,用于邀请新用户注册/安装并建立邀请关系 Response VO")
@Data
@ExcelIgnoreUnannotated
public class KeyboardUserInviteCodesRespVO {
@Schema(description = "邀请码主键ID", requiredMode = Schema.RequiredMode.REQUIRED, example = "3053")
@ExcelProperty("邀请码主键ID")
private Long id;
@Schema(description = "邀请码字符串,对外展示,唯一", requiredMode = Schema.RequiredMode.REQUIRED)
@ExcelProperty("邀请码字符串,对外展示,唯一")
private String code;
@Schema(description = "邀请码所属用户ID邀请人", requiredMode = Schema.RequiredMode.REQUIRED, example = "14170")
@ExcelProperty("邀请码所属用户ID邀请人")
private Long ownerUserId;
@Schema(description = "邀请码状态1=启用0=停用", requiredMode = Schema.RequiredMode.REQUIRED, example = "2")
@ExcelProperty("邀请码状态1=启用0=停用")
private Short status;
@Schema(description = "邀请码创建时间", requiredMode = Schema.RequiredMode.REQUIRED)
@ExcelProperty("邀请码创建时间")
private LocalDateTime createdAt;
@Schema(description = "邀请码过期时间NULL表示永久有效")
@ExcelProperty("邀请码过期时间NULL表示永久有效")
private LocalDateTime expiresAt;
@Schema(description = "邀请码最大可使用次数NULL表示不限次数")
@ExcelProperty("邀请码最大可使用次数NULL表示不限次数")
private Integer maxUses;
@Schema(description = "邀请码已使用次数", requiredMode = Schema.RequiredMode.REQUIRED, example = "25037")
@ExcelProperty("邀请码已使用次数")
private Integer usedCount;
@Schema(description = "邀请码所属系统用户ID邀请人", example = "20047")
@ExcelProperty("邀请码所属系统用户ID邀请人")
private Long systemUserId;
@Schema(description = "邀请码所属租户", example = "17355")
@ExcelProperty("邀请码所属租户")
private Long ownerTenantId;
@Schema(description = "邀请码所属系统用户", example = "772")
@ExcelProperty("邀请码所属系统用户")
private Long owenrSystemUserId;
@Schema(description = "邀请码类型", requiredMode = Schema.RequiredMode.REQUIRED, example = "1")
@ExcelProperty("邀请码类型")
private String inviteType;
}

View File

@@ -0,0 +1,56 @@
package com.yolo.keyboard.controller.admin.userinvitecodes.vo;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.*;
import java.util.*;
import jakarta.validation.constraints.*;
import org.springframework.format.annotation.DateTimeFormat;
import java.time.LocalDateTime;
@Schema(description = "管理后台 - 用户生成的邀请码表,用于邀请新用户注册/安装并建立邀请关系新增/修改 Request VO")
@Data
public class KeyboardUserInviteCodesSaveReqVO {
@Schema(description = "邀请码主键ID", requiredMode = Schema.RequiredMode.REQUIRED, example = "3053")
private Long id;
@Schema(description = "邀请码字符串,对外展示,唯一", requiredMode = Schema.RequiredMode.REQUIRED)
@NotEmpty(message = "邀请码字符串,对外展示,唯一不能为空")
private String code;
@Schema(description = "邀请码所属用户ID邀请人", requiredMode = Schema.RequiredMode.REQUIRED, example = "14170")
@NotNull(message = "邀请码所属用户ID邀请人不能为空")
private Long ownerUserId;
@Schema(description = "邀请码状态1=启用0=停用", requiredMode = Schema.RequiredMode.REQUIRED, example = "2")
@NotNull(message = "邀请码状态1=启用0=停用不能为空")
private Short status;
@Schema(description = "邀请码创建时间", requiredMode = Schema.RequiredMode.REQUIRED)
@NotNull(message = "邀请码创建时间不能为空")
private LocalDateTime createdAt;
@Schema(description = "邀请码过期时间NULL表示永久有效")
private LocalDateTime expiresAt;
@Schema(description = "邀请码最大可使用次数NULL表示不限次数")
private Integer maxUses;
@Schema(description = "邀请码已使用次数", requiredMode = Schema.RequiredMode.REQUIRED, example = "25037")
@NotNull(message = "邀请码已使用次数不能为空")
private Integer usedCount;
@Schema(description = "邀请码所属系统用户ID邀请人", example = "20047")
private Long systemUserId;
@Schema(description = "邀请码所属租户", example = "17355")
private Long ownerTenantId;
@Schema(description = "邀请码所属系统用户", example = "772")
private Long owenrSystemUserId;
@Schema(description = "邀请码类型", requiredMode = Schema.RequiredMode.REQUIRED, example = "1")
@NotEmpty(message = "邀请码类型不能为空")
private String inviteType;
}

View File

@@ -0,0 +1,77 @@
package com.yolo.keyboard.dal.dataobject.userinvitecodes;
import com.yolo.keyboard.framework.tenant.core.aop.TenantIgnore;
import lombok.*;
import java.util.*;
import java.time.LocalDateTime;
import java.time.LocalDateTime;
import com.baomidou.mybatisplus.annotation.*;
import com.yolo.keyboard.framework.mybatis.core.dataobject.BaseDO;
/**
* 用户生成的邀请码表,用于邀请新用户注册/安装并建立邀请关系 DO
*
* @author ziin
*/
@TableName("keyboard_user_invite_codes")
@KeySequence("keyboard_user_invite_codes_seq") // 用于 Oracle、PostgreSQL、Kingbase、DB2、H2 数据库的主键自增。如果是 MySQL 等数据库,可不写。
@Data
@ToString(callSuper = true)
@Builder
@NoArgsConstructor
@AllArgsConstructor
@TenantIgnore
public class KeyboardUserInviteCodesDO {
/**
* 邀请码主键ID
*/
@TableId
private Long id;
/**
* 邀请码字符串,对外展示,唯一
*/
private String code;
/**
* 邀请码所属用户ID邀请人
*/
private Long ownerUserId;
/**
* 邀请码状态1=启用0=停用
*/
private Short status;
/**
* 邀请码创建时间
*/
private LocalDateTime createdAt;
/**
* 邀请码过期时间NULL表示永久有效
*/
private LocalDateTime expiresAt;
/**
* 邀请码最大可使用次数NULL表示不限次数
*/
private Integer maxUses;
/**
* 邀请码已使用次数
*/
private Integer usedCount;
/**
* 邀请码所属系统用户ID邀请人
*/
private Long systemUserId;
/**
* 邀请码所属租户
*/
private Long ownerTenantId;
/**
* 邀请码所属系统用户
*/
private Long owenrSystemUserId;
/**
* 邀请码类型
*/
private String inviteType;
}

View File

@@ -0,0 +1,36 @@
package com.yolo.keyboard.dal.mysql.userinvitecodes;
import java.util.*;
import com.yolo.keyboard.framework.common.pojo.PageResult;
import com.yolo.keyboard.framework.mybatis.core.query.LambdaQueryWrapperX;
import com.yolo.keyboard.framework.mybatis.core.mapper.BaseMapperX;
import com.yolo.keyboard.dal.dataobject.userinvitecodes.KeyboardUserInviteCodesDO;
import org.apache.ibatis.annotations.Mapper;
import com.yolo.keyboard.controller.admin.userinvitecodes.vo.*;
/**
* 用户生成的邀请码表,用于邀请新用户注册/安装并建立邀请关系 Mapper
*
* @author ziin
*/
@Mapper
public interface KeyboardUserInviteCodesMapper extends BaseMapperX<KeyboardUserInviteCodesDO> {
default PageResult<KeyboardUserInviteCodesDO> selectPage(KeyboardUserInviteCodesPageReqVO reqVO) {
return selectPage(reqVO, new LambdaQueryWrapperX<KeyboardUserInviteCodesDO>()
.eqIfPresent(KeyboardUserInviteCodesDO::getCode, reqVO.getCode())
.eqIfPresent(KeyboardUserInviteCodesDO::getOwnerUserId, reqVO.getOwnerUserId())
.eqIfPresent(KeyboardUserInviteCodesDO::getStatus, reqVO.getStatus())
.eqIfPresent(KeyboardUserInviteCodesDO::getCreatedAt, reqVO.getCreatedAt())
.eqIfPresent(KeyboardUserInviteCodesDO::getExpiresAt, reqVO.getExpiresAt())
.eqIfPresent(KeyboardUserInviteCodesDO::getMaxUses, reqVO.getMaxUses())
.eqIfPresent(KeyboardUserInviteCodesDO::getUsedCount, reqVO.getUsedCount())
.eqIfPresent(KeyboardUserInviteCodesDO::getSystemUserId, reqVO.getSystemUserId())
.eqIfPresent(KeyboardUserInviteCodesDO::getOwnerTenantId, reqVO.getOwnerTenantId())
.eqIfPresent(KeyboardUserInviteCodesDO::getOwenrSystemUserId, reqVO.getOwenrSystemUserId())
.eqIfPresent(KeyboardUserInviteCodesDO::getInviteType, reqVO.getInviteType())
.orderByDesc(KeyboardUserInviteCodesDO::getId));
}
}

View File

@@ -0,0 +1,62 @@
package com.yolo.keyboard.service.userinvitecodes;
import java.util.*;
import jakarta.validation.*;
import com.yolo.keyboard.controller.admin.userinvitecodes.vo.*;
import com.yolo.keyboard.dal.dataobject.userinvitecodes.KeyboardUserInviteCodesDO;
import com.yolo.keyboard.framework.common.pojo.PageResult;
import com.yolo.keyboard.framework.common.pojo.PageParam;
/**
* 用户生成的邀请码表,用于邀请新用户注册/安装并建立邀请关系 Service 接口
*
* @author ziin
*/
public interface KeyboardUserInviteCodesService {
/**
* 创建用户生成的邀请码表,用于邀请新用户注册/安装并建立邀请关系
*
* @param createReqVO 创建信息
* @return 编号
*/
Long createUserInviteCodes(@Valid KeyboardUserInviteCodesSaveReqVO createReqVO);
/**
* 更新用户生成的邀请码表,用于邀请新用户注册/安装并建立邀请关系
*
* @param updateReqVO 更新信息
*/
void updateUserInviteCodes(@Valid KeyboardUserInviteCodesSaveReqVO updateReqVO);
/**
* 删除用户生成的邀请码表,用于邀请新用户注册/安装并建立邀请关系
*
* @param id 编号
*/
void deleteUserInviteCodes(Long id);
/**
* 批量删除用户生成的邀请码表,用于邀请新用户注册/安装并建立邀请关系
*
* @param ids 编号
*/
void deleteUserInviteCodesListByIds(List<Long> ids);
/**
* 获得用户生成的邀请码表,用于邀请新用户注册/安装并建立邀请关系
*
* @param id 编号
* @return 用户生成的邀请码表,用于邀请新用户注册/安装并建立邀请关系
*/
KeyboardUserInviteCodesDO getUserInviteCodes(Long id);
/**
* 获得用户生成的邀请码表,用于邀请新用户注册/安装并建立邀请关系分页
*
* @param pageReqVO 分页查询
* @return 用户生成的邀请码表,用于邀请新用户注册/安装并建立邀请关系分页
*/
PageResult<KeyboardUserInviteCodesDO> getUserInviteCodesPage(KeyboardUserInviteCodesPageReqVO pageReqVO);
}

View File

@@ -0,0 +1,85 @@
package com.yolo.keyboard.service.userinvitecodes;
import cn.hutool.core.collection.CollUtil;
import org.springframework.stereotype.Service;
import jakarta.annotation.Resource;
import org.springframework.validation.annotation.Validated;
import org.springframework.transaction.annotation.Transactional;
import java.util.*;
import com.yolo.keyboard.controller.admin.userinvitecodes.vo.*;
import com.yolo.keyboard.dal.dataobject.userinvitecodes.KeyboardUserInviteCodesDO;
import com.yolo.keyboard.framework.common.pojo.PageResult;
import com.yolo.keyboard.framework.common.pojo.PageParam;
import com.yolo.keyboard.framework.common.util.object.BeanUtils;
import com.yolo.keyboard.dal.mysql.userinvitecodes.KeyboardUserInviteCodesMapper;
import static com.yolo.keyboard.framework.common.exception.util.ServiceExceptionUtil.exception;
import static com.yolo.keyboard.framework.common.util.collection.CollectionUtils.convertList;
import static com.yolo.keyboard.framework.common.util.collection.CollectionUtils.diffList;
import static com.yolo.keyboard.module.infra.enums.ErrorCodeConstants.USER_INVITE_CODES_NOT_EXISTS;
/**
* 用户生成的邀请码表,用于邀请新用户注册/安装并建立邀请关系 Service 实现类
*
* @author ziin
*/
@Service
@Validated
public class KeyboardUserInviteCodesServiceImpl implements KeyboardUserInviteCodesService {
@Resource
private KeyboardUserInviteCodesMapper userInviteCodesMapper;
@Override
public Long createUserInviteCodes(KeyboardUserInviteCodesSaveReqVO createReqVO) {
// 插入
KeyboardUserInviteCodesDO userInviteCodes = BeanUtils.toBean(createReqVO, KeyboardUserInviteCodesDO.class);
userInviteCodesMapper.insert(userInviteCodes);
// 返回
return userInviteCodes.getId();
}
@Override
public void updateUserInviteCodes(KeyboardUserInviteCodesSaveReqVO updateReqVO) {
// 校验存在
validateUserInviteCodesExists(updateReqVO.getId());
// 更新
KeyboardUserInviteCodesDO updateObj = BeanUtils.toBean(updateReqVO, KeyboardUserInviteCodesDO.class);
userInviteCodesMapper.updateById(updateObj);
}
@Override
public void deleteUserInviteCodes(Long id) {
// 校验存在
validateUserInviteCodesExists(id);
// 删除
userInviteCodesMapper.deleteById(id);
}
@Override
public void deleteUserInviteCodesListByIds(List<Long> ids) {
// 删除
userInviteCodesMapper.deleteByIds(ids);
}
private void validateUserInviteCodesExists(Long id) {
if (userInviteCodesMapper.selectById(id) == null) {
throw exception(USER_INVITE_CODES_NOT_EXISTS);
}
}
@Override
public KeyboardUserInviteCodesDO getUserInviteCodes(Long id) {
return userInviteCodesMapper.selectById(id);
}
@Override
public PageResult<KeyboardUserInviteCodesDO> getUserInviteCodesPage(KeyboardUserInviteCodesPageReqVO pageReqVO) {
return userInviteCodesMapper.selectPage(pageReqVO);
}
}

View File

@@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.yolo.keyboard.dal.mysql.userinvitecodes.KeyboardUserInviteCodesMapper">
<!--
一般情况下,尽可能使用 Mapper 进行 CRUD 增删改查即可。
无法满足的场景,例如说多表关联查询,才使用 XML 编写 SQL。
代码生成器暂时只生成 Mapper XML 文件本身,更多推荐 MybatisX 快速开发插件来生成查询。
文档可见https://www.iocoder.cn/MyBatis/x-plugins/
-->
</mapper>