SpringBoot使用mybatis-plus代码生成器且xml文件生成在resource文件下
- 一、Pom依赖
- 二、核心代码
- 三、效果
一、Pom依赖
<!--项目代码初始化生成器两个依赖-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.3.1.tmp</version>
</dependency>
<!-- 添加 模板引擎 依赖 -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.2</version>
</dependency>
二、核心代码
//通过插件构建项目
@Test
public void autoGenerate() {
// Step1:代码生成器
//创建一个 代码生成器。用于生成代码。
//此处不用修改。
AutoGenerator mpg = new AutoGenerator();
// Step2:全局配置
//配置全局信息。指定代码输出路径,以及包名、作者等信息。
//此处按需添加,projectPath 需要修改,setAuthor 需要修改。
GlobalConfig gc = new GlobalConfig();
// 填写代码生成的目录(需要修改)
String projectPath = "D:\\JavaDemo\\library_management_system\\library_management_system_java";
// 拼接出代码最终输出的目录
gc.setOutputDir(projectPath + "/src/main/java");
// 配置开发者信息(可选)(需要修改)
gc.setAuthor("licy");
// 配置是否打开目录,false 为不打开(可选)
gc.setOpen(false);
// 实体属性 Swagger2 注解,添加 Swagger 依赖,开启 Swagger2 模式(可选)
gc.setSwagger2(false);
// 重新生成文件时是否覆盖,false 表示不覆盖(可选)
gc.setFileOverride(false);
// 配置主键生成策略,此处为 ASSIGN_ID(可选)
gc.setIdType(IdType.AUTO);
// 配置日期类型,此处为 ONLY_DATE(可选)
gc.setDateType(DateType.ONLY_DATE);
// 默认生成的 service 会有 I 前缀
gc.setServiceName("%sService");
mpg.setGlobalConfig(gc);
// Step3:数据源配置(需要修改)
//置数据源信息。用于指定 需要生成代码的 数据仓库、数据表。
//setUrl、setDriverName、setUsername、setPassword 均需修改。
DataSourceConfig dsc = new DataSourceConfig();
// 配置数据库 url 地址
dsc.setUrl("jdbc:mysql://127.0.0.1:3306/library?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=UTC");
// dsc.setSchemaName("testMyBatisPlus"); // 可以直接在 url 中指定数据库名
// 配置数据库驱动
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
// 配置数据库连接用户名
dsc.setUsername("root");
// 配置数据库连接密码
dsc.setPassword("123456");
mpg.setDataSource(dsc);
// Step:4:包配置
//配置包信息。
//setParent、setModuleName 均需修改。其余按需求修改.
PackageConfig pc = new PackageConfig();
// 配置父包名(需要修改)
pc.setParent("com.example");
// 配置模块名(需要修改)
pc.setModuleName("libraryManagementSystemJava");
// 配置 entity 包名
pc.setEntity("entity");
// 配置 mapper 包名
pc.setMapper("mapper");
pc.setXml(null);
// 配置 service 包名
pc.setService("service");
// 配置 serviceImpl 包名
pc.setServiceImpl("service.Impl");
// 配置 controller 包名
pc.setController("controller");
mpg.setPackageInfo(pc);
// Step:5:将xml生成到resource下面
// 自定义配置
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 projectPath + "/src/main/resources/mapper/"
// + pc.getModuleName()
+ "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
}
});
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);
// 配置模板
TemplateConfig templateConfig = new TemplateConfig();
templateConfig.setXml(null);
mpg.setTemplate(templateConfig);
// Step6:策略配置(数据库表配置)
//配置数据表映射信息。
//setInclude 需要修改,其余按实际开发修改。
StrategyConfig strategy = new StrategyConfig();
// 指定表名(可以同时操作多个表,使用 , 隔开)(需要修改)(不设置的话默认全部表)
//strategy.setInclude("company_car","company_computer","company_user","company_user_car");
//strategy.setInclude("system_user");
// 配置数据表与实体类名之间映射的策略
strategy.setNaming(NamingStrategy.underline_to_camel);
// 配置数据表的字段与实体类的属性名之间映射的策略
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
// 配置 lombok 模式
strategy.setEntityLombokModel(true);
// 配置 rest 风格的控制器(@RestController)
strategy.setRestControllerStyle(true);
// 配置驼峰转连字符
strategy.setControllerMappingHyphenStyle(true);
// 配置表前缀,生成实体时去除表前缀
// 例如表名为 test_mybatis_plus_user,模块名为 test_mybatis_plus,去除前缀后剩下为 user。
//strategy.setTablePrefix(pc.getModuleName() + "_");
mpg.setStrategy(strategy);
// Step7:执行代码生成操作
mpg.execute();
}