技术分享_MyBatis-Plus代码生成器AutoGenerator
前言
MyBatis-Plus代码生成器AutoGenerator
AutoGenerator 是 MyBatis-Plus 的代码生成器，
通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller
等各个模块的代码，极大的提升了开发效率。
一、添加generator依赖
MyBatis-Plus 从 3.0.3 之后移除了代码生成器与模板引擎的默认依赖，需要手动添加相关依赖：
<!--mybatisplus代码生成-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.4.1</version>
</dependency>
注：官网推荐的3.4.2包在mvn上没有，建议使用3.4.1
二、添加模板引擎依赖和swagger依赖
<!--模板-->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.2</version>
</dependency>
<!--swagger2-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.10.5</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.10.5</version>
</dependency>
MyBatis-Plus 支持 Velocity（默认）、Freemarker、Beetl，可以选择自己熟悉的模板引擎，如果都不满足您的要求，可以采用自定义模板引擎。
使用Velocity足够了。
三、创建生成代码
参考：https://mp.baomidou.com/config/generator-config.html
创建生成代码类：
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
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.po.LikeTable;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
public class GeneratorApp {
public static void main(String[] args) {
// 1、创建代码生成器
AutoGenerator mpg = new AutoGenerator();
// 2、全局配置
GlobalConfig gc = new GlobalConfig();
//获得当前项目的路径(物理路径)
String projectPath = System.getProperty("user.dir");
//如果是子工程，则需要写成
//String projectPath = System.getProperty("user.dir")+"service_order";
//设置生成的路径
gc.setOutputDir(projectPath + "/src/main/java");
//设置作者
gc.setAuthor("4977332@qq.com");
//生成后是否打开所在文件夹
gc.setOpen(false);
//生成Swagger2注解（需要导包）
gc.setSwagger2(true);
//重新生成时文件是否覆盖
gc.setFileOverride(true);
//设置实体类的名字
gc.setEntityName("%s");
//设置mapper接口名
gc.setMapperName("%sMapper");
//设置mapper.xml文件名
gc.setXmlName("%sMapper");
//设置在mapper.xml中生成一个基础的<ResultMap>映射所有的字段
gc.setBaseResultMap(true);
//设置业务逻辑类接口名（首字母I去掉）
gc.setServiceName("%sService");
//设置业务逻辑实现类名
gc.setServiceImplName("%sServiceImpl");
//将全局配置设置到AutoGenerator
mpg.setGlobalConfig(gc);
//主键策略
gc.setIdType(IdType.ID_WORKER_STR);
//定义生成的实体类中日期类型
gc.setDateType(DateType.ONLY_DATE);
// 3、数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/test?serverTimezone=UTC&useUnicode=true&characterEncoding=utf8&useSSL=false");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("root");
mpg.setDataSource(dsc);
// 4、包配置：控制项目生成的包
PackageConfig pc = new PackageConfig();
//完整包名
pc.setParent("com.example");
//设置模块名，可以省略不写或null，如果写了就是com.example.模块名
pc.setModuleName(null);
//创建controller包名
pc.setController("controller");
//创建实体类包名
pc.setEntity("entity");
//创建业务逻辑层包名
pc.setService("service");
//创建mapper包名
pc.setMapper("mapper");
mpg.setPackageInfo(pc);
// 5、策略配置
StrategyConfig strategy = new StrategyConfig();
//去掉表前缀
strategy.setTablePrefix("cms_");
//表名映射到实体的命名策略(下划线转驼峰)
strategy.setNaming(NamingStrategy.underline_to_camel);
//字段名映射到实体的命名策略(下划线转驼峰)
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
//实体类是否支持lombok 模型 @Accessors(chain = true) setter链式操作
strategy.setEntityLombokModel(true);
//controller类上是否使用@RestController
strategy.setRestControllerStyle(true);
//对那一张表生成代码(多个用逗号分开)
//strategy.setInclude("cms_user", "cms_role");
//也可以按表的前缀来生成(如将所有以cms_开头的表)
strategy.setLikeTable(new LikeTable("cms_"));
//生成实体时去掉表前缀
strategy.setTablePrefix(pc.getModuleName() + "_");
mpg.setStrategy(strategy);
// 6、执行代码生成
mpg.execute();
}
}
执行上面代码，生成相应的源码文件。
四、完整pom.xml
代码生成器需要依赖数据库表，所以也需要 MySQL 驱动包
需要导入spring-boot-starter-parent、spring-boot-starter-web、mysql、druid、mybatis-plus、lombok、swagger
<properties>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<swagger-version>2.10.5</swagger-version>
<mybatisplus-version>3.4.1</mybatisplus-version>
<druid-version>1.2.6</druid-version>
</properties>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.3.0.RELEASE</version>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--thymeleaf模板引擎-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<!--mysql数据库-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!--druid数据源-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>${druid-version}</version>
</dependency>
<!--mybatisplus-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>${mybatisplus-version}</version>
</dependency>
<!--mybatisplus代码生成-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>${mybatisplus-version}</version>
</dependency>
<!--模板-->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.2</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<!--swagger2-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${swagger-version}</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${swagger-version}</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
五、关于Mapper.xml文件生成位置的问题
上面代码生成后，XxxMapper.xml文件都生成到了src\main\java中的mapper包中，在实际开发中，我们会将XxxMapper.xml文件放到resources目录下。这里需要修改上面的代码，在
https://mp.baomidou.com/guide/generator.html#自定义代码模板
复制自定义配置代码并修改：
// 自定义配置
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 + "/src/main/resources/mapper/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
}
});
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);
再次运行生成代码文件。
浙公网安备 33010602011771号