gradle + mybatis-generator-plugin
[toc]
因?yàn)?code>inke一直使用 gradle 進(jìn)行開發(fā)弄兜，所以學(xué)習(xí) spring boot 的時(shí)候粱挡，比較推崇用 gradle 進(jìn)行構(gòu)建乍桂。
寫博客的初衷是不想大家和我一樣浪費(fèi)時(shí)間在這里锨苏。
花了半天時(shí)間找方案公罕，都是坑爹的方案：
- 大部分都是
maven plugin方案 - 用的
mybatis而不是mybatis-spring-boot-starter:1.3.0翠胰，顯然不是spring boot的方案容贝。 - 使用
gradle然后在調(diào)用ant腳本，雖然gradle無縫兼容maven之景、ant斤富，但是還是感覺不舒服。
又花了半天時(shí)間用來驗(yàn)證方案和寫博客锻狗，一天時(shí)間都花在這上了满力。
-w300
mybatis-generator-plugin插件地址：
https://github.com/kimichen13/mybatis-generator-plugin-
方案來源：
gradle 官網(wǎng)提供的解決方案：
https://plugins.gradle.org/plugin/com.arenagod.gradle.MybatisGenerator
準(zhǔn)備工作：數(shù)據(jù)庫腳本
-- auto-generated definition
create table user
(
` id` int auto_increment comment '用戶id'
primary key,
name varchar(10) null comment '姓名'
)
comment ' 用戶表'
;
第一步：配置 build.gradle
buildscript {
ext {
springBootVersion = '1.5.4.RELEASE'
}
repositories {
mavenCentral()
}
dependencies {
classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
}
}
apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'org.springframework.boot'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = 1.8
repositories {
mavenCentral()
}
dependencies {
compile('org.springframework.boot:spring-boot-starter')
testCompile('org.springframework.boot:spring-boot-starter-test')
compile 'mysql:mysql-connector-java'
//配置mybatis 數(shù)據(jù)源
compile("org.mybatis.spring.boot:mybatis-spring-boot-starter:1.3.0")
testCompile('org.mybatis.spring.boot:mybatis-spring-boot-starter-test:1.3.0')
compile('org.springframework.boot:spring-boot-starter-web')
}
//mybatis generator plugin ------ start
buildscript {
repositories {
maven {
url "https://plugins.gradle.org/m2/"
}
}
dependencies {
classpath "gradle.plugin.com.arenagod.gradle:mybatis-generator-plugin:1.4"
}
}
apply plugin: "com.arenagod.gradle.MybatisGenerator"
configurations {
mybatisGenerator
}
mybatisGenerator {
verbose = true
configFile = 'src/main/resources/tools/generatorConfig.xml'
}
//mybatis generator plugin ------ end
第二步：配置 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>
<!--id:必選，上下文id轻纪，用于在生成錯(cuò)誤時(shí)提示-->
<context id="mysql" targetRuntime="MyBatis3">
<!-- 生成的Java文件的編碼 -->
<property name="javaFileEncoding" value="UTF-8"/>
<!-- 對(duì)注釋進(jìn)行控制 -->
<commentGenerator>
<!-- suppressDate是去掉生成日期那行注釋 -->
<property name="suppressDate" value="true"/>
<!-- suppressAllComments是去掉所有的注解 -->
<property name="suppressAllComments" value="true"/>
</commentGenerator>
<!--jdbc的數(shù)據(jù)庫連接 -->
<jdbcConnection
driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://127.0.0.1:3306/test"
userId="root"
password="root">
</jdbcConnection>
<!-- java類型處理器
用于處理DB中的類型到Java中的類型油额，默認(rèn)使用JavaTypeResolverDefaultImpl；
注意一點(diǎn)刻帚，默認(rèn)會(huì)先嘗試使用Integer潦嘶，Long，Short等來對(duì)應(yīng)DECIMAL和 NUMERIC數(shù)據(jù)類型崇众；
-->
<javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl">
<!--
true：使用BigDecimal對(duì)應(yīng)DECIMAL和 NUMERIC數(shù)據(jù)類型
false：默認(rèn),
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模型創(chuàng)建器看峻，是必須要的元素
負(fù)責(zé)：1，key類（見context的defaultModelType）衙吩；2，java類溪窒；3坤塞，查詢類
targetPackage：生成的類要放的包冯勉，真實(shí)的包受enableSubPackages屬性控制；
targetProject：目標(biāo)項(xiàng)目摹芙，指定一個(gè)存在的目錄下灼狰，生成的內(nèi)容會(huì)放到指定目錄中，如果目錄不存在浮禾，MBG不會(huì)自動(dòng)建目錄
-->
<javaModelGenerator targetPackage="com.example.demo.model" targetProject="src/main/java">
<!-- 是否允許子包交胚，即targetPackage.schemaName.tableName -->
<property name="enableSubPackages" value="true"/>
<!-- 是否對(duì)model添加 構(gòu)造函數(shù) -->
<property name="constructorBased" value="true"/>
<!-- 是否對(duì)類CHAR類型的列的數(shù)據(jù)進(jìn)行trim操作 -->
<property name="trimStrings" value="true"/>
<!-- 建立的Model對(duì)象是否 不可改變 即生成的Model對(duì)象不會(huì)有 setter方法，只有構(gòu)造方法 -->
<property name="immutable" value="false"/>
</javaModelGenerator>
<!-- 生成SQL map的XML文件生成器盈电，
注意蝴簇，在Mybatis3之后，我們可以使用mapper.xml文件+Mapper接口（或者不用mapper接口）匆帚，
或者只使用Mapper接口+Annotation熬词，
所以，如果 javaClientGenerator配置中配置了需要生成XML的話吸重，這個(gè)元素就必須配置
targetPackage/targetProject:同javaModelGenerator
-->
<sqlMapGenerator targetPackage="mapper.com.example.demo" targetProject="src/main/resources">
<!-- 在targetPackage的基礎(chǔ)上互拾，根據(jù)數(shù)據(jù)庫的schema再生成一層package，最終生成的類放在這個(gè)package下嚎幸，默認(rèn)為false -->
<property name="enableSubPackages" value="true"/>
</sqlMapGenerator>
<!-- 對(duì)于mybatis來說颜矿，即生成Mapper接口，注意嫉晶，如果沒有配置該元素骑疆，那么默認(rèn)不會(huì)生成Mapper接口
targetPackage/targetProject:同javaModelGenerator
type：選擇怎么生成mapper接口（在MyBatis3/MyBatis3Simple下）：
1，ANNOTATEDMAPPER：會(huì)生成使用Mapper接口+Annotation的方式創(chuàng)建（SQL生成在annotation中）车遂，不會(huì)生成對(duì)應(yīng)的XML封断；
2，MIXEDMAPPER：使用混合配置舶担，會(huì)生成Mapper接口坡疼，并適當(dāng)添加合適的Annotation，但是XML會(huì)生成在XML中衣陶；
3柄瑰，XMLMAPPER：會(huì)生成Mapper接口，接口完全依賴XML剪况；
注意教沾，如果context是MyBatis3Simple：只支持ANNOTATEDMAPPER和XMLMAPPER
-->
<javaClientGenerator targetPackage="com.example.demo.mapper" type="XMLMAPPER" targetProject="src/main/java">
<!-- 在targetPackage的基礎(chǔ)上，根據(jù)數(shù)據(jù)庫的schema再生成一層package译断，最終生成的類放在這個(gè)package下授翻，默認(rèn)為false -->
<property name="enableSubPackages" value="true"/>
</javaClientGenerator>
<!-- 選擇一個(gè)table來生成相關(guān)文件，可以有一個(gè)或多個(gè)table，必須要有table元素
tableName（必要）：要生成對(duì)象的表名堪唐；
domainObjectName 給表對(duì)應(yīng)的 model 起名字
注意：大小寫敏感問題巡语。
-->
<table tableName="user" domainObjectName="User">
<!--用來修改表中某個(gè)列的屬性,一個(gè)table元素中可以有多個(gè)columnOverride元素哈.
property屬性來指定列要生成的屬性名稱.
-->
<!--<columnOverride column="username" property="userName" />-->
</table>
<!--<table tableName="person" domainObjectName="Person"/>-->
<!--<table tableName="department" domainObjectName="Depart"/>-->
</context>
</generatorConfiguration>
-
第三步：點(diǎn)擊開關(guān)，自動(dòng)生成文件代碼
-w300生成的文件：
-w300
目前唯一比較遺憾的是：不支持 表字段的注釋輸出淮菠，試了好多方式都不行.
驗(yàn)證方案一
implements CommentGenerator:
http://blog.csdn.net/qq_21251983/article/details/50731368驗(yàn)證方案二
extends DefaultCommentGenerator:
http://blog.csdn.net/isea533/article/details/42102297
報(bào)錯(cuò)信息都是：Cannot instantiate object of type MyCommentGenerator
網(wǎng)上的方式打成 jar等方式試了都不行男公，已經(jīng)給作者留了 issue ，希望他可以盡快推出該功能合陵。
歡迎大家的點(diǎn)贊枢赔、留言和打賞。
