mirror of
https://github.com/dromara/RuoYi-Vue-Plus.git
synced 2026-07-22 20:46:11 +00:00
update 重构 将代码生成vm模板替换为fm模板 语法更清晰明了
This commit is contained in:
@@ -32,7 +32,7 @@ description: 在仓库内按代码生成器模板、项目 reference 文档和
|
||||
|
||||
1. 先判断任务类型,并按“文档读取规则”读取当前任务需要的 reference。
|
||||
2. 确认目标模块,优先复用同模块中最近似功能的写法。
|
||||
3. 新增标准 CRUD 代码前,先读取 `ruoyi-modules/ruoyi-gen/src/main/resources/vm/` 下的模板。
|
||||
3. 新增标准 CRUD 代码前,先读取 `ruoyi-modules/ruoyi-gen/src/main/resources/fm/` 下的 FreeMarker 模板。
|
||||
4. 命名和分层保持与仓库一致:
|
||||
`domain` entity、`domain.bo`、`domain.vo`、`mapper`、`service`、`service.impl`、`controller`。
|
||||
5. 优先在生成器结构上扩展,不要自行发明新的分层。
|
||||
@@ -108,14 +108,14 @@ Vue 3、TypeScript API 文件、生成式列表页、表单状态、字典和日
|
||||
|
||||
标准生成器模板通常对应:
|
||||
|
||||
- `vm/java/domain.java.vm` -> entity
|
||||
- `vm/java/bo.java.vm` -> bo
|
||||
- `vm/java/vo.java.vm` -> vo
|
||||
- `vm/java/mapper.java.vm` -> mapper
|
||||
- `vm/java/service.java.vm` -> service interface
|
||||
- `vm/java/serviceImpl.java.vm` -> service impl
|
||||
- `vm/java/controller.java.vm` -> controller
|
||||
- `vm/xml/mapper.xml.vm` -> 自定义 XML mapper 起点
|
||||
- `fm/java/domain.java.ftl` -> entity
|
||||
- `fm/java/bo.java.ftl` -> bo
|
||||
- `fm/java/vo.java.ftl` -> vo
|
||||
- `fm/java/mapper.java.ftl` -> mapper
|
||||
- `fm/java/service.java.ftl` -> service interface
|
||||
- `fm/java/serviceImpl.java.ftl` -> service impl
|
||||
- `fm/java/controller.java.ftl` -> controller
|
||||
- `fm/xml/mapper.xml.ftl` -> 自定义 XML mapper 起点
|
||||
|
||||
## 任务分型
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
## 优先参考的代码来源
|
||||
|
||||
- `ruoyi-modules/ruoyi-gen/src/main/resources/vm/java/*.vm`
|
||||
- `ruoyi-modules/ruoyi-gen/src/main/resources/fm/java/*.ftl`
|
||||
- `ruoyi-modules/ruoyi-demo/...`
|
||||
- `ruoyi-modules/ruoyi-system/...`
|
||||
- `ruoyi-modules/ruoyi-workflow/...`
|
||||
|
||||
@@ -2,18 +2,18 @@
|
||||
|
||||
## 优先参考的代码来源
|
||||
|
||||
- `ruoyi-modules/ruoyi-gen/src/main/resources/vm/<frontendType>/*.vm`
|
||||
- 默认 Vue 模板在 `vm/vue`,React 模板在 `vm/react`
|
||||
- `ruoyi-modules/ruoyi-gen/src/main/resources/fm/<frontendType>/*.ftl`
|
||||
- 默认 Vue 模板在 `fm/vue`,React 模板在 `fm/react`
|
||||
- 前端工程中与目标模块最接近的现有页面
|
||||
|
||||
当前 boot4 仓库通常只含后端与 generator 前端模板;如果前端工程不在当前 root,先以 generator 模板约定为准,再对照用户提供的前端目录或相邻仓库。
|
||||
|
||||
## 前端模板选择规则
|
||||
|
||||
- `gen_table.frontend_type` 存字符串,值直接对应 `vm` 下的模板目录,例如 `vue`、`react`。
|
||||
- 生成器按 `vm/<frontendType>/api.ts.vm`、`types.ts.vm`、`index.*.vm`、`index-tree.*.vm` 查找模板。
|
||||
- 页面输出后缀由页面模板文件名决定:`index.vue.vm` 输出 `index.vue`,`index.tsx.vm` 输出 `index.tsx`。
|
||||
- 新增其他前端时优先只新增 `vm/<frontendType>` 目录和对应 VM 文件,不在 Java 代码里增加数字枚举或硬编码分支。
|
||||
- `gen_table.frontend_type` 存字符串,值直接对应 `fm` 下的模板目录,例如 `vue`、`react`。
|
||||
- 生成器按 `fm/<frontendType>/api.ts.ftl`、`types.ts.ftl`、`index.*.ftl`、`index-tree.*.ftl` 查找模板。
|
||||
- 页面输出后缀由页面模板文件名决定:`index.vue.ftl` 输出 `index.vue`,`index.tsx.ftl` 输出 `index.tsx`。
|
||||
- 新增其他前端时优先只新增 `fm/<frontendType>` 目录和对应 FTL 文件,不在 Java 代码里增加数字枚举或硬编码分支。
|
||||
|
||||
## API 文件规则
|
||||
|
||||
|
||||
Reference in New Issue
Block a user