1.引入maven包
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.3.2</version>
</dependency>
<!--我这里使用的是模板文件是freemarker,所以需要引入它的包-->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.30</version>
</dependency>
2.如果要自定义生成的文件,需要改模板文件(模板源文件在jar包里有)注:不需要自定义可以跳过这一步
1.模板源文件位置(将需要自定义的,复制出来,到项目资源目录下进行修改)
2.根据模板规整修改文件(这些文件会在第三步生成代码的方法中去引用)
3.生成代码方法(具体查看,官方文档和demo)
官方文档地址:https://baomidou.com/config/generator-config.html#%E5%9F%BA%E6%9C%AC%E9%85%8D%E7%BD%AE
package com.hn.renting;
import com.baomidou.mybatisplus.annotation.FieldFill;
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.*;
import com.baomidou.mybatisplus.generator.config.builder.ConfigBuilder;
import com.baomidou.mybatisplus.generator.config.po.TableFill;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.querys.MySqlQuery;
import com.baomidou.mybatisplus.generator.config.querys.OracleQuery;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.FileType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import java.util.*;
// 演示例子,执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
public class CodeGenerator {
public static void main(String[] args) {
mysqlGenerator();
}
/**
* mysql项目代码生成
*/
public static void mysqlGenerator(){
String type = "mysql";
String projectName = "renting";
String modulesPack = "com.hn.renting.modules";
String configPack = "com.hn.renting.config";
boolean isCreateAgain = true;
String dcurl = "jdbc:mysql://localhost:3306/renting?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai";
String dcname = "root";
String dcpwd = "root";
generator(type, projectName, modulesPack, configPack, isCreateAgain, dcurl, dcname, dcpwd);
}
/**
* orcal项目代码生成
*/
public static void oracleGenerator(){
String type = "oracle";
String projectName = "disability";
String modulesPack = "com.hn.kiss.modules";
String configPack = "com.hn.kiss.config";
boolean isCreateAgain = true;
String dcurl = "jdbc:oracle:thin:@localhost:1521:orcl";
String dcname = "disa";
String dcpwd = "disa";
generator(type, projectName, modulesPack, configPack, isCreateAgain, dcurl, dcname, dcpwd);
}
/**
* 代码生成
* @param type 类别(mysql,oracle)
* @param projectName 项目名(例: kiss)
* @param modulesPack 项目模块包名(例: com.hn.kiss.modules)
* @param configPack 配置文件包名(例: com.hn.kiss.config)
* @param isCreateAgain 是否创建新文件替换旧文件
* @param dcurl 数据库连接地址(例:"jdbc:mysql://localhost:3306/stu?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai")
* @param dcname 数据库连接名称(例: root)
* @param dcpwd 数据库连接密码(例: root)
*/
public static void generator(String type, String projectName, String modulesPack, String configPack, boolean isCreateAgain, String dcurl, String dcname, String dcpwd) {
assert ("oracle".equals(type) || "mybatis".equals(type));
// 代码生成器
AutoGenerator mpg = new AutoGenerator();
// 全局配置
GlobalConfig gc = new GlobalConfig();
String projectPath = System.getProperty("user.dir") + "/" + projectName;
gc.setOutputDir(projectPath + "/src/main/java");
gc.setAuthor("zxy");
gc.setOpen(false);
gc.setSwagger2(true);// 实体属性 Swagger2 注解
// gc.setIdType(IdType.INPUT);
gc.setDateType(DateType.ONLY_DATE);//设置时间类型为Date
mpg.setGlobalConfig(gc);
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl(dcurl);
// dsc.setSchemaName("public");
dsc.setUsername(dcname);
dsc.setPassword(dcpwd);
if("oracle".equals(type)){
dsc.setDriverName("oracle.jdbc.driver.OracleDriver");
dsc.setDbQuery(new OracleQuery() {
@Override
public String[] fieldCustom() {
return new String[]{"KEY"};
}
});
}else if("mysql".equals(type)){
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setDbQuery(new MySqlQuery() {
@Override
public String[] fieldCustom() {
return new String[]{"KEY","NULL"};
}
});
}
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
//模块名就是在包的上级加个目录
pc.setModuleName(scanner("模块名"));
pc.setParent(modulesPack);
mpg.setPackageInfo(pc);
// 自定义配置
InjectionConfig cfg = new InjectionConfig() {
@Override
public void initMap() {
Map<String, Object> map = new HashMap<>();
//公共文件包名
map.put("configPack", configPack);
this.setMap(map);
}
};
// 如果模板引擎是 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/java/com/hn/renting/modules/" + pc.getModuleName() + "/mapper/xml"
+ "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
}
});
//自定义生成html文件
/*focList.add(new FileOutConfig("/temp/test.html.ftl") {
@Override
public String outputFile(TableInfo tableInfo) {
// 自定义输出文件名 , 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化!!
return projectPath + "/src/main/resources/templates/" + pc.getModuleName()
+ "/" + tableInfo.getEntityName() + "View" + ".html";
}
});*/
//重复创建,直接返回true,否则不设置,就走默认(文件存在不创建)
if (isCreateAgain){
cfg.setFileCreate(new IFileCreate() {
@Override
public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
return isCreateAgain;
}
});
}
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);
// 配置模板,这里是自定义的模板,可以使用官方的,位置在第二步中有说明
TemplateConfig templateConfig = new TemplateConfig();
templateConfig.setController("/temp/"+ type +"/myController.java");
templateConfig.setEntity("/temp/"+ type +"/myEntity.java");
templateConfig.setService("/temp/"+ type +"/myService.java");
templateConfig.setServiceImpl("/temp/"+ type +"/myServiceImpl.java");
// 配置自定义输出模板
//指定自定义模板路径,注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
// templateConfig.setEntity("templates/entity2.java");
// templateConfig.setService();
// templateConfig.setController();
templateConfig.setXml(null);
mpg.setTemplate(templateConfig);
// 策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setChainModel(true);
strategy.setEntityLombokModel(true);
strategy.setRestControllerStyle(true);
// Controller公共父类
strategy.setSuperControllerClass(configPack + ".compoent.BaseController");
// 写于父类中的公共字段
// strategy.setSuperEntityColumns("id");
strategy.setInclude(scanner("表名,多个英文逗号分割").split(","));
//开启controller mapping命名为 xx-xx的形式
strategy.setControllerMappingHyphenStyle(true);
//去除表前缀,一般情况是模块名,如果不是自行更改
strategy.setTablePrefix(pc.getModuleName() + "_");
//逻辑删除字段
strategy.setLogicDeleteFieldName("DELETED");
//设置自动填充字段
ArrayList<TableFill> tableFills = new ArrayList<>();
tableFills.add(new TableFill("created_by", FieldFill.INSERT));
tableFills.add(new TableFill("created_time", FieldFill.INSERT));
tableFills.add(new TableFill("updated_by", FieldFill.UPDATE));
tableFills.add(new TableFill("updated_time", FieldFill.UPDATE));
strategy.setTableFillList(tableFills);
mpg.setStrategy(strategy);
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
mpg.execute();
}
/**
* <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;
}
}
throw new MybatisPlusException("请输入正确的" + tip + "!");
}
}
4.使用
运行方法,根据控制台提示内容进行输入,注意大小写与数据库保持一致