前言

  1. 代码生成器顾名思义就是为我们生成一些代码，省去了我们一些时间。

  2. MyBatis-Plus 的代码生成器可以生成 Entity、Mapper、Mapper XML、Service、Controller 模块代码。

    须知

  3. MyBatis-Plus 从 3.0.3 之后移除了代码生成器与模板引擎的默认依赖，需要手动添加相关依赖，才能实现代码生成器功能。

    玩熟 MyBatis-Plus 代码生成器

    1.新建 MyBatis-Plus 代码生成器项目

  4. 使用 Spring 脚手架创建 SpringBoot 项目，如果不太熟悉 IDEA 快速生成 SpringBoot 项目，可以先看下面一篇博客，几分钟就搞定。
    SpringBoot 快速入门

    2.添加代码生成器依赖

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

3.添加模板引擎依赖

  1. MyBatis-Plus 支持 Velocity（默认）、Freemarker、Beetl，可以选择自己熟悉的模板引擎，如果都不满足您的要求，可以采用自定义模板引擎。

  2. pom.xml 

    1. <!-- https://mvnrepository.com/artifact/org.apache.velocity/velocity-engine-core -->
    2. <dependency>
    3.  <groupId>org.apache.velocity</groupId>
    4.  <artifactId>velocity-engine-core</artifactId>
    5.  <version>2.2</version>
    6. </dependency>
    7. <!-- https://mvnrepository.com/artifact/org.freemarker/freemarker -->
    8. <dependency>
    9.  <groupId>org.freemarker</groupId>
    10.  <artifactId>freemarker</artifactId>
    11.  <version>2.3.30</version>
    12. </dependency>
    13. <!-- https://mvnrepository.com/artifact/com.ibeetl/beetl -->
    14. <dependency>
    15.  <groupId>com.ibeetl</groupId>
    16.  <artifactId>beetl</artifactId>
    17.  <version>3.1.3.RELEASE</version>
    18. </dependency>

  3. 如果我们选择了非默认引擎，需要在 AutoGenerator 中 设置模板引擎。

    1. AutoGenerator generator = new AutoGenerator();
    2. // set freemarker engine
    3. generator.setTemplateEngine(new FreemarkerTemplateEngine());
    4. // set beetl engine
    5. generator.setTemplateEngine(new BeetlTemplateEngine());
    6. // set custom engine (reference class is your custom engine class)
    7. generator.setTemplateEngine(new CustomTemplateEngine());
    8. // other config
    9. ...

    4.完整pom.xml

  4. 代码生成器需要依赖数据库表，所以也需要 MySQL 驱动包 ``` <?xml version=”1.0” encoding=”UTF-8”?> <project xmlns=”http://maven.apache.org/POM/4.0.0“ xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance“

    1.   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">

    4.0.0 

    1.  <groupId>org.springframework.boot</groupId>
    2.  <artifactId>spring-boot-starter-parent</artifactId>
    3.  <version>2.5.4</version>
    4.  <relativePath/> <!-- lookup parent from repository -->

    com.mybatis.generator generator 0.0.1-SNAPSHOT generator Demo project for Spring Boot

    1.8 org.apache.velocity velocity-engine-core 2.0 org.springframework.boot spring-boot-test org.springframework.boot spring-boot-starter-web com.baomidou mybatis-plus-boot-starter 3.2.0 com.baomidou mybatis-plus-generator 3.2.0 org.freemarker freemarker mysql mysql-connector-java org.projectlombok lombok org.junit.jupiter junit-jupiter test 

  1. <a name="KH7NL"></a>
  2. ## 5.全局配置
  4. 1. `user.dir`获取到你当前工程的 src 目录路径<br />![image.png](https://cdn.nlark.com/yuque/0/2021/png/21469639/1631089843789-aa087d37-3818-467b-8103-c82639456c96.png#height=252&id=bXZUK&margin=%5Bobject%20Object%5D&name=image.png&originHeight=504&originWidth=1366&originalType=binary&ratio=1&size=540546&status=done&style=none&width=683)
  5. <a name="cW5Vb"></a>
  6. ## 6.数据库信息配置
  7. ![image.png](https://cdn.nlark.com/yuque/0/2021/png/21469639/1631089821996-2e4ffcd7-5646-4284-9fc4-a6809aa1a1f6.png#height=168&id=nCGaK&margin=%5Bobject%20Object%5D&name=image.png&originHeight=335&originWidth=1281&originalType=binary&ratio=1&size=329568&status=done&style=none&width=640.5)
  8. <a name="uKiIn"></a>
  9. ## 7.包配置
  10. ![image.png](https://cdn.nlark.com/yuque/0/2021/png/21469639/1631089809080-f765cbfb-2bfa-4aa6-8633-5320f5a666bc.png#height=182&id=pkUYt&margin=%5Bobject%20Object%5D&name=image.png&originHeight=363&originWidth=1315&originalType=binary&ratio=1&size=337103&status=done&style=none&width=657.5)
  11. <a name="dXHhd"></a>
  12. ## 8.策略配置
  14. 1. 配置根据哪张表生成代码<br />![image.png](https://cdn.nlark.com/yuque/0/2021/png/21469639/1631089786337-280a91c5-4229-422f-8f43-ef8f3bbd1dae.png#height=217&id=ku5o3&margin=%5Bobject%20Object%5D&name=image.png&originHeight=433&originWidth=1370&originalType=binary&ratio=1&size=477477&status=done&style=none&width=685)
  15. <a name="6JJIW"></a>
  16. ## 9.完整 MyBatis-Plus 代码生成器代码
  18. 1. MyBatis-Plus 代码生成器所有配置都可以使用 Java Config 完成，不需要单独在 XML 配置。
  19. ```java
  20. package com.mybatis.generator;
  22. import com.baomidou.mybatisplus.annotation.DbType;
  23. import com.baomidou.mybatisplus.annotation.IdType;
  24. import com.baomidou.mybatisplus.generator.AutoGenerator;
  25. import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
  26. import com.baomidou.mybatisplus.generator.config.GlobalConfig;
  27. import com.baomidou.mybatisplus.generator.config.PackageConfig;
  28. import com.baomidou.mybatisplus.generator.config.StrategyConfig;
  29. import com.baomidou.mybatisplus.generator.config.rules.DateType;
  30. import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
  31. import org.junit.jupiter.api.Test;
  32. import org.springframework.boot.test.context.SpringBootTest;
  34. //@SpringBootTest
  35. class GeneratorApplicationTests {
  37.     //    @Test
  38.     public static void main(String[] args) {
  39.         // 1、创建代码生成器
  40.         AutoGenerator mpg = new AutoGenerator();
  42.         // 2、全局配置
  43.         GlobalConfig gc = new GlobalConfig();
  44.         String projectPath = System.getProperty("user.dir");
  45.         gc.setOutputDir(projectPath + "/src/main/java");
  46.         gc.setAuthor("zwq");
  47.         gc.setOpen(false); //生成后是否打开资源管理器
  48.         gc.setFileOverride(false); //重新生成时文件是否覆盖
  49.         gc.setServiceName("%sService"); //去掉Service接口的首字母I
  50.         gc.setIdType(IdType.ID_WORKER_STR); //主键策略
  51.         gc.setDateType(DateType.ONLY_DATE);//定义生成的实体类中日期类型
  52.         gc.setSwagger2(false);//开启Swagger2模式
  54.         mpg.setGlobalConfig(gc);
  56.         // 3、数据源配置
  57.         DataSourceConfig dsc = new DataSourceConfig();
  58.         dsc.setUrl("jdbc:mysql://81.71.13.91:3306/usercenter?serverTimezone=GMT%2B8");
  59.         dsc.setDriverName("com.mysql.cj.jdbc.Driver");
  60.         dsc.setUsername("root");
  61.         dsc.setPassword("123456");
  62.         dsc.setDbType(DbType.MYSQL);
  63.         mpg.setDataSource(dsc);
  65.         // 4、包配置
  66.         PackageConfig pc = new PackageConfig();
  67.         pc.setModuleName(null); //模块名
  68.         pc.setParent("com.mybatis.generator");
  69.         pc.setController("controller");
  70.         pc.setEntity("entity");
  71.         pc.setService("service");
  72.         pc.setMapper("mapper");
  73.         mpg.setPackageInfo(pc);
  75.         // 5、策略配置
  76.         StrategyConfig strategy = new StrategyConfig();
  77.         strategy.setInclude("sys_user");//对那一张表生成代码
  78.         strategy.setNaming(NamingStrategy.underline_to_camel);//数据库表映射到实体的命名策略
  79.         strategy.setTablePrefix(pc.getModuleName() + "_"); //生成实体时去掉表前缀
  81.         strategy.setColumnNaming(NamingStrategy.underline_to_camel);//数据库表字段映射到实体的命名策略
  82.         strategy.setEntityLombokModel(true); // lombok 模型 @Accessors(chain = true) setter链式操作
  84.         strategy.setRestControllerStyle(true); //restful api风格控制器
  85.         strategy.setControllerMappingHyphenStyle(true); //url中驼峰转连字符
  87.         mpg.setStrategy(strategy);
  89.         // 6、执行
  90.         mpg.execute();
  92.     }
  93. }

总结

  1. 代码生成器的全部代码都在这篇博客当中了，没有那块代码是缺漏，相信大家看完这篇博客之后就能玩熟代码生成器了。