Java MyBatis生成文件的拓展插件(分頁(yè)、重命名WithBlobs)

Java目前最常見的開發(fā)場(chǎng)景脯颜,依然是大數(shù)據(jù)哟旗、Web應(yīng)用、后臺(tái)服務(wù)開發(fā)栋操。而在這些開發(fā)中,常用MySQL數(shù)據(jù)庫(kù)饱亮,而MySQL in Java常用的是MyBatis矾芙。

在團(tuán)隊(duì)開發(fā)中,無(wú)可避免的開發(fā)環(huán)境有眾多不同近上。IDE(IDEA剔宪、Eclipse)、發(fā)行版類型(社區(qū)版壹无、旗艦版)葱绒、版本號(hào)(2018.1、2018.2斗锭、2018.3地淀、2019.1...)、插件工具(better-mybatis-generator岖是、Free Mybatis plugin...)這些都會(huì)各不相同帮毁,為了避免協(xié)助開發(fā)時(shí)实苞,先后生成的MyBatis文件不統(tǒng)一,也為了更方便地去生成烈疚,采用此解決方案

1. 使用與個(gè)人開發(fā)環(huán)境無(wú)關(guān)的配置(maven pom配置)
2. 使用易獲取黔牵、可拓展的插件工具(org.mybatis.generator:mybatis-generator-maven-plugin)
3. 實(shí)現(xiàn)插件工具的業(yè)務(wù)定制拓展功能(定制開發(fā)項(xiàng)目 nbj-mybatis-generator-plugins

1. 使用與個(gè)人開發(fā)環(huán)境無(wú)關(guān)的配置

查閱 MyBatis 官網(wǎng)資料,可以了解如何進(jìn)行配置
MyBatis Generator 快速開始指導(dǎo)
基于Maven執(zhí)行MyBatis Generator

在pom.xml里增加build插件

<project ...>
     ...
     <build>
       ...
       <plugins>
        ...
        <plugin>
          <groupId>org.mybatis.generator</groupId>
          <artifactId>mybatis-generator-maven-plugin</artifactId>
          <version>1.4.0</version>
        </plugin>
        ...
      </plugins>
      ...
    </build>
    ...
  </project>

生成文件:在Maven工具欄爷肝,執(zhí)行g(shù)enerate猾浦,或者命令行 mvn mybatis-generator:generate


IDEA 執(zhí)行 mybatis-generator:generator

錯(cuò)誤1:沒有增加mysql connector依賴,會(huì)報(bào)錯(cuò)獲取JDBC Driver失敗灯抛,形如:

Failed to execute goal org.mybatis.generator:mybatis-generator-maven-plugin:1.4.0:generate (default-cli) on project nbj-mybatis-generator-plugins: Execution default-cli of goal org.mybatis.generator:mybatis-generator-maven-plugin:1.4.0:generate failed: Exception getting JDBC Driver

解決1:具體增加依賴形如:

解決1:插件依賴 mysql-connector-java @ pom.xml

錯(cuò)誤2:沒有配置 generatorConfig.xml金赦,會(huì)報(bào)錯(cuò)配置文件不存在,形如:

Failed to execute goal org.mybatis.generator:mybatis-generator-maven-plugin:1.4.0:generate (default-cli) on project xxxx: configfile /Users/nextbin/xxxxxxxxx/xxxx/src/main/resources/generatorConfig.xml does not exist

解決2:修改配置文件路徑牧愁,或新增配置文件

解決2:修改配置文件路徑 @ pom.xml

解決2:新增配置文件 @ generatorConfig.xml

2. 使用易獲取素邪、可拓展的插件工具

generator默認(rèn)生成的文件為:Domain.java、DomainWithBlobs.java猪半、DomainMapper.java兔朦、DomainMapper.xml

但是由于默認(rèn)生成的功能比較有限,沒有分頁(yè)功能磨确,沒有Domain Builder功能沽甥,我們需要引入插件工具,這里首先引入官方自帶的 MyBatis Generator Plugins: Domain-With-Builder和RowBounds乏奥。

generator 引入官方插件

由此配置的 generatorConfig.xml 可以使得生成的Domain帶有 With-Builder摆舟,而Mapper.java帶有RowBounds參數(shù)的分頁(yè)查詢。結(jié)果如下兩圖:


使用官方插件的實(shí)體類With-Builder效果

使用官方插件的Mapper.java效果

3. 實(shí)現(xiàn)插件工具的業(yè)務(wù)定制拓展功能

我們通過官方插件 org.mybatis.generator.plugins.RowBoundsPlugin 生成的 Mapper 使用多了一個(gè)參數(shù)RowBounds 來(lái)達(dá)到分頁(yè)效果邓了。但是恨诱,實(shí)際上該分頁(yè)功能沒有使用到MySQL查詢的limit關(guān)鍵字(可以由生成的Mapper.xml文件看出),所以對(duì)于大表分頁(yè)查詢骗炉,實(shí)際上會(huì)查詢出全表再做分頁(yè)照宝,這在表數(shù)據(jù)量比較大的場(chǎng)景下,是不允許的句葵。因此厕鹃,我們需要定制開發(fā)出帶有l(wèi)imit 關(guān)鍵字的分頁(yè)查詢。

定制插件的開發(fā)文檔

根據(jù)開發(fā)文檔乍丈,可以完成實(shí)現(xiàn)剂碴。在本文章的基礎(chǔ)上,現(xiàn)僅需完成4步小改動(dòng)轻专,即可生成帶有定制插件的文件忆矛,詳見:https://github.com/nextbin/nbj-mybatis-generator-plugins

  1. 安裝依賴(暫時(shí)還沒有發(fā)布到公共maven倉(cāng)庫(kù),需要手動(dòng)安裝)

    git clone https://github.com/nextbin/nbj-mybatis-generator-plugins.git
    git checkout v0.0.1
    mvn clean install
    
  2. 修改 pom.xml铭若,新增 build.plugins.plugin 配置插件 org.mybatis.generator:mybatis-generator-maven-plugin 的插件依賴 github.nextbin.maven:nbj-mybatis-generator-plugins洪碳。


    新增generator依賴 @ pom.xml
  3. 新增 src/main/resources/mybatis/generatorConfig.xml递览,如已配置,則需新增拓展插件瞳腌。


    新增拓展定制插件 @ generatorConfig.xml
  4. 在IDEA側(cè)邊欄執(zhí)行 generate 操作
    生成文件:在Maven工具欄绞铃,執(zhí)行g(shù)enerate,或者命令行 mvn mybatis-generator:generate

更多內(nèi)容:

https://github.com/nextbin/nbj-mybatis-generator-plugins

參考資料:

https://mybatis.org/generator/

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末嫂侍,一起剝皮案震驚了整個(gè)濱河市儿捧,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌挑宠,老刑警劉巖菲盾,帶你破解...
    沈念sama閱讀 222,000評(píng)論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異各淀,居然都是意外死亡懒鉴,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,745評(píng)論 3 399
  • 文/潘曉璐 我一進(jìn)店門碎浇,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)临谱,“玉大人,你說我怎么就攤上這事奴璃∠つ” “怎么了?”我有些...
    開封第一講書人閱讀 168,561評(píng)論 0 360
  • 文/不壞的土叔 我叫張陵苟穆,是天一觀的道長(zhǎng)抄课。 經(jīng)常有香客問我,道長(zhǎng)雳旅,這世上最難降的妖魔是什么跟磨? 我笑而不...
    開封第一講書人閱讀 59,782評(píng)論 1 298
  • 正文 為了忘掉前任,我火速辦了婚禮攒盈,結(jié)果婚禮上吱晒,老公的妹妹穿的比我還像新娘。我一直安慰自己沦童,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,798評(píng)論 6 397
  • 文/花漫 我一把揭開白布叹话。 她就那樣靜靜地躺著偷遗,像睡著了一般。 火紅的嫁衣襯著肌膚如雪驼壶。 梳的紋絲不亂的頭發(fā)上氏豌,一...
    開封第一講書人閱讀 52,394評(píng)論 1 310
  • 那天,我揣著相機(jī)與錄音热凹,去河邊找鬼泵喘。 笑死泪电,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的纪铺。 我是一名探鬼主播相速,決...
    沈念sama閱讀 40,952評(píng)論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼鲜锚!你這毒婦竟也來(lái)了突诬?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,852評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤芜繁,失蹤者是張志新(化名)和其女友劉穎旺隙,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體骏令,經(jīng)...
    沈念sama閱讀 46,409評(píng)論 1 318
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡蔬捷,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,483評(píng)論 3 341
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了榔袋。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片周拐。...
    茶點(diǎn)故事閱讀 40,615評(píng)論 1 352
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖摘昌,靈堂內(nèi)的尸體忽然破棺而出速妖,到底是詐尸還是另有隱情,我是刑警寧澤聪黎,帶...
    沈念sama閱讀 36,303評(píng)論 5 350
  • 正文 年R本政府宣布罕容,位于F島的核電站,受9級(jí)特大地震影響稿饰,放射性物質(zhì)發(fā)生泄漏锦秒。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,979評(píng)論 3 334
  • 文/蒙蒙 一喉镰、第九天 我趴在偏房一處隱蔽的房頂上張望旅择。 院中可真熱鬧,春花似錦侣姆、人聲如沸生真。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,470評(píng)論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)柱蟀。三九已至,卻和暖如春蚜厉,著一層夾襖步出監(jiān)牢的瞬間长已,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,571評(píng)論 1 272
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留术瓮,地道東北人康聂。 一個(gè)月前我還...
    沈念sama閱讀 49,041評(píng)論 3 377
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像胞四,于是被迫代替她去往敵國(guó)和親恬汁。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,630評(píng)論 2 359