109 lines
3.7 KiB
Markdown
109 lines
3.7 KiB
Markdown
# 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="comment">code/code_change_detection_v1.0</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` / `@ApiModel` / 类 Javadoc |
|
||
| 字段说明 | `@Schema` / `@ApiModelProperty` / 字段 Javadoc（见 [field-description.md](field-description.md)） |
|