feat(user-quota): 新增用户永久总次数额度管理功能

2025-12-24 20:19:46 +08:00
parent a5d2125d90
commit bb1b1af3ea
10 changed files with 451 additions and 0 deletions
--- a/keyboard-server/src/main/java/com/yolo/keyboard/controller/admin/userquotatotal/KeyboardUserQuotaTotalController.java
+++ b/keyboard-server/src/main/java/com/yolo/keyboard/controller/admin/userquotatotal/KeyboardUserQuotaTotalController.java
@@ -0,0 +1,104 @@
+package com.yolo.keyboard.controller.admin.userquotatotal;
+
+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.userquotatotal.vo.*;
+import com.yolo.keyboard.dal.dataobject.userquotatotal.KeyboardUserQuotaTotalDO;
+import com.yolo.keyboard.service.userquotatotal.KeyboardUserQuotaTotalService;
+
+@Tag(name = "管理后台 - 用户免费功能永久总次数额度表（所有功能共用）")
+@RestController
+@RequestMapping("/keyboard/user-quota-total")
+@Validated
+public class KeyboardUserQuotaTotalController {
+
+    @Resource
+    private KeyboardUserQuotaTotalService userQuotaTotalService;
+
+    @PostMapping("/create")
+    @Operation(summary = "创建用户免费功能永久总次数额度表（所有功能共用）")
+    @PreAuthorize("@ss.hasPermission('keyboard:user-quota-total:create')")
+    public CommonResult<Long> createUserQuotaTotal(@Valid @RequestBody KeyboardUserQuotaTotalSaveReqVO createReqVO) {
+        return success(userQuotaTotalService.createUserQuotaTotal(createReqVO));
+    }
+
+    @PutMapping("/update")
+    @Operation(summary = "更新用户免费功能永久总次数额度表（所有功能共用）")
+    @PreAuthorize("@ss.hasPermission('keyboard:user-quota-total:update')")
+    public CommonResult<Boolean> updateUserQuotaTotal(@Valid @RequestBody KeyboardUserQuotaTotalSaveReqVO updateReqVO) {
+        userQuotaTotalService.updateUserQuotaTotal(updateReqVO);
+        return success(true);
+    }
+
+    @DeleteMapping("/delete")
+    @Operation(summary = "删除用户免费功能永久总次数额度表（所有功能共用）")
+    @Parameter(name = "id", description = "编号", required = true)
+    @PreAuthorize("@ss.hasPermission('keyboard:user-quota-total:delete')")
+    public CommonResult<Boolean> deleteUserQuotaTotal(@RequestParam("id") Long id) {
+        userQuotaTotalService.deleteUserQuotaTotal(id);
+        return success(true);
+    }
+
+    @DeleteMapping("/delete-list")
+    @Parameter(name = "ids", description = "编号", required = true)
+    @Operation(summary = "批量删除用户免费功能永久总次数额度表（所有功能共用）")
+                @PreAuthorize("@ss.hasPermission('keyboard:user-quota-total:delete')")
+    public CommonResult<Boolean> deleteUserQuotaTotalList(@RequestParam("ids") List<Long> ids) {
+        userQuotaTotalService.deleteUserQuotaTotalListByIds(ids);
+        return success(true);
+    }
+
+    @GetMapping("/get")
+    @Operation(summary = "获得用户免费功能永久总次数额度表（所有功能共用）")
+    @Parameter(name = "id", description = "编号", required = true, example = "1024")
+    @PreAuthorize("@ss.hasPermission('keyboard:user-quota-total:query')")
+    public CommonResult<KeyboardUserQuotaTotalRespVO> getUserQuotaTotal(@RequestParam("id") Long id) {
+        KeyboardUserQuotaTotalDO userQuotaTotal = userQuotaTotalService.getUserQuotaTotal(id);
+        return success(BeanUtils.toBean(userQuotaTotal, KeyboardUserQuotaTotalRespVO.class));
+    }
+
+    @GetMapping("/page")
+    @Operation(summary = "获得用户免费功能永久总次数额度表（所有功能共用）分页")
+    @PreAuthorize("@ss.hasPermission('keyboard:user-quota-total:query')")
+    public CommonResult<PageResult<KeyboardUserQuotaTotalRespVO>> getUserQuotaTotalPage(@Valid KeyboardUserQuotaTotalPageReqVO pageReqVO) {
+        PageResult<KeyboardUserQuotaTotalDO> pageResult = userQuotaTotalService.getUserQuotaTotalPage(pageReqVO);
+        return success(BeanUtils.toBean(pageResult, KeyboardUserQuotaTotalRespVO.class));
+    }
+
+    @GetMapping("/export-excel")
+    @Operation(summary = "导出用户免费功能永久总次数额度表（所有功能共用） Excel")
+    @PreAuthorize("@ss.hasPermission('keyboard:user-quota-total:export')")
+    @ApiAccessLog(operateType = EXPORT)
+    public void exportUserQuotaTotalExcel(@Valid KeyboardUserQuotaTotalPageReqVO pageReqVO,
+              HttpServletResponse response) throws IOException {
+        pageReqVO.setPageSize(PageParam.PAGE_SIZE_NONE);
+        List<KeyboardUserQuotaTotalDO> list = userQuotaTotalService.getUserQuotaTotalPage(pageReqVO).getList();
+        // 导出 Excel
+        ExcelUtils.write(response, "用户免费功能永久总次数额度表（所有功能共用）.xls", "数据", KeyboardUserQuotaTotalRespVO.class,
+                        BeanUtils.toBean(list, KeyboardUserQuotaTotalRespVO.class));
+    }
+
+}
--- a/keyboard-server/src/main/java/com/yolo/keyboard/controller/admin/userquotatotal/vo/KeyboardUserQuotaTotalPageReqVO.java
+++ b/keyboard-server/src/main/java/com/yolo/keyboard/controller/admin/userquotatotal/vo/KeyboardUserQuotaTotalPageReqVO.java
@@ -0,0 +1,31 @@
+package com.yolo.keyboard.controller.admin.userquotatotal.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 KeyboardUserQuotaTotalPageReqVO extends PageParam {
+
+    @Schema(description = "免费体验的永久总次数上限（可通过运营活动增加）")
+    private Integer totalQuota;
+
+    @Schema(description = "已消耗的免费次数")
+    private Integer usedQuota;
+
+    @Schema(description = "乐观锁版本号（并发控制预留字段）")
+    private Integer version;
+
+    @Schema(description = "首次创建额度记录的时间（通常为注册时间）")
+    private LocalDateTime createdAt;
+
+    @Schema(description = "最近一次额度发生变化的时间（消耗或赠送）")
+    private LocalDateTime updatedAt;
+
+}
--- a/keyboard-server/src/main/java/com/yolo/keyboard/controller/admin/userquotatotal/vo/KeyboardUserQuotaTotalRespVO.java
+++ b/keyboard-server/src/main/java/com/yolo/keyboard/controller/admin/userquotatotal/vo/KeyboardUserQuotaTotalRespVO.java
@@ -0,0 +1,39 @@
+package com.yolo.keyboard.controller.admin.userquotatotal.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 KeyboardUserQuotaTotalRespVO {
+
+    @Schema(description = "用户唯一ID，对应系统用户", requiredMode = Schema.RequiredMode.REQUIRED, example = "19113")
+    @ExcelProperty("用户唯一ID，对应系统用户")
+    private Long userId;
+
+    @Schema(description = "免费体验的永久总次数上限（可通过运营活动增加）", requiredMode = Schema.RequiredMode.REQUIRED)
+    @ExcelProperty("免费体验的永久总次数上限（可通过运营活动增加）")
+    private Integer totalQuota;
+
+    @Schema(description = "已消耗的免费次数", requiredMode = Schema.RequiredMode.REQUIRED)
+    @ExcelProperty("已消耗的免费次数")
+    private Integer usedQuota;
+
+    @Schema(description = "乐观锁版本号（并发控制预留字段）", requiredMode = Schema.RequiredMode.REQUIRED)
+    @ExcelProperty("乐观锁版本号（并发控制预留字段）")
+    private Integer version;
+
+    @Schema(description = "首次创建额度记录的时间（通常为注册时间）", requiredMode = Schema.RequiredMode.REQUIRED)
+    @ExcelProperty("首次创建额度记录的时间（通常为注册时间）")
+    private LocalDateTime createdAt;
+
+    @Schema(description = "最近一次额度发生变化的时间（消耗或赠送）", requiredMode = Schema.RequiredMode.REQUIRED)
+    @ExcelProperty("最近一次额度发生变化的时间（消耗或赠送）")
+    private LocalDateTime updatedAt;
+
+}
--- a/keyboard-server/src/main/java/com/yolo/keyboard/controller/admin/userquotatotal/vo/KeyboardUserQuotaTotalSaveReqVO.java
+++ b/keyboard-server/src/main/java/com/yolo/keyboard/controller/admin/userquotatotal/vo/KeyboardUserQuotaTotalSaveReqVO.java
@@ -0,0 +1,37 @@
+package com.yolo.keyboard.controller.admin.userquotatotal.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 KeyboardUserQuotaTotalSaveReqVO {
+
+    @Schema(description = "用户唯一ID，对应系统用户", requiredMode = Schema.RequiredMode.REQUIRED, example = "19113")
+    private Long userId;
+
+    @Schema(description = "免费体验的永久总次数上限（可通过运营活动增加）", requiredMode = Schema.RequiredMode.REQUIRED)
+    @NotNull(message = "免费体验的永久总次数上限（可通过运营活动增加）不能为空")
+    private Integer totalQuota;
+
+    @Schema(description = "已消耗的免费次数", requiredMode = Schema.RequiredMode.REQUIRED)
+    @NotNull(message = "已消耗的免费次数不能为空")
+    private Integer usedQuota;
+
+    @Schema(description = "乐观锁版本号（并发控制预留字段）", requiredMode = Schema.RequiredMode.REQUIRED)
+    @NotNull(message = "乐观锁版本号（并发控制预留字段）不能为空")
+    private Integer version;
+
+    @Schema(description = "首次创建额度记录的时间（通常为注册时间）", requiredMode = Schema.RequiredMode.REQUIRED)
+    @NotNull(message = "首次创建额度记录的时间（通常为注册时间）不能为空")
+    private LocalDateTime createdAt;
+
+    @Schema(description = "最近一次额度发生变化的时间（消耗或赠送）", requiredMode = Schema.RequiredMode.REQUIRED)
+    @NotNull(message = "最近一次额度发生变化的时间（消耗或赠送）不能为空")
+    private LocalDateTime updatedAt;
+
+}
--- a/keyboard-server/src/main/java/com/yolo/keyboard/dal/dataobject/userquotatotal/KeyboardUserQuotaTotalDO.java
+++ b/keyboard-server/src/main/java/com/yolo/keyboard/dal/dataobject/userquotatotal/KeyboardUserQuotaTotalDO.java
@@ -0,0 +1,53 @@
+package com.yolo.keyboard.dal.dataobject.userquotatotal;
+
+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 芋道源码
+ */
+@TableName("keyboard_user_quota_total")
+@KeySequence("keyboard_user_quota_total_seq") // 用于 Oracle、PostgreSQL、Kingbase、DB2、H2 数据库的主键自增。如果是 MySQL 等数据库，可不写。
+@Data
+@ToString(callSuper = true)
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+@TenantIgnore
+public class KeyboardUserQuotaTotalDO{
+
+    /**
+     * 用户唯一ID，对应系统用户
+     */
+    @TableId
+    private Long userId;
+    /**
+     * 免费体验的永久总次数上限（可通过运营活动增加）
+     */
+    private Integer totalQuota;
+    /**
+     * 已消耗的免费次数
+     */
+    private Integer usedQuota;
+    /**
+     * 乐观锁版本号（并发控制预留字段）
+     */
+    private Integer version;
+    /**
+     * 首次创建额度记录的时间（通常为注册时间）
+     */
+    private LocalDateTime createdAt;
+    /**
+     * 最近一次额度发生变化的时间（消耗或赠送）
+     */
+    private LocalDateTime updatedAt;
+
+
+}
--- a/keyboard-server/src/main/java/com/yolo/keyboard/dal/mysql/userquotatotal/KeyboardUserQuotaTotalMapper.java
+++ b/keyboard-server/src/main/java/com/yolo/keyboard/dal/mysql/userquotatotal/KeyboardUserQuotaTotalMapper.java
@@ -0,0 +1,30 @@
+package com.yolo.keyboard.dal.mysql.userquotatotal;
+
+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.userquotatotal.KeyboardUserQuotaTotalDO;
+import org.apache.ibatis.annotations.Mapper;
+import com.yolo.keyboard.controller.admin.userquotatotal.vo.*;
+
+/**
+ * 用户免费功能永久总次数额度表（所有功能共用） Mapper
+ *
+ * @author 芋道源码
+ */
+@Mapper
+public interface KeyboardUserQuotaTotalMapper extends BaseMapperX<KeyboardUserQuotaTotalDO> {
+
+    default PageResult<KeyboardUserQuotaTotalDO> selectPage(KeyboardUserQuotaTotalPageReqVO reqVO) {
+        return selectPage(reqVO, new LambdaQueryWrapperX<KeyboardUserQuotaTotalDO>()
+                .eqIfPresent(KeyboardUserQuotaTotalDO::getTotalQuota, reqVO.getTotalQuota())
+                .eqIfPresent(KeyboardUserQuotaTotalDO::getUsedQuota, reqVO.getUsedQuota())
+                .eqIfPresent(KeyboardUserQuotaTotalDO::getVersion, reqVO.getVersion())
+                .eqIfPresent(KeyboardUserQuotaTotalDO::getCreatedAt, reqVO.getCreatedAt())
+                .eqIfPresent(KeyboardUserQuotaTotalDO::getUpdatedAt, reqVO.getUpdatedAt())
+                .orderByDesc(KeyboardUserQuotaTotalDO::getUserId));
+    }
+
+}
--- a/keyboard-server/src/main/java/com/yolo/keyboard/service/userquotatotal/KeyboardUserQuotaTotalService.java
+++ b/keyboard-server/src/main/java/com/yolo/keyboard/service/userquotatotal/KeyboardUserQuotaTotalService.java
@@ -0,0 +1,62 @@
+package com.yolo.keyboard.service.userquotatotal;
+
+import java.util.*;
+import jakarta.validation.*;
+import com.yolo.keyboard.controller.admin.userquotatotal.vo.*;
+import com.yolo.keyboard.dal.dataobject.userquotatotal.KeyboardUserQuotaTotalDO;
+import com.yolo.keyboard.framework.common.pojo.PageResult;
+import com.yolo.keyboard.framework.common.pojo.PageParam;
+
+/**
+ * 用户免费功能永久总次数额度表（所有功能共用） Service 接口
+ *
+ * @author 芋道源码
+ */
+public interface KeyboardUserQuotaTotalService {
+
+    /**
+     * 创建用户免费功能永久总次数额度表（所有功能共用）
+     *
+     * @param createReqVO 创建信息
+     * @return 编号
+     */
+    Long createUserQuotaTotal(@Valid KeyboardUserQuotaTotalSaveReqVO createReqVO);
+
+    /**
+     * 更新用户免费功能永久总次数额度表（所有功能共用）
+     *
+     * @param updateReqVO 更新信息
+     */
+    void updateUserQuotaTotal(@Valid KeyboardUserQuotaTotalSaveReqVO updateReqVO);
+
+    /**
+     * 删除用户免费功能永久总次数额度表（所有功能共用）
+     *
+     * @param id 编号
+     */
+    void deleteUserQuotaTotal(Long id);
+
+    /**
+    * 批量删除用户免费功能永久总次数额度表（所有功能共用）
+    *
+    * @param ids 编号
+    */
+    void deleteUserQuotaTotalListByIds(List<Long> ids);
+
+    /**
+     * 获得用户免费功能永久总次数额度表（所有功能共用）
+     *
+     * @param id 编号
+     * @return 用户免费功能永久总次数额度表（所有功能共用）
+     */
+    KeyboardUserQuotaTotalDO getUserQuotaTotal(Long id);
+
+    /**
+     * 获得用户免费功能永久总次数额度表（所有功能共用）分页
+     *
+     * @param pageReqVO 分页查询
+     * @return 用户免费功能永久总次数额度表（所有功能共用）分页
+     */
+    PageResult<KeyboardUserQuotaTotalDO> getUserQuotaTotalPage(KeyboardUserQuotaTotalPageReqVO pageReqVO);
+
+}
--- a/keyboard-server/src/main/java/com/yolo/keyboard/service/userquotatotal/KeyboardUserQuotaTotalServiceImpl.java
+++ b/keyboard-server/src/main/java/com/yolo/keyboard/service/userquotatotal/KeyboardUserQuotaTotalServiceImpl.java
@@ -0,0 +1,81 @@
+package com.yolo.keyboard.service.userquotatotal;
+
+import cn.hutool.core.collection.CollUtil;
+import org.springframework.stereotype.Service;
+import jakarta.annotation.Resource;
+import org.springframework.validation.annotation.Validated;
+
+import java.util.*;
+import com.yolo.keyboard.controller.admin.userquotatotal.vo.*;
+import com.yolo.keyboard.dal.dataobject.userquotatotal.KeyboardUserQuotaTotalDO;
+import com.yolo.keyboard.framework.common.pojo.PageResult;
+import com.yolo.keyboard.framework.common.util.object.BeanUtils;
+
+import com.yolo.keyboard.dal.mysql.userquotatotal.KeyboardUserQuotaTotalMapper;
+
+import static com.yolo.keyboard.framework.common.exception.util.ServiceExceptionUtil.exception;
+import static com.yolo.keyboard.module.infra.enums.ErrorCodeConstants.USER_QUOTA_TOTAL_NOT_EXISTS;
+
+/**
+ * 用户免费功能永久总次数额度表（所有功能共用） Service 实现类
+ *
+ * @author 芋道源码
+ */
+@Service
+@Validated
+public class KeyboardUserQuotaTotalServiceImpl implements KeyboardUserQuotaTotalService {
+
+    @Resource
+    private KeyboardUserQuotaTotalMapper userQuotaTotalMapper;
+
+    @Override
+    public Long createUserQuotaTotal(KeyboardUserQuotaTotalSaveReqVO createReqVO) {
+        // 插入
+        KeyboardUserQuotaTotalDO userQuotaTotal = BeanUtils.toBean(createReqVO, KeyboardUserQuotaTotalDO.class);
+        userQuotaTotalMapper.insert(userQuotaTotal);
+
+        // 返回
+        return userQuotaTotal.getUserId();
+    }
+
+    @Override
+    public void updateUserQuotaTotal(KeyboardUserQuotaTotalSaveReqVO updateReqVO) {
+        // 校验存在
+        validateUserQuotaTotalExists(updateReqVO.getUserId());
+        // 更新
+        KeyboardUserQuotaTotalDO updateObj = BeanUtils.toBean(updateReqVO, KeyboardUserQuotaTotalDO.class);
+        userQuotaTotalMapper.updateById(updateObj);
+    }
+
+    @Override
+    public void deleteUserQuotaTotal(Long id) {
+        // 校验存在
+        validateUserQuotaTotalExists(id);
+        // 删除
+        userQuotaTotalMapper.deleteById(id);
+    }
+
+    @Override
+        public void deleteUserQuotaTotalListByIds(List<Long> ids) {
+        // 删除
+        userQuotaTotalMapper.deleteByIds(ids);
+        }
+
+
+    private void validateUserQuotaTotalExists(Long id) {
+        if (userQuotaTotalMapper.selectById(id) == null) {
+            throw exception(USER_QUOTA_TOTAL_NOT_EXISTS);
+        }
+    }
+
+    @Override
+    public KeyboardUserQuotaTotalDO getUserQuotaTotal(Long id) {
+        return userQuotaTotalMapper.selectById(id);
+    }
+
+    @Override
+    public PageResult<KeyboardUserQuotaTotalDO> getUserQuotaTotalPage(KeyboardUserQuotaTotalPageReqVO pageReqVO) {
+        return userQuotaTotalMapper.selectPage(pageReqVO);
+    }
+
+}
--- a/keyboard-server/src/main/resources/mapper/userquotatotal/KeyboardUserQuotaTotalMapper.xml
+++ b/keyboard-server/src/main/resources/mapper/userquotatotal/KeyboardUserQuotaTotalMapper.xml
@@ -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.userquotatotal.KeyboardUserQuotaTotalMapper">
+
+    <!--
+        一般情况下，尽可能使用 Mapper 进行 CRUD 增删改查即可。
+        无法满足的场景，例如说多表关联查询，才使用 XML 编写 SQL。
+        代码生成器暂时只生成 Mapper XML 文件本身，更多推荐 MybatisX 快速开发插件来生成查询。
+        文档可见：https://www.iocoder.cn/MyBatis/x-plugins/
+     -->
+
+</mapper>