在 Gradle 中使用 MyBatis Generator

在 Intellij IDEA 中結合 Gradle 使用 MyBatis Generator 逆向生成代碼

Info:
JDK 1.8
Gradle 2.14
Intellij IDEA 2016.3

前言

由於 IDEA 的教程較少，且 MyBatis Generator 不支持 Gradle 直接運行，因此這次是在自己折騰項目過程中，根據一些參考資料加上自己的實踐得出的結論，並附上相應的 Demo 可供自己未來參考，也與大家分享。

本文的 Demo 也可以當作工具直接導入 IDEA，加上自己的數據庫信息即可生成代碼。

創建項目

詳細的創建步驟可以參考使用 Gradle 構建 Struts 2 Web 應用中「新建 Gradle Web 項目」一節即可。當創建完畢，需要等待 Gradle 聯網構建，由於國內網絡因素，可能需要稍作等待。當構建完成，目錄結構應如下圖一致：

Gradle 構建完成

配置依賴

這里需要使用 MyBatis Generator，MySQL 驅動，以及 MyBatis Mapper。由於代碼生成單獨運行即可，不需要參與到整個項目的編譯，因此在 build.gradle 中添加配置：

configurations {
    mybatisGenerator
}

在 Maven Repository (http://mvnrepository.com/) 分別搜索依賴：

org.mybatis.generator

mysql-connector-java

tk.mybatis:mapper

依賴的版本並不是局限於某個特定版本，可以選擇適時相應的更新版本。添加到 build.gradle 的 dependencies 中（注意前面需將「compile group:」改為「mybatisGenerator」）：

dependencies {
    testCompile group: 'junit', name: 'junit', version: '4.11' mybatisGenerator 'org.mybatis.generator:mybatis-generator-core:1.3.5' mybatisGenerator 'mysql:mysql-connector-java:5.1.40' mybatisGenerator 'tk.mybatis:mapper:3.3.9' }

設置數據庫信息

在 resources 下，新建 mybatis 文件夾，並新建 config.properties 和 generatorConfig.xml，文件結構如下：

配置文件目錄

在 config.properties 中配置數據庫和要生成的 Java 類的包：

# JDBC 驅動類名 jdbc.driverClassName=com.mysql.jdbc.Driver # JDBC URL: jdbc:mysql:// + 數據庫主機地址 + 端口號 + 數據庫名 jdbc.url=jdbc:mysql:// # JDBC 用戶名及密碼 jdbc.username= jdbc.password= # 生成實體類所在的包 package.model=com.maimieng.model # 生成 mapper 類所在的包 package.mapper=com.maimieng.mapper # 生成 mapper xml 文件所在的包，默認存儲在 resources 目錄下 package.xml=mybatis

設置生成代碼的配置文件

在 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="MyBatis3Simple" defaultModelType="flat"> <commentGenerator> <property name="suppressAllComments" value="true"></property> <property name="suppressDate" value="true"></property> <property name="javaFileEncoding" value="utf-8"/> </commentGenerator> <jdbcConnection driverClass="${driverClass}" connectionURL="${connectionURL}" userId="${userId}" password="${password}"> </jdbcConnection> <javaTypeResolver> <property name="forceBigDecimals" value="false"/> </javaTypeResolver> <javaModelGenerator targetPackage="${modelPackage}" targetProject="${src_main_java}"> <property name="enableSubPackages" value="true"></property> <property name="trimStrings" value="true"></property> </javaModelGenerator> <sqlMapGenerator targetPackage="${sqlMapperPackage}" targetProject="${src_main_resources}"> <property name="enableSubPackages" value="true"></property> </sqlMapGenerator> <javaClientGenerator targetPackage="${mapperPackage}" targetProject="${src_main_java}" type="ANNOTATEDMAPPER"> <property name="enableSubPackages" value="true"/> </javaClientGenerator> <!-- sql占位符，表示所有的表 --> <table tableName="%"> <generatedKey column="epa_id" sqlStatement="Mysql" identity="true" /> </table> </context> </generatorConfiguration>

Gradle 設置 Ant Task

由於 MyBatis Generator 尚不支持 Gradle，所以只能使用 Gradle 來執行 Ant Task，達到相同的效果。

build.gradle:

def getDbProperties = { def properties = new Properties() file("src/main/resources/mybatis/jdbc.properties").withInputStream { inputStream -> properties.load(inputStream) } properties } task mybatisGenerate << { def properties = getDbProperties() ant.properties['targetProject'] = projectDir.path ant.properties['driverClass'] = properties.getProperty("jdbc.driverClassName") ant.properties['connectionURL'] = properties.getProperty("jdbc.url") ant.properties['userId'] = properties.getProperty("jdbc.username") ant.properties['password'] = properties.getProperty("jdbc.password") ant.properties['src_main_java'] = sourceSets.main.java.srcDirs[0].path ant.properties['src_main_resources'] = sourceSets.main.resources.srcDirs[0].path ant.properties['modelPackage'] = properties.getProperty("package.model") ant.properties['mapperPackage'] = properties.getProperty("package.mapper") ant.properties['sqlMapperPackage'] = properties.getProperty("package.xml") ant.taskdef(  name: 'mbgenerator',  classname: 'org.mybatis.generator.ant.GeneratorAntTask',  classpath: configurations.mybatisGenerator.asPath ) ant.mbgenerator(overwrite: true,  configfile: 'src/main/resources/mybatis/generatorConfig.xml', verbose: true) { propertyset { propertyref(name: 'targetProject') propertyref(name: 'userId') propertyref(name: 'driverClass') propertyref(name: 'connectionURL') propertyref(name: 'password') propertyref(name: 'src_main_java') propertyref(name: 'src_main_resources') propertyref(name: 'modelPackage') propertyref(name: 'mapperPackage') propertyref(name: 'sqlMapperPackage') } } }

配置好 build.gradle，就可以在 IDEA 的 Gradle 菜單中找到新的 Task：

mybatisGenerate

如果這里沒有，可能是 Gradle 沒有 build，重新刷新即可：

Refresh all Gradle projects

雙擊「mybatisGenerate」即可運行，如果配置正確即可運行成功：

成功生成代碼

注：這里我在 generatorConfig.xml 配置選擇的是按注解映射，因此沒有 xml 文件生成。

總結

這次的 Demo 您可以在 https://github.com/kingcos/MyBatisGenerator-Tool 下載查看。Demo 本身也可作為工具來生成代碼。由於目前正在完善一個 Android + Java Web 的小系統，因此未來可能還會更新 Spring Boot、Druid、Swagger 的配置腳手架。