SpringBoot使用MyBatis-Generator詳解

• • MyBatis-Generator簡介
  • MyBatis-Generator使用
  • • 添加maven依賴
    • 建立MBG配置檔案
    • 運作MBG，生成底層類
  • 資料庫查詢

前幾天工作中接觸到MyBatis-Generator，發現其友善之處，MyBatis-Generator可以幫助我們實作資料庫繁複的增删改查操作，當資料庫中表結構發生變化時，隻需要重新生成一次即可，而不用每一條語句上去添加新增或者删除字段，這樣可以大大的提高我們的開發效率，并且，不需要寫大量的重複性的工作，可以讓我們把精力更多的專注于業務邏輯。

​ MyBatis-Generator官網

​ MyBatis Generator（MBG，縮寫名）是MyBatis的代碼生成器。 它将為所有版本的MyBatis以及版本2.2.0之後的iBATIS版本生成資料庫的底層實作代碼。 它可以根據資料庫中的表檔案，生成可用于通路資料表的Pojo類，dao類和*Mapper.xml的所有檔案。MBG為大部分資料庫操作即相對簡單CRUD（增删改查）提供支援，不過相對複雜的操作比如多表查詢還需自己動手完成sql。

​ MBG生成的SQL配置文包含一下操作的語句：

​ -[ ] insert

​ -[ ] update by primary key

​ -[ ] update by example (using a dynamic where clause)

​ -[ ] delete by primary key

​ -[ ] delete by example (using a dynamic where clause)

​ -[ ] select by primary key

​ -[ ] select by example (using a dynamic where clause)

​ -[ ] count by example

​ MBG預設生成所有的語句，我麼同樣可以在配置檔案中通過配置去除自己不需要的語句。

<!--資料庫連接配接依賴-->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.12</version>
</dependency>
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid-spring-boot-starter</artifactId>
    <version>1.1.10</version>
</dependency>
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>1.1.1</version>
</dependency>
<!--MBG插件-->
<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.3.6</version>
</plugin>
           

本文使用的SpringBoot版本是2.0.3.RELEASE。

​ MBG最重要的就是配置檔案，可以參考以為大神的部落格，我也從中受益很多，因為MBG配置檔案可選參數實在是很多，本文隻介紹些重要的參數的屬性，足夠正常開發使用，如有需要，還是需要看MBG的官方文檔的。

​ 在resources檔案目錄下建立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>
    <classPathEntry
            location="D:\Office SoftWare\maven\repository\mysql\mysql-connector-java\8.0.12\mysql-connector-java-8.0.12.jar"/>

    <context id="MysqlTables" targetRuntime="MyBatis3" defaultModelType="flat">

        <property name="javaFileEncoding" value="UTF-8"/>

        <commentGenerator>
            <property name="suppressDate" value="false"/>
            <property name="addRemarkComments" value="true"/>
            <property name="suppressAllComments" value="false"/>
        </commentGenerator>

        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/testMBG?useUnicode=true&amp;characterEncoding=utf8&amp;useSSL=false"
                        userId="root"
                        password="123456">
            <property name="nullCatalogMeansCurrent" value="true"/>
        </jdbcConnection>

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

        <javaModelGenerator targetPackage="com.doo.mybatis.domain.entity"
                            targetProject="src\main\java">
            <property name="enableSubPackages" value="true"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <sqlMapGenerator targetPackage="mappers" targetProject="src\main\resources">
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>

        <javaClientGenerator type="XMLMAPPER" targetPackage="com.doo.mybatis.dao"
                             targetProject="src\main\java">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>


        <table schema="ins_personal_claim" tableName="claim_apply_record" enableCountByExample="true" domainObjectName="ClaimApplyRecord">
            <columnOverride column="apply_for" javaType="com.jd.ins.personal.claim.domain.enums.ApplyForType" typeHandler="org.apache.ibatis.type.EnumTypeHandler"/>
            <ignoreColumn column="create_time"/>
            <ignoreColumn column="update_time"/>
        </table>

        <table schema="ins_personal_claim" tableName="claim_image_info" enableCountByExample="false" domainObjectName="ClaimImageInfo">
            <columnOverride column="image_type" javaType="com.jd.ins.personal.claim.domain.enums.ImageType" typeHandler="org.apache.ibatis.type.EnumTypeHandler"/>
            <ignoreColumn column="create_time"/>
            <ignoreColumn column="update_time"/>
        </table>

    </context>
</generatorConfiguration>
           

​ 配置檔案中的

<classPathEntry>

是配置驅動的一個簡單的方式，可以通過location制定路徑。

​

<context>

元素用于指定生成一組對象的環境。例如指定要連接配接的資料庫，要生成對象的類型和要處理的資料庫中的表。其中的defaultModelType屬性很重要，這個屬性定義了MBG如何生成實體類，推薦使用flat模式，為每一張表隻生成一個包含表所有字段的實體類。

<javaModelGenerator>

指定生成實體類的生成路徑，trimStrings屬性會對查詢條件進行trim操作，預設值是false。

<sqlMapGenerator>

指定生成xml檔案的路徑。

<javaClientGenerator>

指定生成dao接口。

<table>

可以配置多個，用于指定生成資料庫中的那個表的底層類，可以指定生成的實體類的name，enableCountXXX屬性可以去除不需要的sql方法，其中columnOverride可以指定表中使用的枚舉類，ignoreColumn可以忽略表中的字段，columnOverride和ignoreColumn可以指定0個或多個。

​ 執行MBG的方式有很多，本文使用Maven的方式執行，也是較為簡單的方式。

​

點選執行就可以自動生成代碼，會生成實體類，查詢使用的example檔案，dao，xml檔案，如下圖所示：

@Test
public void queryByPrimaryKey() {
    ClaimImageInfo imageInfo = imageInfoMapper.selectByPrimaryKey(112L);
    log.info("查詢結果為：{}", imageInfo);
}

@Test
public void queryByExample(){
    ClaimImageInfoExample example = new ClaimImageInfoExample();
    example.createCriteria().andIdGreaterThan(112L);
    example.setOrderByClause(" id limit " + 10);
    List<ClaimImageInfo> imageInfoList = imageInfoMapper.selectByExample(example);
    log.info("查詢結果為：{}", imageInfoList);
}