MyBatisPlus代碼生成器的原理及實現詳解

Posted on by

一、代碼生成器原理分析

我們在觀察之前寫的代碼的時候，會發現很多重復的內容。

 一個Book模板，，隻需要把紅色部分的內容全部更換成Book即可。

 所以任何模板的開發，對於這段代碼基本都是對紅色部分的調整，所以我們把去掉紅色內容的東西稱為模板，紅色部分稱為參數，以後隻需要傳入不同的參數，就可以根據模板創建出不同模塊的dao代碼。

處理Dao可以抽取模塊，其實我們常見的類都可以進行抽取，隻要他們公共部分即可。

① 可以根據數據庫表的表名來填充

② 可以根據用戶的配置來生成ID生成策略

③到⑨可以根據數據表的字段名稱來填充

所以隻要我們知道哪張表進行代碼生成，這些內容我們就可以進行填充 

代碼生成，我們需要有以下內容：

模板：MyBatisPlus提供，可以自己提供，但是麻煩，不建議

數據庫相關配置：讀取數據庫獲取表和字段信息

開發者自定義配置：手工配置，比如ID生成策略

二、代碼生成器實現

1、創建一個Maven項目

2、導入相應的jar包

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.1</version>
    </parent>
    <groupId>com.itheima</groupId>
    <artifactId>mybatisplus_04_generator</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <!--spring webmvc-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
 
        <!--mybatisplus-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.4.1</version>
        </dependency>
 
        <!--druid-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.1.16</version>
        </dependency>
 
        <!--mysql-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
 
        <!--test-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
 
        <!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.12</version>
        </dependency>
 
        <!--代碼生成器-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.4.1</version>
        </dependency>
 
        <!--velocity模板引擎-->
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.3</version>
        </dependency>
 
    </dependencies>
 
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

代碼生成器主要jar包是代碼生成器和velocity模板引擎這兩個。

3、表現引導類

@SpringBootApplication
public class Mybatisplus04GeneratorApplication {
 
    public static void main(String[] args) {
        SpringApplication.run(Mybatisplus04GeneratorApplication.class, args);
    }
}

4、創建代碼生成類

public class CodeGenerator {
    public static void main(String[] args) {
        //1.獲取代碼生成器的對象
        AutoGenerator autoGenerator = new AutoGenerator();
 
        //設置數據庫相關配置
        DataSourceConfig dataSource = new DataSourceConfig();
        dataSource.setDriverName("com.mysql.cj.jdbc.Driver");
        dataSource.setUrl("jdbc:mysql://localhost:3306/mybatisplus_db?serverTimezone=UTC");
        dataSource.setUsername("root");
        dataSource.setPassword("root");
        autoGenerator.setDataSource(dataSource);
 
        //設置全局配置
        GlobalConfig globalConfig = new GlobalConfig();
        globalConfig.setOutputDir(System.getProperty("user.dir")+"/mybatisplus_04_generator/src/main/java");    //設置代碼生成位置
        globalConfig.setOpen(false);    //設置生成完畢後是否打開生成代碼所在的目錄
        globalConfig.setAuthor("黑馬程序員");    //設置作者
        globalConfig.setFileOverride(true);     //設置是否覆蓋原始生成的文件
        globalConfig.setMapperName("%sDao");    //設置數據層接口名，%s為占位符，指代模塊名稱
        globalConfig.setIdType(IdType.ASSIGN_ID);   //設置Id生成策略
        autoGenerator.setGlobalConfig(globalConfig);
 
        //設置包名相關配置
        PackageConfig packageInfo = new PackageConfig();
        packageInfo.setParent("com.aaa");   //設置生成的包名，與代碼所在位置不沖突，二者疊加組成完整路徑
        packageInfo.setEntity("domain");    //設置實體類包名
        packageInfo.setMapper("dao");   //設置數據層包名
        autoGenerator.setPackageInfo(packageInfo);
 
        //策略設置
        StrategyConfig strategyConfig = new StrategyConfig();
        strategyConfig.setInclude("tbl_user");  //設置當前參與生成的表名，參數為可變參數
        strategyConfig.setTablePrefix("tbl_");  //設置數據庫表的前綴名稱，模塊名 = 數據庫表名 - 前綴名  例如： User = tbl_user - tbl_
        strategyConfig.setRestControllerStyle(true);    //設置是否啟用Rest風格
        strategyConfig.setVersionFieldName("version");  //設置樂觀鎖字段名
        strategyConfig.setLogicDeleteFieldName("deleted");  //設置邏輯刪除字段名
        strategyConfig.setEntityLombokModel(true);  //設置是否啟用lombok
        autoGenerator.setStrategy(strategyConfig);
        //2.執行生成操作
        autoGenerator.execute();
    }
}

代碼生成器中的代碼內容，我們也可以直接從官方文檔中獲取代碼進行修改

到此這篇關於MyBatisPlus代碼生成器的原理及實現詳解的文章就介紹到這瞭,更多相關MyBatisPlus代碼生成器內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：