Ruoyi Plus AI Coding

RuoYi Plus AI 编码规范

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

适用场景

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

• 新增标准 CRUD 模块。
• 根据新表结构补齐 entity、bo、vo、mapper、service、controller。
• 修改已有模块的查询、校验、导入导出、数据权限、事务逻辑。
• 修改 ruoyi-common 公共能力，例如 mybatis 查询构造器、translation、json enhance、excel、oss、redis、web 配置。
• 修改 Cloud 专属能力，例如 ruoyi-api 远程契约、Dubbo provider/consumer、Gateway/Auth、Nacos 配置约定、Seata 分布式事务、服务间数据权限透传。
• 补充或修正 JavaDoc 注释，尤其是公共 API、接口、BO/VO/Entity 字段、Mapper 默认方法、Service/Controller 方法。
• 在系统、监控、工作流、demo 等模块内按现有约定扩展业务代码。
• 为后端新增接口同步补前端 api/types/index.vue 骨架。

不适用场景

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

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

执行流程

1. 先判断任务类型，并按“文档读取规则”读取当前任务需要的 reference。
2. 确认目标模块，优先复用同模块中最近似功能的写法。
3. 新增标准 CRUD 代码前，先读取 ruoyi-modules/ruoyi-gen/src/main/resources/fm/ 下的模板。
4. 命名和分层保持与仓库一致： domain entity、domain.bo、domain.vo、mapper、service、service.impl、controller。
5. 优先在生成器结构上扩展，不要自行发明新的分层。
6. 修改 ruoyi-system 这类复杂模块前，先阅读同类现有实现，因为这些模块通常比生成器默认产物多出数据权限、联表、缓存、安全校验等逻辑。
7. 修改 ruoyi-common 公共模块前，先阅读同包接口、实现类和调用点，优先保持已有 API 语义与兼容性。
8. 只补注释或文档时，不运行无关格式化，不重排 import，不改代码逻辑。

文档读取规则

使用本 skill 时，先按任务类型读取适用 reference，不一次性展开所有文档：

• 后端 Java、Mapper、Service、Controller、BO、VO、Entity、权限、查询、公共模块或 JavaDoc 任务，先读 references/backend.md。
• Cloud 专属能力，例如 Dubbo 远程调用、ruoyi-api 契约、服务拆分、Gateway、Nacos、Seata 分布式事务、服务间数据权限透传，先读 references/cloud.md。
• 前端 Vue、TypeScript、api、types 或页面任务，先读 references/frontend.md。
• 不确定任务边界、需要标准调用方式或需要对照典型场景时，再读 references/examples.md。

reference 用来约束实现方式和自检范围；发生冲突时，仍以当前模块真实代码和实际调用点为准。

优先级规则

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

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。

Cloud 规则

Dubbo、ruoyi-api、Gateway/Auth、Nacos、Seata、服务间数据权限透传的具体规则见 references/cloud.md。

前端规则

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

使用案例

具体调用方式见 references/examples.md。

仓库通用规则

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

决策规则

• 如果任务是围绕单表的标准 CRUD，尽量贴近生成器默认产物。
• 如果目标模块已经存在自定义校验、数据权限、事务、缓存、Excel 导入导出、联表查询等逻辑，应在此基础上扩展，不要为了“简洁”把它们削平。
• 如果附近 controller 接口已经带有权限、日志、防重、加密、分组校验等注解，新接口默认同步保持一致，除非有明确理由不这样做。
• 如果 BO 或 VO 需要字段校验、翻译、Excel 注解，应优先参考同模块同用途对象，不要机械套通用注解。
• 如果修改公共基础模块，优先保持公开 API 兼容，新增能力要查调用点和同包风格。
• 如果任务只涉及注释，默认补 JavaDoc 并保持实现不变；框架覆写方法不强行重复注释，除非业务语义不直观。

目录映射规则

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

• 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

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

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

任务分型

1. 标准单表 CRUD

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