【SSM -MyBatis篇03】MyBatis Generator(MBG)配置屬性詳解(基于MyBatis3) - 逆向生成 - 配置MBG模板

MyBatis Generator簡介.

?? MyBatis Generator（MBG）是MyBatis和iBATIS的代碼生成器(逆向生成)，它將自動將查詢資料庫表，并將生成可用于訪問表的構件，這減少了設定物件和組態檔以與資料庫表互動的初始麻煩，MBG雖然減少了對于資料庫表簡單的CRUD(創建、檢索、更新、洗掉)大量代碼，但是對于復雜的連接查詢和存盤程序還是需要手動撰寫映射sql和bean，
??使用MyBatis Generator插件自動生成MyBatis所需要的DAO介面、物體模型類(bean)、Mapping映射檔案，將生成的代碼復制到專案工程中即可，把更多精力放在業務邏輯上，

地址：http://mybatis.org/generator/index.html

??MyBatis Generator有三種常用方法自動生成代碼：命令列、Eclipse插件和Maven插件

MyBatis Generator的配置使用(基于MyBatis3)

1. 需要匯入依賴和插件

	</dependency>
	<!--  mybatis-generator的依賴 自動生成javabean和sql -->
	    <dependency>
	      <groupId>org.mybatis.generator</groupId>
	      <artifactId>mybatis-generator-maven-plugin</artifactId>
	      <version>1.3.4</version>
	    </dependency>
	<!--mysql驅動類-->
	    <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
	    <dependency>
	      <groupId>mysql</groupId>
	      <artifactId>mysql-connector-java</artifactId>
	      <version>5.1.38</version>
	    </dependency>
	</dependency>

	<plugins>
		 <!--mybatis-generator插件 用于自動生成javabean和sql
            version版本要與mysql的version一樣
     	 -->
        <plugin>
          <groupId>org.mybatis.generator</groupId>
          <artifactId>mybatis-generator-maven-plugin</artifactId>
          <version>1.3.4</version>
          <dependencies>
            <dependency>
              <groupId>mysql</groupId>
              <artifactId>mysql-connector-java</artifactId>
              <version>5.1.38</version>
            </dependency>
          </dependencies>
          <configuration>
            <overwrite>true</overwrite>
            <configurationFile>./mybatis-generator.xml</configurationFile>
          </configuration>
        </plugin>

	</plugins>

2. 在專案下創建mybatis-generator.xml組態檔，屬性詳解(基于MyBatis3)【*****】

模板：http://mybatis.org/generator/configreference/xmlconfig.html

<?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根節點，沒有任何屬性 -->
<generatorConfiguration>

    <!--<classPathEntry>不必須 0個或多個，  類物體路徑 生成指定路徑的  通過這個屬性指定驅動的路徑-->
    <!-- <classPathEntry location="/Program Files/IBM/SQLLIB/java/db2java.zip" />-->


    <!-- <context>元素用于指定生成一組物件的環境 ： 該元素有一個必選屬性id，用來唯一標識一個<context>元素
            targetRuntime屬性主要使用兩個值： MyBatis3(默認值)和MyBatis3Simple，如果不想生成Example查詢相關的內容，就用MyBatis3Simple
            defaultModelType屬性有三個值：conditional、flat、hierarchical
                conditional：默認值，如果表只包含一個欄位，就不會生成一個單獨的類，會將該欄位合并到基本物體類中，
                flat：為每一張表只生成一個物體類(物體類包含表中的所有欄位)
                hierarchical：如果表有主鍵,那么該模型會產生一個單獨的主鍵物體類,
                              如果表還有BLOB欄位， 則會為表生成一個包含所有BLOB欄位的單獨的物體類，
                              然后為所有其他的欄位生成一個單獨的物體類， MBG會在所有生成的物體類之間維護一個繼承關系，
            -->
    <context id="mybatis" targetRuntime="MyBatis3" defaultModelType="flat">

        <!--<jdbcConnection>必須配置，且只能有一個，用于指定資料庫連接資訊 【***】
            這里可以通過 <properties>元素加載屬性檔案，來讀取jdbc連接的屬性值
        -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/mybatis?useUnicode=true&amp;characterEncoding=utf-8&amp;useSSL=false"
                        userId="root"
                        password="861221293">
        </jdbcConnection>

        <!--<javaTypeResolver >：java型別決議器，最多只能配置一個，-->
        <javaTypeResolver >
            <!--<property>屬性：配置forceBigDecimals(默認值false，一般不需要配置)
              如果將配置forceBigDecimals配置為true：資料庫資料型別number、float、double將會強制轉換為BigDecimals-->
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>

        <!-- <javaModelGenerator>：必須配置，且只能配置一個，【***】
             用來控制生成的物體類(生成bean)
             兩個屬性：targetPackage和targetProject
                targetPackage：生成的物體類存放位置(包名稱)
                targetProject：指定目標專案的路徑(絕對路徑/相對路徑)(點.代表當前檔案所在路徑)

            targetPackage="com.xgf.springmvc.auth.bean" targetProject=".\src\main\java"
            這樣配置將自動生成位置為： 當前檔案路徑.src.main.java.com.xgf.mybatis_generator.bean
          -->
        <javaModelGenerator targetPackage="com.xgf.mybatis_generator.bean" targetProject=".\src\main\java">
            <!--<property>子屬性常用屬性值：enableSubPackages、trimStrings
                    enableSubPackages：該屬性只對MyBatis3有效(對MyBatis3Simple無效)，默認值是false，
                        如果值為true就會通過構造方法加入引數，如果false就會呼叫setter方法加入引數
                    trimStrings：是否對資料庫查詢結果進行trim操作(trim:最常見的用途是移除開頭或結尾的空白字符)，默認是false，
                        如果為true就會掉用三目運算式：呼叫set方式傳參的時候，設定值：this.username = (username == null ? null : username.trim())
            -->
            <property name="enableSubPackages" value="true" />
            <property name="trimStrings" value="true" />
        </javaModelGenerator>


        <!--<sqlMapGenerator> 可選屬性，最多只能配置一個(0個或者1個)， 用于生成xml映射檔案 (生成XxxMpper.xml檔案)
                有兩個屬性必選：targetPackage、targetProject
                    (和前面的<javaModelGenerator>屬性一樣，只是這個是生成mapper映射檔案，且存盤在resources資源目錄下)

                targetPackage="com.xgf.mybatis_generator.bean"  targetProject=".\src\main\resources" (點.代表當前檔案所在路徑)
                    生成的mapper映射檔案路徑為：當前檔案路徑.src.main.resources.com.xgf.mybatis_generator.dao
        -->
        <sqlMapGenerator targetPackage="com.xgf.mybatis_generator.dao"  targetProject=".\src\main\resources">
            <!--sqlMapGenerator的property子屬性只有一個可以配置的屬性值enableSubPackages
                    enableSubPackages：默認是false
                        如果是true，MBG會根據catalog和schema來生成子包
                        如果false就會直接用targetPackage屬性
            -->
            <property name="enableSubPackages" value="true" />
        </sqlMapGenerator>

        <!--<javaClientGenerator>：可選屬性，但是最多只能配置一個(0個或1個)，(生成dao介面)
             用于生成dao層(資料庫操作層)，不配置該元素，就不會生成類的資料庫操作mapper介面
             該元素有三個必選屬性：type、targetPackage、targetProject
                type：用于選擇一個預定義的客戶端代碼（可以理解為Mapper介面）生成器，
                    如果使用的是MyBatis3配置，有以下三個值：
                    ANNOTATEDMAPPER：基于注解的Mapper介面，不會有對應的XML映射檔案
                    MIXEDMAPPER：XML和注解的混合形式，相比ANNOTATEDMAPPER方式，SqlProvider注解方法會被XML替代，
                    XMLMAPPER:所有的方法都寫在XML中，介面呼叫需要依賴XML檔案，
        -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.xgf.mybatis_generator.dao"  targetProject=".\src\main\java">
            <property name="enableSubPackages" value="true" />
        </javaClientGenerator>


        <!-- <table>元素：至少配置一個，可以配置多個(1個或多個)，
             用來配置需要生成的資料庫表，只有配置table才能生成對應表的物體類、映射檔案和介面
             必選屬性：tableName：這個是對應資料庫的表名稱(可以使用SQL通配符匹配多個表  可以通過tableName="%"生成全部的表)
             可選屬性：schema：設定該值，生成SQL的表名會變成如schema.tableName的形式(一般寫你的【資料庫名稱】)
                      domainObjectName：生成的物件名稱，就是生成的javabean的類名(沒有指定，就會和資料庫表名相同)

            useActualColumnNames 使用真實的列名 列名作為屬性名
            generatedKey 主鍵  sqlStatement資料庫 identity自增長
            columnOverride 列覆寫
            ignoreColumn 忽略列
        -->
        <table schema="mybatis" tableName="user" domainObjectName="User" >

            <!--<property>：
                    可選屬性：useActualColumnNames，默認值是false，
                        設定為true，會用資料庫表的列名，來作為javabean物件的屬性名稱
                        設定為false(默認值)，MGB將會嘗試將回傳的名稱轉換為駝峰形式
            -->
            <property name="useActualColumnNames" value="true"/>

            <!--<generatedKey>：最多配置一個，用于指定自動生成的主鍵屬性，【主鍵】
                    必選屬性：column：生成的列名稱
                            sqlStatement：用于回傳新值的SQL陳述句，如果該列是identity列，可以使用其中一個預定義的的特殊值
                                就是寫你使用的資料庫名稱(MySql/DB2/SqlServer/HSQLDB等資料庫名(預定義的特殊值))
                    可選屬性：identity：當設定為true時,該列會被標記為identity列

            -->
            <generatedKey column="ID" sqlStatement="MySql" identity="true" />


            <!--<columnOverride>元素：可選，可以配置多個(0個或多個)
                    將某些屬性默認計算的值更改為指定的值
                    有多個值的時候【比如checkbox、select有多選的時候】，將VARCHAR通過handler轉換陣列型別
                    必選屬性：column：要重寫的列名
                    可選屬性：javaType：值為完全限定名的Java型別(需要將資料表列資料(column)轉換為的型別)
                            typeHandler：自己定義的需要用來處理這列(column)資料的型別處理器(自定義)
            -->

            <!-- 通過自定義typeHandler將資料庫表中的hoobys和friends通過分隔符轉換為字串陣列 -->
            <columnOverride column="hobbys" property="hobbys"
                            javaType="java.lang.String[]" jdbcType="VARCHAR"
                            typeHandler="com.xgf.mybatis_generator.typeHandler.StringArrayVarcharHandler"/>
            <columnOverride column="friends" property="friends"
                            javaType="java.lang.String[]" jdbcType="VARCHAR"
                            typeHandler="com.xgf.mybatis_generator.typeHandler.StringArrayVarcharHandler"/>
            <!--<columnOverride column="DATE_FIELD" property="startDate" />-->

            <!--<ignoreColumn>元素：可選，可以配置多個(0個或多個)，用來屏蔽不需要生成的列(設定該值得列將不生成到javabean的屬性中)
                    必選屬性：column：配置要忽略的資料庫表列名
                    可選屬性：delimitedColumnName：默認值false，匹配列名是否區分大小寫，如果為true就區分，如果為false，就不區分，
            -->
            <!--<ignoreColumn column="FRED" />-->

        </table>

    </context>
</generatorConfiguration>

3. 自動生成bean、dao、和mapper映射檔案

在當前mybatis-generator.xml同路徑下打開Terminal終端
輸入命令mvn mybatis-generator:generate