在gradle中使用MyBatis Generator生成model,dao,mapper

参考https://chenkaihua.com/2015/12/19/running-mybatis-generator-with-gradle/
#在gradle中使用MyBatis Generator生成model,dao,mapper

Mybatis Generator是一个mybatis工具项目，用于生成mybatis的model,mapper,dao持久层代码。Mybatis Generator提供了maven plugin,ant target，java三种方式启动。现在主流的构建工具是gradle,虽然mybatis generator没有提供gradle的插件，但gradle可以调用ant任务，因此，gradle也能启动Mybatis Generator。

环境说明

• 数据库:mysql
• 数据库配置文件:src/main/resources/db-mysql.properties
• 项目中使用了mybatistk.mybatis:mapper:3.3.2插件

配置依赖

在build.gradle中:
运行ant需要运行环境，也就是相应的jar包，因此添加一个配置

configurations {
    mybatisGenerator
}

给这个配置添加依赖

repositories {
    mavenCentral()
}
dependencies {
    mybatisGenerator 'org.mybatis.generator:mybatis-generator-core:1.3.2'
    mybatisGenerator 'mysql:mysql-connector-java:5.1.36'
    mybatisGenerator 'tk.mybatis:mapper:3.3.2'
}

配置task

在build.gradle中，定义一个task，在task里面调用ant

//执行mybatisGenerate任务自动生成model mapper和dao文件
def getDbProperties = {
    def properties = new Properties()
    file("src/main/resources/jdbc.properties").withInputStream { inputStream ->
        properties.load(inputStream)
    }
    properties
}

task mybatisGenerate  {
    def properties = getDbProperties()
    ant.properties['targetProject'] = projectDir.path
    ant.properties['driverClass'] = properties.getProperty("jdbc_driver")
    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['modelPackage'] = properties.getProperty("model.package")
    ant.properties['daoPackage'] = properties.getProperty("dao.package")
    ant.properties['sqlMapperPackage'] = properties.getProperty("xml.sqlmapper.package")
    ant.taskdef(
            name: 'mbgenerator',
            classname: 'org.mybatis.generator.ant.GeneratorAntTask',
            classpath: configurations.mybatisGenerator.asPath
    )

    ant.mbgenerator(overwrite: true,
            configfile: 'src/main/resources/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: 'daoPackage')
            propertyref(name: 'sqlMapperPackage')
        }
    }
}

大致思路是:

• 从jdbc.propertis读取配置
• 把配置注入ant任务
• 运行ant,生成文件

数据库配置文件，文件在src/main/resources/jdbc.properties

# \uFFFD\uFFFD\uFFFD\u077F\uFFFD\uFFFD\uFFFD\uFFFD\uFFFD
jdbc_driver=com.mysql.jdbc.Driver
jdbc_url=jdbc:mysql://192.168.6.51:3306/ahimmu_inpatient?useSSL=true&useUnicode=true&characterEncoding=UTF-8
jdbc_username=root
jdbc_password=12345
initialSize=1
minIdle=1
maxActive=20
#生成数据库中表对应的实体类所在包
model.package=com.system.entity
#生成的mapper接口类所在包
dao.package=com.system.dao
#生成的mapper xml文件所在包，默认存储在resources目录下
xml.sqlmapper.package=com.system.mapper.generated

generatorConfig配置
配置文件更加详细的解释，可以参考 https://blog.csdn.net/woshixuye/article/details/29220123

<?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="tk.mybatis.mapper.generator.TkMyBatis3Impl" defaultModelType="flat">

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

        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
        <plugin type="org.mybatis.generator.plugins.EqualsHashCodePlugin"/>
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
        <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
            <property name="mappers" value="tk.mybatis.mapper.common.Mapper"/>
            <!-- caseSensitive默认false，当数据库表名区分大小写时，可以将该属性设置为true -->
            <property name="caseSensitive" value="true"/>
        </plugin>

        <!-- 是否去除自动生成的注释 -->
        <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>

        <!-- false：JDBC DECIMAL、NUMERIC类型解析为Integer，默认方式 -->
        <!-- true： JDBC DECIMAL、NUMERIC类型解析为java.math.BigDecimal -->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- 生成model模型的包名和位置 -->
        <javaModelGenerator targetPackage="${modelPackage}" targetProject="${src_main_java}">
            <!-- 是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="true"></property>
            <!-- 从数据库返回的值被清理前后的空格 -->
            <property name="trimStrings" value="true"></property>
        </javaModelGenerator>

        <!-- 生成xml mapper映射文件的包名和位置 -->
        <sqlMapGenerator targetPackage="${sqlMapperPackage}" targetProject="${src_main_java}">
            <property name="enableSubPackages" value="true"></property>
        </sqlMapGenerator>

        <!--生成xml dao 的包名和位置 -->
        <javaClientGenerator targetPackage="${daoPackage}" targetProject="${src_main_java}"  type="XMLMAPPER">
            <property name="enableSubPackages" value="true"></property>
        </javaClientGenerator>

        <!-- sql占位符，表示所有的表 -->
        <table tableName="%" mapperName="{0}Dao"
               enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false"
               selectByExampleQueryId="false">
            <generatedKey column="id" sqlStatement="Mysql" identity="true"/>

            <!-- 忽略该字段(可省略) -->
            <!--<ignoreColumn column="name" />-->

        </table>
    </context>
</generatorConfiguration>

run 生成代码

gradle mybatisGenerate