ruoyi-code-generator

用途

该技能面向若依（RuoYi）框架，根据用户提供的数据表信息（表名、字段定义），按照若依框架规范自动生成完整的 CRUD 代码。适用于创建新模块、添加业务功能、根据表结构生成代码等场景。

主要能力

可生成以下内容：

Java 后端代码：Domain（实体类）、Mapper、Service、ServiceImpl、Controller
MyBatis XML 映射文件
Vue 前端代码：页面组件（列表页）、API 封装
菜单初始化 SQL

输入定义

用户需提供以下信息（可通过对话澄清获取）：

tableName（必填）：数据库表名，示例 sys_product
tableComment（必填）：表注释/功能名称，示例产品管理
columns（必填）：字段列表（含类型、注释）
packageName（可选）：包路径，默认 com.ruoyi.system
moduleName（可选）：模块名，默认取表前缀后的名称
businessName（可选）：业务名称，默认取表名去前缀
author（可选）：作者名，默认 ruoyi
tplCategory（可选）：模板类型 crud/tree/sub，默认 crud

字段定义示例：

{
  "tableName": "sys_product",
  "tableComment": "产品管理",
  "columns": [
    {"name": "product_id", "type": "bigint", "comment": "产品ID", "isPk": true, "isIncrement": true},
    {"name": "product_name", "type": "varchar(100)", "comment": "产品名称", "isRequired": true, "isQuery": true},
    {"name": "product_code", "type": "varchar(50)", "comment": "产品编码", "isRequired": true},
    {"name": "category_id", "type": "bigint", "comment": "分类ID", "dictType": "product_category"},
    {"name": "price", "type": "decimal(10,2)", "comment": "价格"},
    {"name": "status", "type": "char(1)", "comment": "状态（0正常 1停用）", "dictType": "sys_normal_disable"},
    {"name": "create_time", "type": "datetime", "comment": "创建时间"}
  ]
}

输出结构

生成的文件结构如下：

├── java/
│   ├── domain/{ClassName}.java          # 实体类
│   ├── mapper/{ClassName}Mapper.java    # Mapper接口
│   ├── service/I{ClassName}Service.java # Service接口
│   ├── service/impl/{ClassName}ServiceImpl.java  # Service实现
│   └── controller/{ClassName}Controller.java     # REST控制器
├── xml/
│   └── {ClassName}Mapper.xml             # MyBatis映射文件
├── vue/
│   ├── api/{businessName}.js             # API封装
│   └── views/{moduleName}/{businessName}/index.vue  # 页面组件
└── sql/
    └── {businessName}Menu.sql            # 菜单初始化SQL

使用方式

执行流程分为四步：

信息收集与验证：解析用户请求，识别表名与字段信息；缺少必要信息时主动询问；推断默认值（className 为表名转大驼峰并去除表前缀如 sys_，moduleName 为表前缀后的模块名，businessName 为表名去前缀后的小写形式，主键字段为 isPk=true 的字段，默认为 {tableName}_id）。
变量准备：计算模板变量，包括 ${tableName}、${tableComment}、${ClassName}、${className}、${moduleName}、${businessName}、${BusinessName}、${packageName}、${author}、${datetime}、${pkColumn}、${columns}、${permissionPrefix}（格式 moduleName:businessName）。
代码生成：从 templates/ 目录加载对应模板，进行变量替换，按字段配置处理 #if/#foreach 逻辑，输出最终代码文件。
自检与交付：检查生成代码是否符合规范，告知用户需要添加的依赖或配置，提供后续操作指引。

模板引用：Java 模板位于 templates/java/ 目录下的 .vm 文件，Vue 模板位于 templates/vue/ 目录，XML 模板位于 templates/xml/ 目录，SQL 模板位于 templates/sql/ 目录。

字段类型映射

bigint → Long（长整型）
int/integer → Integer（整型）
varchar/char/text → String（字符串）
datetime/timestamp → Date（日期时间）
date → Date（日期）
decimal/numeric → BigDecimal（高精度数值）
float/double → Double（浮点数）
tinyint(1)/bit → Boolean（布尔值）

约束条件

命名规范：类名使用大驼峰（PascalCase），变量名使用小驼峰（camelCase），包路径全小写。

编码规范：Java 文件使用 UTF-8 编码，缩进使用 4 个空格，必须包含完整的 Javadoc 注释。

安全规范：Controller 必须添加 @PreAuthorize 权限注解，删除操作必须添加 @Log 日志注解，敏感字段（如密码）不出现在列表展示中。

禁止事项：不生成测试类（如需要请单独请求）；不修改已存在的文件（除非用户明确要求）；不硬编码任何敏感信息。

适用场景与限制

适用场景包括创建新模块、添加业务功能、根据表结构生成代码等。兼容版本为 RuoYi-Vue v3.9.x，前端框架为 Vue 2 + Element UI，后端框架为 Spring Boot 2.x + MyBatis。其他版本兼容性、收费方式、价格等信息暂未提供。