當(dāng)前位置：首頁(yè) > 编程资源 > 编程问答 >内容正文

编程问答

MyBatis 为什么需要通用 Mapper ?

發(fā)布時(shí)間：2025/3/15 编程问答 21 豆豆

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

版權(quán)聲明：版權(quán)歸博主所有，轉(zhuǎn)載請(qǐng)帶上本文鏈接！聯(lián)系方式：abel533@gmail.com https://blog.csdn.net/isea533/article/details/83045335 </div>

在早期項(xiàng)目文檔中有過(guò)類(lèi)似主題的內(nèi)容，但是最近我自己看文檔的時(shí)候發(fā)現(xiàn)一個(gè)問(wèn)題，文檔雖然很詳細(xì)，但是并不適合初次接觸的人。為了方便第一次聽(tīng)說(shuō)，第一次嘗試的開(kāi)發(fā)人員了解通用 Mapper，補(bǔ)充此文檔。

一、通用 Mapper 的用途 ?

我個(gè)人最早用 MyBatis 時(shí)，先是完全手寫(xiě)，然后用上了 MyBatis 代碼生成器（簡(jiǎn)稱(chēng)為 MBG），在使用 MBG 過(guò)程中，發(fā)現(xiàn)一個(gè)很麻煩的問(wèn)題，如果數(shù)據(jù)庫(kù)字段變化很頻繁，就需要反復(fù)重新生成代碼，并且由于 MBG 覆蓋生成代碼和追加方式生成 XML，導(dǎo)致每次重新生成都需要大量的比對(duì)修改。除了這個(gè)問(wèn)題外，還有一個(gè)問(wèn)題，僅僅基礎(chǔ)的增刪改查等方法，就已經(jīng)產(chǎn)生了大量的 XML 內(nèi)容，還沒(méi)有添加一個(gè)自己手寫(xiě)的方法，代碼可能就已經(jīng)幾百行了，內(nèi)容多，看著比較礙事。

因?yàn)楹芏嗳硕荚谑褂?MBG，MBG 中定義了很多常用的單表方法，為了解決前面提到的問(wèn)題，也為了兼容 MBG 的方法避免項(xiàng)目重構(gòu)太多，在 MBG 的基礎(chǔ)上結(jié)合了部分 JPA 注解產(chǎn)生了通用 Mapper。通用 Mapper 可以很簡(jiǎn)單的讓你獲取基礎(chǔ)的單表方法，也很方便擴(kuò)展通用方法。使用通用 Mapper 可以極大的提高你的工作效率。

通過(guò)下面的快速入門(mén)，會(huì)讓你盡快的了解基本的用法。

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

二、快速入門(mén)

為了讓你更快速的了解通用 Mapper 的優(yōu)勢(shì)，這里會(huì)更簡(jiǎn)潔的讓你了解整個(gè)過(guò)程。

首先在 Maven 項(xiàng)目的 pom.xml 中添加通用 Mapper 依賴(lài)：

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

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

接下來(lái)，開(kāi)始具體的使用。

1. 配置實(shí)體類(lèi)

通過(guò) MBG 配合 專(zhuān)用代碼生成器 可以直接生成實(shí)體類(lèi)等基礎(chǔ)代碼，為了避免信息量過(guò)大，這里當(dāng)作手工編寫(xiě)和配置。

有如下類(lèi)：

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 方法

}

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

該類(lèi)對(duì)應(yīng)數(shù)據(jù)表為 country，因?yàn)轭?lèi)名和數(shù)據(jù)庫(kù)名對(duì)應(yīng)（當(dāng)前數(shù)據(jù)庫(kù)忽略大小寫(xiě)），因此不需要在類(lèi)上添加 @Table(name = "country")。

經(jīng)過(guò)上面簡(jiǎn)單的配置后，相當(dāng)于就有了 MyBatis 中的 <resultMap> 關(guān)系映射了，特別注意，這個(gè)映射關(guān)系只對(duì)通用 Mapper 有效，自己手寫(xiě)方法時(shí)，需要自己處理映射關(guān)系。

這部分的詳細(xì)內(nèi)容參考文檔：對(duì)象關(guān)系映射

2. 創(chuàng)建 Mapper 接口

根據(jù)上述實(shí)體類(lèi)，創(chuàng)建對(duì)應(yīng)的 CountryMapper 接口如下：

import tk.mybatis.mapper.common.Mapper;

public interface CountryMapper extends Mapper<Country> {

}

這里繼承了 tk.mybatis.mapper.common.Mapper 接口，在接口上指定了泛型類(lèi)型 Country。當(dāng)你繼承了 Mapper 接口后，此時(shí)就已經(jīng)有了針對(duì) Country 的大量方法，方法如下：

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

3. 配置通用 Mapper

為了讓上述方法可以直接使用，還需要配置通用 Mapper，讓項(xiàng)目在啟動(dòng)的時(shí)候，把上述方法都自動(dòng)生成好，這樣在運(yùn)行時(shí)就可以使用上面所有的方法。

根據(jù)不同的開(kāi)發(fā)環(huán)境，需要不同的配置方式，完整的內(nèi)容可以 集成通用 Mapper，我們這里以最常見(jiàn)的 Spring 和 MyBatis 集成為例。

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

注意官方的包名和這里 tk 包名的區(qū)別：

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

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

此時(shí)通用 Mapper 最簡(jiǎn)單的配置就完成了，完整的配置可以看這里 和 Spring 集成。

4. 簡(jiǎn)單使用

下面是一個(gè)簡(jiǎn)單的測(cè)試用例，實(shí)際使用中，可以直接注入 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()); }

}

該測(cè)試完整地址：Spring 集成測(cè)試用例

通用 Mapper 只是提供了基礎(chǔ)的大量方法，遇到?jīng)]有的方法時(shí)，你可以正常按照 MyBatis 的用法手寫(xiě)，和正常用法沒(méi)有任何區(qū)別。

5. 了解更多

上面的簡(jiǎn)單的介紹已經(jīng)可以應(yīng)用到真正的項(xiàng)目中了，但是有很多細(xì)節(jié)這里都沒(méi)有涉及，如果你準(zhǔn)備加入通用 Mapper，你可以先按上述內(nèi)容引入項(xiàng)目，然后通過(guò)更詳細(xì)的文檔去了解更多的細(xì)節(jié)，有很多你可能想要但是 MBG 不存在的方法，在這里都有，而且如果你想實(shí)現(xiàn)自己的通用方法，可以很輕松的進(jìn)行擴(kuò)展。

完整文檔：https://github.com/abel533/Mapper/wiki
遇到問(wèn)題提 issues: https://github.com/abel533/Mapper/issues
更多完整項(xiàng)目示例：https://mybatis.tk/samples.html
果子籃開(kāi)發(fā)架構(gòu): http://guozilan.tk
MyBatis 交流：點(diǎn)擊加入 MyBatis QQ 群

三、最后問(wèn)一句

你覺(jué)得 MyBatis 需要通用 Mapper 嗎？

由于每個(gè)人對(duì)技術(shù)的掌握程度不同，對(duì)新事物的接受能力不同，因此我們都習(xí)慣于自己已經(jīng)掌握的內(nèi)容，抵制未知的能力，如果你不去試試，你能回答這個(gè)問(wèn)題嗎？

轉(zhuǎn)載： https://blog.csdn.net/isea533/article/details/83045335

總結(jié)

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

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。

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