模版提交

This commit is contained in:
2026-06-09 18:20:42 +08:00
parent be9ace256d
commit a9c916efb1
9 changed files with 629 additions and 0 deletions

View File

@@ -0,0 +1,38 @@
# API 请求方式变更通知模版
对应 `11.py``build_method_change_markdown()`
适用URI 不变,仅 **HTTP 方法** 变化(如 `GET``POST`)。
> 第一期是否纳入,待产品确认;模版先备齐。
---
## 完整示例
```
# 【API请求方式变更通知】
变更类型: <font color="warning">**修改请求方式**</font>
路径: <font color="info">**jnpf-ftb/jnpf-ftb-biz/src/main/java/jnpf/workflow/controller/ApplyClockInController.java**</font>
修改人: dongzi
修改时间: 2026-06-08 16:30:00
---------------------------------------
#### 【请求方式变更详情】
- **URI** <font color="info">**`/apply/clockIn/{id}`**</font>
- **原请求方式:** <font color="warning">**GET**</font>
- **新请求方式:** <font color="info">**PUT**</font> ← <font color="info">**请求方式已变更**</font>
```
---
## 检测逻辑
- 方法指纹相同 + URI 相同 + `httpMethod` 不同 → `is_method_changed = true`
- 与路径变更、参数变更报告**互斥拆分**(同 11.py `comparator` 约定)
## 实现
- `EndpointDiffEngine`
- `ApiChangeNotifier.buildMethodChangeMarkdown()`

View File

@@ -0,0 +1,121 @@
# API 参数变更通知模版
对应 `11.py``build_markdown_notification()` 中参数变更分支 + `_format_endpoint_block()`
适用:**URI 与 HTTP 方法均未变**,仅入参发生变化。
---
## 完整示例
```
# 【API参数变更通知】
- **修改人:** dongzi
- **修改时间:** 2026-06-08 16:30:00
- **变更类型:** <font color="warning">**修改参数**</font>
- **URI** **POST** `/apply/clockIn`
- **路径:** <font color="info">**jnpf-ftb/jnpf-ftb-biz/src/main/java/jnpf/workflow/controller/ApplyClockInController.java**</font>
---------------------------------------
#### 【接口参数变动详情】
**类对象变更(一级字段)**
共 **1** 个类对象 · **2** 项字段变更
**`ApplyAttendanceChangeDto`**
├─ `taskIds` · `List<String>` · 必填 [新增]
> 说明:流程主键集合
└─ `applyUser1` · `Integer` [删除]
> 说明:申请人员
**普通参数变更**
共 **1** 项变更
1. `id` · `String` · 路径参数 [新增]
> 说明:主键
```
---
## 示例(仅普通参数,无 RequestBody
```
# 【API参数变更通知】
- **修改人:** dongzi
- **修改时间:** 2026-06-08 16:30:00
- **变更类型:** <font color="warning">**修改参数**</font>
- **URI** **GET** `/apply/clockIn/{id}`
- **路径:** <font color="info">**jnpf-ftb/.../ApplyClockInController.java**</font>
---------------------------------------
#### 【接口参数变动详情】
**普通参数变更**
共 **1** 项变更
1. `pageSize` · `Integer` · 查询参数 [新增]
```
---
## 参数分类与检测
| 来源注解 | `source` 字段 | diff 粒度 |
|----------|---------------|-----------|
| `@RequestBody` | `body` | Dto **一级字段**(复用 `FieldDiffEngine` |
| `@PathVariable` | `path` | 参数名、类型、增删 |
| `@RequestParam` | `query` | 参数名、类型、required、增删 |
| 无注解 | `simple` | 待确认是否纳入 |
### 排除的框架参数(建议默认开启)
`HttpServletRequest``HttpServletResponse``BindingResult``Principal``Authentication``Model``ModelMap``UriComponentsBuilder` 等。
---
## ParameterChange 数据结构(对齐 11.py
| 字段 | 说明 |
|------|------|
| `param_name` | 当前参数名 / 字段名 |
| `old_name` | 重命名前名称 |
| `param_type` | 类型字符串,如 `List<String>` |
| `description` | 说明(@Schema / 注释) |
| `source` | `body` / `path` / `query` |
| `body_param_name` | `@RequestBody` 形参名 |
| `parent_dto` | Dto 简单类名 |
| `change_type` | `added` / `removed` / `modified` / `renamed` |
| `detail` | 类型变化等详情 |
---
## 与路径变更的拆分规则11.py 约定)
| 同一次改动 | 通知策略 |
|------------|----------|
| 仅参数变 | 本模版 |
| 路径变 + 参数变 | **拆两条**:先路径通知,再参数通知 |
| 方法变 + 参数变 | **拆两条**:先方法通知,再参数通知 |
| 新增接口 + 带参数 | 路径通知可**附带**参数详情区块 |
---
## JavaParser 实现要点
1. **EndpointSnapshotParser**:遍历 `MethodDeclaration.getParameters()`,读参数注解
2. **@RequestBody**:取 Dto 类型 → `ClassFieldParser.parseFields()` 得字段列表
3. **ParameterDiffEngine**:旧/新快照按方法指纹对齐后 diff
4. **ApiChangeNotifier**:渲染本模版;泛型类型展示规则与类变更通知一致(`<>` 不 HTML 转义)
## 实现
- `ParameterDiffEngine`
- `ApiChangeNotifier.formatEndpointBlock()`
- 复用 `FieldDiffEngine` / `WeComNotifier` 中的字段行格式(可选统一)

View File

@@ -0,0 +1,88 @@
# API 路径变更通知模版
对应 `11.py``build_path_change_markdown()`
适用:**新增接口**、**删除接口**、**修改路径**。
---
## 完整示例(修改路径)
```
# 【API路径变更通知】
变更类型: <font color="warning">**修改路径**</font>
路径: <font color="info">**jnpf-ftb/jnpf-ftb-biz/src/main/java/jnpf/workflow/controller/ApplyClockInController.java**</font>
修改人: dongzi
修改时间: 2026-06-08 16:30:00
---------------------------------------
#### 【URI变更详情】
- **原路径:** <font color="warning">~~`/apply/clockIn`~~</font> ← <font color="warning">**旧路径**</font>
- **新路径:** <font color="info">**`/apply/clockIn/v2`**</font> ← <font color="info">**新路径**</font>
```
---
## 示例(新增接口)
```
# 【API路径变更通知】
变更类型: <font color="warning">**新增接口**</font>
路径: <font color="info">**jnpf-ftb/.../ApplyClockInController.java**</font>
修改人: dongzi
修改时间: 2026-06-08 16:30:00
---------------------------------------
#### 【URI变更详情】
- **原路径:** `-`
- **新路径:** <font color="info">**`/apply/clockIn`**</font> ← <font color="info">**新增**</font>
```
> 若新增接口同时有参数变更,可在路径通知后追加【接口参数变动详情】区块(见 `api-param-change.md`)。
---
## 示例(删除接口)
```
# 【API路径变更通知】
变更类型: <font color="warning">**删除接口**</font>
路径: <font color="info">**jnpf-ftb/.../ApplyClockInController.java**</font>
修改人: dongzi
修改时间: 2026-06-08 16:30:00
---------------------------------------
#### 【URI变更详情】
- **原路径:** <font color="warning">**`/apply/clockIn/{id}`**</font> ← <font color="warning">**已删除**</font>
- **新路径:** `已删除`
```
---
## 字段说明
| 占位符 | 来源 |
|--------|------|
| 变更类型 | `新增接口` / `删除接口` / `修改路径` |
| 路径 | Controller `.java` 相对仓库根路径(`source_file` |
| 原路径 / 新路径 | 类级 `@RequestMapping` + 方法级 Mapping 拼接后的 URI |
| HTTP 方法 | 路径变更通知中默认不展示;与请求方式变更模版区分 |
## 检测逻辑JavaParser
1. 解析旧/新 commit 下同一 Controller 源码 AST
2. 提取每个方法的 `httpMethod` + `uri`(已有 `EndpointParser` 逻辑)
3. 用**方法指纹**(类文件 + 方法名,如 `ApplyClockInController.java#getApply`)匹配新旧接口;参数增删改由 ParameterDiffEngine 检测
4. 指纹相同且 URI 不同 → **修改路径**
5. 仅旧有新无 → **删除**;仅新有旧无 → **新增**
## 实现
- `EndpointSnapshotParser` — 解析快照
- `EndpointDiffEngine` — 对比产出 `EndpointChangeReport.is_renamed_endpoint` 等标志
- `ApiChangeNotifier.buildPathChangeMarkdown()` — 渲染本模版

View File

@@ -0,0 +1,58 @@
# 类变更通知模版
Push 触发 CI 后,按变更类的后缀(`Dto` / `Vo` / `Entity` / `Model`)选用对应模版生成企业微信 Markdown 通知。
## 企微语法说明
使用 webhook **`markdown`**v1支持 font 三色;**不支持无序列表**,故各项以**引用块 + 换行**分行展示。
| 语法 | 说明 |
|------|------|
| `#` / `##` / `###` | 标题(主区块用【】) |
| `` `行内代码` `` | 字段名、URI |
| `>` | 引用行(每项一行) |
| `**bold**` | 头部四行、统计行加粗 |
| `<font color="info">` | 绿类名、新增、HTTP 方法、新类型 |
| `<font color="comment">` | 灰:说明、路径、无影响 |
| `<font color="warning">` | 橙:[修改]/[删除]、旧类型、统计数字 |
## 布局约定
1. **# 【类变更通知】** — 头部 4 项,每项一行 `>**标签: 值**`(加粗,冒号后两空格);变更对象括号内展示类中文说明(@Schema / Javadoc无说明则仅类名
2. **## 【对象变更细节】** — 统计行 + 每条变更单行(标签/说明/类型合并)
3. **## 【影响范围】** — 各 ### 小节内,每项一行引用
## 公共头部
```
# 【类变更通知】
> **变更对象: <font color="info">ApplyAttendanceChangeDto</font><font color="comment">流程表单 [出勤变更]</font>**
> **修改人: <font color="comment">dongzi</font>**
> **时间: <font color="comment">2026-06-07 20:14:35</font>**
> **路径: <font color="comment">jnpf-ftb/.../ApplyAttendanceChangeDto.java</font>**
```
## 影响范围
| 类类型 | request | response | 类转换 |
|--------|:-------:|:--------:|:------:|
| Dto | ✅ | ✅ | ✅ |
| Vo | ✅ | ✅ | ✅ |
| Entity / Model | ❌ | ❌ | ✅ |
Dto/Vo 均固定展示 request、response 两栏;无匹配接口时显示「无」。类转换栏仅在 `dto_entity_conversion.enabled: true` 时展示,关闭时不出现该小节。实际影响由接口索引 + 嵌套关系传播,不假定 Dto 仅 request、Vo 仅 response。
## 模版文件
| 文件 | 场景 |
|------|------|
| [field-description.md](field-description.md) | 字段说明与行格式 |
| [dto.md](dto.md) | Dto |
| [vo.md](vo.md) | Vo |
| [entity.md](entity.md) | Entity |
| [model.md](model.md) | Model |
## 实现
`WeComNotifier.buildMarkdown()` · 消息类型 `markdown` · 路径取自 `ClassChangeReport.sourceFile`

View File

@@ -0,0 +1,106 @@
# Dto 类变更通知模版
**识别规则**:类名以 `Dto` 结尾。
**影响范围**request + response + 类转换(无匹配时对应栏显示「无」)。
**嵌套标识**:被其他 Dto/Vo 嵌套时在「变更对象」行追加 `(嵌套对象)`;若同时直接作接口入参/返回值根类型,再追加 `(顶层对象)`。纯顶层不标注。
---
## 完整示例(字段修改)
```
# 【类变更通知】
> **变更对象: <font color="info">ApplyAttendanceChangeDto</font><font color="comment">流程表单 [出勤变更]</font>**
> **修改人: <font color="comment">dongzi</font>**
> **时间: <font color="comment">2026-06-07 20:14:35</font>**
> **路径: <font color="comment">jnpf-ftb/jnpf-ftb-entity/src/main/java/jnpf/model/workflow/dto/ApplyAttendanceChangeDto.java</font>**
## 【对象变更细节】
> **共 <font color="warning">4</font> 项变更**
> <font color="warning">[修改]</font> `taskId` 说明: <font color="comment">流程主键</font> 类型: <font color="warning">Integer</font> → <font color="info">String</font>
> <font color="warning">[修改]</font> `changeUserId` 说明: <font color="comment">变更人员id</font> 类型: <font color="warning">String</font> → <font color="info">Integer</font>
> <font color="info">[新增]</font> `storeId` 说明: <font color="comment">门店ID</font> 类型: <font color="info">String</font>
> <font color="warning">[删除]</font> `oldField` 说明: <font color="comment">已废弃字段</font> 类型: <font color="warning">Integer</font>
## 【影响范围】
### 影响 request 接口
> <font color="info">POST</font> `/apply/clockIn`
> <font color="info">PUT</font> `/apply/clockIn/{id}`
### 类转换影响
> <font color="comment">未开启检测</font>
```
---
## 示例(嵌套对象)
```
> **变更对象: <font color="info">UserSelfDto</font><font color="comment">嵌套对象</font>**
```
若该类同时直接出现在某接口 `@RequestBody` 或返回值类型中:
```
> **变更对象: <font color="info">SomeDto</font><font color="comment">说明</font><font color="comment">嵌套对象</font><font color="comment">顶层对象</font>**
```
---
## 示例(类删除)
```
## 【对象变更细节】
> <font color="warning">[已删除]</font> <font color="comment">该类文件已被移除</font>
```
---
## 示例(仅类名变更)
```
## 【对象变更细节】
> <font color="warning">[类名变更]</font> <font color="comment">ApplyAttendanceChangeDto</font> → <font color="info">ApplyAttendanceChangeNewDto</font>
> <font color="comment">字段无变化</font>
## 【影响范围】
### 影响 request 接口
> <font color="info">POST</font> `/apply/clockIn`
> <font color="info">PUT</font> `/apply/clockIn/{id}`
### 类转换影响
> <font color="comment">未开启检测</font>
```
---
## 示例(类名 + 字段同时变更)
```
## 【对象变更细节】
> <font color="warning">[类名变更]</font> <font color="comment">ApplyAttendanceChangeDto</font> → <font color="info">ApplyAttendanceChangeNewDto</font>
> **共 <font color="warning">1</font> 项变更**
> <font color="warning">[修改]</font> `changeMinute` 说明: <font color="comment">变更分钟数</font> 类型: <font color="warning">Integer</font> → <font color="info">String</font>
```
---
## 占位符
| 占位符 | 来源 |
|--------|------|
| 路径 | Git 相对路径,`ClassChangeReport.sourceFile` |
| 说明 | `@Schema` / 注释 |

View File

@@ -0,0 +1,49 @@
# Entity 类变更通知模版
**识别规则**:类名以 `Entity` 结尾。
**影响范围**:仅类转换(不展示 request/response 接口)。
---
## 完整示例(字段修改)
```
# 【类变更通知】
> **变更对象: <font color="info">TrainingPositionEntity</font><font color="comment">培训岗位</font>**
> **修改人: <font color="comment">张三</font>**
> **时间: <font color="comment">2026-06-07 14:30:00</font>**
> **路径: <font color="comment">jnpf-ftb/jnpf-ftb-entity/src/main/java/jnpf/entity/training/TrainingPositionEntity.java</font>**
## 【对象变更细节】
> **共 <font color="warning">1</font> 项变更**
> <font color="warning">[修改]</font> `createTime` 说明: <font color="comment">创建时间</font> 类型: <font color="warning">Date</font> → <font color="info">LocalDateTime</font>
## 【影响范围】
### 类转换影响
> Entity: <font color="info">TrainingPositionEntity</font>
```
---
## 示例(类删除)
```
## 【对象变更细节】
> <font color="warning">[已删除]</font> <font color="comment">该类文件已被移除</font>
```
---
## 示例(仅类名变更)
```
## 【对象变更细节】
> <font color="warning">[类名变更]</font> <font color="comment">TrainingPositionEntity</font> → <font color="info">TrainingPositionNewEntity</font>
> <font color="comment">字段无变化</font>
```

View File

@@ -0,0 +1,57 @@
# 字段说明规则
字段变更采用 **引用块 + 单行合并 + font 颜色**,遵循企微 `markdown` v1不支持列表
## 说明提取优先级
| 优先级 | 来源 |
|:------:|------|
| 1 | `@Schema(description = "...")` |
| 2 | `@ApiModelProperty` |
| 3 | `/** ... */` 字段注释 |
| 4 | 空串 |
## 字段变更行格式
每条变更占**一行**,标签、说明、类型横向排列,冒号后两空格:
```
> **共 <font color="warning">2</font> 项变更**
> <font color="warning">[重命名]</font> <font color="comment">taskId</font> → <font color="info">taskIds</font> 说明: <font color="comment">流程主键</font>
> <font color="info">[新增]</font> `applyUserList` 说明: <font color="comment">申请人员集合</font> 类型: <font color="info">List<String></font>
> <font color="warning">[删除]</font> `applyUser1` 说明: <font color="comment">申请人员</font> 类型: <font color="warning">Integer</font>
```
| 操作 | 标签 | 类型段 |
|------|------|--------|
| 新增 | info `[新增]` | 始终展示,绿色 `info` |
| 删除 | warning `[删除]` | 始终展示,橙色 `warning` |
| 修改 | warning `[修改]` | 始终展示,旧类型 warning → 新类型 info |
| 重命名 | warning `[重命名]` | 始终展示;仅改名时单色 info改类型时 old → new |
### 重命名配对规则
- 删除+新增且**类型相同、说明相同**(非空)→ `[重命名]`
- 删除+新增且**说明相同但类型不同** → `[重命名]` + 类型行
- 说明均为空时也可配对
- 说明不同则不配对,保持删除+新增
- 统计行加粗,数字用 warning橙色文案为「共 N 项变更」(不含「字段」)
- 多条变更之间用**空行**分隔
- 说明为空时显示 `<font color="comment">(无说明)</font>`
- 头部四行加粗,用 `quoteKvBold`;不要在 `<font>` 内嵌 `**bold**`
## 接口行格式
```
> <font color="info">POST</font> `/apply/clockIn`
```
## 实现
- `ClassFieldParser.extractFieldLabel()`
- `FieldDiffEngine` — 类型变化产生 `[修改]`,说明匹配的删除+新增合并为 `[重命名]`
- `WeComNotifier.formatFieldChange()`

View File

@@ -0,0 +1,49 @@
# Model 类变更通知模版
**识别规则**:类名以 `Model` 结尾。
**影响范围**:仅类转换(不展示 request/response 接口)。
---
## 完整示例(字段修改)
```
# 【类变更通知】
> **变更对象: <font color="info">AttendanceRuleModel</font><font color="comment">考勤规则</font>**
> **修改人: <font color="comment">张三</font>**
> **时间: <font color="comment">2026-06-07 14:30:00</font>**
> **路径: <font color="comment">jnpf-ftb/jnpf-ftb-entity/src/main/java/jnpf/model/attendance/AttendanceRuleModel.java</font>**
## 【对象变更细节】
> **共 <font color="warning">1</font> 项变更**
> <font color="warning">[修改]</font> `ruleType` 说明: <font color="comment">规则类型</font> 类型: <font color="warning">Date</font> → <font color="info">String</font>
## 【影响范围】
### 类转换影响
> Entity: <font color="info">AttendanceRuleEntity</font>
```
---
## 示例(类删除)
```
## 【对象变更细节】
> <font color="warning">[已删除]</font> <font color="comment">该类文件已被移除</font>
```
---
## 示例(仅类名变更)
```
## 【对象变更细节】
> <font color="warning">[类名变更]</font> <font color="comment">AttendanceRuleModel</font> → <font color="info">AttendanceRuleNewModel</font>
> <font color="comment">字段无变化</font>
```

View File

@@ -0,0 +1,63 @@
# Vo 类变更通知模版
**识别规则**:类名以 `Vo``VO` 结尾。
**影响范围**request + response + 类转换(无匹配时对应栏显示「无」)。
**嵌套标识**:规则同 Dto——仅嵌套时标注 `(嵌套对象)`,嵌套且直接作接口根类型时追加 `(顶层对象)`
---
## 完整示例(字段修改)
```
# 【类变更通知】
> **变更对象: <font color="info">AttendanceDetailVo</font><font color="comment">考勤详情</font>**
> **修改人: <font color="comment">张三</font>**
> **时间: <font color="comment">2026-06-07 14:30:00</font>**
> **路径: <font color="comment">jnpf-ftb/jnpf-ftb-entity/src/main/java/jnpf/model/attendance/vo/AttendanceDetailVo.java</font>**
## 【对象变更细节】
> **共 <font color="warning">2</font> 项变更**
> <font color="info">[新增]</font> `overtimeHours` 说明: <font color="comment">加班时长</font>
> <font color="warning">[修改]</font> `status` 说明: <font color="comment">考勤状态</font> 类型: <font color="warning">Integer</font> → <font color="info">String</font>
## 【影响范围】
### 影响 response 接口
> <font color="info">GET</font> `/api/attendance/detail`
### 类转换影响
> Entity: <font color="info">AttendanceDetailEntity</font>
```
---
## 示例(类删除)
```
## 【对象变更细节】
> <font color="warning">[已删除]</font> <font color="comment">该类文件已被移除</font>
```
---
## 示例(仅类名变更)
```
## 【对象变更细节】
> <font color="warning">[类名变更]</font> <font color="comment">AttendanceDetailVo</font> → <font color="info">AttendanceDetailNewVo</font>
> <font color="comment">字段无变化</font>
## 【影响范围】
### 影响 response 接口
> <font color="info">GET</font> `/api/attendance/detail`
### 类转换影响
> <font color="comment">未开启检测</font>
```