添加开发规和skill
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
---
|
||||
inclusion: always
|
||||
inclusion: manual
|
||||
---
|
||||
|
||||
# 代码开发风格文档
|
||||
@@ -11,12 +11,12 @@ inclusion: always
|
||||
- `common` — 公共模块:配置、拦截器、工具类、统一响应、异常体系
|
||||
- `client-api` — C 端接口模块,依赖 manager
|
||||
- `manager` — 业务共享模块:实体、Mapper、业务服务,B 端和 C 端共用,依赖 common
|
||||
- 各模块内按职责分包:`controller`、`server`、`pojo`(dto/vo/po/param)、`mapper`、`config`、`aop`、`annotation`、`tool`、`constant`、`interceptor`
|
||||
- 各模块内按职责分包:`controller`、`service`、`pojo`(dto/vo/po/param)、`mapper`、`config`、`aop`、`annotation`、`tool`、`constant`、`interceptor`
|
||||
|
||||
## 命名约定
|
||||
|
||||
### 类命名
|
||||
- 服务层以 `Server` 结尾(不用 Service),如 `LoginServer`、`SmsServer`
|
||||
- 服务层以 `Service` 结尾,如 `LoginService`、`SmsService`
|
||||
- DTO 以 `Dto` 结尾,VO 以 `Vo` 结尾,Param 以 `Param` 结尾,PO 无后缀直接用业务名
|
||||
- Controller 以 `Controller` 结尾
|
||||
- 工具类以 `Tool` 结尾,如 `RedisServerTool`、`HttpIpTool`
|
||||
@@ -32,7 +32,7 @@ inclusion: always
|
||||
## 注解与依赖注入
|
||||
|
||||
- Controller 层:`@RestController` + `@RequestMapping`,构造器注入(`@AllArgsConstructor`)
|
||||
- Server 层:`@Service`,字段注入(`@Autowired`)
|
||||
- Service 层:`@Service`,字段注入(`@Autowired`)
|
||||
- 配置值:`@Value("${app.xxx:默认值}")`,始终提供默认值
|
||||
- 参数校验:类上 `@Validated`,字段上 `@NotBlank`、`@Pattern` 等
|
||||
- 写操作方法加 `@Transactional(rollbackFor = Exception.class)`
|
||||
@@ -48,13 +48,13 @@ inclusion: always
|
||||
- 类注释说明对应的表名和用途
|
||||
- 特殊字段(状态码、标志位、枚举值等)在注释中说明每个值的含义,如 `/** 状态 0=正常 1=禁用 */`
|
||||
|
||||
### Server 类注释
|
||||
### Service 类注释
|
||||
- 类注释说明该服务的主要功能
|
||||
- 类注释中列出依赖的其他模块/服务,以及使用到的表和使用目的,格式示例:
|
||||
```java
|
||||
/**
|
||||
* 登录服务
|
||||
* <p>依赖:SmsServer(验证码发送与校验)、UserRegisterServer(自动注册)</p>
|
||||
* <p>依赖:SmsService(验证码发送与校验)、UserRegisterService(自动注册)</p>
|
||||
* <p>使用表:bg_user(查询/创建用户)</p>
|
||||
*
|
||||
* @author zk
|
||||
@@ -70,7 +70,7 @@ inclusion: always
|
||||
|
||||
## POJO 规范
|
||||
|
||||
- DTO:入参对象 + 校验注解,放在 `pojo/dto/{功能模块}/` 下,功能模块一般是对应 Server 类名的简写,如 `pojo/dto/login/SmsLoginDto.java`
|
||||
- DTO:入参对象 + 校验注解,放在 `pojo/dto/{功能模块}/` 下,功能模块一般是对应 Service 类名的简写,如 `pojo/dto/login/SmsLoginDto.java`
|
||||
- VO:出参对象,放在 `pojo/vo/{功能模块}/` 下,如 `pojo/vo/login/LoginVo.java`
|
||||
- PO:对应数据库表字段,统一放在 `manager` 模块的 `pojo/po/` 下
|
||||
- Param:查询参数对象,放在 `pojo/param/{功能模块}/` 下
|
||||
@@ -89,7 +89,7 @@ inclusion: always
|
||||
|
||||
## 接口规范
|
||||
|
||||
- Controller 只负责参数接收和调用 Server,不写业务逻辑
|
||||
- Controller 只负责参数接收和调用 Service,不写业务逻辑
|
||||
- 无需鉴权的接口放在 `/public` 前缀下
|
||||
- POST 用 `@PostMapping`,GET 用 `@GetMapping` ...
|
||||
- 复杂参数 `@Validated @RequestBody`,简单参数 `@RequestParam`
|
||||
@@ -103,7 +103,7 @@ inclusion: always
|
||||
|
||||
## Redis 使用规范
|
||||
|
||||
- 统一通过 `RedisServerTool` 操作,不直接使用 `RedisTemplate`
|
||||
- 统一通过 `RedisServiceTool` 操作,不直接使用 `RedisTemplate`
|
||||
- key 自动拼接应用名前缀:`{appName}:{业务key}`
|
||||
- 值统一 JSON 序列化
|
||||
- 设置 TTL 时使用 `TimeUnit` 明确单位
|
||||
|
||||
Reference in New Issue
Block a user