1. 为什么选择RuoYi-Vue-Plus进行业务模块重构RuoYi-Vue-Plus作为RuoYi-Vue的增强版本在保留原有功能的基础上针对现代开发需求做了大量优化。我在最近的一个后台管理系统项目中选择了这个框架实测下来开发效率提升了40%以上。它最大的优势在于对单体架构和分布式场景的双重支持这让业务模块重构变得非常灵活。这个框架原生集成了Mybatis-Plus和Hutool这意味着我们不用再花时间去折腾基础配置。比如要做个用户管理模块用Mybatis-Plus的代码生成器5分钟就能生成全套CRUD代码。Hutool则解决了工具类分散的问题以前需要自己封装的日期处理、加密解密等功能现在直接调用现成方法就行。2. SpringDoc集成实现API文档自动化2.1 从Knife4j迁移到SpringDoc的实战经验在旧项目中我们常用Knife4j做接口文档但这次我选择了SpringDoc。配置起来特别简单只需要在pom.xml里加个依赖dependency groupIdorg.springdoc/groupId artifactIdspringdoc-openapi-starter-webmvc-ui/artifactId version2.1.0/version /dependency然后在application.yml中添加基本配置springdoc: swagger-ui: path: /swagger-ui.html api-docs: path: /v3/api-docs default-produces-media-type: application/json2.2 如何让文档与代码保持同步SpringDoc最让我惊喜的是它的自动化程度。只要在Controller方法上使用标准注解文档就会自动更新。比如Operation(summary 获取用户列表) GetMapping(/users) public ResultListUser listUsers( Parameter(description 部门ID) RequestParam Long deptId) { // 业务逻辑 }这样生成的文档不仅包含参数说明还会自动识别返回类型。我建议在DTO字段上也要加Schema注解这样连字段级别的文档都有了。3. Mybatis-Plus最佳实践3.1 代码生成器的深度定制RuoYi-Vue-Plus自带的代码生成器已经很好用但我们可以做得更好。我通常会修改模板文件加入Swagger注解和参数校验// 在controller模板中加入 Operation(summary 新增${functionName}) PostMapping public ResultBoolean add(Validated RequestBody ${ClassName} ${className}) { return success(${className}Service.save(${className})); }3.2 高级查询的优雅实现Mybatis-Plus的Wrapper功能可以大幅简化复杂查询。比如要实现一个多条件用户查询public PageResultUserVO queryUsers(UserQuery query) { LambdaQueryWrapperUser wrapper Wrappers.lambdaQuery(); wrapper.eq(StringUtils.isNotBlank(query.getUsername()), User::getUsername, query.getUsername()) .between(query.getBeginTime() ! null query.getEndTime() ! null, User::getCreateTime, query.getBeginTime(), query.getEndTime()); return PageResult.success(userMapper.selectPage(query.buildPage(), wrapper)); }4. Hutool工具库的妙用4.1 告别繁琐的工具类编写Hutool几乎涵盖了所有常用工具需求。比如密码加密// 替代传统的MD5Utils String password SecureUtil.md5(password salt);日期处理也变得异常简单// 获取上个月最后一天 DateTime lastMonth DateUtil.endOfMonth(DateUtil.lastMonth());4.2 提升开发效率的冷门功能Hutool有些功能特别实用但容易被忽略。比如Excel导出ExcelWriter writer ExcelUtil.getWriter(); writer.addHeaderAlias(username, 用户名); writer.write(userList, true); writer.autoSizeColumnAll(); response.setContentType(application/vnd.ms-excel); writer.flush(response.getOutputStream(), true);还有发邮件功能三行代码搞定MailUtil.send(toexample.com, 测试邮件, 邮件内容, false);5. 重构过程中的坑与解决方案在重构用户管理模块时我遇到了几个典型问题。首先是权限校验原框架使用Shiro而RuoYi-Vue-Plus改用Sa-Token。迁移时要注意注解的变化// 原代码 RequiresPermissions(user:add) // 新代码 SaCheckPermission(user:add)其次是事务管理的问题。Mybatis-Plus的Service层方法默认都有事务但如果你在Controller直接调用Mapper记得加上Transactional注解。缓存处理也要特别注意。框架默认使用Redisson但配置方式和原来的RedisTemplate不同// 获取缓存示例 RBucketString bucket redissonClient.getBucket(key); bucket.set(value, 10, TimeUnit.MINUTES);6. 前后端协同开发技巧6.1 接口规范的统一建议在项目中建立统一的返回格式public class ResultT implements Serializable { private int code; private String msg; private T data; // 省略构造方法 }前端可以根据code值做统一处理比如axios.interceptors.response.use(response { if (response.data.code ! 200) { Message.error(response.data.msg) return Promise.reject(response.data.msg) } return response.data.data })6.2 联调时的调试技巧推荐使用Undertow的开发模式配置server: undertow: accesslog: enabled: true dir: ./logs worker-threads: 16这样可以在控制台看到详细的请求日志。对于复杂问题可以开启Mybatis-Plus的SQL日志mybatis-plus: configuration: log-impl: org.apache.ibatis.logging.stdout.StdOutImpl7. 性能优化实战7.1 数据库查询优化利用Mybatis-Plus的二级缓存CacheNamespace(implementation MybatisRedisCache.class, eviction MybatisRedisCache.class) public interface UserMapper extends BaseMapperUser {}对于常用但变化少的数据可以使用内存缓存Cacheable(value deptCache, key #deptId) public Dept getDeptById(Long deptId) { return deptMapper.selectById(deptId); }7.2 接口响应优化使用Hutool的线程池工具处理批量操作ThreadUtil.execAsync(() - { // 异步处理逻辑 }, true);对于导出等耗时操作建议采用异步导出进度查询的方式PostMapping(/export) public ResultString export() { String taskId IdUtil.fastUUID(); ThreadUtil.execute(() - exportService.doExport(taskId)); return Result.success(taskId); } GetMapping(/export/progress) public ResultInteger getProgress(String taskId) { return Result.success(exportService.getProgress(taskId)); }8. 项目部署与维护8.1 多环境配置管理使用Hutool的Profile功能简化配置// 根据启动参数切换环境 String env System.getProperty(env, dev); Profile.setProfile(env);然后在不同配置文件中定义环境相关参数# application-dev.yml server: port: 8080 # application-prod.yml server: port: 808.2 健康检查与监控SpringBoot-Admin的集成非常简单EnableAdminServer SpringBootApplication public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } }配合前端展示可以实时监控服务状态// 在前端项目中添加监控页面 { path: /monitor, component: () import(/views/monitor/index), meta: { title: 系统监控, icon: dashboard } }在实际项目中发现这套技术组合特别适合中小型后台管理系统开发。从需求分析到上线原本需要2个月的项目现在3周就能完成核心功能开发。最重要的是代码质量明显提高后续维护成本大幅降低。
基于RuoYi-Vue-Plus整合SpringDoc+Mybatis-Plus+Hutool重构单体业务模块 实现高效开发与文档同步
1. 为什么选择RuoYi-Vue-Plus进行业务模块重构RuoYi-Vue-Plus作为RuoYi-Vue的增强版本在保留原有功能的基础上针对现代开发需求做了大量优化。我在最近的一个后台管理系统项目中选择了这个框架实测下来开发效率提升了40%以上。它最大的优势在于对单体架构和分布式场景的双重支持这让业务模块重构变得非常灵活。这个框架原生集成了Mybatis-Plus和Hutool这意味着我们不用再花时间去折腾基础配置。比如要做个用户管理模块用Mybatis-Plus的代码生成器5分钟就能生成全套CRUD代码。Hutool则解决了工具类分散的问题以前需要自己封装的日期处理、加密解密等功能现在直接调用现成方法就行。2. SpringDoc集成实现API文档自动化2.1 从Knife4j迁移到SpringDoc的实战经验在旧项目中我们常用Knife4j做接口文档但这次我选择了SpringDoc。配置起来特别简单只需要在pom.xml里加个依赖dependency groupIdorg.springdoc/groupId artifactIdspringdoc-openapi-starter-webmvc-ui/artifactId version2.1.0/version /dependency然后在application.yml中添加基本配置springdoc: swagger-ui: path: /swagger-ui.html api-docs: path: /v3/api-docs default-produces-media-type: application/json2.2 如何让文档与代码保持同步SpringDoc最让我惊喜的是它的自动化程度。只要在Controller方法上使用标准注解文档就会自动更新。比如Operation(summary 获取用户列表) GetMapping(/users) public ResultListUser listUsers( Parameter(description 部门ID) RequestParam Long deptId) { // 业务逻辑 }这样生成的文档不仅包含参数说明还会自动识别返回类型。我建议在DTO字段上也要加Schema注解这样连字段级别的文档都有了。3. Mybatis-Plus最佳实践3.1 代码生成器的深度定制RuoYi-Vue-Plus自带的代码生成器已经很好用但我们可以做得更好。我通常会修改模板文件加入Swagger注解和参数校验// 在controller模板中加入 Operation(summary 新增${functionName}) PostMapping public ResultBoolean add(Validated RequestBody ${ClassName} ${className}) { return success(${className}Service.save(${className})); }3.2 高级查询的优雅实现Mybatis-Plus的Wrapper功能可以大幅简化复杂查询。比如要实现一个多条件用户查询public PageResultUserVO queryUsers(UserQuery query) { LambdaQueryWrapperUser wrapper Wrappers.lambdaQuery(); wrapper.eq(StringUtils.isNotBlank(query.getUsername()), User::getUsername, query.getUsername()) .between(query.getBeginTime() ! null query.getEndTime() ! null, User::getCreateTime, query.getBeginTime(), query.getEndTime()); return PageResult.success(userMapper.selectPage(query.buildPage(), wrapper)); }4. Hutool工具库的妙用4.1 告别繁琐的工具类编写Hutool几乎涵盖了所有常用工具需求。比如密码加密// 替代传统的MD5Utils String password SecureUtil.md5(password salt);日期处理也变得异常简单// 获取上个月最后一天 DateTime lastMonth DateUtil.endOfMonth(DateUtil.lastMonth());4.2 提升开发效率的冷门功能Hutool有些功能特别实用但容易被忽略。比如Excel导出ExcelWriter writer ExcelUtil.getWriter(); writer.addHeaderAlias(username, 用户名); writer.write(userList, true); writer.autoSizeColumnAll(); response.setContentType(application/vnd.ms-excel); writer.flush(response.getOutputStream(), true);还有发邮件功能三行代码搞定MailUtil.send(toexample.com, 测试邮件, 邮件内容, false);5. 重构过程中的坑与解决方案在重构用户管理模块时我遇到了几个典型问题。首先是权限校验原框架使用Shiro而RuoYi-Vue-Plus改用Sa-Token。迁移时要注意注解的变化// 原代码 RequiresPermissions(user:add) // 新代码 SaCheckPermission(user:add)其次是事务管理的问题。Mybatis-Plus的Service层方法默认都有事务但如果你在Controller直接调用Mapper记得加上Transactional注解。缓存处理也要特别注意。框架默认使用Redisson但配置方式和原来的RedisTemplate不同// 获取缓存示例 RBucketString bucket redissonClient.getBucket(key); bucket.set(value, 10, TimeUnit.MINUTES);6. 前后端协同开发技巧6.1 接口规范的统一建议在项目中建立统一的返回格式public class ResultT implements Serializable { private int code; private String msg; private T data; // 省略构造方法 }前端可以根据code值做统一处理比如axios.interceptors.response.use(response { if (response.data.code ! 200) { Message.error(response.data.msg) return Promise.reject(response.data.msg) } return response.data.data })6.2 联调时的调试技巧推荐使用Undertow的开发模式配置server: undertow: accesslog: enabled: true dir: ./logs worker-threads: 16这样可以在控制台看到详细的请求日志。对于复杂问题可以开启Mybatis-Plus的SQL日志mybatis-plus: configuration: log-impl: org.apache.ibatis.logging.stdout.StdOutImpl7. 性能优化实战7.1 数据库查询优化利用Mybatis-Plus的二级缓存CacheNamespace(implementation MybatisRedisCache.class, eviction MybatisRedisCache.class) public interface UserMapper extends BaseMapperUser {}对于常用但变化少的数据可以使用内存缓存Cacheable(value deptCache, key #deptId) public Dept getDeptById(Long deptId) { return deptMapper.selectById(deptId); }7.2 接口响应优化使用Hutool的线程池工具处理批量操作ThreadUtil.execAsync(() - { // 异步处理逻辑 }, true);对于导出等耗时操作建议采用异步导出进度查询的方式PostMapping(/export) public ResultString export() { String taskId IdUtil.fastUUID(); ThreadUtil.execute(() - exportService.doExport(taskId)); return Result.success(taskId); } GetMapping(/export/progress) public ResultInteger getProgress(String taskId) { return Result.success(exportService.getProgress(taskId)); }8. 项目部署与维护8.1 多环境配置管理使用Hutool的Profile功能简化配置// 根据启动参数切换环境 String env System.getProperty(env, dev); Profile.setProfile(env);然后在不同配置文件中定义环境相关参数# application-dev.yml server: port: 8080 # application-prod.yml server: port: 808.2 健康检查与监控SpringBoot-Admin的集成非常简单EnableAdminServer SpringBootApplication public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } }配合前端展示可以实时监控服务状态// 在前端项目中添加监控页面 { path: /monitor, component: () import(/views/monitor/index), meta: { title: 系统监控, icon: dashboard } }在实际项目中发现这套技术组合特别适合中小型后台管理系统开发。从需求分析到上线原本需要2个月的项目现在3周就能完成核心功能开发。最重要的是代码质量明显提高后续维护成本大幅降低。
