在我們需要一些資料庫的實體類時,需要手動建立實體與類,這很浪費時間,所以我研究了一下和上網找了一些資料,整合出了一套可靈活設定生成路徑的程式碼!!!
↓↓↓直接上程式碼↓↓↓
package xgg.mybatisplus.generator;
import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import org.apache.commons.lang3.StringUtils;
import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;
/**
* 程式碼生成器
*
* @author xiegege
*/
public class CodeGenerator {
// 資料庫連線地址
private static final String URL = "jdbc:mysql://127.0.0.1:3306/springboot-mini?useUnicode=true&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC&useSSL=true&characterEncoding=UTF-8";
// 資料庫連線驅動
private static final String DRIVER_NAME = "com.mysql.cj.jdbc.Driver";
// 資料庫連線使用者名稱
private static final String USERNAME = "root";
// 資料庫連線密碼
private static final String PASSWORD = "123456";
// 模組名(可選)
private static final String MODULE_NAME = "";
// 專案路徑
private static final String PROJECT_PATH = System.getProperty("user.dir");
// xxx.java檔案放置路徑
private static String JAVA_PATH = "/src/main/java";
// xxxMapper.xml檔案放置路徑
private static String XML_PATH = "/src/main/resources/mapper/";
private static final String SCANNER_TEXT = "請輸入";
/**
* 自動生成程式碼
*/
public static void main(String[] args) {
scannerModuleName("maven模組名(如:common)");
String parentPackageName = scanner("父包名(如:com.xxx.xxx)");
String author = scanner("開發人員(作者)");
// 程式碼生成器
AutoGenerator mpg = new AutoGenerator();
// TODO 全域性設定
GlobalConfig gc = new GlobalConfig();
// 生成檔案的輸出目錄
gc.setOutputDir(PROJECT_PATH + JAVA_PATH);
// 作者
gc.setAuthor(author);
// 是否開啟輸出目錄
gc.setOpen(false);
// controller 命名方式,注意 %s 會自動填充表實體屬性
gc.setControllerName("%sController");
// service 命名方式
gc.setServiceName("%sService");
// serviceImpl 命名方式
gc.setServiceImplName("%sServiceImpl");
// mapper 命名方式
gc.setMapperName("%sMapper");
// xml 命名方式
gc.setXmlName("%sMapper");
// 開啟 swagger2 模式
gc.setSwagger2(true);
// 是否覆蓋已有檔案
gc.setFileOverride(true);
// 是否開啟 ActiveRecord 模式
gc.setActiveRecord(true);
// 是否在xml中新增二級快取設定
gc.setEnableCache(false);
// 是否開啟 BaseResultMap
gc.setBaseResultMap(false);
// XML columList
gc.setBaseColumnList(false);
// 全域性 相關設定
mpg.setGlobalConfig(gc);
// TODO 資料來源設定
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl(URL);
dsc.setDriverName(DRIVER_NAME);
dsc.setUsername(USERNAME);
dsc.setPassword(PASSWORD);
mpg.setDataSource(dsc);
// TODO 包設定
PackageConfig pc = new PackageConfig();
// 父包名。如果為空,將下面子包名必須寫全部, 否則就只需寫子包名
pc.setParent(parentPackageName);
// 模組名,可以不指定
pc.setModuleName(MODULE_NAME);
// Controller包名
pc.setController("controller");
// Service包名
pc.setService("service");
// ServiceImpl包名
pc.setServiceImpl("service.impl");
// Mapper 包名
pc.setMapper("mapper");
// Entity包名
pc.setEntity("pojo");
mpg.setPackageInfo(pc);
// TODO 自定義設定
InjectionConfig cfg = new InjectionConfig() {
@Override
public void initMap() {
// to do nothing
}
};
// 輸出檔案設定
List<FileOutConfig> focList = new ArrayList<>();
focList.add(new FileOutConfig("/templates/mapper.xml.ftl") {
@Override
public String outputFile(TableInfo tableInfo) {
// Mapper.xml 檔案存放地址及檔名
return PROJECT_PATH + XML_PATH + MODULE_NAME + "/" + tableInfo.getEntityName() + "Mapper.xml";
}
});
// 自定義輸出檔案
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);
mpg.setTemplate(new TemplateConfig().setXml(null));
// TODO 策略設定
StrategyConfig strategy = new StrategyConfig();
// 資料庫表對映到實體的命名策略,駝峰原則
strategy.setNaming(NamingStrategy.underline_to_camel);
// 字資料庫表欄位對映到實體的命名策略,駝峰原則
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
// 實體是否生成 serialVersionUID
strategy.setEntitySerialVersionUID(false);
// 是否生成實體時,生成欄位註解
strategy.setEntityTableFieldAnnotationEnable(true);
// 使用lombok
strategy.setEntityLombokModel(true);
// 設定邏輯刪除鍵
strategy.setLogicDeleteFieldName("del_flag");
// TODO 指定生成的bean的資料庫表名
strategy.setInclude(scanner("表名,多個表使用英文逗號分割").split(","));
// 駝峰轉連字元
strategy.setControllerMappingHyphenStyle(true);
mpg.setStrategy(strategy);
// 選擇 freemarker 引擎需要指定如下加,注意 pom 依賴必須有!
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
mpg.execute();
}
/**
* 模組名鍵盤輸入
*
* @param text 提示文字
*/
public static void scannerModuleName(String text) {
Scanner scanner = new Scanner(System.in);
System.out.println(SCANNER_TEXT + text);
if (scanner.hasNext()) {
String moduleName = scanner.next();
if (StringUtils.isNotEmpty(moduleName)) {
JAVA_PATH = "/" + moduleName + JAVA_PATH;
XML_PATH = "/" + moduleName + XML_PATH;
return;
}
}
throw new MybatisPlusException(SCANNER_TEXT + "正確的" + text + "!");
}
/**
* 通用鍵盤輸入
*
* @param text 提示文字
*/
public static String scanner(String text) {
Scanner scanner = new Scanner(System.in);
System.out.println(SCANNER_TEXT + text + ":");
if (scanner.hasNext()) {
String str = scanner.next();
if (StringUtils.isNotEmpty(str)) {
return str;
}
}
throw new MybatisPlusException(SCANNER_TEXT + "正確的" + text + "!");
}
}
下面是程式碼結構
我們測試一下:程式碼生成在miaosha
模組下,父包名:xgg.miaosha.demo
執行成功,接下來看看有沒有生成我們想要的程式碼
可以看到程式碼都成功生成了
還有一種結構生成方式(修改常數MODULE_NAME的值為:user)
// 模組名(可選)
private static final String MODULE_NAME = "user";
再次執行程式碼
可以看到,多了一層父級目錄
<!-- mybatisPlus Freemarker 模版引擎 -->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
</dependency>
必須加上這個依賴,不然會報以下錯
使用到的依賴
<!-- RESTful APIs swagger2 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
<exclusions>
<exclusion>
<groupId>io.swagger</groupId>
<artifactId>swagger-annotations</artifactId>
</exclusion>
<exclusion>
<groupId>io.swagger</groupId>
<artifactId>swagger-models</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-annotations</artifactId>
<version>1.5.21</version>
</dependency>
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-models</artifactId>
<version>1.5.21</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.3.1</version>
</dependency>
<!-- mybatis-plus程式碼生成器 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.3.1.tmp</version>
</dependency>
<!--Mysql依賴包-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<!-- druid資料來源驅動 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>1.1.10</version>
</dependency>
<!--lombok外掛-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<!-- mybatisPlus Freemarker 模版引擎 -->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
</dependency>
這個程式碼生成器可靈活設定生成路徑,在微服務、多模組的專案使用起來非常方便!