當前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

MyBatis 为什么需要通用 Mapper ?

發布時間：2025/3/15 编程问答 18 豆豆

生活随笔收集整理的這篇文章主要介紹了 MyBatis 为什么需要通用 Mapper ? 小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

在早期項目文檔中有過類似主題的內容，但是最近我自己看文檔的時候發現一個問題，文檔雖然很詳細，但是并不適合初次接觸的人。為了方便第一次聽說，第一次嘗試的開發人員了解通用 Mapper，補充此文檔。

一、通用 Mapper 的用途 ?

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

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

通過下面的快速入門，會讓你盡快的了解基本的用法。

通用 Mapper 誕生于 2014 年 11 月：https://blog.csdn.net/isea533/article/details/41457529
上面文章的設計思路和現在完全不同。
如果想要了解當前的實現原理，可以看下面這篇。
MyBatis 通用 Mapper 實現原理：https://blog.csdn.net/isea533/article/details/78493852

二、快速入門

為了讓你更快速的了解通用 Mapper 的優勢，這里會更簡潔的讓你了解整個過程。

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

<dependency><groupId>tk.mybatis</groupId><artifactId>mapper</artifactId><version>最新版本</version> </dependency>

最新版本可以看這里: https://mvnrepository.com/artifact/tk.mybatis/mapper

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

1. 配置實體類

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

有如下類：

public class Country implements Serializable {private static final long serialVersionUID = 1L;@Id@KeySql(useGeneratedKeys = true)private Long id;private String countryname;private String countrycode; //setter 和 getter 方法

}

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

該類對應數據表為 country，因為類名和數據庫名對應（當前數據庫忽略大小寫），因此不需要在類上添加 @Table(name = "country")。

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

這部分的詳細內容參考文檔：對象關系映射

2. 創建 Mapper 接口

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

import tk.mybatis.mapper.common.Mapper;

public interface CountryMapper extends Mapper<Country> {

}

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

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

3. 配置通用 Mapper

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

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

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

注意官方的包名和這里 tk 包名的區別：

tk.mybatis.spring.mapper.MapperScannerConfigurer
org.mybatis.spring.mapper.MapperScannerConfigurer

只有第一部分從 org 換成了 tk。

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

4. 簡單使用

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

public class SpringXmlTest { private ClassPathXmlApplicationContext context;@Test public void testCountryMapper() {context = new ClassPathXmlApplicationContext("tk/mybatis/mapper/xml/spring.xml");CountryMapper countryMapper = context.getBean(CountryMapper.class);//獲取全部信息List<Country> countries = countryMapper.selectAll();Assert.assertNotNull(countries);Assert.assertEquals(183, countries.size()); }

}

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

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

5. 了解更多

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

完整文檔：https://github.com/abel533/Mapper/wiki
遇到問題提 issues: https://github.com/abel533/Mapper/issues
更多完整項目示例：https://mybatis.tk/samples.html
果子籃開發架構: http://guozilan.tk
MyBatis 交流：點擊加入 MyBatis QQ 群

三、最后問一句

你覺得 MyBatis 需要通用 Mapper 嗎？

由于每個人對技術的掌握程度不同，對新事物的接受能力不同，因此我們都習慣于自己已經掌握的內容，抵制未知的能力，如果你不去試試，你能回答這個問題嗎？

轉載： https://blog.csdn.net/isea533/article/details/83045335

總結

以上是生活随笔為你收集整理的MyBatis 为什么需要通用 Mapper ?的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。

上一篇： Java Graphics类的绘图方法
下一篇：云服务器的主机名是否可以修改？？