MyBatis-Plus 代码生成器超详细讲解

前言

1. 代码生成器顾名思义就是为我们生成一些代码，省去了我们一些时间。
2. MyBatis-Plus 的代码生成器可以生成 Entity、Mapper、Mapper XML、Service、Controller 模块代码。

须知

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

玩熟 MyBatis-Plus 代码生成器

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

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

2.添加代码生成器依赖

    com.baomidou
    mybatis-plus-generator
    3.2.0

3.添加模板引擎依赖

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

   
   
       org.apache.velocity
       velocity-engine-core
       2.2
   
   
   
   
       org.freemarker
       freemarker
       2.3.30
   
   
   
   
       com.ibeetl
       beetl
       3.1.3.RELEASE
   
   

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

   AutoGenerator generator = new AutoGenerator();
   
   // set freemarker engine
   generator.setTemplateEngine(new FreemarkerTemplateEngine());
   
   // set beetl engine
   generator.setTemplateEngine(new BeetlTemplateEngine());
   
   // set custom engine (reference class is your custom engine class)
   generator.setTemplateEngine(new CustomTemplateEngine());
   
   // other config
   ...
   

4.完整pom.xml

1. 代码生成器需要依赖数据库表，所以也需要 MySQL 驱动包

   
   
       4.0.0
       
       
           org.springframework.boot
           spring-boot-starter-parent
           2.1.5.RELEASE
            
       
     
       cn.zwq
       mybatis-plus-auto-generator
       0.0.1-SNAPSHOT
       mybatis-plus-auto-generator
       mybatis-plus-auto-generator
   
       
           1.8
       
   
       
       
           
               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
           
           
       
   
   

5.全局配置

1. user.dir获取到你当前工程的 src 目录路径
   
   

   在这里插入图片描述

6.数据库信息配置

在这里插入图片描述

7.包配置

在这里插入图片描述

8.策略配置

1. 配置根据哪张表生成代码

   
   
   

   在这里插入图片描述

9.完整 MyBatis-Plus 代码生成器代码

1. MyBatis-Plus 代码生成器所有配置都可以使用 Java Config 完成，不需要单独在 XML 配置。

   public class SggCodeGenerator {
   
       public static void main(String[] args) {
   
           // 1、创建代码生成器
           AutoGenerator mpg = new AutoGenerator();
   
           // 2、全局配置
           GlobalConfig gc = new GlobalConfig();
           String projectPath = System.getProperty("user.dir");
           gc.setOutputDir(projectPath + "/src/main/java");
           gc.setAuthor("zwq");
           gc.setOpen(false); //生成后是否打开资源管理器
           gc.setFileOverride(false); //重新生成时文件是否覆盖
           gc.setServiceName("%sService"); //去掉Service接口的首字母I
           gc.setIdType(IdType.ID_WORKER_STR); //主键策略
           gc.setDateType(DateType.ONLY_DATE);//定义生成的实体类中日期类型
           gc.setSwagger2(false);//开启Swagger2模式
   
           mpg.setGlobalConfig(gc);
   
           // 3、数据源配置
           DataSourceConfig dsc = new DataSourceConfig();
           dsc.setUrl("jdbc:mysql://localhost:3306/mybatis-plus?serverTimezone=GMT%2B8");
           dsc.setDriverName("com.mysql.cj.jdbc.Driver");
           dsc.setUsername("root");
           dsc.setPassword("root");
           dsc.setDbType(DbType.MYSQL);
           mpg.setDataSource(dsc);
   
           // 4、包配置
           PackageConfig pc = new PackageConfig();
           pc.setModuleName(null); //模块名
           pc.setParent("cn.zwq.mybatis-plus");
           pc.setController("controller");
           pc.setEntity("entity");
           pc.setService("service");
           pc.setMapper("mapper");
           mpg.setPackageInfo(pc);
   
           // 5、策略配置
           StrategyConfig strategy = new StrategyConfig();
           strategy.setInclude("user");//对那一张表生成代码
           strategy.setNaming(NamingStrategy.underline_to_camel);//数据库表映射到实体的命名策略
           strategy.setTablePrefix(pc.getModuleName() + "_"); //生成实体时去掉表前缀
   
           strategy.setColumnNaming(NamingStrategy.underline_to_camel);//数据库表字段映射到实体的命名策略
           strategy.setEntityLombokModel(true); // lombok 模型 @Accessors(chain = true) setter链式操作
   
           strategy.setRestControllerStyle(true); //restful api风格控制器
           strategy.setControllerMappingHyphenStyle(true); //url中驼峰转连字符
   
           mpg.setStrategy(strategy);
   
           // 6、执行
           mpg.execute();
       }
   }
   

运行代码生成器代码

1. 主要运行其中的 main 方法即可，然后就自动根据哪张表生成代码了。

   
   
   

   在这里插入图片描述

总结

1. 代码生成器的全部代码都在这篇博客当中了，没有那块代码是缺漏，相信大家看完这篇博客之后就能玩熟代码生成器了。
2. 如果觉得不错，可以点个赞或者关注博主我也行，感谢！