Skip to content

Commit 85f3849

Browse files
committed
docs: 新增 AGENTS.md 统一维护开发指南,CLAUDE.md/CODEBUDDY.md 简化为引用入口
1 parent 7627008 commit 85f3849

3 files changed

Lines changed: 260 additions & 200 deletions

File tree

‎AGENTS.md‎

Lines changed: 243 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,243 @@
1+
# AGENTS.md
2+
3+
This file provides guidance to AI coding agents when working with code in this repository.
4+
5+
## 项目概述
6+
7+
springboot-framework 是一个基于 Spring Boot 2.7.18(Java 8)的多模块企业级开发框架,由 CodingApi 团队维护。核心定位是为领域驱动设计(DDD)与事件风暴提供开箱即用的基础设施。当前开发版本为 `8.2.0-SNAPSHOT`,采用 Maven `${revision}` CI-Friendly 版本机制,正式发布时通过 `-Drevision=x.y.z` 指定正式版本号。版本号含义:8 = 最低 JDK 版本,2 = Spring Boot 大版本,第三位为补丁版本。
8+
9+
**回复语言**:请使用中文进行回答。
10+
11+
**版本线说明**:本仓库维护两条版本线——`17.3.x`(JDK 17 / Spring Boot 3.x)与 `8.2.x`(JDK 8 / Spring Boot 2.x,当前分支)。两条版本线功能基本一致,主要差异为 JDK 与 Spring Boot 代际:本分支使用 `javax.*` 命名空间(如 `javax.servlet`、`javax.persistence`),**禁止使用** `jakarta.*`。本分支不包含示例工程(example)与前端工程(frontend)。
12+
13+
## 常用命令
14+
15+
```bash
16+
# 全量构建
17+
./mvnw clean install
18+
19+
# 仅运行测试(CI 使用)
20+
./mvnw clean test -P travis
21+
22+
# 运行单个模块的测试
23+
./mvnw test -pl springboot-starter
24+
./mvnw test -pl springboot-starter-security
25+
26+
# 运行单个测试类
27+
./mvnw test -pl springboot-starter -Dtest=SomeTestClass
28+
29+
# 正式发布(通过 -Drevision 指定正式版本号,无需修改 pom)
30+
./mvnw clean deploy -P ossrh -Drevision=8.2.0
31+
```
32+
33+
## 模块架构
34+
35+
### Starter 模块(框架核心)
36+
37+
| 模块 | 职责 |
38+
|------|------|
39+
| `springboot-starter` | 核心基础:统一 Response DTO、分页 PageRequest/Filter、事件系统、国际化异常、事务管理 |
40+
| `springboot-starter-security` | Spring Security + JWT 无状态认证 / Redis 有状态认证,加解密支持 |
41+
| `springboot-starter-data-fast` | JPA 增强:FastRepository 支持动态过滤查询、HQL 构建、SearchRequest |
42+
| `springboot-starter-data-authorization` | 数据权限:通过 JDBC Connection/Statement 代理拦截 SQL,透明注入权限条件 |
43+
| `springboot-starter-script` | Groovy 脚本引擎:运行时编译、LRU 缓存、热更新,提供 REST API |
44+
45+
### 自动配置注册
46+
47+
各 starter 模块同时维护 `META-INF/spring.factories`(兼容旧版)和 `META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports`(Spring Boot 2.7+ 支持)。新增 starter 时需同时注册这两种文件。
48+
49+
### 模块间依赖关系
50+
51+
```
52+
springboot-starter (核心,无外部依赖)
53+
├── springboot-starter-security (依赖 starter)
54+
├── springboot-starter-data-fast (依赖 starter)
55+
├── springboot-starter-data-authorization (依赖 starter + JSqlParser)
56+
└── springboot-starter-script (依赖 starter + Groovy)
57+
```
58+
59+
注意:根 `pom.xml` 默认 `<modules>` 中仅包含 `springboot-starter-data-authorization`,完整 5 模块通过 `dev` / `travis` / `ossrh` profile 激活。
60+
61+
## 核心架构模式
62+
63+
### 事件系统(Event System)
64+
65+
框架自建的发布-订阅事件机制,是 DDD 领域事件的核心基础设施:
66+
67+
- **`IEvent`** — 事件标记接口,分为 `ISyncEvent`(同步)和 `IAsyncEvent`(异步)
68+
- **`IHandler<T extends IEvent>`** — 事件处理器,支持 `order()` 排序和 `error()` 异常回调
69+
- **`EventPusher.push(event, sync)`** — 事件推送入口
70+
- **`DomainEvent`** — 领域实体事件基类,派生 `DomainCreateEvent`、`DomainChangeEvent`、`DomainDeleteEvent`
71+
- **`DomainChangeInterceptor`** — 通过代理拦截实体字段变更,自动推送 `DomainChangeEvent`
72+
73+
标注 `@Handler`(或 `@Component`/`@Service`)的处理器会被注册为 Spring Bean;`SpringHandlerConfiguration` 收集容器中所有 `IHandler` Bean,在构造事件处理器时通过 `addHandlers` 统一注册到 `ApplicationHandlerUtils`。
74+
75+
### 统一响应封装
76+
77+
```java
78+
Response // 基础响应(success / errCode / errMessage)
79+
SingleResponse<T> // 单对象响应
80+
MultiResponse<T> // 列表响应
81+
MapResponse // Map 响应
82+
```
83+
84+
### 数据查询(PageRequest + FastRepository)
85+
86+
`PageRequest` 扩展了 Spring Data 的 `PageRequest`,增加了 `RequestFilter` 动态过滤条件:
87+
88+
```java
89+
PageRequest request = PageRequest.of(0, 20);
90+
request.addFilter("name", "张三");
91+
request.addFilter("age", Relation.GREATER_THAN, 18);
92+
Page<User> page = userRepository.findAll(request);
93+
```
94+
95+
`FastRepository.findAll(PageRequest)` 全部为等值条件时构建 Example 查询;包含 LIKE/范围/IN/OR 等复杂条件时自动切换 `DynamicSQLBuilder` 构建的 HQL 查询。
96+
97+
### 数据权限(SQL 拦截)
98+
99+
`ConnectionProxy` → `PreparedStatementProxy` / `StatementProxy` 代理链,在 SQL 执行前通过 `SQLRunningContext.intercept(sql)` 注入权限条件,实现透明的行级数据过滤。使用 JSqlParser 解析和改写 SQL。列级脱敏通过 `ResultSetProxy` + `ColumnHandlerContext` 在结果集读取时完成。
100+
101+
## 框架配置项
102+
103+
在 `application.properties` 中可用的配置前缀:
104+
105+
```properties
106+
# 安全模块
107+
codingapi.security.jwt.enable=true # 启用 JWT 认证(必须显式开启)
108+
codingapi.security.redis.enable=true # 启用 Redis 有状态认证(必须显式开启)
109+
codingapi.security.ignore-urls=/open/**,/#/** # 免认证 URL 列表
110+
111+
# 框架核心
112+
codingapi.framework.handler-thread-pool-size=20 # 事件异步线程池大小
113+
114+
# 数据权限
115+
codingapi.data-authorization.show-sql=false # 打印拦截后的 SQL
116+
```
117+
118+
## 关键依赖版本
119+
120+
见根 `pom.xml` 的 `<properties>` 区块。主要版本:Groovy 4.0.24、JSqlParser 5.0、Fastjson 2.0.53、JJWT 0.12.6、H2 1.4.200。
121+
122+
## 开发规范
123+
124+
本仓库同时维护 **8.x(JDK 8 / Spring Boot 2.7.x / `javax.*`,当前分支)与 17.x(JDK 17 / Spring Boot 3.x / `jakarta.*`)两条版本线**,各自独立交付,没有 `dev` 分支。8.x 分支不包含 `example/` 与 `frontend/`。
125+
126+
### GitHub Issue 标准处理流程
127+
128+
处理任何来自 GitHub 的 issue 时,必须遵循 [docs/conventions/workflow/github-issue.md](./docs/conventions/workflow/github-issue.md):
129+
130+
1. **定位阶段**可只读代码分析,不必创建 worktree;
131+
2. **先确认影响版本线**(8.x / 17.x / 两者),定位完成后先回复 issue,说明根因、影响版本与处理方案;
132+
3. **实际改代码必须使用 git worktree + 特性分支**,基线按版本线选择:8.x 用 `8.2.x`,17.x 用 `17.3.x`;不得在主工作区直接修改;
133+
4. 修复需测试先行,并使用对应版本线的 JDK 完成本地编译/测试验证;双版本 issue 必须两条线分别验证;
134+
5. 完成后**只推送该 issue 的特性分支到 GitHub**:提交内容、推送与 issue 关联均以该特性分支为准,**不合并版本分支**;是否合并由人工决定,任务完成时仅提示分支与 PR 链接(PR 目标为 `8.2.x` 或 `17.3.x`);
135+
6. 提交信息使用 `Closes #<issue编号>` 关联 issue;仅当进入默认分支 `main` 时自动关闭,未自动关闭时需用户确认后手动关闭(8.x 合并到 `8.2.x` 不会自动关闭);
136+
7. **特性分支推送到 GitHub 后再回复 issue**,说明修复内容、验证结果与推送分支/提交;未推送前不得发布完成回复(定位回复不受此限)。
137+
138+
### 基本规范
139+
140+
- **与用户沟通及编写文档时,所有内容必须使用中文表述**
141+
- **在每次修改代码以后,要执行本地化的编译验证确保代码没有错误**
142+
- Java 代码遵循 Spring Boot 规范
143+
- 8.x 使用 `javax.*` 与 JDK 8,17.x 使用 `jakarta.*` 与 JDK 17,两条线的修复不得直接 cherry-pick,必须做命名空间与代际适配
144+
- 编码规范见 `docs/conventions`:方法命名 [java/naming-convention](./docs/conventions/java/naming-convention.md)、测试设计 [java/test-design-convention](./docs/conventions/java/test-design-convention.md)、领域建模 [java/domain-modeling-convention](./docs/conventions/java/domain-modeling-convention.md)、静态方法 [java/static-method-convention](./docs/conventions/java/static-method-convention.md)
145+
146+
### 测试规范
147+
148+
本项目后端采用 JUnit 5 进行单元测试。两条版本线测试命令一致,但需切换到对应 JDK(8.x 用 JDK 8,17.x 用 JDK 17)。
149+
150+
**测试文件位置:**
151+
152+
- 测试文件放在各模块 `src/test/java/` 目录下,包路径与源码保持一致
153+
- 测试文件命名:`*Test.java`
154+
155+
**测试编写流程:**
156+
157+
1. **Red(红灯)**:先编写测试用例,明确预期行为
158+
2. **Green(绿灯)**:编写最小代码使测试通过
159+
3. **Refactor(重构)**:优化代码结构,运行全部测试确认不回归
160+
161+
**测试用例设计要求:**
162+
163+
- 每个测试用例需明确:测试目标、前置条件、执行步骤、期望断言
164+
- 优先测试核心业务逻辑(DTO、事件系统、动态查询、SQL 拦截、脚本引擎等)
165+
- 测试应该有确定性结果,避免依赖外部状态
166+
167+
**测试命令:**
168+
169+
```bash
170+
# 运行所有测试(与 CI 一致)
171+
./mvnw clean test -P travis
172+
173+
# 运行特定模块的测试
174+
./mvnw test -pl springboot-starter
175+
176+
# 运行特定的测试类
177+
./mvnw test -pl springboot-starter -Dtest=ResponseTest
178+
```
179+
180+
**示例(基于 springboot-starter 的响应封装测试,8.x 版本线):**
181+
182+
```java
183+
package com.codingapi.springboot.framework.dto;
184+
185+
import com.codingapi.springboot.framework.dto.response.SingleResponse;
186+
import org.junit.jupiter.api.Test;
187+
188+
import static org.junit.jupiter.api.Assertions.assertEquals;
189+
import static org.junit.jupiter.api.Assertions.assertTrue;
190+
191+
class SingleResponseTest {
192+
193+
@Test
194+
void should_wrap_single_data() {
195+
// given
196+
String data = "hello";
197+
198+
// when
199+
SingleResponse<String> response = SingleResponse.of(data);
200+
201+
// then
202+
assertTrue(response.isSuccess());
203+
assertEquals(data, response.getData());
204+
}
205+
}
206+
```
207+
208+
<!-- PKR-START -->
209+
## PKR 知识查阅(编码前必须)
210+
211+
进入计划模式或实现功能前,**必须按以下优先级查阅**:
212+
213+
### ⚠️ 开发规范(最高优先级,必须严格遵守)
214+
215+
1. [docs/conventions/index.md](./docs/conventions/index.md) — 项目开发规范
216+
217+
**规范具有最高优先级。** 所有代码必须遵循已注册的 Convention,违反规范的代码视为缺陷。
218+
编码前必须逐条检查相关规范,确保命名、结构、模式完全符合要求。
219+
220+
### 已有能力(必须复用,禁止重复实现)
221+
222+
2. [docs/capabilities/index.md](./docs/capabilities/index.md) — 已有可复用能力
223+
224+
已有能力必须复用,禁止重新实现。优先组合已有能力解决问题。
225+
226+
### 计划模式约束
227+
228+
计划方案中必须包含:
229+
1. **遵循了哪些规范** — 列出遵守的 Convention(必须首先说明)
230+
2. **复用了哪些已有能力** — 列出从 PKR 中找到并复用的 Capability
231+
3. **是否有新增能力** — 如果本次开发产生了可复用的新能力,完成后通过 `/pkr-add` 注册
232+
233+
### 知识管理命令
234+
235+
| 命令 | 用途 |
236+
|------|------|
237+
| `/pkr-init` | 扫描项目,发现候选能力和规范(自动跳过已有文档) |
238+
| `/pkr-sync` | 全量同步,对比代码变更 |
239+
| `/pkr-update <module>/<name> [desc]` | 单项更新,可带描述指导更新 |
240+
| `/pkr-add <module>/<name> <desc>` | 从代码/框架扫描注册 |
241+
| `/pkr-add plan <module>/<name> <desc>` | 注册计划中的能力 |
242+
| `/pkr-export <module> ...` | 导出模块文档供其他项目使用 |
243+
<!-- PKR-END -->

0 commit comments

Comments
 (0)