RuoYi-Cloud-Plus/.codex/skills/ruoyi-plus-ai-coding/SKILL.md

---
name: ruoyi-plus-ai-coding
description: 在仓库内按代码生成器模板和项目既有约定生成或修改代码。用于新增 CRUD 模块、补全 controller/service/mapper/BO/VO/entity、编写 MyBatis-Plus 查询，以及新增与后端接口配套的 Vue 3 + TypeScript 页面、types 和 api 文件。
---

# RuoYi Plus AI 编码规范

先对齐代码生成器产物，再叠加仓库里真实业务代码已经形成的更强约定。

## 适用场景

在下面这些任务里优先使用此 skill：

- 新增标准 CRUD 模块。
- 根据新表结构补齐 entity、bo、vo、mapper、service、controller。
- 修改已有模块的查询、校验、导入导出、数据权限、事务逻辑。
- 在系统、监控、工作流、demo 等模块内按现有约定扩展业务代码。
- 为后端新增接口同步补前端 `api/types/index.vue` 骨架。

## 不适用场景

下面这些任务不要机械套用本 skill 的 CRUD 规则：

- 基础框架升级、Spring Boot 主版本迁移。
- 与当前分层明显不同的实验性模块。
- 第三方中间件深度接入、基础设施改造。
- 完全脱离 generator 体系的独立子系统。

## 执行流程

1. 先确认目标模块，优先复用同模块中最近似功能的写法。
2. 新增标准 CRUD 代码前，先读取 `ruoyi-modules/ruoyi-gen/src/main/resources/vm/` 下的模板。
3. 命名和分层保持与仓库一致：
   `domain` entity、`domain.bo`、`domain.vo`、`mapper`、`service`、`service.impl`、`controller`。
4. 先判断任务只发生在单个微服务内，还是同时涉及 `ruoyi-api`、Dubbo 远程调用、gateway 路由、跨服务事务。
5. 优先在生成器结构上扩展，不要自行发明新的分层。
6. 修改 `ruoyi-system` 这类复杂模块前，先阅读同类现有实现，因为这些模块通常比生成器默认产物多出数据权限、联表、缓存、安全校验等逻辑。

## 优先级规则

发生冲突时按下面顺序决策：

1. 当前模块内最近似业务代码。
2. 当前仓库公共基础模块约定，例如 `common-mybatis`、`common-core`、`common-web`。
3. 代码生成器模板。
4. 通用 Spring Boot / MyBatis-Plus 习惯。

也就是说：

- 同模块已有成熟实现时，优先复用该实现。
- 同模块没有现成代码时，再参考 generator 模板。
- 不要因为“更通用”就覆盖掉项目已形成的强约定。

## 后端规则

Java、MyBatis-Plus、BO/VO/entity、controller、mapper、service 的具体规则见 [references/backend.md](references/backend.md)。

如果任务涉及微服务边界、`ruoyi-api` 契约、Dubbo 调用、Seata、Nacos 配置或 gateway 路由，也优先参考 [references/backend.md](references/backend.md) 中的微服务章节。

## 前端规则

Vue 3、TypeScript API 文件、生成式列表页、表单状态、字典和日期范围约定见 [references/frontend.md](references/frontend.md)。

## 使用案例

具体调用方式见 [references/examples.md](references/examples.md)。

## 仓库通用规则

- 遵循 [`.editorconfig`](../../../.editorconfig)：UTF-8、LF，默认 4 空格，JSON/YAML 为 2 空格。
- 不要把 `BaseMapperPlus`、`PageQuery`、`PageResult`、`R`、`MapstructUtils` 或项目工具类替换成临时自造方案。
- 仓库已使用 `List.of(...)` 的地方，数组转列表优先继续沿用。
- import、注解顺序、文件结构以附近代码为准，不要顺手重排整个文件。
- 只有在业务逻辑不直观时才加简短注释。

## 决策规则

- 如果任务是围绕单表的标准 CRUD，尽量贴近生成器默认产物。
- 如果目标模块已经存在自定义校验、数据权限、事务、缓存、Excel 导入导出、联表查询等逻辑，应在此基础上扩展，不要为了“简洁”把它们削平。
- 如果附近 controller 接口已经带有权限、日志、防重、加密、分组校验等注解，新接口默认同步保持一致，除非有明确理由不这样做。
- 如果 BO 或 VO 需要字段校验、翻译、Excel 注解，应优先参考同模块同用途对象，不要机械套通用注解。
- 如果需求跨服务复用能力，优先新增或扩展 `ruoyi-api` 下的 `Remote*Service` 契约，再在服务提供方用 `@DubboService` 实现，在消费方用 `@DubboReference` 注入。
- 如果只是服务内 controller/service/mapper 调整，不要顺手把它拔高成远程接口。
- 如果需求只影响前端访问入口但不改变服务内部逻辑，先检查是否只需要调整 gateway 或 Nacos 中的路由配置；不要把路由问题误改成业务代码问题。

## 目录映射规则

标准后端模块通常按下面结构组织：

- `src/main/java/.../domain/Entity.java`
- `src/main/java/.../domain/bo/EntityBo.java`
- `src/main/java/.../domain/vo/EntityVo.java`
- `src/main/java/.../mapper/EntityMapper.java`
- `src/main/java/.../service/IEntityService.java`
- `src/main/java/.../service/impl/EntityServiceImpl.java`
- `src/main/java/.../controller/EntityController.java`

标准生成器模板通常对应：

- `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 起点

微服务相关目录通常按下面结构组织：

- `ruoyi-auth`、`ruoyi-gateway`、`ruoyi-modules/*`：具体服务实现与服务内 controller/service/mapper。
- `ruoyi-api/ruoyi-api-system|resource|workflow`：跨服务契约层，放 `Remote*Service`、远程 BO/VO/model、mock/stub。
- `ruoyi-modules/*/src/main/java/.../dubbo/`：`@DubboService` 提供者实现。
- `ruoyi-*/src/main/resources/application.yml`：服务自身端口、应用名、Nacos 配置导入入口。

## 任务分型

### 1. 标准单表 CRUD

优先按 generator 模板落骨架，再补校验、权限、导出、翻译等项目约定。

### 2. 强业务模块扩展

如果目标模块像 `system`、`workflow` 一样已经有复杂逻辑，优先增量修改，不要回退成模板式简化代码。

### 3. 微服务协作扩展

如果需求横跨两个及以上服务，先明确服务提供方、消费方与契约归属：

- 对外给其他服务复用的能力，放到 `ruoyi-api`。
- provider 在归属服务内实现 `dubbo/Remote*ServiceImpl`。
- consumer 通过 `@DubboReference` 调用，不在 controller 里手写 HTTP 互调。
- 需要容错时复用现有 `Mock` / `Stub` 风格，不自造另一套降级约定。

### 4. 基础能力复用

如果涉及数据权限、缓存、事务、导入导出、字典、翻译、加密、分组校验，优先查项目已有做法并复用公共能力。

## 输出要求

使用本 skill 时，默认期望产出应满足：

- 后端分层完整，不直接在 controller 里堆业务逻辑。
- `BO/VO/Entity` 职责分明。
- 查询、分页、删除校验、写入校验逻辑闭环完整。
- 权限、日志、防重、事务、数据权限尽量贴近同模块现有实现。
- 如果同步改前端，前端 API 路径和后端接口保持一致。
- 如果跨服务，`ruoyi-api` 契约、provider 实现、consumer 调用三处保持一致。
- 如果涉及跨服务写操作，明确本地事务与分布式事务边界，不要无故扩大 `@GlobalTransactional` 范围。

## 快速检查清单

- 包路径和 `@RequestMapping` 与模块保持一致。
- 权限标识遵循 `${module}:${business}:${action}`。
- Mapper 继承 `BaseMapperPlus<Entity, Vo>`。
- Service 使用 `baseMapper`，并按场景返回 `PageResult` 或 `List<Vo>`。
- 查询代码优先使用 `LambdaQueryWrapper`，复杂模块沿用既有 MPJ 联表风格。
- BO 使用 `@AutoMapper(target = Entity.class, reverseConvertGenerate = false)`。
- VO 使用 `@AutoMapper(target = Entity.class)`。
- 前端 API 路径与后端路由完全对应。
- 前端列表页继续使用仓库里的 `proxy?.addDateRange`、`proxy?.$modal`、`proxy?.download`、`useDict`、`pagination` 等工具。
- 不要把当前仓库的 Dubbo 远程调用误写成 Feign。
- 新增远程能力时，先看是否应落在 `ruoyi-api-system`、`ruoyi-api-resource`、`ruoyi-api-workflow`。
- `@DubboReference` 只有在确实跨服务时才新增；服务内调用继续直接走本地 service。
- gateway 负责入口、鉴权、过滤、跨域、日志等，不承载具体业务 service 逻辑。
- 服务 `application.yml` 继续沿用当前的 `spring.config.import` + `optional:nacos:*` 结构，不要擅自改成另一套配置加载方式。

## 推荐提问方式

推荐把任务描述到下面这个粒度：

- 目标模块和业务名
- 是新建模块还是修改已有模块
- 表名或接口前缀
- 是否需要分页、导出、导入、数据权限、字典、翻译、联表
- 希望参考哪个现有模块

例如：

- 使用 `$ruoyi-plus-ai-coding` 在 `system` 模块新增一个标准单表 CRUD，参考 `SysConfig` 与 generator 模板。
- 使用 `$ruoyi-plus-ai-coding` 修改 `workflow/category` 的查询和导出逻辑，保持现有模块风格。