Springboot集成MBG

原文： https://cloud.tencent.com/developer/article/1606375

前言

在使用Mybatis進行項目開發的時候，最繁瑣的事情就是實體類，dao接口，mapper.xml文件的編寫，幾乎每個表都需要對應寫一套，並且大部分的工作量都在最基本的增刪改查上。如果表中的字段進行了修改，那麼實體類，mapper文件甚至dao接口都要進行修改。

天下苦mapper文件久矣，於是Mybatis官方推薦了一個Mybatis代碼生成器（MBG）來救民於水火之中。

Mybatis 代碼生成器

MBG

MBG 全稱 MyBatis Generator，可以用來生成Mybatis開發相關的代碼，包括基本增刪改查的實體類，dao接口和mapper文件。並且 MBG 工具支持所有版本的Mybatis。

官方文檔地址：http://mybatis.org/generator/

SpringBoot 集成 MBG

本文代碼會在一個SpringBoot+Mybatis的空項目中進行

1.導入依賴

SpringBoot中使用MBG需要在導入MBG依賴的同時導入MBG的啓動插件。 MBG的依賴

<dependency>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-core</artifactId>
    <version>1.4.0</version>
</dependency>

MBG的啓動插件

<!--MybatisGenerator的啓動插件-->
<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.4.0</version>
    <!--jar包去生成對應類 需要連接數據庫 數據連接的版本和項目中的一致-->
    <dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.21</version>
        </dependency>
    </dependencies>
    <configuration>
        <!--MBG配置文件的路徑 -->
        <configurationFile>${basedir}/src/main/resources/generatorConfig.xml</configurationFile>
        <overwrite>true</overwrite>
    </configuration>
</plugin>

注意：

1. 插件中的 mysql-connector-java 版本和項目中版本號一致
2. configurationFile 配置的是 MBG配置文件的地址 src/main/resources

2.導入並編寫MBG配置文件

導入依賴之後，需要在SpringBoot resources目錄下導入 MBG 的配置文件 generatorConfig.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
        "<http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd>">
<generatorConfiguration>
    <context id="mysql" targetRuntime="MyBatis3">
        <plugin type="org.mybatis.generator.plugins.EqualsHashCodePlugin"></plugin>
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"></plugin>
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin"></plugin>

        <commentGenerator>
            <!-- 這個元素用來去除指定生成的註釋中是否包含生成的日期 false:表示包含 -->
            <!-- 如果生成日期，會造成即使修改一個字段，整個實體類所有屬性都會發生變化，不利於版本控制，所以設置爲true -->
            <property name="suppressDate" value="true"/>
            <!-- 是否去除自動生成的註釋 true：是 ：false:否 -->
            <property name="suppressAllComments" value="true"/>

        </commentGenerator>

        <!--數據庫鏈接URL，用戶名、密碼 -->
        <jdbcConnection
                driverClass="com.mysql.cj.jdbc.Driver"
                connectionURL="jdbc:mysql://localhost:3306/points?useUnicode=true&amp;characterEncoding=utf-8&amp;serverTimezone=GMT%2B8&amp;useSSL=false"
                userId="root"
                password="root">
        </jdbcConnection>

        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- 生成實體類的包名和位置 -->
        <javaModelGenerator targetPackage="com.example.demomysql.pojo"
                            targetProject="src/main/java">
            <property name="enableSubPackages" value="true"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <!--生成映射文件的包名和位置  -->
        <sqlMapGenerator targetPackage="mapper"
                         targetProject="src/main/resources">
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>

        <!-- 生成DAO的包名和位置 mybatis兩種開發模式 xml 註解式-->
        <!-- 對於mybatis來說，即生成Mapper接口，注意，如果沒有配置該元素，那麼默認不會生成Mapper接口
             targetPackage/targetProject:同javaModelGenerator
             type：選擇怎麼生成mapper接口（在MyBatis3/MyBatis3Simple下）：
             1，ANNOTATEDMAPPER：會生成使用Mapper接口+Annotation的方式創建（SQL生成在annotation中），不會生成對應的XML；
             2，MIXEDMAPPER：使用混合配置，會生成Mapper接口，並適當添加合適的Annotation，但是XML會生成在XML中；
             3，XMLMAPPER：會生成Mapper接口，接口完全依賴XML；
             注意，如果context是MyBatis3Simple：只支持ANNOTATEDMAPPER和XMLMAPPER
        -->
        <javaClientGenerator type="MIXEDMAPPER"
                             targetPackage="com.example.demomysql.dao"
                             targetProject="src/main/java">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>

        <!-- 要生成哪些表 -->
        <table tableName="app_info" domainObjectName="AppInfo"
               enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false"
               selectByExampleQueryId="false">
        </table>

    </context>
</generatorConfiguration>

重點配置 ！！！

在配置文件中有一下配置需要使用者根據自己的情況進行配置

1. 數據庫連接參數 修改爲自己數據庫的連接參數
2. dao接口、實體類、mapper文件生成位置、包結構的配置

注意：生成位置和包結構參數根據自己實際情況進行修改，其他的內容不需要修改

3. 配置 要生成哪些表 對應的實體類、dao接口 和 mapper文件

注意：除了以上三個配置，其他配置都可以不必修改