云e办（后端）——AutoGenerator的使用

AutoGenerator的使用

AutoGenerator是什么？

AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Pojo、Mapper、Mapper XML、Service、Controller 等各个模块的代码。mybatis的逆向工程无法生成service，controller的代码。

怎么使用？

创建一个AutoGenerator项目

AutoGenerator本身和我们项目没有关联，所以可以单独新建为一个Project，这边也做成Maven聚合项目里的一个子项目。

添加依赖

<?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"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
         <groupId>com.xxxx</groupId>
         <artifactId>yeb</artifactId>
         <version>0.0.1-SNAPSHOT</version>
     </parent>
     
     <groupId>com.xxxx</groupId>
     <artifactId>yeb-generator</artifactId>
     <version>0.0.1-SNAPSHOT</version>
     
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <maven.compiler.source>1.8</maven.compiler.source>
         <maven.compiler.target>1.8</maven.compiler.target>
     </properties>
     
     <dependencies>
         <!--web 依赖-->
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-web</artifactId>
         </dependency>
         <!--mybatis-plus 依赖-->
         <dependency>
             <groupId>com.baomidou</groupId>
             <artifactId>mybatis-plus-boot-starter</artifactId>
             <version>3.3.1.tmp</version>
         </dependency>
         <!--mybatis-plus 代码生成器依赖-->
         <dependency>
             <groupId>com.baomidou</groupId>
             <artifactId>mybatis-plus-generator</artifactId>
             <version>3.3.1.tmp</version>
         </dependency>
         <!--freemarker 依赖-->
         <dependency>
             <groupId>org.freemarker</groupId>
             <artifactId>freemarker</artifactId>
         </dependency>
         <!--mysql 依赖-->
         <dependency>
             <groupId>mysql</groupId>
             <artifactId>mysql-connector-java</artifactId>
             <scope>runtime</scope>
         </dependency>
     </dependencies>
</project>

CodeGenerator工具类

package com.xxxx.generator;
import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.FileOutConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.TemplateConfig;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;
/**
* 执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
*
* @author zhoubin
* @since 1.0.0
*/
public class CodeGenerator {
    /**
     * <p>
     * 读取控制台内容
     * </p>
     */
     public static String scanner(String tip) {
         Scanner scanner = new Scanner(System.in);
         StringBuilder help = new StringBuilder();
         help.append("请输入" + tip + "：");
         System.out.println(help.toString());
         if (scanner.hasNext()) {
             String ipt = scanner.next();
             if (StringUtils.isNotEmpty(ipt)) {
                 return ipt;
             }
         }
             tadminow new MybatisPlusException("请输入正确的" + tip + "！");
     }
     
 public static void main(String[] args) {
     // 代码生成器
     AutoGenerator mpg = new AutoGenerator();
     
     // 全局配置
     GlobalConfig gc = new GlobalConfig();
     String projectPath = System.getProperty("user.dir");
     gc.setOutputDir(projectPath + "/yeb-generator/src/main/java");
     //作者
     gc.setAuthor("zhoubin");
     //打开输出目录
     gc.setOpen(false);
     //xml开启 BaseResultMap
     gc.setBaseResultMap(true);
     //xml 开启BaseColumnList
     gc.setBaseColumnList(true);
     // 实体属性 Swagger2 注解
     gc.setSwagger2(true);
     mpg.setGlobalConfig(gc);
     
     // 数据源配置
     DataSourceConfig dsc = new DataSourceConfig();
     dsc.setUrl("jdbc:mysql://localhost:3306/yeb?
    useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia" + "/Shanghai");
     dsc.setDriverName("com.mysql.cj.jdbc.Driver");
     dsc.setUsername("root");
     dsc.setPassword("root");
     mpg.setDataSource(dsc);
     
     // 包配置
     PackageConfig pc = new PackageConfig();
     pc.setParent("com.xxxx")
          .setEntity("pojo")
          .setMapper("mapper")
          .setService("service")
          .setServiceImpl("service.impl")
          .setController("controller");
     mpg.setPackageInfo(pc);
     
     // 自定义配置
     InjectionConfig cfg = new InjectionConfig() {
     @Override
      public void initMap() {
         // to do nothing
     }
  };
  
      // 如果模板引擎是 freemarker
      String templatePath = "/templates/mapper.xml.ftl";
      // 如果模板引擎是 velocity
      // String templatePath = "/templates/mapper.xml.vm";
      
      // 自定义输出配置
      List<FileOutConfig> focList = new ArrayList<>();
      // 自定义配置会被优先输出
      focList.add(new FileOutConfig(templatePath) {
      @Override
      public String outputFile(TableInfo tableInfo) {
           // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
           return projectPath + "/yeb-generator/src/main/resources/mapper/"
                              + tableInfo.getEntityName() + "Mapper"
                               + StringPool.DOT_XML;
           }
      });
      cfg.setFileOutConfigList(focList);
      mpg.setCfg(cfg);
      
      // 配置模板
      TemplateConfig templateConfig = new TemplateConfig();
      templateConfig.setXml(null);
      mpg.setTemplate(templateConfig);
      
      // 策略配置
      StrategyConfig strategy = new StrategyConfig();
      //数据库表映射到实体的命名策略
      strategy.setNaming(NamingStrategy.underline_to_camel);
      //数据库表字段映射到实体的命名策略
      strategy.setColumnNaming(NamingStrategy.no_change);
      //lombok模型
      strategy.setEntityLombokModel(true);
      //生成 @RestController 控制器
      strategy.setRestControllerStyle(true);
      strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
      strategy.setControllerMappingHyphenStyle(true);
      //表前缀
      strategy.setTablePrefix("t_");
      mpg.setStrategy(strategy);
      mpg.setTemplateEngine(new FreemarkerTemplateEngine());
     mpg.execute();
      }
}