關(guān)于IDEA MybatisX插件的使用小技巧

更新時(shí)間：2023年03月29日 15:51:21 作者：貝貝才不是小淘氣

這篇文章主要介紹了關(guān)于MybatisX插件的使用小技巧,MybatisX是IDEA的一款第三方插件,可以極大地提升我們的開(kāi)發(fā)效率,一起來(lái)看看吧

前言

一開(kāi)始本來(lái)我是想用Free Mybatis plugin的，結(jié)果搜不到，然后就發(fā)現(xiàn)了這貨，一番體驗(yàn)之后是真的舒爽啊?。?！

1.安裝MybatisX

在這里插入圖片描述

2.功能

2.1.文件跳轉(zhuǎn)

這個(gè)功能我是在太愛(ài)了，在使用mybatis框架的時(shí)候，你還在繁瑣的找和接口對(duì)應(yīng)的mapper.xml、SQL語(yǔ)句嗎？還在繁瑣的找和mapper.xml對(duì)應(yīng)的接口、方法嗎？還在繁瑣的找注入給serviceImpl的接口嗎？
這也太麻煩還巨浪費(fèi)時(shí)間了！?。?，而MybatisX插件提供了跳轉(zhuǎn)的功能，通過(guò)點(diǎn)擊“憤怒的小鳥”就可以跳轉(zhuǎn)到對(duì)應(yīng)的地方。

我敲了個(gè)簡(jiǎn)單項(xiàng)目來(lái)演示：

在這里插入圖片描述

跳到了mapper.xml（點(diǎn)第二只小鳥會(huì)跳到id為findAll所對(duì)應(yīng)的方法）

在這里插入圖片描述

2.2.代碼自動(dòng)生成

其實(shí)很久以前我就非常頭疼寫一堆dao、service、serviceImpl、mapper.xml、pojo的重復(fù)性工作，一直希望有那么一個(gè)工具幫我干這些重復(fù)性工作，而MybatisX可以根據(jù)表自動(dòng)生成且模板可自定義。

最好搭配以下一起食用：

SpringBootMybatisPlus（可選，但是不選，效果就沒(méi)有那么好了）。

第一步：連接數(shù)據(jù)源。

在這里插入圖片描述

注意：時(shí)區(qū)要寫對(duì)，不然會(huì)犯病（時(shí)區(qū)在哪配置？上面"測(cè)試連接"要是測(cè)出了時(shí)區(qū)問(wèn)題，你可以按照指引去做配置，改成Asia/Shanghai即可）。

第二步：點(diǎn)batisx-generator，配置自動(dòng)生成代碼。

在這里插入圖片描述

module path：模塊路徑，此處填寫項(xiàng)目所在路徑。
base package：填寫項(xiàng)目的包（你需要把dao、service、serviceImpl、mapper.xml、pojo這些生成在哪個(gè)包下）
encoding：編碼，使用UTF-8即可。
base path：就是base package的前段（比如，base path+base package=src/main/java/com/sangeng）
relative package：實(shí)體類所在的包名，默認(rèn)是domain。
extra class suffix：生成的實(shí)體類后面會(huì)加上此內(nèi)容。例如，上圖中本來(lái)要生成的實(shí)體類為User的，然后我們?cè)趀xtra class suffix框里敲上Test，最后生成的實(shí)體類為UserTest。
ignore field prefix（前綴）：數(shù)據(jù)庫(kù)中有字段名為name的，若ignore field prefix框里敲上na，則生成的實(shí)體類中對(duì)應(yīng)的屬性名為me，省略了na。
ignore table prefix：數(shù)據(jù)庫(kù)表名為mybatis_db，若ignore tableprefix框里敲上my，則生成的實(shí)體類的名字變?yōu)閎atis_db（當(dāng)然，要是你設(shè)置了extra class suffix，那么生成的實(shí)體類后面會(huì)加上指定內(nèi)容）。
superClass：生成實(shí)體類繼承的父類。

在這里插入圖片描述

annotation選項(xiàng)：生成的代碼中是否加上注解（例如，@TableName等注解）。None為沒(méi)有注解，其它為字面意思。
- 因?yàn)槲抑皇亲鰝€(gè)演示，沒(méi)有使用MybatisPlus框架，也沒(méi)有service、serviceImpl，所以是這樣配置的，要是想要有service和serviceImpl，annotation可以勾選Mybatis-Plus3。
options選項(xiàng)：經(jīng)過(guò)嘗試后，作用大致如下：
- comment：可能和生成java doc comments有關(guān)，但試了下，好像沒(méi)有效果。
- toString/hashCode/equals：是否生成相應(yīng)的方法，建議勾選。
- Lombok：勾選后實(shí)體類自動(dòng)添加Lombok的@Data注解，建議勾選（要先安裝Lombok插件哦）
- Actual Column：勾選后，生成的實(shí)體類屬性名和表中字段名大小寫會(huì)保持一致。例如，表中有字段Name，勾選該選項(xiàng)后生成的屬性名也為Name，未勾選則為name，建議根據(jù)實(shí)際需要勾選。
- Actual Column Annotation：是否對(duì)所有屬性名都加上注解標(biāo)明對(duì)應(yīng)字段，例如@TableName，建議勾選。
- JSR310:Data API：是否使用新標(biāo)準(zhǔn)的時(shí)間日期API，包括 Instant、Clock、LocalDateTime、DateTimeFormatter、ZonedDateTime 以及替換 Calendar 的 Chronology 等類。建議勾選（新標(biāo)準(zhǔn)的時(shí)間日期API比老版本友好多了，強(qiáng)烈建議使用新版時(shí)間日期API）
template選項(xiàng)：生成mapper、service等相關(guān)代碼所使用的模板。
- 如果沒(méi)有使用MybatisPlus，可以選擇default-empty模板或自定義其它模板—默認(rèn)位于：臨時(shí)文件和控制臺(tái)–>Extensions–>MybatisX（就在idea左下邊）
- 對(duì)應(yīng)文件夾內(nèi)即為相關(guān)模板的具體配置文件。如果需要重置，右鍵template文件夾點(diǎn)擊重置默認(rèn)擴(kuò)展即可。

在這里插入圖片描述

最底下的表：顯示所要生成文件的類型、模塊路徑、基本路徑、生成后位于哪個(gè)包（默認(rèn)為mapper）。后面3個(gè)列都可以修改值（以符合項(xiàng)目需求）。這些也可以在對(duì)應(yīng)的template的文件夾內(nèi)的.meta.xml中進(jìn)行修改。