标签：String 自定义 配置 生成器 strategy Plus Mybatis new public
Mybatis Plus 代码自动生成器常用配置
代码自动生成器常用配置
从ssm转springboot，尝试了jpa，还是没有mybatis顺手，但是mybatis generator不管是maven插件还是IDEA插件，都有点受限，比如想做个模糊搜索，还是要自己写语句，一套下来没比jpa上直接写语句便宜多少，所以还是花点时间转到mybaitis plus上了，简单总结一下。
基础配置
- 依赖 ：
<!--spring-boot-starter-web-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--mybatis plus-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.2</version>
</dependency>
<!--mybatis plus代码生成器-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.4.1</version>
</dependency>
<!--代码生成器的模板引擎-->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.31</version>
</dependency>
- 数据源等配置 application.yml
#数据源
spring:
datasource:
driver-class-name: org.postgresql.Driver
url: jdbc:postgresql://localhost:5432/ultron
username: postgres
password: password
#xml位置
mybatis-plus:
mapper-locations: classpath:/mapper/*Mapper.xml
- 在 Spring Boot 启动类中添加 @MapperScan 注解，扫描 Mapper 文件夹
@SpringBootApplication
@MapperScan("com.example.ultron.mapper")
public class UltronApplication {
public static void main(String[] args) {
SpringApplication.run(UltronApplication.class, args);
}
}
- mybaitis plus具体的基础配置与使用可以参考官方指南。
代码自动生成配置(详)
1.常量
final String ProjectPath = System.getProperty("user.dir");//D://workspace/ultron
final String CustomMapperPath = "/src/main/resources/mapper/";//自定义xml输出位置
final String SuperEntityClass = "com.example.ultron.pojo.BaseEntity";//实体的公共父类
final String JdbcUrl = "jdbc:postgresql://localhost:5432/ultron";//数据库连接字符串
final String DriverName = "org.postgresql.Driver";//数据库驱动
final String Username = "postgres";//数据库用户名
final String Password = "password";//数据库密码
2.主方法用于运行生成代码
public static void main(String[] args) {
//GenerateTables generateTables = JsonReader.read(PATH);
MyBatisGenerator genarator = new MyBatisGenerator();
String[] generateTables = {
//"t_user","auth","role" //已经生成过的数据库表
"newtable" //待运行生成的数据库表
};
assert generateTables != null;
genarator.genarate(generateTables);//调用代码生成方法
}
3.代码生成方法
public void genarate(String... generateTables) {
//代码生成器
AutoGenerator mpg = new AutoGenerator();
//1.加载全局配置
GlobalConfig gc = getGlobalConfig();
mpg.setGlobalConfig(gc);
//2.加载数据源配置
DataSourceConfig dsc = getDataSourceConfig();
mpg.setDataSource(gc);
//3.加载包配置
PackageConfig pc = getPackageConfig();
mpg.setPackageInfo(pc);
//4.加载模板配置
TemplateConfig templateConfig = getTemplateConfig();
mpg.setTemplate(templateConfig);
//5.加载策略配置
StrategyConfig strategy = getStrategyConfig();
mpg.setStrategy(strategy);
/*
自定义包输出配置(将xml输出到resource下而非source root下)
*/
// 如果模板引擎是 freemarker 默认为/templates/mapper.xml.ftl
String templatePath = "/templates/mapper.xml.ftl";
// 如果模板引擎是 velocity
// String templatePath = "/templates/mapper.xml.vm";
// 自定义mapper.xml的输出
List<FileOutConfig> focList = new ArrayList<>();
// 自定义配置会被优先输出
focList.add(new FileOutConfig(templatePath) {
@Override
public String outputFile(TableInfo tableInfo) {
// 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
return ProjectPath + CustomMapperPath + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
}
});
//6.设置模板引擎//支持 Velocity(默认)/Freemarker/Beetl
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
//生成器执行，生成代码
mpg.execute();
}
4.各项配置详解
(1) 全局必要的配置
public GlobalConfig getGlobalConfig() {
GlobalConfig gc = new GlobalConfig();
//全局路径到项目的Source Root根目录即可
gc.setOutputDir(ProjectPath + "/src/main/java");
//设置作者
gc.setAuthor("author");
//实体属性 Swagger2 注解
gc.setSwagger2(true);
//是否覆盖生成文件
gc.setFileOverride(true);
//Service默认生成会有I-前缀
//其他Controller/ServiceImpl则没有,不需要单独设置
gc.setServiceName("%sService");//%s是占位符
//如果主键在数据库设置了自增
//则就需要在pojo/vo中的实体类中标注主键@TableId(type=IdType.AUTO)
//或者在此设置IdType
gc.setIdType(IdType.AUTO);
return gc;
}
(2) 数据源配置
public DataSourceConfig getDataSourceConfig() {
DataSourceConfig dsc = new DataSourceConfig();
dsc.setDbType(DbType.POSTGRE_SQL);//必须设置数据库类型
dsc.setUrl(JdbcUrl);
//PostgreSQL可设置,默认为"public",MySQL不需要设置
//dsc.setSchemaName("public");
dsc.setDriverName(DriverName);
dsc.setUsername(Username);
dsc.setPassword(Password);
return dsc;
}
(3) 包配置，用于指定生成的controller/service(impl)/entity/mapper/xml等输出的包位置
public PackageConfig getPackageConfig() {
PackageConfig pc = new PackageConfig();
pc.setParent("com.example");
pc.setModuleName("ultron");//模块名
//配置entity的输出包，其他的包名controller/service/service.impl/mapper等默认一样
pc.setEntity("vo");
return pc;
}
(4) 模板配置，用于指定生成各类文件的模板，一般均采用默认模板，如果不需要自动生成哪一类文件，则向setter传null即可。
public TemplateConfig getTemplateConfig() {
TemplateConfig templateConfig = new TemplateConfig();
// 配置自定义输出模板
//指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
// templateConfig.setEntity("templates/entity2.java");
// templateConfig.setService();
//不自动生成Controller
templateConfig.setController(null);
//已经另外配置了路径输出xml,故设置不自动生成xml
templateConfig.setXml(null);
return templateConfig ;
}
(5) 策略配置，用于设置各种生成策略和一些数据表策略
public StrategyConfig getStrategyConfig() {
StrategyConfig strategy = new StrategyConfig();
//数据库表映射到实体的命名策略:下划线转驼峰命名
strategy.setNaming(NamingStrategy.underline_to_camel);
//数据库表字段映射到实体的命名策略:下划线转驼峰命名 //未指定按照 naming 执行
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
//自定义继承的Entity类全称，带包名
/* 自定义公共父类时需要给字段注解：
* @TableField(exist = false)//表示该属性不是数据库表字段，但又是必须使用的
* 否则mybatis-plus使用对象属性进行SQL操作，比如save(insert/insertBatch)
* 会报错表示对象属性非数据据库表的字段
*/
strategy.setSuperEntityClass(SuperEntityClass);
//[实体]是否为lombok模型(默认 false)
//3.3.2以下版本默认生成了链式模型，3.3.2以后，默认不生成，如有需要，请开启 chainModel
strategy.setChainModel(true);
strategy.setEntityLombokModel(true);
//是否生成实体时，生成字段注解
/*
* 部分字段注解：
* @TableField(exist = false)：表示该属性不是数据库表字段，但又是必须使用的。
* @TableField(exist = true)：表示该属性是数据库表字段，默认是这个注解。
* @TableName：数据库表相关
* @TableId：表主键标
* @TableField：表字段标识
* @TableLogic：表字段逻辑处理注解（逻辑删除）
*/
strategy.setEntityTableFieldAnnotationEnable(true);
//设置RestController模式
//strategy.setRestControllerStyle(true);
//公共的父类控制器,没有就不用设置
// strategy.setSuperControllerClass("");
//写于父类中的公共字段
//strategy.setSuperEntityColumns("id");
//需要包含的表名，当enableSqlFilter为false时，允许正则表达式（与exclude二选一配置）
strategy.setInclude(generateTables);
//strategy.setControllerMappingHyphenStyle(true);
//strategy.setTablePrefix(pc.getModuleName() + "_");
return strategy;
}
(6) 自定义配置，不常用
public InjectionConfig getInjectionConfig() {
InjectionConfig cfg = new InjectionConfig() {
@Override
public void initMap() {
// to do nothing
}
};
/*
cfg.setFileCreate(new IFileCreate() {
@Override
public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
// 判断自定义文件夹是否需要创建
checkDir("调用默认方法创建的目录，自定义目录用");
if (fileType == FileType.MAPPER) {
// 已经生成 mapper 文件判断存在，不想重新生成返回 false
return !new File(filePath).exists();
}
// 允许生成模板文件
return true;
}
});
*/
cfg.setFileOutConfigList(focList);
return cfg;
}
- 更多关于 mybatis plus 的配置，参考 官网.
标签：String,自定义,配置,生成器,strategy,Plus,Mybatis,new,public 来源： https://blog.csdn.net/u011743323/article/details/115530897
本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享； 2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关； 3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关； 4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除； 5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。