通過Maven運行 MyBatis Generator · Java 開源項目中文文檔

# 通過Maven運行 MyBatis Generator MyBatis Generator (MBG) 包含了一個可以集成到Maven構建的Maven插件，按照Maven的配置慣例, 將MBG集成到Maven很容易. 最簡配置如下: ``` <project ...> ... <build> ... <plugins> ... <plugin> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-maven-plugin</artifactId> <version>1.3.0</version> </plugin> ... </plugins> ... </build> ... </project> ``` 當然，事情永遠不會那么容易！ ## Maven Goal and Execution（Maven 目標和執行） The MBG Maven plugin 包含一個目標: * `mybatis-generator:generate` 這個目標不會被Maven自動執行，他可以通過以下兩種方式執行。可以在命令行通過以下命令執行: * `mvn mybatis-generator:generate` 您可以通過標準的Maven命令屬性傳遞參數，例如: * `mvn -Dmybatis.generator.overwrite=true mybatis-generator:generate` 這條命令會使MBG覆蓋重名的文件在一個連續的編譯環境中，您可能想讓MGB作為Maven構建的一部分自動執行。這可以通過配置自動執行的目標來實現，這種情況的例子如下: ``` <project ...> ... <build> ... <plugins> ... <plugin> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-maven-plugin</artifactId> <version>1.3.0</version> <executions> <execution> <id>Generate MyBatis Artifacts</id> <goals> <goal>generate</goal> </goals> </execution> </executions> </plugin> ... </plugins> ... </build> ... </project> ``` MBG插件將會綁定到Maven構建的 `generate-sources` 階段。所以他會在編譯步驟之前執行。此外注意MBG目標將綁定生成Java和XML資源文件的建立，他們都將包括在生成的JAR包內。 ## MyBatis Generator 配置屬性所有配置在POM中的屬性都可以傳遞到配置文件，并且可以用通常的方式使用。例如: ``` <project ...> ... <properties> <dao.target.dir>src/main/java</dao.target.dir> </properties> ... <build> ... <plugins> ... <plugin> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-maven-plugin</artifactId> <version>1.3.0</version> <executions> <execution> <id>Generate MyBatis Artifacts</id> <goals> <goal>generate</goal> </goals> </execution> </executions> </plugin> ... </plugins> ... </build> ... </project> ``` 在這種情況下，屬性可以在配置文件中被訪問的語法是 `${dao.target.dir}`. ## 參考參數所有的參數都是可選的，大部分都適合的默認值。 | 參數 | 表達式 | 類型 | 注釋 | | --- | --- | --- | --- | | configurationFile | ${mybatis.generator.configurationFile} | java.io.File | 指定配置文件的名稱。默認值:${basedir}/src/main/resources/generatorConfig.xml | | contexts | ${mybatis.generator.contexts} | java.lang.String | 如果指定了該參數，逗號隔開的這些context會被執行。這些指定的context必須和配置文件中 <context> 元素的 `id` 屬性一致。只有指定的這些contextid會被激活執行。如果沒有指定該參數，所有的context都會被激活執行。 | | jdbcDriver | ${mybatis.generator.jdbcDriver} | java.lang.String | 如果您指定了 `sqlScript` 參數, 當連接數據庫時這里的值是JDBC驅動類的權限定名稱。 | | jdbcPassword | ${mybatis.generator.jdbcPassword} | java.lang.String | 如果您指定了 `sqlScript` 參數, 這是連接數據庫的密碼。 | | jdbcURL | ${mybatis.generator.jdbcURL} | java.lang.String | 如果您指定了 `sqlScript` 參數, 這是連接數據庫的JDBC URL | | jdbcUserId | ${mybatis.generator.jdbcUserId} | java.lang.String | 如果您指定了 `sqlScript` 參數, 這里是連接數據庫的用戶id | | outputDirectory | ${mybatis.generator.outputDirectory} | java.io.File | 將放置 MBG 所生成文件的目錄。這個目錄是用于當 `targetProject` 在配置文件中設置特殊值的"MAVEN"時使用(大小寫敏感)。默認值:${project.build.directory}/generated-sources/mybatis-generator | | overwrite | ${mybatis.generator.overwrite} | boolean | 如果指定了該參數，如果生成的java文件存在已經同名的文件，新生成的文件會覆蓋原有的文件。如果沒有指定該參數，如果存在同名的文件，MBG會給新生成的代碼文件生成一個唯一的名字(例如： MyClass.java.1, MyClass.java.2 等等)。 **重要: 生成器一定會自動合并或覆蓋已經生成的XML文件。**默認值:false | | sqlScript | ${mybatis.generator.sqlScript} | java.lang.String | 要在生成代碼之前運行的 SQL 腳本文件的位置。如果空，不會執行任何腳本。如果不是空，`jdbcDriver`, `jdbcURL` 參數必須提供。另外如果連接數據庫需要認證也需要提供 `jdbcUserId` 和 `jdbcPassword` 參數。值可以使一個文件系統的絕對路徑或者是一個使用"classpath:"開頭放在構建的類路徑下的路徑。 | | tableNames | ${mybatis.generator.tableNames} | java.lang.String | 如果指定了該參數，逗號隔開的這個表會被運行，這些表名必須和 <table> 配置中的表面完全一致。只有指定的這些表會被執行。如果沒有指定該參數，所有的表都會被執行。按如下方式指定表明: `table` `schema.table` `catalog..table` 等等。 | | verbose | ${mybatis.generator.verbose} | boolean | 如果指定該參數，執行過程會輸出到控制臺。 | ## targetProject 解釋與Maven運行時生成器配置的 `targetProject` 屬性有不同的解釋。如果指定值為"MAVEN" (大小寫敏感), `targetProject` 將被設置為插件的輸出目錄，而且如果不存在這個目錄，將會創建這個目錄。如果沒有設置為 "MAVEN", 那么`targetProject` 將會被 MGB 當成普通的 - 它必須是一個已經存在的目錄。