引言:
学习了MybatisPlus的代码生成器,做一些相关笔记
Spirngboot版本:2.6.1
MybatisPlus版本:3.4.3.4
Maven版本:3.6.1
jdk:1.8
需要引入相关依赖:
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.3.4</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.4.1</version>
</dependency>
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.2</version>
</dependency>
创建一个类:MyBatisPlusAuto
一些注意点:
1. 相关包配置:mybatisplus默认会创建出controller,service接口及其实现类,mapper接口和实体类,可自己定义相关类的名称,以自己定义的优先
2. 配置模板引擎:最好配置一下
// 配置模板,如果没有这一步的话mybatisplus会在mapper层上同时创建出xml包及其xml文件
TemplateConfig templateConfig = new TemplateConfig();
templateConfig.setXml(null);
mpg.setTemplate(templateConfig);
public class MyBatisPlusAuto {
public static String scanner(String tip) {
Scanner scanner = new Scanner(System.in);
System.out.println("请输入" + tip + ":");
if (scanner.hasNext()) {
String ipt = scanner.next();
if (StringUtils.isNotBlank(ipt)) {
return ipt;
}
}
throw new MybatisPlusException("请输入正确的" + tip + "!");
}
public static void main(String[] args) {
AutoGenerator mpg = new AutoGenerator();
//全局配置
GlobalConfig globalConfig = new GlobalConfig();
String property = System.getProperty("user.dir");
globalConfig.setOutputDir(property + "/src/main/java");
globalConfig.setAuthor("你的作者名");
globalConfig.setOpen(false);
globalConfig.setFileOverride(false);
globalConfig.setServiceName("%sService");
globalConfig.setDateType(DateType.ONLY_DATE);
mpg.setGlobalConfig(globalConfig);
//数据源配置
DataSourceConfig dataSourceConfig = new DataSourceConfig();
/*
mysql8.0以上版本需要在数据库名后面加上?serverTimezone=UTC
mysql8.0以上版本为:com.mysql.cj.jdbc.Driver
以下版本为:com.mysql.jdbc.Driver
*/
dataSourceConfig.setUrl("jdbc:mysql://localhost:3306/你的数据库名");
dataSourceConfig.setDriverName("com.mysql.cj.jdbc.Driver");
dataSourceConfig.setPassword("数据库密码");
dataSourceConfig.setUsername("root");
mpg.setDataSource(dataSourceConfig);
/*
相关包配置
*/
PackageConfig packageConfig = new PackageConfig();
//packageConfig.setModuleName(scanner("模块名"));//模块名,可有可无
packageConfig.setParent("com.xxx.www");
packageConfig.setEntity("pojo");
//mybatisPlus会自动创建
// packageConfig.setMapper("mapper");
// packageConfig.setService("service");
// packageConfig.setController("controller");
mpg.setPackageInfo(packageConfig);
// 自定义配置
InjectionConfig cfg = new InjectionConfig() {
@Override
public void initMap() {
// to do nothing
}
};
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 property + "/src/main/resources/mapper/" + packageConfig.getModuleName()
+ "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
}
});
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);
// 配置模板,如果没有这一步的话mybatisplus会在mapper层上同时创建出xml包及其xml文件
TemplateConfig templateConfig = new TemplateConfig();
// 配置自定义输出模板
//指定自定义模板路径,注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
// templateConfig.setEntity("templates/entity2.java");
// templateConfig.setService();
// templateConfig.setController();
templateConfig.setXml(null);
mpg.setTemplate(templateConfig);
//相关策略配置
StrategyConfig strategyConfig = new StrategyConfig();
strategyConfig.setNaming(NamingStrategy.underline_to_camel);
strategyConfig.setColumnNaming(NamingStrategy.underline_to_camel);
strategyConfig.setInclude(scanner("表名,多个英文逗号分割").split(","));
strategyConfig.setEntityLombokModel(true);//自动lombok
//逻辑删除
//strategyConfig.setLogicDeleteFieldName("deleted");
//自动填充
TableFill createFill = new TableFill("gmt_create", FieldFill.INSERT);
TableFill modifiedFill = new TableFill("gmt_modified",FieldFill.INSERT_UPDATE);
List<TableFill> tableFills = new ArrayList<>();
tableFills.add(createFill);
tableFills.add(modifiedFill);
strategyConfig.setTableFillList(tableFills);
//乐观锁
// strategyConfig.setVersionFieldName("version");
strategyConfig.setRestControllerStyle(true);
strategyConfig.setControllerMappingHyphenStyle(true);
mpg.setStrategy(strategyConfig);
mpg.execute();
}
}
最后进行测试即可:
目录结构:
输入要生成的表名:
生成完毕(能看到对应的包及xml文件都创建出来了):
最后只需要关注业务开发就行啦!!