代码规范

项目代码规范（Tduck-X 后端）

统一包前缀：

com.tduck.cloud.xxx

📦 包结构规范

包名 说明 命名规范
controller 接口层，处理 HTTP 请求 如UserController
constant 项目中的常量定义 如CommonConstants
entity 实体类，映射数据库表 命名以xxxEntity结尾
service 业务接口层 如UserService
impl service实现类 如UserServiceImpl
mapper 数据访问层，继承BaseMapper 如UserMapper
util 工具类 如UserUtils
request 接收前端参数的 DTO 类 命名以xxxRequest结尾
vo 接口响应返回封装类（VO） 命名以xxxVO结尾

🗄️ 表设计规范

表命名规范

  • 命名规则：[模块缩写]_[业务名]
    • 如：系统模块（tduck-system） ➝ sys_user, sys_role

字段规范（基础字段统一）

字段名 类型 说明
id bigint 主键，自增
create_by varchar 创建人账号名
create_time datetime 创建时间
update_by varchar 最后更新人
update_time datetime 最后更新时间

✅ 实体类统一继承 BaseEntity 或 SysBaseEntity，自动注入基础字段。

表设计示例：

CREATE TABLE `sys_user` (
  `id` bigint NOT NULL AUTO_INCREMENT COMMENT '用户ID',
  `create_by` varchar(64) DEFAULT '' COMMENT '创建者',
  `create_time` datetime DEFAULT NULL COMMENT '创建时间',
  `update_by` varchar(64) DEFAULT '' COMMENT '更新者',
  `update_time` datetime DEFAULT NULL COMMENT '更新时间',
  PRIMARY KEY (`id`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb3 COMMENT='用户信息表';

🧑‍💻 编码规范

  • 基础规范：
    • 命名语义清晰，驼峰命名法；
    • 类名统一使用大驼峰；
    • 业务方法遵循：动词 + 业务名（如：saveUser()、getById()）；
    • 工具类统一后缀为 Utils；
    • 接口返回统一使用 Result<T> 封装响应。
  • 建议使用 IDE 插件辅助检查：