MyBatisPlus-代碼生成器原理及實作

目錄

​​一、代碼生成器原理分析​​

​​二、代碼生成器實作​​

一、代碼生成器原理分析

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

 一個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();
    }
}      

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

​​代碼生成器（新） | MyBatis-Plus (baomidou.com)

https://baomidou.com/pages/779a6e/​​