天天看點

IntelliJ IDEA+Gradle+Mybatis逆向工程配置詳情

一、config.properties配置

# JDBC 驅動類名
jdbc.driverClassName=com.mysql.cj.jdbc.Driver
# JDBC URL: jdbc:mysql:// + 資料庫主機位址 + 端口号 + 資料庫名
jdbc.url=jdbc:mysql://192.168.44.222:3306/myTest?characterEncoding=utf8&useSSL=true&serverTimezone=Asia/Shanghai&zeroDateTimeBehavior=CONVERT_TO_NULL
# JDBC 使用者名及密碼
jdbc.username=root
jdbc.password=123456

# 生成實體類所在的包
package.model=com.kaneki.model
# 生成 mapper 類所在的包
package.mapper=com.kaneki.mapper
# 生成 mapper xml 檔案所在的包,預設存儲在 resources 目錄下
package.xml=mybatis
           

二、build.gradle配置

//添加mybatisGenerator
configurations {
    mybatisGenerator
}
dependencies {
    //mybatis逆向工程,這樣配置好像不會放到Libraries下面
    mybatisGenerator 'org.mybatis.generator:mybatis-generator-core:1.3.5'
    //版本過高,會出現很多問題,嫌麻煩可以降低
    mybatisGenerator 'mysql:mysql-connector-java:8.0.16'
    //下面這個包注釋掉了,并沒有發現有什麼用
    //mybatisGenerator 'tk.mybatis:mapper:3.3.9'
	//是以我又在下面用compile引入了一遍
	//mybatisGenerator
    compile group: 'org.mybatis.generator', name: 'mybatis-generator-core', version: '1.3.5'
    //mysql jdbc
    compile group: 'mysql', name: 'mysql-connector-java', version: '8.0.16'
}


def getDbProperties = {
    def properties = new Properties()
    file("src/main/resources/config.properties").withInputStream { inputStream ->
        properties.load(inputStream)
    }
    properties
}
//這裡沒有寫>>符号
task mybatisGenerator  {
    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/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')
        }
    }
}

           

三、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:必選,上下文id,用于在生成錯誤時提示
    defaultModelType:指定生成對象的樣式
        1,conditional:類似hierarchical;
        2,flat:所有内容(主鍵,blob)等全部生成在一個對象中;
        3,hierarchical:主鍵生成一個XXKey對象(key class),Blob等單獨生成一個對象,其他簡單屬性在一個對象中(record class)
    targetRuntime:
        1,MyBatis3:預設的值,生成基于MyBatis3.x以上版本的内容,包括XXXBySample;
        2,MyBatis3Simple:類似MyBatis3,隻是不生成XXXBySample;
    introspectedColumnImpl:類全限定名,用于擴充MBG-->
    <context id="Mysql" targetRuntime="MyBatis3" defaultModelType="flat">
    //下面這個配置我也注釋掉了,因為這個配置出現了很多問題,會繼承mapper,增删改查語句無法生成,還有model層一些注解,我并不知道有什麼用,困擾了我兩天
       <!-- <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
            <property name="mappers" value="tk.mybatis.mapper.common.Mapper"/>
            <property name="caseSensitive" value="true"/>
        </plugin>-->
        <!--自動實作Serializable接口-->
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
        <commentGenerator>
            <!-- 是否去除自動生成的注釋 true:是 : false:否 -->
            <property name="suppressAllComments" value="true"/>
            <!-- 是否生成注釋代時間戳-->
            <property name="suppressDate" value="true"/>
            <!-- 自動識别資料庫關鍵字,預設false,如果設定為true,根據SqlReservedWords中定義的關鍵字清單;
            一般保留預設值,遇到資料庫關鍵字(Java關鍵字),使用columnOverride覆寫-->
            <property name="autoDelimitKeywords" value="false"/>
            <!-- java 檔案編碼格式  -->
            <property name="javaFileEncoding" value="utf-8"/>
            <!-- 格式化java代碼 -->
            <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
            <!-- 格式化XML代碼 -->
            <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
            <!-- beginningDelimiter和endingDelimiter:指明資料庫的用于标記資料庫對象名的符号,比如ORACLE就是雙引号,MYSQL預設是`反引号; -->
            <property name="beginningDelimiter" value="`"/>
            <property name="endingDelimiter" value="`"/>
        </commentGenerator>
        <!-- jdbc 連接配接資訊  -->
        <jdbcConnection driverClass="${driverClass}"
                        connectionURL="${connectionURL}"
                        userId="${userId}"
                        password="${password}">
            <property name="nullCatalogMeansCurrent" value="true"/>
        </jdbcConnection>
        <!-- java類型處理器
        用于處理DB中的類型到Java中的類型,預設使用JavaTypeResolverDefaultImpl;
        注意一點,預設會先嘗試使用Integer,Long,Short等來對應DECIMAL和 NUMERIC資料類型;-->
        <javaTypeResolver>
            <!--
            true:使用BigDecimal對應DECIMAL和 NUMERIC資料類型
            false:預設,
                scale>0;length>18:使用BigDecimal;
                scale=0;length[10,18]:使用Long;
                scale=0;length[5,9]:使用Integer;
                scale=0;length<5:使用Short;
            -->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>
        <!-- java模型建立器,是必須要的元素
        負責:1,key類(見context的defaultModelType);2,java類;3,查詢類
        targetPackage:生成的類要放的包,真實的包受enableSubPackages屬性控制;
        targetProject:目标項目,指定一個存在的目錄下,生成的内容會放到指定目錄中,如果目錄不存在,MBG不會自動建目錄
        -->
        <javaModelGenerator targetPackage="${modelPackage}" targetProject="${src_main_java}">
            <!-- 在targetPackage的基礎上,根據資料庫的schema再生成一層package,最終生成的類放在這個package下,預設為false -->
            <property name="enableSubPackages" value="false"/>
            <!-- 設定是否在getter方法中,對String類型字段調用trim()方法 -->
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        <!-- 生成SQL map的XML檔案生成器,
       注意,在Mybatis3之後,我們可以使用mapper.xml檔案+Mapper接口(或者不用mapper接口),
           或者隻使用Mapper接口+Annotation,是以,如果 javaClientGenerator配置中配置了需要生成XML的話,這個元素就必須配置
       targetPackage/targetProject:同javaModelGenerator
        -->
        <sqlMapGenerator targetPackage="${sqlMapperPackage}" targetProject="${src_main_resources}">
            <!-- enableSubPackages:是否讓schema作為包的字尾 -->
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>
        <!-- 對于mybatis來說,即生成Mapper接口,注意,如果沒有配置該元素,那麼預設不會生成Mapper接口
        targetPackage/targetProject:同javaModelGenerator
        type:選擇怎麼生成mapper接口(在MyBatis3/MyBatis3Simple下):
            1,ANNOTATEDMAPPER:會生成使用Mapper接口+Annotation的方式建立(SQL生成在annotation中),不會生成對應的XML;
            2,MIXEDMAPPER:使用混合配置,會生成Mapper接口,并适當添加合适的Annotation,但是XML會生成在XML中;
            3,XMLMAPPER:會生成Mapper接口,接口完全依賴XML;
        注意,如果context是MyBatis3Simple:隻支援ANNOTATEDMAPPER和XMLMAPPER
        -->
        <javaClientGenerator targetPackage="${mapperPackage}" targetProject="${src_main_java}" type="XMLMAPPER">
            <!-- enableSubPackages:是否讓schema作為包的字尾 -->
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>

        <!-- 選擇一個table來生成相關檔案,可以有一個或多個table,必須要有table元素
        選擇的table會生成一下檔案:
        1,SQL map檔案
        2,生成一個主鍵類;
        3,除了BLOB和主鍵的其他字段的類;
        4,包含BLOB的類;
        5,一個使用者生成動态查詢的條件類(selectByExample, deleteByExample),可選;
        6,Mapper接口(可選)

        tableName(必要):要生成對象的表名;
        注意:大小寫敏感問題。正常情況下,MBG會自動的去識别資料庫辨別符的大小寫敏感度,在一般情況下,MBG會
            根據設定的schema,catalog或tablename去查詢資料表,按照下面的流程:
            1,如果schema,catalog或tablename中有空格,那麼設定的是什麼格式,就精确的使用指定的大小寫格式去查詢;
            2,否則,如果資料庫的辨別符使用大寫的,那麼MBG自動把表名變成大寫再查找;
            3,否則,如果資料庫的辨別符使用小寫的,那麼MBG自動把表名變成小寫再查找;
            4,否則,使用指定的大小寫格式查詢;
        另外的,如果在建立表的時候,使用的""把資料庫對象規定大小寫,就算資料庫辨別符是使用的大寫,在這種情況下也會使用給定的大小寫來建立表名;
        這個時候,請設定delimitIdentifiers="true"即可保留大小寫格式;

        可選:
        1,schema:資料庫的schema;
        2,catalog:資料庫的catalog;
        3,alias:為資料表設定的别名,如果設定了alias,那麼生成的所有的SELECT SQL語句中,列名會變成:alias_actualColumnName
        4,domainObjectName:生成的domain類的名字,如果不設定,直接使用表名作為domain類的名字;可以設定為somepck.domainName,那麼會自動把domainName類再放到somepck包裡面;
        5,enableInsert(預設true):指定是否生成insert語句;
        6,enableSelectByPrimaryKey(預設true):指定是否生成按照主鍵查詢對象的語句(就是getById或get);
        7,enableSelectByExample(預設true):MyBatis3Simple為false,指定是否生成動态查詢語句;
        8,enableUpdateByPrimaryKey(預設true):指定是否生成按照主鍵修改對象的語句(即update);
        9,enableDeleteByPrimaryKey(預設true):指定是否生成按照主鍵删除對象的語句(即delete);
        10,enableDeleteByExample(預設true):MyBatis3Simple為false,指定是否生成動态删除語句;
        11,enableCountByExample(預設true):MyBatis3Simple為false,指定是否生成動态查詢總條數語句(用于分頁的總條數查詢);
        12,enableUpdateByExample(預設true):MyBatis3Simple為false,指定是否生成動态修改語句(隻修改對象中不為空的屬性);
        13,modelType:參考context元素的defaultModelType,相當于覆寫;
        14,delimitIdentifiers:參考tableName的解釋,注意,預設的delimitIdentifiers是雙引号,如果類似MYSQL這樣的資料庫,使用的是`(反引号,那麼還需要設定context的beginningDelimiter和endingDelimiter屬性)
        15,delimitAllColumns:設定是否所有生成的SQL中的列名都使用辨別符引起來。預設為false,delimitIdentifiers參考context的屬性

        注意,table裡面很多參數都是對javaModelGenerator,context等元素的預設屬性的一個複寫;
        -->
        <!-- 要生成的表 schema即為資料庫名 tableName為對應的資料庫表-->
        <!-- 這裡的百分号代表對該資料庫中所有的表進行生成 -->
        <table tableName="%" schema="myTest"
               enableInsert="true"
               enableSelectByPrimaryKey="true"
               enableUpdateByPrimaryKey="true"
               enableDeleteByPrimaryKey="true"
               enableDeleteByExample="false"
               enableCountByExample="false"
               enableSelectByExample="false"
               enableUpdateByExample="false"
               selectByExampleQueryId="false">
        </table>
    </context>
</generatorConfiguration>
           

遇到的問題和注意事項:

1.jdbc driver:com.mysql.cj.jdbc.Driver

2.jdbc url:添加serverTimezone=Asia/Shanghai

3.因mybatisGenerator 引入jar包會導緻後面一些錯誤的問題:

如:http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd紅色警告;

添加:

compile group: ‘org.mybatis.generator’, name: ‘mybatis-generator-core’, version: ‘1.3.5’

compile group: ‘mysql’, name: ‘mysql-connector-java’, version: '8.0.16’

我是這麼解決的,也許有其他方法

4.将task mybatisGenerator >> {…}變為task mybatisGenerator {…}

5.tableName="%"會把root使用者下的所有表都生成mapper接口,model和xml檔案

jdbcConnection标簽内添加:

<property name=“nullCatalogMeansCurrent” value=“true”/>

table标簽中添加:

schema="資料庫名稱"

6.MybatisGenerator無法生成inset,select,update,delete語句等問題(不是動态的)

tk.mybatis包也就沒什麼用了,也許是我的了解不夠深,還有其他辦法

去掉generatorConfig.xml中下面配置:

<plugin type="tk.mybatis.mapper.generator.MapperPlugin">
            <property name="mappers" value="tk.mybatis.mapper.common.Mapper"/>
            <property name="caseSensitive" value="true"/>
        </plugin>
           

注:文檔來自于網絡,書本知識和自己總結,有什麼問題或需要幫助的可以評論或者微信掃描右邊二維碼聯系我。