（2022最新版本）SpringBoot 整合 MyBatis Plus 代码生成器

「爱情、让人受尽委屈。」 2024-05-06 09:41 78阅读 0赞

1.导入Maven

2.编写GeneratorVO

3.编写service代码

4.编写controller测试

5.请求接口

6.查看生成的目录

1.导入Maven

  1. <dependency>
  2.     <groupId>com.baomidou</groupId>
  3.     <artifactId>mybatis-plus-generator</artifactId>
  4.     <version>3.5.1</version>
  5. </dependency>

2.编写GeneratorVO

用于自定义数据库地址、表明、作者等请求参数

  1. import lombok.Data;
  2. import javax.validation.constraints.NotBlank;
  3. import javax.validation.constraints.NotNull;
  4. import javax.validation.constraints.Size;
  5. import java.io.Serializable;
  6. import java.util.List;
  7. /**
  8.  * @Author liuy
  9.  * @Description mybatis-plus自动生成vo
  10.  * @Date 2022/01/19 10:04
  11.  * @Version 1.0
  12.  */
  13. @Data
  14. public class GeneratorVO implements Serializable {
  15.     private static final long serialVersionUID = 4123743393008761522L;
  16.     /**
  17.      * 数据库连接地址
  18.      */
  19.     @NotBlank(message = "数据库连接地址必填")
  20.     private String dataSourceUrl;
  22.     /**
  23.      * 数据库用户名
  24.      */
  25.     @NotBlank(message = "数据库用户名必填")
  26.     private String dataSourceUserName;
  27.     /**
  28.      * 数据库密码
  29.      */
  30.     @NotBlank(message = "数据库密码必填")
  31.     private String dataSourcePassword;
  32.     /**
  33.      * 自动生成表名集合
  34.      */
  35.     @NotNull(message = "表名不能为空")
  36.     @Size(min = 1, message = "表名集合至少包含一个元素")
  37.     private List<String> tables;
  38.     /**
  39.      * 作者
  40.      */
  41.     @NotBlank(message = "作者必填")
  42.     private String author;
  43.     /**
  44.      * 逻辑删除字段名
  45.      */
  46.     @NotBlank(message = "逻辑删除字段名必填")
  47.     private String deleteColumnName;
  48.     /**
  49.      * 乐观锁字段名
  50.      */
  51.     private String versionColumnName;
  53. }

3.编写service代码

  1. import com.baomidou.mybatisplus.generator.AutoGenerator;
  2. import com.baomidou.mybatisplus.generator.config.*;
  3. import com.soboot.gen.domain.vo.GeneratorVO;
  4. import org.springframework.stereotype.Service;
  6. import java.util.Collections;
  7. import java.util.List;
  8. /**
  9.  * @Author liuy
  10.  * @Description mybatis-plus generator自动生成代码服务
  11.  * @Date 2022/01/19 10:08
  12.  * @Version 1.0
  13.  */
  14. @Service("generatorService")
  15. public class GeneratorService {
  16.     /**
  17.      * 数据源配置
  18.      */
  19.     private DataSourceConfig dataSourceConfig(String url, String username, String password) {
  20.         return new DataSourceConfig.Builder(url, username, password).build();
  21.     }
  23.     /**
  24.      * 策略配置
  25.      */
  26.     private StrategyConfig.Builder strategyConfig(String deleteColumn, String versionColumn, List<String> tables) {
  27.         StrategyConfig.Builder strategyConfig = new StrategyConfig.Builder().addInclude(tables);
  28.         strategyConfig.entityBuilder().enableLombok().formatFileName("%s")
  29.                 .mapperBuilder().formatMapperFileName("%sMapper").formatXmlFileName("%sMapperXml")
  30.                 .controllerBuilder().enableRestStyle().formatFileName("%sAction")
  31.                 .serviceBuilder().formatServiceFileName("%sService").formatServiceImplFileName("%sService")
  32.                 //逻辑删除字段 和 默认乐观锁字段
  33.                 .entityBuilder().logicDeleteColumnName(deleteColumn).versionColumnName(versionColumn);
  34.         return strategyConfig; // 设置需要生成的表名
  35.     }
  37.     /**
  38.      * 全局配置
  39.      */
  40.     private GlobalConfig.Builder globalConfig(String author) {
  41.         GlobalConfig.Builder globalConfig = new GlobalConfig.Builder().fileOverride();
  42.         globalConfig.author(author)               //作者
  43.                 .outputDir("D://generator")    //输出路径(写到java目录)
  44.                 .commentDate("yyyy-MM-dd")
  45.                 .fileOverride();            //开启覆盖之前生成的文件
  46.         return globalConfig;
  47.     }
  49.     /**
  50.      * 包配置
  51.      */
  52.     private PackageConfig.Builder packageConfig() {
  53.         PackageConfig.Builder packageConfig = new PackageConfig.Builder();
  54.         packageConfig.parent("com")
  55.                 //父包模块名
  56.                 .moduleName("soboot")
  57.                 .entity("entity")
  58.                 .service("service")
  59.                 .serviceImpl("serviceImpl")
  60.                 .controller("controller")
  61.                 .mapper("mapper")
  62.                 .xml("mapper")
  63.                 //默认生成路径 D盘
  64.                 .pathInfo(Collections.singletonMap(OutputFile.mapperXml, "D://"));
  65.         return packageConfig;
  66.     }
  68.     /**
  69.      * 模板配置
  70.      */
  71.     private TemplateConfig.Builder templateConfig() {
  72.         TemplateConfig.Builder templateConfig = new TemplateConfig.Builder();
  73.         templateConfig
  74.                 //自定义service模板
  75.                 .serviceImpl("/template/template.java");
  76.         return templateConfig;
  77.     }
  79.     /**
  80.      * 注入配置
  81.      */
  82.     private InjectionConfig.Builder injectionConfig() {
  83.         // 测试自定义输出文件之前注入操作，该操作再执行生成代码前 debug 查看
  84.         return new InjectionConfig.Builder().beforeOutputFile((tableInfo, objectMap) -> {
  85.             System.out.println("tableInfo: " + tableInfo.getEntityName() + " objectMap: " + objectMap.size());
  86.         });
  87.     }
  89.     /**
  90.      * 基础代码生成
  91.      * @param generatorVO
  92.      */
  93.     public void generatorBase(GeneratorVO generatorVO) {
  94.         AutoGenerator generator = new AutoGenerator(dataSourceConfig(generatorVO.getDataSourceUrl(), generatorVO.getDataSourceUserName(), generatorVO.getDataSourcePassword()));
  95.         generator.strategy(strategyConfig(generatorVO.getDeleteColumnName(), generatorVO.getVersionColumnName(), generatorVO.getTables()).build());
  96.         generator.injection(injectionConfig().build());
  97.         generator.template(templateConfig()
  98.                 .build());
  99.         generator.global(globalConfig(generatorVO.getAuthor()).build());
  100.         generator.execute();
  101.     }
  104. }

我这里自定义了service生成的模板 template.java.vm

watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5o6C5o6C5LiJ55Sf5pyJ5bm4_size_9_color_FFFFFF_t_70_g_se_x_16

上面两个模板之前想用但是感觉没太必要

如果大家需要自定义模板可以去Mybatis Plus的包里找到默认模板

watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5o6C5o6C5LiJ55Sf5pyJ5bm4_size_20_color_FFFFFF_t_70_g_se_x_16

如果想自定义生成模板那么需要在 GeneratorService代码里的templateConfig中修改配置路径

watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5o6C5o6C5LiJ55Sf5pyJ5bm4_size_20_color_FFFFFF_t_70_g_se_x_16 1

我这里只改了service的生成模板

template.java.vm

  1. package ${package.ServiceImpl};
  2. import ${package.Entity}.${entity};
  3. import ${package.Mapper}.${table.mapperName};
  4. import org.springframework.stereotype.Service;
  5. import com.soboot.common.core.com.soboot.dict.service.AbstractService;
  7. /**
  8. * <p>
  9.  * $!{table.comment} 服务
  10.  * </p>
  11. *
  12. * @author ${author}
  13. * @since ${date}
  14. */
  15. @Service
  16. #if(${kotlin})
  17. open class ${table.serviceImplName} : ${superServiceImplClass}<${table.mapperName}, ${entity}>(), ${table.serviceName} {
  19. }
  20. #else
  21. public class ${table.serviceImplName}  extends AbstractService<${table.mapperName}, ${entity}> {
  23. }
  24. #end

AbstractService.java

  1. import com.baomidou.mybatisplus.core.mapper.BaseMapper;
  2. import com.baomidou.mybatisplus.extension.service.IService;
  3. import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
  4. import org.springframework.beans.factory.annotation.Autowired;
  6. /**
  7.  * 基础服务类
  8.  *
  9.  * @param <T>   实体
  10.  * @param <M>   mapper
  11.  * @author liuy
  12.  * @version 1.0
  13.  * @date 2021-10-13 09:48:46
  14.  */
  15. public abstract class AbstractService<M extends BaseMapper<T>,T> extends ServiceImpl<M, T> implements IService<T> {
  17.     @Autowired
  18.     @SuppressWarnings("all")
  19.     protected M mapper;
  20. }

4.编写controller测试

  1. import com.soboot.gen.domain.vo.GeneratorVO;
  2. import com.soboot.gen.service.GeneratorService;
  3. import org.springframework.beans.factory.annotation.Autowired;
  4. import org.springframework.validation.annotation.Validated;
  6. import org.springframework.web.bind.annotation.PostMapping;
  7. import org.springframework.web.bind.annotation.RequestBody;
  8. import org.springframework.web.bind.annotation.RequestMapping;
  9. import org.springframework.web.bind.annotation.RestController;
  12. /**
  13.  * 代码生成 操作处理
  14.  * 
  15.  * @author liuy
  16.  */
  17. @RequestMapping("/gen")
  18. @RestController
  19. public class GenController
  20. {
  23.     @Autowired
  24.     private GeneratorService generatorService;
  26.     /**
  27.      * 基础代码生成
  28.      * @param generatorVO 参数vo
  29.      */
  30.     @PostMapping("/baseGen")
  31.     public void generatorBase(@RequestBody @Validated GeneratorVO generatorVO) {
  32.         generatorService.generatorBase(generatorVO);
  33.     }
  34. }

5.请求接口

watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5o6C5o6C5LiJ55Sf5pyJ5bm4_size_20_color_FFFFFF_t_70_g_se_x_16 2

6.查看生成的目录

watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5o6C5o6C5LiJ55Sf5pyJ5bm4_size_19_color_FFFFFF_t_70_g_se_x_16

默认生成路径我写在了=D://generator下面

如果要改可以GeneratorService代码里的globalConfig全局配置里更改

watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5o6C5o6C5LiJ55Sf5pyJ5bm4_size_20_color_FFFFFF_t_70_g_se_x_16 3

有兴趣可以看看MybatisPlus Generator源码

MybatisPlus Generator源码地址

MybatisPlus自动生成工具就此整合完成

祝大家生活愉快！！！

发表评论

表情：
评论列表 （有 0 条评论，78人围观）

还没有评论，来说两句吧...

相关阅读

    相关 MyBatis-Plus代码生成器

    > 前言：本文主要讲解如何使用MyBatis-Plus的代码生成器，能根据数据库表自动生成相对于的实体类、映射层、服务层、控制器层，使用代码生成器能大大提高工作效率，减少重复工

    矫情吗；*矫情吗；*/ 0 赞/ 189 阅读