简介:AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。
<!-- mybatis-plus-generator代码生成器-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.5.1</version>
</dependency>
<!-- freemarker模板引擎 -->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.31</version>
</dependency>
package com.tms.tblog;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
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.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import com.baomidou.mybatisplus.generator.fill.Column;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
/***
* 代码生成器 执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
*/
public class CodeGenerator {
public static void main(String[] args) {
System.out.println("=====================数据库配置=======================");
String url = "jdbc:mysql://localhost:3306/tblog?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=UTC";
String username = "root";
String password = "root";
String author = "lcj";
String parentName = "com.tms";// 父包名
String moduleName = "tblog";// 父包模块名
String tableName = "customer";//表名,多个英文逗号分隔?所有输入 all
AutoGenerator(url,
username,
password,
author,
parentName,
moduleName,
tableName);
}
/**
* 自动生成代码调用方法
* @param url 数据库地址
* @param username 数据库用户名
* @param password 数据库密码
* @param author 作者
* @param parentName 父包名
* @param moduleName 父包模块名
* @param tableName 表名,多个英文逗号分隔?所有输入 all
*/
protected static void AutoGenerator(String url,
String username,
String password,
String author,
String parentName,
String moduleName,
String tableName) {
FastAutoGenerator.create(url, username, password)
// 全局配置
.globalConfig(builder -> builder.author(author)// 设置作者名
.outputDir(System.getProperty("user.dir") + "/src/main/java") //设置输出路径:项目的 java 目录下
.commentDate("yyyy-MM-dd hh:mm:ss")//注释日期
.dateType(DateType.TIME_PACK)//定义生成的实体类中日期的类型 TIME_PACK=LocalDateTime;ONLY_DATE=Date;
.fileOverride()//覆盖之前的文件
// .enableSwagger()//开启 swagger 模式
.disableOpenDir() //禁止打开输出目录,默认打开
)
// 包配置
.packageConfig(builder -> builder.parent(parentName)// 设置父包名
.moduleName(moduleName)//设置模块包名
.entity("entity") //entity 实体类包名
.service("service")//Service 包名
.serviceImpl("service.iImpl")// ***ServiceImpl 包名
.mapper("dao") //Mapper 包名
.xml("mapper") //Mapper XML 包名
.controller("controller") //Controller 包名
.other("utils")//自定义文件包名
.pathInfo(Collections.singletonMap(OutputFile.mapperXml, System.getProperty("user.dir") + "/src/main/resources/mapper")) //配置 mapper.xml 路径信息:项目的 resources 目录下
)
// 策略配置
.strategyConfig(builder -> {
builder.addInclude(getTables(tableName))// 设置需要生成的数据表名
.addTablePrefix("t_", "c_") // 设置过滤表前缀
// service 策略配置
.serviceBuilder()
.formatServiceFileName("%sService")//格式化 service 接口文件名称,%s进行匹配表名,如 UserService
.formatServiceImplFileName("%sServiceImpl") //格式化 service 实现类文件名称,%s进行匹配表名,如 UserServiceImpl
// 实体类策略配置
.entityBuilder() //实体类策略配置
.enableLombok() //开启 Lombok
.disableSerialVersionUID() //不实现 Serializable 接口,不生产 SerialVersionUID
.logicDeleteColumnName("deleted") //逻辑删除字段名
.naming(NamingStrategy.underline_to_camel) //数据库表映射到实体的命名策略:下划线转驼峰命
.columnNaming(NamingStrategy.underline_to_camel) //数据库表字段映射到实体的命名策略:下划线转驼峰命
//添加表字段填充,"create_time"字段自动填充为插入时间,"modify_time"字段自动填充为插入修改时间
.addTableFills(
new Column("create_time", FieldFill.INSERT),
new Column("modify_time", FieldFill.INSERT_UPDATE))
.enableTableFieldAnnotation() // 开启生成实体时生成字段注解
// Controller策略配置
.controllerBuilder()
.formatFileName("%sController")//格式化 Controller 类文件名称,%s进行匹配表名,如 UserController
.enableRestStyle() //开启生成 @RestController 控制器
// Mapper策略配置
.mapperBuilder()
.superClass(BaseMapper.class) //设置父类
.formatMapperFileName("%sMapper") //格式化 mapper 文件名称
.enableMapperAnnotation() //开启 @Mapper 注解
.formatXmlFileName("%sMapper"); //格式化 Xml 文件名称
})
//5、模板
.templateEngine(new FreemarkerTemplateEngine())
/*
.templateEngine(new VelocityTemplateEngine())
.templateEngine(new FreemarkerTemplateEngine())
.templateEngine(new BeetlTemplateEngine())
*/
//6、执行
.execute();
/*
模板引擎配置,默认 Velocity 可选模板引擎 Beetl 或 Freemarker
.templateEngine(new BeetlTemplateEngine())
.templateEngine(new FreemarkerTemplateEngine())
.execute(); */
}
// 处理 all 情况
protected static List<String> getTables(String tables) {
return "all".equals(tables) ? Collections.emptyList() : Arrays.asList(tables.split(","));
}
}
代码已经写好了,接下来运行CodeGenerator文件的这个main方法,运行完之后控制台会打印出生成结果
生成完之后查看一下生成文件
MyBatis-Plus自动生成代码简单的配置就是这样,在实际用的时候,可以根据自己的需求和个性自定义自己比较喜欢的代码样式和模板。