Ruoyi框架MyBatis-Plus代码生成器深度优化实践

1. 项目概述

ruoyi作为国内流行的开源后台管理系统框架，其前后端分离版本在企业级应用开发中广受欢迎。在实际项目开发中，代码生成器是提升开发效率的利器，但默认生成的MyBatis-Plus代码格式往往需要二次调整才能符合团队规范。本文将分享如何深度优化ruoyi框架中的代码生成脚本，使其生成的MyBatis-Plus代码格式更符合企业级开发标准。

提示：本文基于ruoyi 4.7.3版本进行优化，但方法论适用于大多数基于MyBatis-Plus的代码生成场景

2. 核心需求解析

2.1 默认生成器的问题分析

ruoyi默认的代码生成器存在几个典型问题：

1. 实体类字段注释格式不统一，部分场景缺失
2. Mapper接口方法命名风格与团队规范不一致
3. Service层实现类中重复代码较多
4. Controller层Swagger注解配置不够完善
5. 生成的Vue前端代码缩进和命名风格需要手动调整

2.2 优化目标设定

我们的优化主要聚焦在以下几个方向：

• 统一实体类字段的注释格式（包含数据库字段类型和业务说明）
• 规范Mapper接口方法命名（遵循MyBatis-Plus最佳实践）
• 优化Service层模板减少重复代码
• 增强Controller层的Swagger文档支持
• 保持前后端代码风格一致性

3. 代码生成器原理解析

3.1 ruoyi代码生成器架构

ruoyi的代码生成器核心由三部分组成：

1. 模板引擎：基于Velocity 1.7
2. 元数据解析：通过JDBC获取表结构信息
3. 文件输出：按照预设目录结构生成文件

关键配置文件位置：

src/main/resources/templates/vm ├── java │ ├── controller.java.vm │ ├── domain.java.vm │ ├── mapper.java.vm │ ├── service.java.vm │ └── serviceImpl.java.vm └── vue ├── api.js.vm └── index.vue.vm

3.2 MyBatis-Plus特性集成

在优化过程中需要特别注意MyBatis-Plus的特性支持：

1. Lambda表达式查询支持
2. 自动分页插件集成
3. 逻辑删除标识处理
4. 字段自动填充配置
5. 乐观锁版本控制

4. 关键优化实现步骤

4.1 实体类模板优化

修改domain.java.vm模板，主要改进点：

/** * ${functionName}实体类 * * @author ${author} * @date ${datetime} */ @TableName("${tableName}") public class ${ClassName} extends BaseEntity { private static final long serialVersionUID = 1L; #foreach ($column in $columns) #if($column.columnComment && $column.columnComment != '') /** * ${column.columnComment} (${column.columnType}) */ #else /** * ${column.columnName} (${column.columnType}) */ #end #if($column.javaField == 'delFlag') @TableLogic #end #if($column.isPk == '1') @TableId(type = IdType.AUTO) #end private $column.javaType $column.javaField; #end }

优化说明：

1. 统一注释格式，包含字段类型信息
2. 自动识别主键和逻辑删除字段
3. 完善类级别的JavaDoc

4.2 Mapper接口优化

修改mapper.java.vm模板：

@Mapper public interface ${ClassName}Mapper extends BaseMapper<${ClassName}> { /** * 根据条件分页查询${functionName}列表 * * @param query 查询条件 * @return 分页结果 */ Page<${ClassName}> select${ClassName}Page(@Param("query") ${ClassName} query); /** * 批量删除${functionName} * * @param ids 需要删除的数据ID * @return 删除结果 */ int delete${ClassName}ByIds(@Param("ids") Long[] ids); }

关键改进：

1. 使用MyBatis-Plus的BaseMapper作为父接口
2. 添加常用业务方法的默认实现
3. 完善方法级别的JavaDoc

4.3 Service层优化

serviceImpl.java.vm模板优化重点：

@Service public class ${ClassName}ServiceImpl extends ServiceImpl<${ClassName}Mapper, ${ClassName}> implements I${ClassName}Service { @Override public Page<${ClassName}> select${ClassName}Page(${ClassName} ${className}) { return lambdaQuery() .eq(${className}.getId() != null, ${ClassName}::getId, ${className}.getId()) .like(StringUtils.isNotBlank(${className}.getName()), ${ClassName}::getName, ${className}.getName()) .page(new Page<>(pageNum, pageSize)); } @Override @Transactional(rollbackFor = Exception.class) public int delete${ClassName}ByIds(Long[] ids) { return baseMapper.delete${ClassName}ByIds(ids); } }

优化亮点：

1. 使用Lambda表达式构建查询条件
2. 自动处理空值判断
3. 统一事务管理
4. 减少重复代码

5. 前端代码协同优化

5.1 Vue API模板优化

api.js.vm模板改进：

import request from '@/utils/request' // 查询${functionName}列表 export function list${BusinessName}(query) { return request({ url: '/${moduleName}/${businessName}/list', method: 'get', params: query }) } // 导出${functionName} export function export${BusinessName}(query) { return request({ url: '/${moduleName}/${businessName}/export', method: 'get', params: query, responseType: 'blob' }) }

5.2 Vue页面模板优化

index.vue.vm关键改进：

<template> <div class="app-container"> <el-table v-loading="loading" :data="${businessName}List" @selection-change="handleSelectionChange" > <el-table-column type="selection" width="55" align="center" /> #foreach($column in $columns) #if($column.list == '1') <el-table-column label="${column.columnComment}" align="center" prop="${column.javaField}" /> #end #end </el-table> </div> </template>

6. 高级配置技巧

6.1 全局配置优化

在application.yml中添加MyBatis-Plus全局配置：

mybatis-plus: global-config: db-config: id-type: auto logic-delete-field: delFlag logic-not-delete-value: 0 logic-delete-value: 1 configuration: map-underscore-to-camel-case: true log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

6.2 代码风格统一配置

创建.editorconfig文件确保生成代码风格一致：

root = true [*] charset = utf-8 indent_style = space indent_size = 2 end_of_line = lf insert_final_newline = true trim_trailing_whitespace = true

7. 常见问题与解决方案

7.1 字段类型映射问题

常见字段类型映射配置（在GenUtil.java中补充）：

// 数据库类型到Java类型的映射 private static Map<String, String> javaTypeMap = new HashMap<>(); static { javaTypeMap.put("tinyint", "Integer"); javaTypeMap.put("smallint", "Integer"); javaTypeMap.put("mediumint", "Integer"); javaTypeMap.put("int", "Integer"); javaTypeMap.put("bigint", "Long"); javaTypeMap.put("float", "Float"); javaTypeMap.put("double", "Double"); // 其他类型映射... }

7.2 分页查询优化

改进分页查询实现方式：

public Page<${ClassName}> select${ClassName}Page(${ClassName} query) { return page(new Page<>(query.getPageNum(), query.getPageSize()), new LambdaQueryWrapper<${ClassName}>() .eq(query.getId() != null, ${ClassName}::getId, query.getId()) .like(StringUtils.isNotBlank(query.getName()), ${ClassName}::getName, query.getName()) ); }

8. 实际应用效果对比

8.1 优化前后代码对比

以用户管理模块为例：

优化前：

@TableName("sys_user") public class User { private Long userId; private String userName; // getter/setter... }

优化后：

/** * 用户信息实体 * * @author ruoyi */ @TableName("sys_user") public class User extends BaseEntity { private static final long serialVersionUID = 1L; /** * 用户ID (bigint) */ @TableId(type = IdType.AUTO) private Long userId; /** * 用户名称 (varchar) */ private String userName; // 其他字段... }

8.2 生成效率提升

经过优化后：

• 代码规范符合率从60%提升到95%+
• 二次修改时间减少约70%
• 团队协作一致性显著提高

9. 扩展优化思路

9.1 动态模板支持

可以扩展支持多套模板，根据项目需求选择：

public enum TemplateType { DEFAULT("默认模板"), SIMPLE("简洁模板"), ENTERPRISE("企业级模板"); private String desc; // 构造方法等... }

9.2 自动生成测试用例

在模板中添加单元测试生成支持：

@SpringBootTest public class ${ClassName}ServiceTest { @Autowired private I${ClassName}Service ${className}Service; @Test public void testSelectById() { ${ClassName} result = ${className}Service.getById(1L); Assert.notNull(result, "查询结果不应为null"); } }

10. 部署与使用建议

10.1 项目集成方式

建议将优化后的代码生成器作为独立模块集成：

ruoyi-modules └── ruoyi-generator ├── src/main/resources/templates/vm └── pom.xml

10.2 团队规范制定

配套的代码规范建议：

1. 实体类必须包含完整字段注释
2. Service方法必须添加事务注解
3. Controller层统一返回结果封装
4. 前端API调用统一错误处理
5. Vue组件命名遵循PascalCase规则

在实际项目中，我们团队通过这套优化方案，将代码生成器的实用价值提升了3倍以上。特别是在大型项目中，统一的代码风格和完整的注释显著降低了维护成本。一个实用的建议是：定期根据团队的实际使用反馈调整模板，使其越来越贴合项目需求。