MybatisPlus代码生成器的使用
一、引入依赖
mysql
mysql-connector-java
8.0.15
com.baomidou
mybatis-plus-boot-starter
3.5.2
com.baomidou
mybatis-plus-generator
3.5.2
org.freemarker
freemarker
2.3.31
二、配置数据库连接
spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/student_manager?characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai
username: root
password: root123
三、创建实体类父类(非必要步骤)
@Data
public class BaseEntity {
protected Date createTime;
protected Date modifiedTime;
protected Integer deleted;
}
四、测试生成代码
package com.example.mybatisgenerator;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import com.example.mybatisgenerator.commons.BaseEntity;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.test.context.SpringBootTest;
import java.util.Collections;
@SpringBootTest
class MybatisGeneratorApplicationTests {
@Value("${spring.datasource.url}")
private String url;
@Value("${spring.datasource.username}")
private String username;
@Value("${spring.datasource.password}")
private String password;
@Test
void testGenerator() {
// 获取当前项目目录
String projectPath = System.getProperty("user.dir");
FastAutoGenerator.create(url, username, password)
// 全局配置
.globalConfig(builder -> {
builder.author("刘路生") // 设置作者
.outputDir(projectPath + "/src/main/java") // 指定输出目录
.commentDate("yyyy/MM/dd") // 指定注释日期的格式
// .enableSwagger() // 开启swagger注解
.dateType(DateType.ONLY_DATE);
})
// 包配置
.packageConfig(builder -> {
builder.parent("com.example.mybatisgenerator") // 设置父包名
// .moduleName("sys") // 设置模块名
.entity("entity")
.mapper("mapper")
.service("service")
.serviceImpl("service.impl")
.controller("controller")
.pathInfo(Collections.singletonMap(OutputFile.xml, projectPath + "/src/main/resources/mapper")); // 设置mapperXml文件生成路径
})
// 策略配置
.strategyConfig(builder -> {
// 设置需要生成代码的表名
builder.addInclude("teacher")
// 实体类具体配置
.entityBuilder()
.superClass(BaseEntity.class) // 设置实体类继承的父类
.addSuperEntityColumns("create_time", "modified_time", "deleted") // 添加父类中的公共字段
.idType(IdType.ASSIGN_ID) // 设置主键ID的生成策略
.enableLombok() // 开启lombok注解
// mapper类具体配置
.mapperBuilder()
.formatMapperFileName("%sMapper") // mapper类的命名格式
.formatXmlFileName("%sMapper") // mapperXml文件的命名格式
.enableMapperAnnotation() // 开启mapper类上的@Mapper注解
// service类具体配置
.serviceBuilder()
.formatServiceFileName("%sService") // service接口的命名格式
.formatServiceImplFileName("%sServiceImpl") // serviceImpl实现类的命名格式
// controller类具体配置
.controllerBuilder()
.formatFileName("%sController") // controller类的命名格式
.enableRestStyle(); // 开启@RestController注解
})
.templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板,默认的是Velocity引擎模板
.execute();
}
@Test
void testGeneratorPlus() {
// 获取当前项目目录
String projectPath = System.getProperty("user.dir");
FastAutoGenerator.create(url, username, password)
// 全局配置
.globalConfig((scanner, builder) -> {
builder.author(scanner.apply("请设置作者名?")) // 设置作者
.outputDir(projectPath + "/src/main/java") // 指定输出目录
.commentDate("yyyy/MM/dd") // 指定注释日期的格式
// .enableSwagger() // 开启swagger注解
.dateType(DateType.ONLY_DATE);
})
// 包配置
.packageConfig((scanner, builder) -> {
builder.parent(scanner.apply("请输入父包名?")) // 设置父包名
// .moduleName("sys") // 设置模块名
.entity("entity")
.mapper("mapper")
.service("service")
.serviceImpl("service.impl")
.controller("controller")
.pathInfo(Collections.singletonMap(OutputFile.xml, projectPath + "/src/main/resources/mapper")); // 设置mapperXml文件生成路径
})
// 策略配置
.strategyConfig((scanner, builder) -> {
// 设置需要生成代码的表名
builder.addInclude(scanner.apply("请输入需要生成的表名?"))
// 实体类具体配置
.entityBuilder()
.superClass(BaseEntity.class) // 设置实体类继承的父类
.addSuperEntityColumns("create_time", "modified_time", "deleted") // 添加父类中的公共字段
.idType(IdType.ASSIGN_ID) // 设置主键ID的生成策略
.enableLombok() // 开启lombok注解
// mapper类具体配置
.mapperBuilder()
.formatMapperFileName("%sMapper") // mapper类的命名格式
.formatXmlFileName("%sMapper") // mapperXml文件的命名格式
.enableMapperAnnotation() // 开启mapper类上的@Mapper注解
// service类具体配置
.serviceBuilder()
.formatServiceFileName("%sService") // service接口的命名格式
.formatServiceImplFileName("%sServiceImpl") // serviceImpl实现类的命名格式
// controller类具体配置
.controllerBuilder()
.formatFileName("%sController") // controller类的命名格式
.enableRestStyle(); // 开启@RestController注解
})
.templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板,默认的是Velocity引擎模板
.execute();
}
}