feat(keyboard): 新增键盘用户管理模块

新增 keyboard-server 子模块，含用户 DO/Mapper/Service/Controller 全套代码；补充错误码 KEYBOARD_USER_NOT_EXISTS；主工程引入 keyboard-server 依赖并扩展包扫描路径。
2025-12-23 21:39:38 +08:00
parent 368639f275
commit 6394818d6b
16 changed files with 655 additions and 14 deletions
--- a/keyboard-server/src/main/java/com/yolo/keyboard/controller/admin/user/KeyboardUserController.java
+++ b/keyboard-server/src/main/java/com/yolo/keyboard/controller/admin/user/KeyboardUserController.java
@@ -0,0 +1,105 @@
+package com.yolo.keyboard.controller.admin.user;
+
+import com.yolo.keyboard.dal.dataobject.user.KeyboardUserDO;
+import com.yolo.keyboard.controller.admin.user.vo.KeyboardUserPageReqVO;
+import com.yolo.keyboard.controller.admin.user.vo.KeyboardUserRespVO;
+import com.yolo.keyboard.controller.admin.user.vo.KeyboardUserSaveReqVO;
+import com.yolo.keyboard.service.user.KeyboardUserService;
+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.*;
+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.*;
+
+
+@Tag(name = "管理后台 - 键盘用户")
+@RestController
+@RequestMapping("/keyboard-server/keyboard-user")
+@Validated
+public class KeyboardUserController {
+
+    @Resource
+    private KeyboardUserService keyboardUserService;
+
+    @PostMapping("/create")
+    @Operation(summary = "创建键盘用户")
+    @PreAuthorize("@ss.hasPermission('keyboard-server:keyboard-user:create')")
+    public CommonResult<Long> createKeyboardUser(@Valid @RequestBody KeyboardUserSaveReqVO createReqVO) {
+        return success(keyboardUserService.createKeyboardUser(createReqVO));
+    }
+
+    @PutMapping("/update")
+    @Operation(summary = "更新键盘用户")
+    @PreAuthorize("@ss.hasPermission('keyboard-server:keyboard-user:update')")
+    public CommonResult<Boolean> updateKeyboardUser(@Valid @RequestBody KeyboardUserSaveReqVO updateReqVO) {
+        keyboardUserService.updateKeyboardUser(updateReqVO);
+        return success(true);
+    }
+
+    @DeleteMapping("/delete")
+    @Operation(summary = "删除键盘用户")
+    @Parameter(name = "id", description = "编号", required = true)
+    @PreAuthorize("@ss.hasPermission('keyboard-server:keyboard-user:delete')")
+    public CommonResult<Boolean> deleteKeyboardUser(@RequestParam("id") Long id) {
+        keyboardUserService.deleteKeyboardUser(id);
+        return success(true);
+    }
+
+    @DeleteMapping("/delete-list")
+    @Parameter(name = "ids", description = "编号", required = true)
+    @Operation(summary = "批量删除键盘用户")
+                @PreAuthorize("@ss.hasPermission('keyboard-server:keyboard-user:delete')")
+    public CommonResult<Boolean> deleteKeyboardUserList(@RequestParam("ids") List<Long> ids) {
+        keyboardUserService.deleteKeyboardUserListByIds(ids);
+        return success(true);
+    }
+
+    @GetMapping("/get")
+    @Operation(summary = "获得键盘用户")
+    @Parameter(name = "id", description = "编号", required = true, example = "1024")
+    @PreAuthorize("@ss.hasPermission('keyboard-server:keyboard-user:query')")
+    public CommonResult<KeyboardUserRespVO> getKeyboardUser(@RequestParam("id") Long id) {
+        KeyboardUserDO keyboardUser = keyboardUserService.getKeyboardUser(id);
+        return success(BeanUtils.toBean(keyboardUser, KeyboardUserRespVO.class));
+    }
+
+    @GetMapping("/page")
+    @Operation(summary = "获得键盘用户分页")
+    @PreAuthorize("@ss.hasPermission('keyboard-server:keyboard-user:query')")
+    public CommonResult<PageResult<KeyboardUserRespVO>> getKeyboardUserPage(@Valid KeyboardUserPageReqVO pageReqVO) {
+        PageResult<KeyboardUserDO> pageResult = keyboardUserService.getKeyboardUserPage(pageReqVO);
+        return success(BeanUtils.toBean(pageResult, KeyboardUserRespVO.class));
+    }
+
+    @GetMapping("/export-excel")
+    @Operation(summary = "导出键盘用户 Excel")
+    @PreAuthorize("@ss.hasPermission('keyboard-server:keyboard-user:export')")
+    @ApiAccessLog(operateType = EXPORT)
+    public void exportKeyboardUserExcel(@Valid KeyboardUserPageReqVO pageReqVO,
+              HttpServletResponse response) throws IOException {
+        pageReqVO.setPageSize(PageParam.PAGE_SIZE_NONE);
+        List<KeyboardUserDO> list = keyboardUserService.getKeyboardUserPage(pageReqVO).getList();
+        // 导出 Excel
+        ExcelUtils.write(response, "键盘用户.xls", "数据", KeyboardUserRespVO.class,
+                        BeanUtils.toBean(list, KeyboardUserRespVO.class));
+    }
+
+}
--- a/keyboard-server/src/main/java/com/yolo/keyboard/controller/admin/user/vo/KeyboardUserPageReqVO.java
+++ b/keyboard-server/src/main/java/com/yolo/keyboard/controller/admin/user/vo/KeyboardUserPageReqVO.java
@@ -0,0 +1,55 @@
+package com.yolo.keyboard.controller.admin.user.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 KeyboardUserPageReqVO extends PageParam {
+
+    @Schema(description = "用户 Id", example = "16033")
+    private Long uid;
+
+    @Schema(description = "用户昵称", example = "张三")
+    private String nickName;
+
+    @Schema(description = "性别")
+    private Integer gender;
+
+    @Schema(description = "头像地址", example = "https://www.iocoder.cn")
+    private String avatarUrl;
+
+    @Schema(description = "创建时间")
+    private LocalDateTime createdAt;
+
+    @Schema(description = "更新时间")
+    private LocalDateTime updatedAt;
+
+    @Schema(description = "邮箱地址")
+    private String email;
+
+    @Schema(description = "是否禁用", example = "1")
+    private Boolean status;
+
+    @Schema(description = "密码")
+    private String password;
+
+    @Schema(description = "苹果登录subjectId", example = "12266")
+    private String subjectId;
+
+    @Schema(description = "邮箱是否验证")
+    private Boolean emailVerified;
+
+    @Schema(description = "是否是 VIP")
+    private Boolean isVip;
+
+    @Schema(description = "VIP 过期时间")
+    private LocalDateTime vipExpiry;
+
+}
--- a/keyboard-server/src/main/java/com/yolo/keyboard/controller/admin/user/vo/KeyboardUserRespVO.java
+++ b/keyboard-server/src/main/java/com/yolo/keyboard/controller/admin/user/vo/KeyboardUserRespVO.java
@@ -0,0 +1,69 @@
+package com.yolo.keyboard.controller.admin.user.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 KeyboardUserRespVO {
+
+    @Schema(description = "主键", requiredMode = Schema.RequiredMode.REQUIRED, example = "22036")
+    @ExcelProperty("主键")
+    private Long id;
+
+    @Schema(description = "用户 Id", requiredMode = Schema.RequiredMode.REQUIRED, example = "16033")
+    @ExcelProperty("用户 Id")
+    private Long uid;
+
+    @Schema(description = "用户昵称", requiredMode = Schema.RequiredMode.REQUIRED, example = "张三")
+    @ExcelProperty("用户昵称")
+    private String nickName;
+
+    @Schema(description = "性别")
+    @ExcelProperty("性别")
+    private Integer gender;
+
+    @Schema(description = "头像地址", example = "https://www.iocoder.cn")
+    @ExcelProperty("头像地址")
+    private String avatarUrl;
+
+    @Schema(description = "创建时间")
+    @ExcelProperty("创建时间")
+    private LocalDateTime createdAt;
+
+    @Schema(description = "更新时间")
+    @ExcelProperty("更新时间")
+    private LocalDateTime updatedAt;
+
+    @Schema(description = "邮箱地址")
+    @ExcelProperty("邮箱地址")
+    private String email;
+
+    @Schema(description = "是否禁用", example = "1")
+    @ExcelProperty("是否禁用")
+    private Boolean status;
+
+
+
+    @Schema(description = "苹果登录subjectId", example = "12266")
+    @ExcelProperty("苹果登录subjectId")
+    private String subjectId;
+
+    @Schema(description = "邮箱是否验证")
+    @ExcelProperty("邮箱是否验证")
+    private Boolean emailVerified;
+
+    @Schema(description = "是否是 VIP")
+    @ExcelProperty("是否是 VIP")
+    private Boolean isVip;
+
+    @Schema(description = "VIP 过期时间")
+    @ExcelProperty("VIP 过期时间")
+    private LocalDateTime vipExpiry;
+
+}
--- a/keyboard-server/src/main/java/com/yolo/keyboard/controller/admin/user/vo/KeyboardUserSaveReqVO.java
+++ b/keyboard-server/src/main/java/com/yolo/keyboard/controller/admin/user/vo/KeyboardUserSaveReqVO.java
@@ -0,0 +1,58 @@
+package com.yolo.keyboard.controller.admin.user.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 KeyboardUserSaveReqVO {
+
+    @Schema(description = "主键", requiredMode = Schema.RequiredMode.REQUIRED, example = "22036")
+    private Long id;
+
+    @Schema(description = "用户 Id", requiredMode = Schema.RequiredMode.REQUIRED, example = "16033")
+    @NotNull(message = "用户 Id不能为空")
+    private Long uid;
+
+    @Schema(description = "用户昵称", requiredMode = Schema.RequiredMode.REQUIRED, example = "张三")
+    @NotEmpty(message = "用户昵称不能为空")
+    private String nickName;
+
+    @Schema(description = "性别")
+    private Integer gender;
+
+    @Schema(description = "头像地址", example = "https://www.iocoder.cn")
+    private String avatarUrl;
+
+    @Schema(description = "创建时间")
+    private LocalDateTime createdAt;
+
+    @Schema(description = "更新时间")
+    private LocalDateTime updatedAt;
+
+    @Schema(description = "邮箱地址")
+    private String email;
+
+    @Schema(description = "是否禁用", example = "1")
+    private Boolean status;
+
+    @Schema(description = "密码")
+    private String password;
+
+    @Schema(description = "苹果登录subjectId", example = "12266")
+    private String subjectId;
+
+    @Schema(description = "邮箱是否验证")
+    private Boolean emailVerified;
+
+    @Schema(description = "是否是 VIP")
+    private Boolean isVip;
+
+    @Schema(description = "VIP 过期时间")
+    private LocalDateTime vipExpiry;
+
+}
--- a/keyboard-server/src/main/java/com/yolo/keyboard/dal/dataobject/user/KeyboardUserDO.java
+++ b/keyboard-server/src/main/java/com/yolo/keyboard/dal/dataobject/user/KeyboardUserDO.java
@@ -0,0 +1,87 @@
+package com.yolo.keyboard.dal.dataobject.user;
+
+
+import com.yolo.keyboard.framework.tenant.core.aop.TenantIgnore;
+import lombok.*;
+import java.util.*;
+import java.time.LocalDateTime;
+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")
+@KeySequence("keyboard_user_seq") // 用于 Oracle、PostgreSQL、Kingbase、DB2、H2 数据库的主键自增。如果是 MySQL 等数据库，可不写。
+@Data
+@ToString(callSuper = true)
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+@TenantIgnore
+public class KeyboardUserDO  {
+
+    /**
+     * 主键
+     */
+    @TableId
+    private Long id;
+    /**
+     * 用户 Id
+     */
+    private Long uid;
+    /**
+     * 用户昵称
+     */
+    private String nickName;
+    /**
+     * 性别
+     */
+    private Integer gender;
+    /**
+     * 头像地址
+     */
+    private String avatarUrl;
+    /**
+     * 创建时间
+     */
+    private LocalDateTime createdAt;
+    /**
+     * 更新时间
+     */
+    private LocalDateTime updatedAt;
+    /**
+     * 邮箱地址
+     */
+    private String email;
+    /**
+     * 是否禁用
+     */
+    private Boolean status;
+    /**
+     * 密码
+     */
+    private String password;
+    /**
+     * 苹果登录subjectId
+     */
+    private String subjectId;
+    /**
+     * 邮箱是否验证
+     */
+    private Boolean emailVerified;
+    /**
+     * 是否是 VIP
+     */
+    private Boolean isVip;
+    /**
+     * VIP 过期时间
+     */
+    private LocalDateTime vipExpiry;
+
+
+}
--- a/keyboard-server/src/main/java/com/yolo/keyboard/dal/mysql/user/KeyboardUserMapper.java
+++ b/keyboard-server/src/main/java/com/yolo/keyboard/dal/mysql/user/KeyboardUserMapper.java
@@ -0,0 +1,38 @@
+package com.yolo.keyboard.dal.mysql.user;
+
+
+
+import com.yolo.keyboard.dal.dataobject.user.KeyboardUserDO;
+import com.yolo.keyboard.controller.admin.user.vo.KeyboardUserPageReqVO;
+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 org.apache.ibatis.annotations.Mapper;
+
+/**
+ * 键盘用户 Mapper
+ *
+ * @author ziin
+ */
+@Mapper
+public interface KeyboardUserMapper extends BaseMapperX<KeyboardUserDO> {
+
+    default PageResult<KeyboardUserDO> selectPage(KeyboardUserPageReqVO reqVO) {
+        return selectPage(reqVO, new LambdaQueryWrapperX<KeyboardUserDO>()
+                .eqIfPresent(KeyboardUserDO::getUid, reqVO.getUid())
+                .likeIfPresent(KeyboardUserDO::getNickName, reqVO.getNickName())
+                .eqIfPresent(KeyboardUserDO::getGender, reqVO.getGender())
+                .eqIfPresent(KeyboardUserDO::getAvatarUrl, reqVO.getAvatarUrl())
+                .eqIfPresent(KeyboardUserDO::getCreatedAt, reqVO.getCreatedAt())
+                .eqIfPresent(KeyboardUserDO::getUpdatedAt, reqVO.getUpdatedAt())
+                .eqIfPresent(KeyboardUserDO::getEmail, reqVO.getEmail())
+                .eqIfPresent(KeyboardUserDO::getStatus, reqVO.getStatus())
+                .eqIfPresent(KeyboardUserDO::getPassword, reqVO.getPassword())
+                .eqIfPresent(KeyboardUserDO::getSubjectId, reqVO.getSubjectId())
+                .eqIfPresent(KeyboardUserDO::getEmailVerified, reqVO.getEmailVerified())
+                .eqIfPresent(KeyboardUserDO::getIsVip, reqVO.getIsVip())
+                .eqIfPresent(KeyboardUserDO::getVipExpiry, reqVO.getVipExpiry())
+                .orderByDesc(KeyboardUserDO::getId));
+    }
+
+}
--- a/keyboard-server/src/main/java/com/yolo/keyboard/service/user/KeyboardUserService.java
+++ b/keyboard-server/src/main/java/com/yolo/keyboard/service/user/KeyboardUserService.java
@@ -0,0 +1,64 @@
+package com.yolo.keyboard.service.user;
+
+
+import java.util.*;
+
+import com.yolo.keyboard.dal.dataobject.user.KeyboardUserDO;
+import com.yolo.keyboard.controller.admin.user.vo.KeyboardUserPageReqVO;
+import com.yolo.keyboard.controller.admin.user.vo.KeyboardUserSaveReqVO;
+import jakarta.validation.*;
+import com.yolo.keyboard.framework.common.pojo.PageResult;
+
+/**
+ * 键盘用户 Service 接口
+ *
+ * @author ziin
+ */
+public interface KeyboardUserService {
+
+    /**
+     * 创建键盘用户
+     *
+     * @param createReqVO 创建信息
+     * @return 编号
+     */
+    Long createKeyboardUser(@Valid KeyboardUserSaveReqVO createReqVO);
+
+    /**
+     * 更新键盘用户
+     *
+     * @param updateReqVO 更新信息
+     */
+    void updateKeyboardUser(@Valid KeyboardUserSaveReqVO updateReqVO);
+
+    /**
+     * 删除键盘用户
+     *
+     * @param id 编号
+     */
+    void deleteKeyboardUser(Long id);
+
+    /**
+    * 批量删除键盘用户
+    *
+    * @param ids 编号
+    */
+    void deleteKeyboardUserListByIds(List<Long> ids);
+
+    /**
+     * 获得键盘用户
+     *
+     * @param id 编号
+     * @return 键盘用户
+     */
+    KeyboardUserDO getKeyboardUser(Long id);
+
+    /**
+     * 获得键盘用户分页
+     *
+     * @param pageReqVO 分页查询
+     * @return 键盘用户分页
+     */
+    PageResult<KeyboardUserDO> getKeyboardUserPage(KeyboardUserPageReqVO pageReqVO);
+
+}
--- a/keyboard-server/src/main/java/com/yolo/keyboard/service/user/KeyboardUserServiceImpl.java
+++ b/keyboard-server/src/main/java/com/yolo/keyboard/service/user/KeyboardUserServiceImpl.java
@@ -0,0 +1,82 @@
+package com.yolo.keyboard.service.user;
+
+
+import com.yolo.keyboard.dal.dataobject.user.KeyboardUserDO;
+import com.yolo.keyboard.dal.mysql.user.KeyboardUserMapper;
+import com.yolo.keyboard.controller.admin.user.vo.KeyboardUserPageReqVO;
+import com.yolo.keyboard.controller.admin.user.vo.KeyboardUserSaveReqVO;
+import org.springframework.stereotype.Service;
+import jakarta.annotation.Resource;
+import org.springframework.validation.annotation.Validated;
+
+import java.util.*;
+import com.yolo.keyboard.framework.common.pojo.PageResult;
+import com.yolo.keyboard.framework.common.util.object.BeanUtils;
+
+
+import static com.yolo.keyboard.framework.common.exception.util.ServiceExceptionUtil.exception;
+import static com.yolo.keyboard.module.infra.enums.ErrorCodeConstants.*;
+
+/**
+ * 键盘用户 Service 实现类
+ *
+ * @author ziin
+ */
+@Service
+@Validated
+public class KeyboardUserServiceImpl implements KeyboardUserService {
+
+    @Resource
+    private KeyboardUserMapper keyboardUserMapper;
+
+    @Override
+    public Long createKeyboardUser(KeyboardUserSaveReqVO createReqVO) {
+        // 插入
+        KeyboardUserDO keyboardUser = BeanUtils.toBean(createReqVO, KeyboardUserDO.class);
+        keyboardUserMapper.insert(keyboardUser);
+
+        // 返回
+        return keyboardUser.getId();
+    }
+
+    @Override
+    public void updateKeyboardUser(KeyboardUserSaveReqVO updateReqVO) {
+        // 校验存在
+        validateKeyboardUserExists(updateReqVO.getId());
+        // 更新
+        KeyboardUserDO updateObj = BeanUtils.toBean(updateReqVO, KeyboardUserDO.class);
+        keyboardUserMapper.updateById(updateObj);
+    }
+
+    @Override
+    public void deleteKeyboardUser(Long id) {
+        // 校验存在
+        validateKeyboardUserExists(id);
+        // 删除
+        keyboardUserMapper.deleteById(id);
+    }
+
+    @Override
+        public void deleteKeyboardUserListByIds(List<Long> ids) {
+        // 删除
+        keyboardUserMapper.deleteByIds(ids);
+        }
+
+
+    private void validateKeyboardUserExists(Long id) {
+        if (keyboardUserMapper.selectById(id) == null) {
+            throw exception(KEYBOARD_USER_NOT_EXISTS);
+        }
+    }
+
+    @Override
+    public KeyboardUserDO getKeyboardUser(Long id) {
+        return keyboardUserMapper.selectById(id);
+    }
+
+    @Override
+    public PageResult<KeyboardUserDO> getKeyboardUserPage(KeyboardUserPageReqVO pageReqVO) {
+        return keyboardUserMapper.selectPage(pageReqVO);
+    }
+
+}