添加开发规和skill
This commit is contained in:
@@ -0,0 +1,27 @@
|
||||
---
|
||||
inclusion: always
|
||||
---
|
||||
|
||||
# 项目规范执行指引
|
||||
|
||||
## 方案讨论前
|
||||
|
||||
必读 `#[[file:.kiro/steering/项目结构说明.md]]`,全面了解:
|
||||
- 三层模块职责与依赖关系:`client-api` → `manager` → `common`
|
||||
- 所有业务实体及其关联
|
||||
- 权限体系设计、邀请模块设计
|
||||
- 现有的公共能力(工具类、配置、拦截器),避免重复造轮子
|
||||
|
||||
方案讨论时,说明涉及哪些现有模块和实体,新增内容放在哪个模块,做好解耦。
|
||||
|
||||
## 开发方案输出前 / 写代码前
|
||||
|
||||
必读 `#[[file:.kiro/steering/代码开发风格文档.md]]`,严格遵守:
|
||||
- 命名约定、注解与依赖注入规范
|
||||
- POJO 分包规则(dto/vo/po/param 按功能模块建子目录)
|
||||
- Service 类注释规范(主要功能、依赖服务、使用的表、方法逻辑流程)
|
||||
- 接口规范、异常处理、Redis 使用、数据库设计风格、分页规范
|
||||
|
||||
## 写完代码后
|
||||
|
||||
涉及新增文件、新增模块或目录结构变更时,必须同步更新 `#[[file:.kiro/steering/项目结构说明.md]]`,保持文档与实际代码一致。
|
||||
@@ -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` 明确单位
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
inclusion: manual
|
||||
---
|
||||
|
||||
# OfferPie Back‑End 项目结构说明
|
||||
@zk
|
||||
## 1️⃣ 项目整体层次
|
||||
@@ -18,11 +22,11 @@ offerpie/back-end
|
||||
│ ├─ controller/
|
||||
│ │ ├─ LoginController.java # 登录相关接口(发送验证码、短信登录)
|
||||
│ │ └─ RouteMenuController.java # 路由菜单接口(获取用户有效菜单树)
|
||||
│ ├─ server/
|
||||
│ │ ├─ LoginServer.java # 登录业务逻辑(验证码校验、自动注册、JWT生成、Cookie设置)
|
||||
│ │ ├─ UserRegisterServer.java # 用户注册服务(注册逻辑、邀请码生成与绑定)
|
||||
│ │ ├─ FuncPermissionServer.java # 功能权限服务(校验、扣减、查询、添加库存、回退)
|
||||
│ │ ├─ RouteMenuServer.java # 路由菜单服务(查询、添加库存、获取用户菜单树)
|
||||
│ ├─ service/
|
||||
│ │ ├─ LoginService.java # 登录业务逻辑(验证码校验、自动注册、JWT生成、Cookie设置)
|
||||
│ │ ├─ UserRegisterService.java # 用户注册服务(注册逻辑、邀请码生成与绑定)
|
||||
│ │ ├─ FuncPermissionService.java # 功能权限服务(校验、扣减、查询、添加库存、回退)
|
||||
│ │ ├─ RouteMenuService.java # 路由菜单服务(查询、添加库存、获取用户菜单树)
|
||||
│ │ └─ WxPayNotifyMessageAbstractImpl.java # 微信支付回调实现
|
||||
│ └─ pojo/
|
||||
│ ├─ dto/
|
||||
@@ -71,16 +75,16 @@ offerpie/back-end
|
||||
│ │ ├─ UserFuncPermissionStock.java # 用户功能权限库存表(bg_user_func_permission_stock)
|
||||
│ │ └─ UserFuncUsageLog.java # 用户功能使用记录表(bg_user_func_usage_log)
|
||||
│ └─ vo/ # ViewObject(OssUrlVo 等)
|
||||
└─ server/ # 业务 Service(OssServer、SmsServer 等)
|
||||
└─ service/ # 业务 Service(OssService、SmsService 等)
|
||||
```
|
||||
> **设计理念** – 业务实体和 Mapper 位于 `manager`,B 端和 C 端共享;C 端特有的注解、切面、权限服务、路由菜单服务位于 `client-api`,避免 B 端误用;`common` 提供统一的技术支撑。
|
||||
|
||||
## 2️⃣ 各层模块职责
|
||||
| 层级 | 主要职责 | 关键类/包 |
|
||||
|------|----------|-----------|
|
||||
| **client-api** | - 面向终端用户的 REST API <br> - 启动 Spring Boot 应用 <br> - 短信验证码登录(含自动注册、邀请码绑定) <br> - **功能权限校验**:注解 + 切面 + 权限服务(校验、扣减、回退) <br> - **路由菜单**:获取用户有效菜单树 | `ClientApplication`、`LoginController`、`RouteMenuController`、`FuncPermission`、`FuncPermissionAspect`、`FuncPermissionServer`、`RouteMenuServer`、`UserRegisterServer`、`RouteMenuVo` |
|
||||
| **client-api** | - 面向终端用户的 REST API <br> - 启动 Spring Boot 应用 <br> - 短信验证码登录(含自动注册、邀请码绑定) <br> - **功能权限校验**:注解 + 切面 + 权限服务(校验、扣减、回退) <br> - **路由菜单**:获取用户有效菜单树 | `ClientApplication`、`LoginController`、`RouteMenuController`、`FuncPermission`、`FuncPermissionAspect`、`FuncPermissionService`、`RouteMenuService`、`UserRegisterService`、`RouteMenuVo` |
|
||||
| **common** | - **统一配置**:OSS、Redis、Security、WxPay、Sms 等 <br> - **跨层工具**:HTTP、IP、认证、验证码、Redis Server 等 <br> - **全局拦截/切面**:日志、TraceId、黑名单、SQL 打印 <br> - **统一异常/响应**:`GlobalExceptionAdvice`、`UnifiedResponse` <br> - **业务抽象**:邮件发送、微信支付(Native/JS/Transfer) <br> - **公共 POJO**:登录令牌、防重放信息等 | `config/`, `tool/`, `interceptor/`, `aop/`, `exception/`, `email/`, `wxPay/`, `pojo/` |
|
||||
| **manager** | - **业务实体**(`User`、`OssFile`、`UserInvite`、`RouteMenu`、`FuncPermission`、`UserRouteMenuStock`、`UserFuncPermissionStock`、`UserFuncUsageLog`) <br> - **MyBatis Mapper**(`UserMapper`、`OssFileMapper`、`UserInviteMapper`、`RouteMenuMapper`、`FuncPermissionMapper`、`UserRouteMenuStockMapper`、`UserFuncPermissionStockMapper`、`UserFuncUsageLogMapper`) <br> - **业务 API**:文件上传/下载、健康检查等 <br> - **业务逻辑**:服务层、工具类等 <br> - **既供 B 端 UI(待实现)使用,也供 C 端业务直接调用** | `controller/`, `mapper/`, `pojo/po/`, `pojo/vo/`, `server/`, `constant/` |
|
||||
| **manager** | - **业务实体**(`User`、`OssFile`、`UserInvite`、`RouteMenu`、`FuncPermission`、`UserRouteMenuStock`、`UserFuncPermissionStock`、`UserFuncUsageLog`) <br> - **MyBatis Mapper**(`UserMapper`、`OssFileMapper`、`UserInviteMapper`、`RouteMenuMapper`、`FuncPermissionMapper`、`UserRouteMenuStockMapper`、`UserFuncPermissionStockMapper`、`UserFuncUsageLogMapper`) <br> - **业务 API**:文件上传/下载、健康检查等 <br> - **业务逻辑**:服务层、工具类等 <br> - **既供 B 端 UI(待实现)使用,也供 C 端业务直接调用** | `controller/`, `mapper/`, `pojo/po/`, `pojo/vo/`, `service/`, `constant/` |
|
||||
|
||||
## 3️⃣ 关键业务实体
|
||||
| 实体 | 所属模块 | 作用概述 |
|
||||
@@ -164,4 +168,4 @@ offerpie/back-end
|
||||
### 核心逻辑
|
||||
- 用户注册时自动生成10位邀请码(大写字母+数字),存入 `User.invite_code`,碰撞检查最多重试3次
|
||||
- 注册时可携带 `inviteCode`,有效则写入邀请记录,无效仅日志警告不阻断注册
|
||||
- 注册逻辑由 `UserRegisterServer` 独立承担,`LoginServer` 委托调用
|
||||
- 注册逻辑由 `UserRegisterService` 独立承担,`LoginService` 委托调用
|
||||
|
||||
Reference in New Issue
Block a user