溫馨提示×

您好,登錄后才能下訂單哦!

密碼登錄×
登錄注冊(cè)×
其他方式登錄
點(diǎn)擊 登錄注冊(cè) 即表示同意《億速云用戶(hù)服務(wù)條款》

如何實(shí)現(xiàn)Mybatis Plus代碼生成器

發(fā)布時(shí)間:2020-07-02 14:36:42 來(lái)源:億速云 閱讀:229 作者:清晨 欄目:開(kāi)發(fā)技術(shù)

這篇文章將為大家詳細(xì)講解有關(guān)如何實(shí)現(xiàn)Mybatis Plus代碼生成器,小編覺(jué)得挺實(shí)用的,因此分享給大家做個(gè)參考,希望大家閱讀完這篇文章后可以有所收獲。

1. 前言

對(duì)于寫(xiě)Crud的老司機(jī)來(lái)說(shuō)時(shí)間非常寶貴,一些樣板代碼寫(xiě)不但費(fèi)時(shí)費(fèi)力,而且枯燥無(wú)味。經(jīng)常有小伙伴問(wèn)我,胖哥你怎么天天那么有時(shí)間去搞新東西,透露一下秘訣唄。

如何實(shí)現(xiàn)Mybatis Plus代碼生成器

好吧,今天就把Mybatis-plus的代碼生成器分享出來(lái),讓你也成為一個(gè)優(yōu)秀的時(shí)間管理大師。

2. 基本依賴(lài)

以Spring Boot和MySQL為例,你需要下面這些依賴(lài):

<!-- lombok 如果不使用 需要修改代碼生成器的相關(guān)配置 -->
<dependency>
 <groupId>org.projectlombok</groupId>
 <artifactId>lombok</artifactId>
 <scope>compile</scope>
</dependency>
<!-- 連接池 你可以使用其它替換掉 -->
<dependency>
 <groupId>com.zaxxer</groupId>
 <artifactId>HikariCP</artifactId>
</dependency>
<!-- mysql -->
<dependency>
 <groupId>mysql</groupId>
 <artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- mybatis plus starter -->
<dependency>
 <groupId>com.baomidou</groupId>
 <artifactId>mybatis-plus-boot-starter</artifactId>
</dependency>
<!-- mybatis plus 生成器模塊 -->
<dependency>
 <groupId>com.baomidou</groupId>
 <artifactId>mybatis-plus-generator</artifactId>
 <scope>compile</scope>
 <optional>true</optional>
</dependency>
<!-- 引入freemarker包 作為代碼生成器引擎 -->
<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-freemarker</artifactId>
 <scope>compile</scope>
 <optional>true</optional>
</dependency>

然后配置好你的數(shù)據(jù)庫(kù),確保數(shù)據(jù)庫(kù)連接通訊暢通。

3. 定制代碼生成器

這里我期望生成的目錄結(jié)構(gòu)是這樣的:

如何實(shí)現(xiàn)Mybatis Plus代碼生成器

于是我花了點(diǎn)時(shí)間定制了一些生成器的配置,代碼如下,就是這么硬核!

package cn.felord.mybatis.util;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
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 java.util.ArrayList;
import java.util.List;
import java.util.Optional;


/**
 * 代碼生成器配置
 *
 * @author felord
 * @since 10 :39 2018/9/9
 */
public class CodeGenerator {
 private String dbUrl;
 private String userName;
 private String password;
 private String dir;
 private String xmlDir;
 private String packageName;

 private CodeGenerator() {
 }

 /**
 * The type Config builder.
 */
 public static class ConfigBuilder {

 private String dbUrl;
 private String userName;
 private String password;
 private String dir;
 private String xmlDir;
 private String packageName;


 /**
  * Db url config builder.
  *
  * @param dbUrl the db url
  * @return the config builder
  */
 public ConfigBuilder dbUrl(final String dbUrl) {
  this.dbUrl = dbUrl;
  return this;
 }

 /**
  * User name config builder.
  *
  * @param userName the user name
  * @return the config builder
  */
 public ConfigBuilder userName(final String userName) {
  this.userName = userName;
  return this;
 }

 /**
  * Password config builder.
  *
  * @param password the password
  * @return the config builder
  */
 public ConfigBuilder password(final String password) {
  this.password = password;
  return this;
 }

 /**
  * Dir config builder.
  *
  * @param dir the dir
  * @return the config builder
  */
 public ConfigBuilder dir(final String dir) {
  this.dir = dir;
  return this;
 }

 /**
  * Dir config builder.
  *
  * @param xmlDir the dir
  * @return the config builder
  */
 public ConfigBuilder xmlDir(final String xmlDir) {
  this.xmlDir = xmlDir;
  return this;
 }

 /**
  * Package name config builder.
  *
  * @param packageName the package name
  * @return the config builder
  */
 public ConfigBuilder packageName(final String packageName) {
  this.packageName = packageName;
  return this;
 }

 /**
  * Build code generator.
  *
  * @return the code generator
  */
 public CodeGenerator build() {
  CodeGenerator generator = new CodeGenerator();

  generator.dbUrl = Optional.of(this.dbUrl).get();
  generator.userName = Optional.of(this.userName).get();
  generator.password = Optional.of(this.password).get();
  generator.dir = Optional.of(this.dir).get();
  generator.xmlDir = Optional.of(this.xmlDir).get();
  generator.packageName = Optional.of(this.packageName).get();
  return generator;
 }
 }


 /**
 * Code.
 *
 * @param tableNames the table names
 */
 public void code(String... tableNames) {
 codingMysql(true, false, true, this.dbUrl, this.userName, this.password, this.dir, this.xmlDir, this.packageName, tableNames);
 }

 /**
 *
 * 生成器核心部分
 *
 * @param serviceNameStartWithI 是否前綴I
 * @param createController 是否生成controller
 * @param useLombok  是否使用 lombok
 * @param dbUrl   數(shù)據(jù)庫(kù)連接
 * @param username  用戶(hù)名稱(chēng)
 * @param password  密碼
 * @param outDir  輸出目錄
 * @param xmlDir  xml 文件目錄
 * @param packageName  包路徑
 * @param tableNames  表名稱(chēng)
 */
 private static void codingMysql(boolean serviceNameStartWithI,
     boolean createController,
     boolean useLombok,
     String dbUrl,
     String username,
     String password,
     String outDir,
     String xmlDir,
     String packageName,
     String... tableNames) {
 GlobalConfig config = new GlobalConfig();
 DataSourceConfig dataSourceConfig = new DataSourceConfig();
// 數(shù)據(jù)庫(kù)類(lèi)型 這里使用 mysql
 dataSourceConfig.setDbType(DbType.MYSQL)
  .setUrl(dbUrl)
  .setUsername(username)
  .setPassword(password)
//  驅(qū)動(dòng)名稱(chēng) 這里使用mysql
  .setDriverName("com.mysql.jdbc.Driver");

 // 自定義xml輸出路徑
 InjectionConfig cfg = new InjectionConfig() {
  @Override
  public void initMap() {
  // to do nothing
  }
 };
 List<FileOutConfig> focList = new ArrayList<>();
// 你也可以定制 xml 的模板
 focList.add(new FileOutConfig("/templates/mapper.xml.ftl") {
  @Override
  public String outputFile(TableInfo tableInfo) {
  // 自定義xml文件的路徑
  return xmlDir + "/mapper/" + tableInfo.getMapperName() + StringPool.DOT_XML;
  }
 });
 cfg.setFileOutConfigList(focList);


// 策略配置項(xiàng)
 StrategyConfig strategyConfig = new StrategyConfig();
 strategyConfig
  .setCapitalMode(false)
//  是否使用 lombok
  .setEntityLombokModel(useLombok)
//  下劃線(xiàn)轉(zhuǎn)駝峰
  .setNaming(NamingStrategy.underline_to_camel)
  //修改替換成你需要的表名,多個(gè)表名傳數(shù)組
  .setInclude(tableNames);
// 使用 AR 模式
 config.setActiveRecord(true)
//  設(shè)置頭注釋的 author
  .setAuthor("system")
//  項(xiàng)目輸出路徑
  .setOutputDir(outDir)
//  是否覆蓋已經(jīng)生成的同名文件
  .setFileOverride(true)
//  雪花算法生成id
  .setIdType(IdType.ASSIGN_ID)
//  是否使用緩存
  .setEnableCache(false)
//  是否生成 xml 中的 基礎(chǔ) resultMap
  .setBaseResultMap(true);
 if (!serviceNameStartWithI) {
//  Service 層的 通用格式后綴
  config.setServiceName("%sService");
 }
//  實(shí)體類(lèi)包名
 PackageConfig packageConfig = new PackageConfig().setParent(packageName).setEntity("entity");
 TemplateConfig templateConfig = new TemplateConfig().setXml(null);
// 這里選擇不生成 controller 實(shí)際上 生成的大多不符合我們需要 到服務(wù)層就行了
 if (!createController) {
  templateConfig.setController(null);
 }
// 整合起來(lái)運(yùn)行
 new AutoGenerator()
  .setGlobalConfig(config)
  .setTemplateEngine(new FreemarkerTemplateEngine())
  .setDataSource(dataSourceConfig)
  .setStrategy(strategyConfig)
  .setPackageInfo(packageConfig)
  .setCfg(cfg)
  .setTemplate(templateConfig)
  .execute();
 }

}

如果我生成的目錄結(jié)構(gòu)能夠滿(mǎn)足你的需要,那就巧了,直接拿去用;如果不滿(mǎn)足需要,你可以按照注釋的說(shuō)明進(jìn)行微調(diào)。18年搞的用了好幾年,沒(méi)出過(guò)什么亂子。

4. 代碼生成器的使用

使用起來(lái)非常簡(jiǎn)單,確保數(shù)據(jù)庫(kù)能夠使用JDBC連接成功,寫(xiě)個(gè)main方法,配置一下,跑起來(lái)就是了:

/**
 * @author felord.cn
 * @since 11:34
 **/
public class AutoCoding {
 public static void main(String[] args) {

//   maven 工程 main 包的全路徑
  final String mainDir = "C:\\IdeaProjects\\bc-recyling\\src\\main\\";

  CodeGenerator.ConfigBuilder builder = new CodeGenerator.ConfigBuilder();

  CodeGenerator codeGenerator = builder
//    數(shù)據(jù)庫(kù)連接
    .dbUrl("jdbc:mysql://localhost:3306/test")
//    賬戶(hù)
    .userName("root")
//    密碼
    .password("123456")
    // 生成類(lèi)位置
    .dir(mainDir + "java")
    // 生成xml 位置
    .xmlDir(mainDir + "resources")
    // 包引用路徑
    .packageName("cn.felord.mybatis")
    .build();

  //根據(jù)表生成后臺(tái)代碼
  codeGenerator.code("user_info");


 }
}

然后代碼就生成了,是不是非常的好用?恭喜你獲得了 時(shí)間管理大師 榮譽(yù)稱(chēng)號(hào)。

切記不要炫耀,否則需求加倍。

關(guān)于如何實(shí)現(xiàn)Mybatis Plus代碼生成器就分享到這里了,希望以上內(nèi)容可以對(duì)大家有一定的幫助,可以學(xué)到更多知識(shí)。如果覺(jué)得文章不錯(cuò),可以把它分享出去讓更多的人看到。

向AI問(wèn)一下細(xì)節(jié)

免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。

AI