devbox
不正经
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

SpringBoot 集成MyBatis-Plus-Generator（最新版3.5.2版本）自动生成代码（附带集成MyBatis-Plus)

作者：不正经 | 2024-04-16 13:52:52

赞

踩

mybatis-plus-generator

官方文档

示例项目技术栈

  • spring boot 2.3.12.RELEASE
  • mybatis 3.5.2
  • mybatis plus 3.5.2
  • mybatis plus generator 3.5.2
  • mysql 8.0.17
  • velocity 2.3
  • hutool 5.8.15
  • druid 1.2.8
  • lombok 自带

示例程序选择的技术目前各项技术的稳定版本。

前言

相信大家厌烦重复的造轮子过程，编写与数据库表对应的实体类，接着再进行创建各种层次的包（mapper,service,impl)，而现在一款神器登场了，它就是：MpBatis-Plus的代码自动生成器。能够节约大部分时间，还能覆盖许多增删改查方法，加快我们的开发速度。

 项目源地址放在gitee仓库，想要源代码的读者也可以根据实际情况自取，对你有帮助的话不妨点个赞加个Star⭐吧

代码源地址PracticeCode: 练习

项目搭建

1. 创建表

  1. SET NAMES utf8mb4;
  2. SET FOREIGN_KEY_CHECKS = 0;
  3.  
  4. -- ----------------------------
  5. -- Table structure for user
  6. -- ----------------------------
  7. DROP TABLE IF EXISTS `user`;
  8. CREATE TABLE `user`  (
  9.   `id` bigint(0) NOT NULL AUTO_INCREMENT,
  10.   `name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL,
  11.   `password` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL,
  12.   PRIMARY KEY (`id`) USING BTREE
  13. ) ENGINE = InnoDB AUTO_INCREMENT = 1 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_0900_ai_ci ROW_FORMAT = Dynamic;
  14.  
  15. -- ----------------------------
  16. -- Records of user
  17. -- ----------------------------
  18. INSERT INTO `user` VALUES (1, 'yeye', '123');
  19.  
  20. SET FOREIGN_KEY_CHECKS = 1;

2. 创建Spring Boot项目

创建Spring Boot项目，在pom.xml文件中引入如下依赖：

  1. <properties>
  2.   <java.version>1.8</java.version>
  3.   <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  4.   <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  5.   <spring-boot.version>2.3.12.RELEASE</spring-boot.version>
  6.   <hutool.version>5.8.15</hutool.version>
  7.   <mybatis-plus.version>3.5.2</mybatis-plus.version>
  8.   <velocity.version>2.3</velocity.version>
  9.   <mysql.version>8.0.17</mysql.version>
  10.   <fastjson.version>2.0.5</fastjson.version>
  11.   <druid.version>1.2.8</druid.version>
  12. </properties>
  13.  
  14. <dependencies>
  15.   <dependency>
  16.     <groupId>com.alibaba</groupId>
  17.     <artifactId>fastjson</artifactId>
  18.     <version>${fastjson.version}</version>
  19.   </dependency>
  20.  
  21.   <!-- https://mvnrepository.com/artifact/com.alibaba/druid-spring-boot-starter -->
  22.   <dependency>
  23.     <groupId>com.alibaba</groupId>
  24.     <artifactId>druid-spring-boot-starter</artifactId>
  25.     <version>${druid.version}</version>
  26.   </dependency>
  27.   <!-- mysql驱动 -->
  28.   <dependency>
  29.     <groupId>mysql</groupId>
  30.     <artifactId>mysql-connector-java</artifactId>
  31.     <version>${mysql.version}</version>
  32.     <scope>runtime</scope>
  33.   </dependency>
  34.  
  35.  
  36.   <!-- https://mvnrepository.com/artifact/cn.hutool/hutool-all -->
  37.   <dependency>
  38.     <groupId>cn.hutool</groupId>
  39.     <artifactId>hutool-all</artifactId>
  40.     <version>${hutool.version}</version>
  41.   </dependency>
  42.  
  43.   <dependency>
  44.     <groupId>com.baomidou</groupId>
  45.     <artifactId>mybatis-plus-boot-starter</artifactId>
  46.     <version>${mybatis-plus.version}</version>
  47.   </dependency>
  48.  
  49.   <dependency>
  50.     <groupId>com.baomidou</groupId>
  51.     <artifactId>mybatis-plus-generator</artifactId>
  52.     <version>${mybatis-plus.version}</version>
  53.   </dependency>
  54.  
  55.   <dependency>
  56.     <groupId>org.apache.velocity</groupId>
  57.     <artifactId>velocity-engine-core</artifactId>
  58.     <version>${velocity.version}</version>
  59.   </dependency>
  60.  
  61.   <dependency>
  62.     <groupId>org.springframework.boot</groupId>
  63.     <artifactId>spring-boot-starter-web</artifactId>
  64.   </dependency>
  65.  
  66.   <dependency>
  67.     <groupId>org.projectlombok</groupId>
  68.     <artifactId>lombok</artifactId>
  69.     <optional>true</optional>
  70.   </dependency>
  71.   <dependency>
  72.     <groupId>org.springframework.boot</groupId>
  73.     <artifactId>spring-boot-starter-test</artifactId>
  74.     <scope>test</scope>
  75.     <exclusions>
  76.       <exclusion>
  77.         <groupId>org.junit.vintage</groupId>
  78.         <artifactId>junit-vintage-engine</artifactId>
  79.       </exclusion>
  80.     </exclusions>
  81.   </dependency>
  82. </dependencies>


MyBatis Plus Generator支持的模板引擎有Velocity、Beetl、FreeMarker，笔者这里选择的是MyBatis Plus Generator默认的模板引擎 — Velocity 2.3，选择不同的模板引擎导入不同的模板即可。

3. 创建代码生成器启动类

数据源配置和全局代码配置类

  1. String password = "123456";
  2. String username = "root";
  3. String url = "jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=Asia/Shanghai";
  4. DataSourceConfig.Builder dataSourceConfig = new DataSourceConfig.Builder(url, username, password);
  5. String finalProjectPath = System.getProperty("user.dir"); //当前项目根目录
  6.  
  7. // dataSourceConfig数据源
  8. FastAutoGenerator.create(dataSourceConfig)
  9. // 全局代码配置类
  10. .globalConfig(builder -> {
  11.     builder.author("yeye") // 设置作者
  12.     .enableSwagger() // 开启 swagger 模式
  13.     .fileOverride() // 覆盖已生成文件
  14.     .disableOpenDir() //禁止打开输出目录
  15.     .outputDir(finalProjectPath + "/src/main/java"); // 指定输出目录
  16. })
  17. // 包配置
  18. .packageConfig(builder -> {
  19.     ///
  20. })
  21. // 策略配置
  22. .strategyConfig(builder -> {
  23.     ///
  24. })
  25. // 自定义模版引擎
  26. .injectionConfig(consumer -> {
  27.     ///
  28. })
  29. // 选择模板引擎
  30. .templateEngine(
  31.     ///
  32. )
  33. // 执行
  34. .execute();

包配置

  1. FastAutoGenerator.create(dataSourceConfig)
  2. // 全局代码配置类
  3. .globalConfig(builder -> {
  4.     //
  5. })
  6. // 包配置
  7. .packageConfig(builder -> {
  8.     builder.parent("com.yeye") // 设置父包名
  9.     .entity("model") //设置entity包名
  10.     .controller("web.controller")//设置controller包名
  11.     .mapper("dao")//设置mapper包名
  12.     .service("service")//设置service包名
  13.     .serviceImpl("service.impl")//设置impl包名
  14.     .other("other")//设置other包名
  15.     .pathInfo(Collections.singletonMap(OutputFile.xml, finalProjectPath + "/src/main/resources/mapper")); // 设置mapperXml生成路径
  16. })
  17. // 策略配置
  18. .strategyConfig(builder -> {
  19.     ///
  20. })
  21. // 自定义模版引擎
  22. .injectionConfig(consumer -> {
  23.     ///
  24. })
  25. // 选择模板引擎
  26. .templateEngine(
  27.     ///
  28. )
  29. // 执行
  30. .execute();

在包配置中，笔者配置了父包名，配置了mybatis mapper文件存储路径，配置 Entity 包名、Mapper 包名、Service 包名、Controller 包名的。

策略配置

  1. // dataSourceConfig数据源
  2. FastAutoGenerator.create(dataSourceConfig)
  3. //
  4. })
  5. // 包配置
  6. .packageConfig(builder -> {
  7.     ///
  8. })
  9. // 策略配置
  10. .strategyConfig(builder -> {
  11.  
  12.     if (!CollectionUtils.isEmpty(tableList)) {
  13.         builder.addInclude(tableList);
  14.     }
  15.  
  16.     builder.addTablePrefix("wms_");// 设置过滤表前缀
  17.  
  18.     builder.entityBuilder() // entity配置
  19.     .enableRemoveIsPrefix()
  20.     .enableTableFieldAnnotation()
  21.     .enableLombok();
  22.  
  23.     builder.controllerBuilder() // controller配置
  24.     .enableRestStyle();
  25.  
  26.     builder.serviceBuilder() // service配置
  27.     .formatServiceFileName("%sService")
  28.     .formatServiceImplFileName("%sServiceImpl")
  29.     .fileOverride();
  30.  
  31.     builder.mapperBuilder() // mapper配置
  32.     .enableBaseResultMap()
  33.     .enableMapperAnnotation()
  34.     .formatMapperFileName("%sDao")
  35.     .formatXmlFileName("%sMapper")
  36.     .enableBaseColumnList();
  37.     if (isOverride) { // 覆写配置
  38.         builder.entityBuilder() // entity配置
  39.         .fileOverride();
  40.         builder.controllerBuilder() // controller配置
  41.         .fileOverride();
  42.         builder.serviceBuilder() // service配置
  43.         .fileOverride();
  44.         builder.mapperBuilder() // mapper配置
  45.         .fileOverride();
  46.     }
  47. })
  48. // 自定义模版引擎
  49. .injectionConfig(consumer -> {
  50.     ///
  51. })
  52. // 选择模板引擎
  53. .templateEngine(
  54.     ///
  55. )
  56. // 执行
  57. .execute();

在策略配置中，笔者配置了需要生成的表名、过滤表前缀、开启 Lombok、覆盖已生成文件、下划线转驼峰命、Service 接口文件及实现类的文件名以及是否覆写。

自定义模版引擎

  1. // dataSourceConfig数据源
  2. FastAutoGenerator.create(dataSourceConfig)
  3. // 全局代码配置类
  4. .globalConfig(builder -> {
  5.     //
  6. })
  7. // 包配置
  8. .packageConfig(builder -> {
  9.     ///
  10. })
  11. // 策略配置
  12. .strategyConfig(builder -> {
  13.     ///
  14. })
  15. // 自定义模版引擎
  16. .injectionConfig(consumer -> {
  17.     Map<String, String> customFile = new HashMap<>();
  18.     customFile.put("DTO.java", "/templates/entityDTO.java.ftl"); //自定义模版引擎
  19.     consumer.customFile(customFile);
  20. })
  21. // 选择模板引擎
  22. .templateEngine(
  23.     ///
  24. )
  25. // 执行
  26. .execute();

选择模板引擎

  1. // dataSourceConfig数据源
  2. FastAutoGenerator.create(dataSourceConfig)
  3. // 全局代码配置类
  4. //
  5. })
  6. // 包配置
  7. .packageConfig(builder -> {
  8.     ///
  9. })
  10. // 策略配置
  11. .strategyConfig(builder -> {
  12.     ///
  13. })
  14. // 自定义模版引擎
  15. .injectionConfig(consumer -> {
  16.     ///
  17. })
  18. // 选择模板引擎
  19. .templateEngine(
  20. new VelocityTemplateEngine()
  21. )
  22. // 执行
  23. .execute();

4. 代码生成器启动类完整代码

完整的代码生成器启动类 CodeGenerator.java 内容如下：

  1. package com.yeye.util;
  2.  
  3.  
  4. import com.baomidou.mybatisplus.generator.FastAutoGenerator;
  5. import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
  6. import com.baomidou.mybatisplus.generator.config.OutputFile;
  7. import com.baomidou.mybatisplus.generator.engine.VelocityTemplateEngine;
  8. import org.springframework.util.CollectionUtils;
  9.  
  10. import java.util.*;
  11.  
  12. public class CodeGenerator {
  13.  
  14.   public static void main(String[] args) {
  15.     String password = "123456";
  16.     String username = "root";
  17.     String url = "jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=Asia/Shanghai";
  18.     DataSourceConfig.Builder dataSourceConfig = new DataSourceConfig.Builder(url, username, password);
  19.  
  20.     //String finalProjectPath = System.getProperty("user.dir"); //当前项目根目录
  21.     String finalProjectPath = Objects.requireNonNull(CodeGenerator.class.getClassLoader().getResource(""))
  22.       .getPath().replace("/target/classes/", "");
  23.  
  24.     List<String> tableList = new ArrayList<>();
  25.     tableList.add("user");    // 生成全部table注释add掉就好
  26.     // 写死
  27.     creteModel(dataSourceConfig, finalProjectPath, Boolean.TRUE, tableList);
  28.  
  29.     // 手动输入（互动式）
  30.     createSingleModel(dataSourceConfig,finalProjectPath);
  31.   }
  32.  
  33.   private static void creteModel(DataSourceConfig.Builder dataSourceConfig,
  34.                                  String finalProjectPath,
  35.                                  Boolean isOverride,
  36.                                  List<String> tableList) {
  37.     // dataSourceConfig数据源
  38.     FastAutoGenerator.create(dataSourceConfig)
  39.       // 全局代码配置类
  40.       .globalConfig(builder -> {
  41.         builder.author("yeye") // 设置作者
  42. //          .enableSwagger() // 开启 swagger 模式
  43.           .fileOverride() // 覆盖已生成文件
  44.           .disableOpenDir() //禁止打开输出目录
  45.           .outputDir(finalProjectPath + "/src/main/java"); // 指定输出目录
  46.       })
  47.       // 包配置
  48.       .packageConfig(builder -> {
  49.         builder.parent("com.yeye") // 设置父包名
  50.           .entity("model") //设置entity包名
  51.           .controller("web.controller")
  52.           .mapper("dao")
  53.           .service("service")
  54.           .serviceImpl("service.impl")
  55.           .other("other")
  56.           .pathInfo(Collections.singletonMap(OutputFile.xml, finalProjectPath + "/src/main/resources/mapper")); // 设置mapperXml生成路径
  57.  
  58.       })
  59.       // 策略配置
  60.       .strategyConfig(builder -> {
  61.  
  62.         if (!CollectionUtils.isEmpty(tableList)) {
  63.           builder.addInclude(tableList);
  64.         }
  65.  
  66.         builder.addTablePrefix("wms_");// 设置过滤表前缀
  67.  
  68.         builder.entityBuilder() // entity配置
  69.           .enableRemoveIsPrefix()
  70.           .enableTableFieldAnnotation()
  71.           .enableLombok();
  72.  
  73.         builder.controllerBuilder() // controller配置
  74.           .enableRestStyle();
  75.  
  76.         builder.serviceBuilder() // service配置
  77.           .formatServiceFileName("%sService")
  78.           .formatServiceImplFileName("%sServiceImpl")
  79.           .fileOverride();
  80.  
  81.         builder.mapperBuilder() // mapper配置
  82.           .enableBaseResultMap()
  83.           .enableMapperAnnotation()
  84.           .formatMapperFileName("%sDao")
  85.           .formatXmlFileName("%sMapper")
  86.           .enableBaseColumnList();
  87.         if (isOverride) {
  88.           builder.entityBuilder() // entity配置
  89.             .fileOverride();
  90.           builder.controllerBuilder() // controller配置
  91.             .fileOverride();
  92.           builder.serviceBuilder() // service配置
  93.             .fileOverride();
  94.           builder.mapperBuilder() // mapper配置
  95.             .fileOverride();
  96.         }
  97.       })
  98.       // 自定义模版引擎
  99.       .injectionConfig(consumer -> {
  100.         Map<String, String> customFile = new HashMap<>();
  101.         // DTO
  102. //        customFile.put("DTO.java", "/templates/entityDTO.java.ftl"); //自定义模版引擎
  103.         consumer.customFile(customFile);
  104.       })
  105.       // 选择模板引擎
  106.       .templateEngine(new VelocityTemplateEngine())
  107.       // 执行
  108.       .execute();
  109.   }
  110.  
  111.   private static void createSingleModel(DataSourceConfig.Builder dataSourceConfig, String finalProjectPath) {
  112.     FastAutoGenerator.create(dataSourceConfig)
  113.       // 全局配置
  114.       .globalConfig((scanner, builder) ->
  115.         builder.author(scanner.apply("请输入作者名称？"))
  116.           .fileOverride()
  117.           .outputDir(finalProjectPath + "/src/main/java"))
  118.       // 包配置
  119.       .packageConfig(builder -> {
  120.         builder.parent("com.yeye") // 设置父包名
  121.           .entity("model") //设置entity包名
  122.           .other("dao") // 设置dto包名
  123.           .pathInfo(Collections.singletonMap(OutputFile.xml, finalProjectPath + "/src/main/resources/mapper")); // 设置mapperXml生成路径
  124.  
  125.       })
  126.       // 策略配置
  127.       .strategyConfig((scanner, builder) -> builder.addInclude(getTables(scanner.apply("请输入表名，多个英文逗号分隔？所有输入 all")))
  128.         .controllerBuilder().enableRestStyle()
  129.         .entityBuilder().enableLombok()
  130.         .mapperBuilder().enableBaseResultMap().enableBaseColumnList()
  131.         .build())
  132.  
  133.       .execute();
  134.  
  135.  
  136.   }
  137.  
  138.   // 处理 all 情况
  139.   protected static List<String> getTables(String tables) {
  140.     return "all".equals(tables) ? Collections.emptyList() : Arrays.asList(tables.split(","));
  141.   }
  142.  
  143. }

注意：全局配置中的用于覆盖已生成文件的方法fileOverride在当前版本中已过时，官方文档中目前还未更新，笔者使用 Boolean isOverride控制是否覆写代码。

另外，本文提供了两种生成方式，一种是写死的代码生成，另外一种是交互式生成方式，可自行选择使用。

5. 项目结构效果图

MyBatis-Plus使用实例

增删改查及自定义查询示例

  1. @RestController
  2. @RequestMapping("/user")
  3. public class UserController {
  4.  
  5.   @Autowired
  6.   private UserService userService;
  7.  
  8.   @GetMapping("list")
  9.   public R list() {
  10.     return R.ok().put("data", userService.list());
  11.   }
  12.   @GetMapping("count")
  13.   public R count() {
  14.     return R.ok().put("data", userService.count());
  15.   }
  16.  
  17.   @GetMapping("info")
  18.   public R info(@PathVariable("id") Long id) {
  19.     return R.ok().put("data", userService.getById(id));
  20.   }
  21.  
  22.   @GetMapping("query")
  23.   public R query(@PathVariable("name") Long name) {
  24.     return R.ok().put("data", userService
  25.                       .getOne(new LambdaQueryWrapper<User>().eq(User::getName,name)));
  26.   }
  27.  
  28.   @GetMapping("delete")
  29.   public R delete(@PathVariable("id") Long id) {
  30.     return R.ok().put("data", userService.removeById(id));
  31.   }
  32.   @PostMapping("save")
  33.   public R save(@RequestParam User user) {
  34.     return R.ok().put("data", userService.save(user));
  35.   }
  36.  
  37.   @PostMapping("saveBatch")
  38.   public R saveBatch(@RequestParam User user) {
  39.     return R.ok().put("data", userService.saveBatch((Collection<User>) user));
  40.   }
  41. }

后记

MyBatis Plus Generator 根据默认模板生成的代码是比较简单的，在实际的应用中需要根据自身需要编写自定义模板引擎代码模板，实现自己的定制代码生成，对于笔者来说基本够用，能够满足日常的增删改查操作。

项目源地址放在gitee仓库，想要源代码的读者也可以根据实际情况自取，对你有帮助的话不妨点个赞加个Star⭐吧

代码源地址PracticeCode: 练习

如果这篇【文章】有帮助到你，希望可以给笔者点个赞声明：本文内容由网友自发贡献，转载请注明出处：【wpsshop博客】

推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。