前言
日常開發中,單表操作的模塊文件編寫比較重復且耗費時間
如果項目中使用mybatis-plus,則可以嘗試其自家的逆向工程工具,快速生成數據庫中對應的所有mvc結構文件和實體類,以及mapper.xml文件,降低時間成本
可以配置lombok、swagger、@RestController等常用工具、注解
一、 添加逆向工程所需的相關pom坐標
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</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>
<!-- mybatis-plus 代碼生成器默認模板 -->
<!--<dependency>-->
<!-- <groupId>org.apache.velocity</groupId>-->
<!-- <artifactId>velocity-engine-core</artifactId>-->
<!-- <version>2.2</version>-->
<!--</dependency>-->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.31</version>
</dependency>
二、 在項目中添加AutoGenerator代碼生成器入口文件,啟動文件即可
- AutoGenerator 是 MyBatis-Plus 的代碼生成器,通過 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各個模塊的代碼,極大的提升了開發效率。
public class CodeGenerator {
/**
* <p>
* 讀取控制台內容
* </p>
*/
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 gc = new GlobalConfig();
String projectPath = System.getProperty("user.dir");
gc.setOutputDir(projectPath + "/src/main/java");
gc.setAuthor("suhai");
gc.setBaseResultMap(true); //xml開啟BaseResultMap
gc.setBaseColumnList(true); //xml開啟BaseColumnList
gc.setOpen(false); //代碼生成后打開目錄
gc.setSwagger2(true); // 實體屬性 Swagger2 注解
gc.setServiceName("%sService"); //設置service名稱,否則service的接口名稱為 "IXXXService",設置后加入I前綴
mpg.setGlobalConfig(gc);
// 數據源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/數據庫名稱?useUnicode=true&useSSL=false&characterEncoding=utf8");
// dsc.setSchemaName("public");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("數據庫密碼");
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
//配置包結構模塊名,一般為com.xxxx.模塊名.pojo,數據庫表結構名稱前綴也可以一樣
//pc.setModuleName(scanner("模塊名"));
pc.setParent("com.xxxx")
.setEntity("pojo")
.setMapper("mapper")
.setService("service")
.setServiceImpl("service.impl")
.setController("controller");
mpg.setPackageInfo(pc);
// 自定義配置
InjectionConfig cfg = new InjectionConfig() {
@Override
public void initMap() {
// to do nothing
}
};
// 如果模板引擎是 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 + "/yeb-generator/src/main/resources/mapper/"
+ tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
}
});
/*
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);
mpg.setCfg(cfg);
// 配置模板
TemplateConfig templateConfig = new TemplateConfig();
// 配置自定義輸出模板
// 指定自定義模板路徑,注意不要帶上.ftl/.vm, 會根據使用的模板引擎自動識別
// templateConfig.setEntity("templates/entity2.java");
// templateConfig.setService();
// templateConfig.setController();
templateConfig.setXml(null);
mpg.setTemplate(templateConfig);
// 策略配置
StrategyConfig strategy = new StrategyConfig();
// 數據庫表映射到實體的命名策略,underline_to_camel:下划線轉駝峰命名 no_change:不做任何改變,原樣輸出
strategy.setNaming(NamingStrategy.underline_to_camel);
// 數據庫表字段映射到實體的命名策略,策略同上
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
// Lombok原型
strategy.setEntityLombokModel(true);
// 生成@RestController控制器
strategy.setRestControllerStyle(true);
//strategy.setSuperEntityClass("你自己的父類實體,沒有就不用設置!");
// 公共父類
//strategy.setSuperControllerClass("你自己的父類控制器,沒有就不用設置!");
// 寫於父類中的公共字段
//strategy.setSuperEntityColumns("id");
// 指定要生成的表名稱,若需要生成所有表,則不需要配置
strategy.setInclude(scanner("表名,多個英文逗號分割").split(","));
strategy.setControllerMappingHyphenStyle(true);
// 表前綴
//strategy.setTablePrefix(pc.getModuleName() + "_");
strategy.setTablePrefix("t_"); //這里的 "t_" 為數據庫表名稱前綴,例如:t_admin,主要在生成文件時起去除前綴的作用
mpg.setStrategy(strategy);
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
mpg.execute();
}
}