ruoyi-vue-pro代码生成器：一键生成前后端代码的神器
项目地址: https://gitcode.com/GitHub_Trending/ruoy/ruoyi-vue-pro 概述
在当今快速发展的软件开发领域，效率是决定项目成败的关键因素之一。ruoyi-vue-pro代码生成器作为一款强大的开发工具，能够显著提升开发效率，让开发者从重复的CRUD（增删改查）代码编写中解放出来，专注于业务逻辑的实现。
本文将深入解析ruoyi-vue-pro代码生成器的核心功能、使用方法和最佳实践，帮助您充分利用这一神器来加速项目开发。
代码生成器核心功能
多技术栈支持
ruoyi-vue-pro代码生成器支持多种技术栈组合，满足不同项目的需求：
| 技术栈 | 后端框架 | 前端框架 | 模板引擎 |
|---|---|---|---|
| 标准版 | Spring Boot + MyBatis Plus | Vue 2 + Element UI | Velocity |
| 进阶版 | Spring Boot + MyBatis Plus | Vue 3 + Vben Admin | Velocity |
| 企业版 | Spring Boot + MyBatis Plus | Vue 3 + Ant Design | Velocity |
完整的代码生成流程
支持的代码类型
代码生成器能够生成以下类型的代码文件：
-
后端代码
- 实体类（DO - Data Object）
- 数据访问层（Mapper接口和XML）
- 服务层接口和实现
- 控制器层（Controller）
- 请求/响应VO（Value Object）
- 枚举类
-
前端代码
- Vue组件
- API接口定义
- 路由配置
- 表单验证规则
- 类型定义文件
-
数据库脚本
- 建表SQL
- 初始化数据SQL
- 索引和约束定义
使用指南
环境准备
在使用代码生成器之前，需要确保以下环境配置：
# 项目依赖
JDK 1.8+
Maven 3.6+
Node.js 14+
MySQL 5.7+ 或其他支持的数据库
# 数据库配置
spring.datasource.url=jdbc:mysql://localhost:3306/your_database
spring.datasource.username=your_username
spring.datasource.password=your_password
代码生成步骤
第一步：配置数据源
在系统管理 → 基础设施 → 数据源配置中，添加您的数据库连接信息：
// 数据源配置示例
@Data
public class DataSourceConfigDO {
private Long id;
private String name; // 数据源名称
private String url; // 数据库连接URL
private String username; // 用户名
private String password; // 密码
private String driverClass; // 驱动类名
}
第二步：选择数据库表
进入代码生成器界面，选择已配置的数据源，系统会自动列出所有可用的数据库表：
-- 示例表结构
CREATE TABLE `sys_user` (
`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '用户ID',
`username` varchar(30) NOT NULL COMMENT '用户账号',
`password` varchar(100) NOT NULL COMMENT '密码',
`nickname` varchar(30) NOT NULL COMMENT '用户昵称',
`email` varchar(50) DEFAULT '' COMMENT '用户邮箱',
`mobile` varchar(11) DEFAULT '' COMMENT '手机号码',
`status` tinyint(4) DEFAULT '0' COMMENT '帐号状态（0正常 1停用）',
`create_time` datetime DEFAULT NULL COMMENT '创建时间',
`update_time` datetime DEFAULT NULL COMMENT '更新时间',
PRIMARY KEY (`id`),
UNIQUE KEY `username_unique` (`username`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='用户信息表';
第三步：配置生成参数
根据业务需求配置以下参数：
| 参数类别 | 参数名称 | 说明 | 示例值 |
|---|---|---|---|
| 基本配置 | 模块名 | 代码所属模块 | system |
| 基本配置 | 业务名 | 业务功能名称 | user |
| 基本配置 | 类注释 | 类描述信息 | 用户管理 |
| 前端配置 | Vue版本 | 前端框架版本 | Vue 3 |
| 前端配置 | UI框架 | 使用的UI组件库 | Element Plus |
| 高级配置 | 作者名 | 代码作者信息 | 您的姓名 |
| 高级配置 | 生成路径 | 代码输出路径 | /src/main/java |
第四步：预览和生成
在生成代码之前，可以预览将要生成的所有文件：
// 预览生成的Controller示例
@RestController
@RequestMapping("/system/user")
public class UserController {
@Resource
private UserService userService;
@GetMapping("/page")
public CommonResult<PageResult<UserRespVO>> getUserPage(UserPageReqVO reqVO) {
PageResult<UserDO> pageResult = userService.getUserPage(reqVO);
return success(UserConvert.INSTANCE.convertPage(pageResult));
}
@PostMapping("/create")
public CommonResult<Long> createUser(@Valid @RequestBody UserCreateReqVO reqVO) {
return success(userService.createUser(reqVO));
}
}
第五步：下载和使用
生成完成后，系统会提供一个ZIP压缩包，包含所有生成的代码文件。解压后按照以下步骤集成到项目中：
- 将Java文件复制到对应的包路径
- 将Vue文件复制到前端项目
- 执行SQL脚本初始化数据库
- 重启应用服务
高级特性
自定义模板机制
ruoyi-vue-pro代码生成器基于Velocity模板引擎，支持自定义模板：
## 后端Controller模板示例
package ${packageName}.controller;
import org.springframework.web.bind.annotation.*;
import javax.annotation.Resource;
@RestController
@RequestMapping("/${moduleName}/${businessName}")
public class ${className} {
@Resource
private ${serviceName} ${serviceVariableName};
@GetMapping("/page")
public CommonResult<PageResult<${respVOClassName}>> get${businessNameCap}Page(${pageReqVOClassName} reqVO) {
PageResult<${doClassName}> pageResult = ${serviceVariableName}.get${businessNameCap}Page(reqVO);
return success(${convertClassName}.INSTANCE.convertPage(pageResult));
}
}
多数据源支持
代码生成器支持多种数据库类型：
| 数据库类型 | 驱动类 | 连接URL格式 | 备注 |
|---|---|---|---|
| MySQL | com.mysql.cj.jdbc.Driver | jdbc:mysql://host:port/database | 最常用 |
| Oracle | oracle.jdbc.OracleDriver | jdbc:oracle:thin:@host:port:database | 企业级 |
| PostgreSQL | org.postgresql.Driver | jdbc:postgresql://host:port/database | 开源 |
| SQL Server | com.microsoft.sqlserver.jdbc.SQLServerDriver | jdbc:sqlserver://host:port;databaseName=name | Windows环境 |
字段类型映射
系统自动处理数据库字段类型到Java类型的映射：
// 字段类型映射配置
public class CodegenColumnDO {
private String columnName; // 字段名
private String dataType; // 数据库类型
private String columnType; // 字段类型（带长度）
private String javaType; // Java类型
private String javaField; // Java字段名
private String comment; // 字段注释
private boolean nullable; // 是否可为空
private boolean primaryKey; // 是否主键
}
映射关系表示例：
| 数据库类型 | Java类型 | 包装类型 | 默认值 |
|---|---|---|---|
| varchar | String | String | "" |
| int | int | Integer | 0 |
| bigint | long | Long | 0L |
| datetime | LocalDateTime | LocalDateTime | null |
| decimal | BigDecimal | BigDecimal | BigDecimal.ZERO |
| tinyint | int | Integer | 0 |
最佳实践
1. 命名规范建议
遵循统一的命名规范可以提升代码的可维护性：
// 后端命名规范
实体类：UserDO → 用户数据对象
服务接口：UserService → 用户服务
服务实现：UserServiceImpl → 用户服务实现
控制器：UserController → 用户控制器
请求VO：UserCreateReqVO → 用户创建请求值对象
响应VO：UserRespVO → 用户响应值对象
// 前端命名规范
API文件：user.ts → 用户API
Vue组件：UserList.vue → 用户列表组件
路由路径：/system/user → 系统用户管理
2. 代码生成策略
根据不同的业务场景采用不同的生成策略：
场景一：基础CRUD功能
- 生成完整的增删改查代码
- 包含分页查询和批量操作
- 自动生成前端列表和表单
场景二：树形结构数据
- 生成树形结构相关的递归方法
- 包含层级查询和路径处理
- 自动生成树形表格组件
场景三：关联查询需求
- 生成关联查询的SQL和Java代码
- 包含JOIN查询和结果映射
- 自动生成关联选择器组件
3. 自定义扩展建议
虽然代码生成器可以生成大部分标准代码，但某些特殊业务逻辑仍需手动扩展：
// 在生成的Service基础上扩展业务逻辑
@Service
public class UserServiceImpl implements UserService {
// 生成的标准方法
@Override
public PageResult<UserDO> getUserPage(UserPageReqVO reqVO) {
// 自动生成的代码...
}
// 手动扩展的业务方法
@Override
public void updateUserStatus(Long userId, Integer status) {
// 自定义业务逻辑...
UserDO user = getUser(userId);
user.setStatus(status);
updateUser(user);
// 记录操作日志
logService.createLog("更新用户状态", userId);
}
}
常见问题解答
Q1: 生成的代码需要手动修改吗？
A: 基础CRUD功能通常不需要修改，但业务逻辑相关的代码可能需要根据具体需求进行调整。建议在生成的代码基础上进行扩展，而不是直接修改生成的代码。
Q2: 如何更新已生成的代码？
A: 代码生成器支持同步功能，当数据库表结构发生变化时，可以通过"同步数据库"功能更新已生成的代码定义，然后重新生成代码。
Q3: 支持自定义模板吗？
A: 支持。您可以修改src/main/resources/codegen/目录下的Velocity模板文件来自定义代码生成格式。
Q4: 生成的前端代码如何集成？
A: 生成的前端代码需要手动复制到Vue项目的对应目录，并注册路由和菜单。系统提供了完整的组件和API定义。
性能优化建议
1. 批量操作优化
对于大量数据的生成需求，建议使用批量操作：
// 批量生成代码示例
@PostMapping("/batch-generate")
public CommonResult<Boolean> batchGenerateCode(@RequestBody List<Long> tableIds) {
for (Long tableId : tableIds) {
codegenService.generationCodes(tableId);
}
return success(true);
}
2. 模板缓存优化
启用模板缓存可以提升代码生成速度：
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
