MyBatis 爲什麼需要通用 Mapper ? 轉

一、通用 Mapper 的用途 ?

我個人最早用 MyBatis 時,先是完全手寫,然後用上了 MyBatis 代碼生成器(簡稱爲 MBG),在使用 MBG 過程中,發現一個很麻煩的問題,如果數據庫字段變化很頻繁,就需要反覆重新生成代碼,並且由於 MBG 覆蓋生成代碼和追加方式生成 XML,導致每次重新生成都需要大量的比對修改。除了這個問題外,還有一個問題,僅僅基礎的增刪改查等方法,就已經產生了大量的 XML 內容,還沒有添加一個自己手寫的方法,代碼可能就已經幾百行了,內容多,看着比較礙事。

因爲很多人都在使用 MBG,MBG 中定義了很多常用的單表方法,爲了解決前面提到的問題,也爲了兼容 MBG 的方法避免項目重構太多,在 MBG 的基礎上結合了部分 JPA 註解產生了通用 Mapper。通用 Mapper 可以很簡單的讓你獲取基礎的單表方法,也很方便擴展通用方法。使用通用 Mapper 可以極大的提高你的工作效率。
 

二、快速入門

爲了讓你更快速的瞭解通用 Mapper 的優勢,這裏會更簡潔的讓你瞭解整個過程。

首先在 Maven 項目的 pom.xml 中添加通用 Mapper 依賴:

接下來,開始具體的使用。

1. 配置實體類

通過 MBG 配合 專用代碼生成器 可以直接生成實體類等基礎代碼,爲了避免信息量過大,這裏當作手工編寫和配置。

有如下類:

在上面類中,我們給主鍵添加了 @Id,標記該字段爲數據庫主鍵。還有一個通用 Mapper 的特殊註解 @KeySql,配置的 useGeneratedKeys = true 和 MyBatis 中的 useGeneratedKeys 含義相同,意思是說使用 JDBC 的方式獲取數據庫自增的主鍵值。

經過上面簡單的配置後,相當於就有了 MyBatis 中的 <resultMap> 關係映射了,特別注意,這個映射關係只對通用 Mapper 有效,自己手寫方法時,需要自己處理映射關係

2. 創建 Mapper 接口

根據上述實體類,創建對應的 CountryMapper 接口如下:

這裏繼承了 tk.mybatis.mapper.common.Mapper 接口,在接口上指定了泛型類型 Country。當你繼承了 Mapper 接口後,此時就已經有了針對 Country 的大量方法,方法如下:

在這裏插入圖片描述

這些方法中和 MBG 生成的大部分方法都一致,還有一部分 MBG 之外的常用方法。

3. 配置通用 Mapper

爲了讓上述方法可以直接使用,還需要配置通用 Mapper,讓項目在啓動的時候,把上述方法都自動生成好,這樣在運行時就可以使用上面所有的方法。

根據不同的開發環境,需要不同的配置方式,完整的內容可以 集成通用 Mapper,我們這裏以最常見的 Spring 和 MyBatis 集成爲例。

在集成 Spring 的環境中使用 MyBatis 接口方式時,需要配置 MapperScannerConfigurer,在這種情況下使用通用 Mapper,只需要修改配置如下:

注意官方的包名和這裏 tk 包名的區別:

1.tk.mybatis.spring.mapper.MapperScannerConfigurer
2.org.mybatis.spring.mapper.MapperScannerConfigurer
只有第一部分從 org 換成了 tk。

此時通用 Mapper 最簡單的配置就完成了,完整的配置可以看這裏 和 Spring 集成。

4. 簡單使用

下面是一個簡單的測試用例,實際使用中,可以直接注入 CountryMapper

該測試完整地址:Spring 集成測試用例

通用 Mapper 只是提供了基礎的大量方法,遇到沒有的方法時,你可以正常按照 MyBatis 的用法手寫,和正常用法沒有任何區別。

5. 瞭解更多

上面的簡單的介紹已經可以應用到真正的項目中了,但是有很多細節這裏都沒有涉及,如果你準備加入通用 Mapper,你可以先按上述內容引入項目,然後通過更詳細的文檔去了解更多的細節,有很多你可能想要但是 MBG 不存在的方法,在這裏都有,而且如果你想實現自己的通用方法,可以很輕鬆的進行擴展。


出處:https://blog.csdn.net/isea533/article/details/83045335 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章