2. 程式人生 > >MyBatis Generator （自動生成工具） 詳解

MyBatis Generator （自動生成工具） 詳解

阿新 • • 發佈：2019-01-04

MyBatis Generator中文文件地址：

該中文文件由於儘可能和原文內容一致，所以有些地方如果不熟悉，看中文版的文件的也會有一定的障礙，所以本章根據該中文文件以及實際應用，使用通俗的語言來講解詳細的配置。

本文中所有節點的連結都是對應的中文文件地址，可以點選檢視詳細資訊。

注:本文後面提到的MBG全部指代MyBatis Generator。

在MBG中，最主要也最重要的就是XML配置檔案，因此本篇文章主要的內容就是XML配置。

這裡按照配置的順序對配置逐個講解，更細的內容可以配合中文文件參照。

1. 配置檔案頭

<?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">

使用最新版的MBG需要使用上面的xml頭，配置檔案必須包含上面的DOCTYPE。

generatorConfiguration節點沒有任何屬性，直接寫節點即可，如下：

<generatorConfiguration>
    <!-- 具體配置內容 -->
</generatorConfiguration>

3. <generatorConfiguration>子元素

從這段開始，就是配置的主要內容，這些配置都是generatorConfiguration元素的子元素。

包含以下子元素（有嚴格的順序）：

這個元素用來指定外部的屬性元素，不是必須的元素。

元素用於指定一個需要在配置中解析使用的外部屬性檔案，引入屬性檔案後，可以在配置中使用 ${property}這種形式的引用，通過這種方式引用屬性檔案中的屬性值。 對於後面需要配置的**jdbc資訊**和targetProject屬性會很有用。

這個屬性可以通過resource或者url

來指定屬性檔案的位置，這兩個屬性只能使用其中一個來指定，同時出現會報錯。

  • resource：指定**classpath**下的屬性檔案，使用類似com/myproject/generatorConfig.properties這樣的屬性值。

  • url：可以指定檔案系統上的特定位置，例如file:///C:/myfolder/generatorConfig.properties

這個元素可以0或多個，不受限制。

最常見的用法是通過這個屬性指定驅動的路徑，例如：

<classPathEntry location="E:\mysql\mysql-connector-java-5.1.29.jar"/>

重點提醒：本文之前在這裡有誤導，特別強調。

注意，classPathEntry只在下面這兩種情況下才有效：

  • 當載入 JDBC 驅動內省資料庫時
  • 當載入根類中的 JavaModelGenerator 檢查重寫的方法時
因此，如果你需要載入其他用途的jar包，classPathEntry起不到作用，不能這麼寫，解決的辦法就是將你用的jar包新增到類路徑中，在Eclipse等IDE中執行的時候，新增jar包比較容易。當從命令列執行的時候，需要用java -cp xx.jar,xx2.jar xxxMainClass這種方式在-cp後面指定來使用(注意-jar會導致-cp無效)。

在MBG的配置中，至少需要有一個<context>元素。

<context>元素用於指定生成一組物件的環境。例如指定要連線的資料庫，要生成物件的型別和要處理的資料庫中的表。執行MBG的時候還可以指定要執行的<context>。

該元素只有一個**必選屬性**id，用來唯一確定一個<context>元素，該id屬性可以在執行MBG的使用。

此外還有幾個**可選屬性**：

  • defaultModelType:**這個屬性很重要**，這個屬性定義了MBG如何生成**實體類**。
    這個屬性有以下可選值：

    • conditional:*這是預設值*,這個模型和下面的hierarchical類似，除了如果那個單獨的類將只包含一個欄位，將不會生成一個單獨的類。 因此,如果一個表的主鍵只有一個欄位,那麼不會為該欄位生成單獨的實體類,會將該欄位合併到基本實體類中。
    • flat:該模型為每一張表只生成一個實體類。這個實體類包含表中的所有欄位。**這種模型最簡單，推薦使用。**
    • hierarchical:如果表有主鍵,那麼該模型會產生一個單獨的主鍵實體類,如果表還有BLOB欄位， 則會為表生成一個包含所有BLOB欄位的單獨的實體類,然後為所有其他的欄位生成一個單獨的實體類。 MBG會在所有生成的實體類之間維護一個繼承關係。

  • targetRuntime:此屬性用於指定生成的程式碼的執行時環境。該屬性支援以下可選值：

    • MyBatis3:*這是預設值*
    • MyBatis3Simple
    • Ibatis2Java2
    • Ibatis2Java5 一般情況下使用預設值即可，有關這些值的具體作用以及區別請檢視中文文件的詳細內容。

  • introspectedColumnImpl:該引數可以指定擴充套件org.mybatis.generator.api.IntrospectedColumn該類的實現類。該屬性的作用可以檢視擴充套件MyBatis Generator。

一般情況下，我們使用如下的配置即可：

<context id="Mysql" defaultModelType="flat">

如果你希望不生成和Example查詢有關的內容，那麼可以按照如下進行配置:

<context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">

使用MyBatis3Simple可以避免在後面的<table>中逐個進行配置（後面會提到）。

MBG配置中的其他幾個元素，基本上都是<context>的子元素，這些子元素（有嚴格的配置順序）包括：

其中<property>屬性比較特殊，後面講解的時候都會和父元素一起進行講解。在講解<property>屬性前，我們先看看**什麼是分隔符？**。

這裡通過一個例子說明。假設在MySQL資料庫中有一個表名為user info，你沒有看錯，中間是一個空格，這種情況下如果寫出select * from user info這樣的語句，肯定是要報錯的，在Mysql中的時候我們一般會寫成如下的樣子:

select * from `user info`

這裡的使用的**反單引號(`)**就是**分隔符**，**分隔符**可以用於**表名**或者**列名**。

下面繼續看<property>支援的屬性：

  • autoDelimitKeywords
  • beginningDelimiter
  • endingDelimiter
  • javaFileEncoding
  • javaFormatter
  • xmlFormatter

由於這些屬性比較重要，這裡一一講解。

首先是autoDelimitKeywords，當表名或者欄位名為SQL關鍵字的時候，可以設定該屬性為true，MBG會自動給表名或欄位名新增**分隔符**。

然後這裡繼續上面的例子來講beginningDelimiter和endingDelimiter屬性。
由於beginningDelimiter和endingDelimiter的預設值為雙引號(")，在Mysql中不能這麼寫，所以還要將這兩個預設值改為**反單引號(`)**，配置如下：

<property name="beginningDelimiter" value="`"/>
<property name="endingDelimiter" value="`"/>

屬性javaFileEncoding設定要使用的Java檔案的編碼，預設使用當前平臺的編碼，只有當生產的編碼需要特殊指定時才需要使用，一般用不到。

最後兩個javaFormatter和xmlFormatter屬性**可能會**很有用，如果你想使用模板來定製生成的java檔案和xml檔案的樣式，你可以通過指定這兩個屬性的值來實現。

接下來分節對其他的子元素逐個進行介紹。

該元素可以配置0個或者多個，不受限制。

<plugin>元素用來定義一個外掛。外掛用於擴充套件或修改通過MyBatis Generator (MBG)程式碼生成器生成的程式碼。

外掛將按在配置中配置的順序執行。

有關外掛的詳細資訊可以參考開發外掛和提供的外掛瞭解更多。

該元素最多可以配置1個。

這個元素非常有用，相信很多人都有過這樣的需求，就是希望MBG生成的程式碼中可以包含**註釋資訊**，具體就是生成表或欄位的備註資訊。

使用這個元素就能很簡單的實現我們想要的功能。這裡先介紹該元素，介紹完後會舉例如何擴充套件實現該功能。

該元素有一個可選屬性type,可以指定使用者的實現類，該類需要實現org.mybatis.generator.api.CommentGenerator介面。而且必有一個預設的構造方法。這個屬性接收預設的特殊值DEFAULT，會使用預設的實現類org.mybatis.generator.internal.DefaultCommentGenerator。

預設的實現類中提供了兩個可選屬性，需要通過<property>屬性進行配置。

  • suppressAllComments:**阻止**生成註釋，預設為false
  • suppressDate:**阻止**生成的註釋包含時間戳，預設為false

一般情況下由於MBG生成的註釋資訊沒有任何價值，而且有時間戳的情況下每次生成的註釋都不一樣，使用**版本控制**的時候每次都會提交，因而一般情況下我們都會遮蔽註釋資訊，可以如下配置：

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

接下來我們簡單舉例實現生成包含表字段註釋資訊的註釋

因為系統提供了一個預設的實現類，所以對我們來說，自己實現一個會很容易，最簡單的方法就是複製預設實現類程式碼到一個新的檔案中，修改類名如MyCommentGenerator，在你自己的實現類中，你可以選擇是否繼續支援上面的兩個屬性，你還可以增加對其他屬性的支援。

我們通過下面一個方法的修改來了解，其他幾個方法請自行修改(寫本章的時候我也沒有完全實現該類，所以不提供完整原始碼了):

@Override
public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn) {
    if (introspectedColumn.getRemarks() != null && !introspectedColumn.getRemarks().equals("")) {
        field.addJavaDocLine("/**");
        field.addJavaDocLine(" * " + introspectedColumn.getRemarks());
        addJavadocTag(field, false);
        field.addJavaDocLine(" */");
    }
}

這個方法是給欄位添加註釋資訊的，其中IntrospectedColumn包含了欄位的完整資訊，通過getRemarks方法可以獲取欄位的註釋資訊。上面這個方法修改起來還是很容易的。除了欄位的註釋外還有Getter和Setter，以及類的註釋。此外還有生成XML的註釋，大家可以根據預設的實現進行修改。

完成我們自己的實現類後，我們還需要做如下配置：

<commentGenerator type="com.github.abel533.mybatis.generator.MyCommentGenerator"/>

<jdbcConnection>用於指定資料庫連線資訊，該元素必選，並且只能有一個。

配置該元素只需要注意如果JDBC驅動不在**classpath**下，就需要通過<classPathEntry>元素引入jar包，這裡**推薦**將jar包放到**classpath**下。

該元素有兩個必選屬性:

  • driverClass:訪問資料庫的JDBC驅動程式的完全限定類名
  • connectionURL:訪問資料庫的JDBC連線URL

該元素還有兩個可選屬性:

  • userId:訪問資料庫的使用者ID
  • password:訪問資料庫的密碼

此外該元素還可以接受多個<property>子元素，這裡配置的<property>屬性都會新增到JDBC驅動的屬性中。

這個元素配置起來最容易，這裡舉個簡單例子：

<jdbcConnection driverClass="com.mysql.jdbc.Driver"
                connectionURL="jdbc:mysql://localhost:3306/test"
                userId="root"
                password="">
</jdbcConnection>

該元素最多可以配置一個。

這個元素的配置用來指定JDBC型別和Java型別如何轉換。

該元素提供了一個可選的屬性type，和<commentGenerator>比較型別，提供了預設的實現DEFAULT，一般情況下使用預設即可，需要特殊處理的情況可以通過其他元素配置來解決，不建議修改該屬性。

該屬性還有一個可以配置的<property>元素。

可以配置的屬性為forceBigDecimals，該屬性可以控制是否強制DECIMAL和NUMERIC型別的欄位轉換為Java型別的java.math.BigDecimal,預設值為false，一般不需要配置。

預設情況下的轉換規則為：

  1. 如果精度>0或者長度>18，就會使用java.math.BigDecimal
  2. 如果精度=0並且