mybatis plus可以使用模板完成代碼的自動生成,再創建新的項目時,更新數據庫表時,都可以直接使用代碼生成器直接生成新的代碼。
具體實現步驟如下:
第一步:引入代碼生成器依賴的jar包
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</exclusion>
</exclusions>
</dependency>
<!--lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<!--mybatis plus-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.3.2</version>
</dependency>
<!--mybatis代碼生成器-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.3.2</version>
</dependency>
<!--freemarker-->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.28</version>
</dependency>
<!--mysql-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<!-- druid連接池 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.1.21</version>
</dependency>
<!-- shardingjdbc -->
<dependency>
<groupId>io.shardingjdbc</groupId>
<artifactId>sharding-jdbc-core</artifactId>
<version>2.0.3</version>
</dependency>
<dependency>
<groupId>com.lmax</groupId>
<artifactId>disruptor</artifactId>
<version>3.4.2</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
第二步:編寫代碼生成器
import com.baomidou.mybatisplus.annotation.IdType;
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.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import lombok.Data;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;
import java.util.Scanner;
@Data
public class CodeGenerator {
/**
* 配置文件名
*/
private final static String APP_PROPERTY = "application-dev.properties";
private String projectPath = System.getProperty("user.dir");
/**
* 公共包路徑
*/
private String parentPackage = "com.geexek.www";
/**
* 模塊名
*/
private String module = "geexekscore";
/**
* 自定義模板位置
*/
private String templatePath = "templates/mp/";
private String controllerTemplate = templatePath + "controller.java";
private String serviceTemplate = templatePath + "service.java";
private String serviceImplTemplate = templatePath + "serviceImpl.java";
private String mapperTemplate = templatePath + "mapper.java";
public static void main(String[] args) {
//全局配置
CodeGenerator codeGenerator = new CodeGenerator();
codeGenerator.execute();
}
/**
* <p>
* 讀取控制檯內容
* </p>
*/
public static String scanner(String tip) {
Scanner scanner = new Scanner(System.in);
StringBuilder help = new StringBuilder();
help.append("請輸入" + tip + ":");
System.out.println(help.toString());
if (scanner.hasNext()) {
String ipt = scanner.next();
if (ipt != null && !ipt.trim().isEmpty()) {
return ipt;
}
}
throw new MybatisPlusException("請輸入正確的" + tip + "!");
}
public void execute() {
// 代碼生成器
AutoGenerator mpg = new AutoGenerator();
/**
* 全局配置
*/
GlobalConfig gc = new GlobalConfig();
//生成文件輸出目錄
gc.setOutputDir(projectPath + "/src/main/java");
//每個文件註釋部分的創建者
gc.setAuthor("sunyuhua");
//是否打開輸出目錄
gc.setOpen(false);
//開啓 ActiveRecord 模式
gc.setActiveRecord(true);
//指定生成的主鍵的ID類型
gc.setIdType(IdType.AUTO);
//各層文件名稱方式,例如: %sService 生成 UserService
gc.setServiceName("%sService");
//開啓 BaseResultMap
gc.setBaseResultMap(true);
//開啓 baseColumnList
gc.setBaseColumnList(true);
//是否覆蓋已有文件
gc.setFileOverride(true);
//實體屬性 Swagger2 註解,開啓 swagger2 模式
gc.setSwagger2(true);
//全局 相關配置
mpg.setGlobalConfig(gc);
/**
* 數據源配置
*/
mpg.setDataSource(dataSourceConfig());
/**
* 包配置
*/
PackageConfig pc = new PackageConfig();
//父包名。如果爲空,將下面子包名必須寫全部, 否則就只需寫子包名
pc.setParent(parentPackage);
//父包模塊名
pc.setModuleName(module);
mpg.setPackageInfo(pc);
/**
* 自定義配置
*/
InjectionConfig cfg = new InjectionConfig() {
@Override
public void initMap() {
// to do nothing
}
};
mpg.setCfg(cfg);
/**
* 配置模板
*/
TemplateConfig templateConfig = new TemplateConfig();
// 配置自定義輸出模板
//指定自定義模板路徑,注意不要帶上.ftl/.vm, 會根據使用的模板引擎自動識別
templateConfig.setXml(null);
templateConfig.setService(serviceTemplate);
templateConfig.setServiceImpl(serviceImplTemplate);
templateConfig.setMapper(mapperTemplate);
templateConfig.setController(controllerTemplate);
mpg.setTemplate(templateConfig);
/**
* 策略配置
*/
StrategyConfig strategy = new StrategyConfig();
//數據庫表映射到實體的命名策略,將下劃線轉駝峯命名
strategy.setNaming(NamingStrategy.underline_to_camel);
//數據庫表字段映射到實體的命名策略,下劃線轉駝峯命名
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
//strategy.setSuperEntityClass("你自己的父類實體,沒有就不用設置!");
//【實體】是否爲lombok模型(默認 false),lombok模型更爲簡單
strategy.setEntityLombokModel(true);
//生成 <code>@RestController</code> 控制器,即爲controller層的註解@RestController
strategy.setRestControllerStyle(true);
// 公共父類
//strategy.setSuperControllerClass("你自己的父類控制器,沒有就不用設置!");
// 寫於父類中的公共字段
strategy.setSuperEntityColumns("id");
//將數據庫表中的gk_開頭的前綴去掉
strategy.setTablePrefix("gk_");
//設置生成模式,表名之間用逗號分隔
strategy.setInclude(scanner("表名,多個英文逗號分割").split(","));
//駝峯轉連字符,
// <code>@RequestMapping("/managerUserActionHistory")</code> -> <code>@RequestMapping("/manager-user-action-history")</code>
strategy.setControllerMappingHyphenStyle(true);
mpg.setStrategy(strategy);
/**
* 設置模板引擎
*/
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
mpg.execute();
}
/**
* 設置DataSource
* @return
*/
private static DataSourceConfig dataSourceConfig() {
DataSourceConfig dsc = new DataSourceConfig();
String resourcePath = System.getProperty("user.dir") + "/src/main/resources/" + APP_PROPERTY;
try {
InputStream inStream = new FileInputStream(new File(resourcePath));
Properties prop = new Properties();
prop.load(inStream);
dsc.setUrl(prop.getProperty("spring.datasource.url"));
dsc.setDriverName(prop.getProperty("spring.datasource.driver-class-name"));
dsc.setUsername(prop.getProperty("spring.datasource.username"));
dsc.setPassword(prop.getProperty("spring.datasource.password"));
} catch (IOException e) {
e.printStackTrace();
}
return dsc;
}
}
第三步:整理模板,編輯好模板
第四步:運行代碼,輸入表名,執行代碼生成器
第五步:查看生成的代碼
完整工程下載地址: