https://blog.csdn.net/isea533/article/details/83045335
一、通用 Mapper 的用途 ?
我個人最早用 MyBatis 時，先是完全手寫赖淤，然后用上了 MyBatis 代碼生成器（簡稱為 MBG）疤坝，在使用 MBG 過程中嫁乘，發(fā)現(xiàn)一個很麻煩的問題卫漫，如果數(shù)據(jù)庫字段變化很頻繁柑爸，就需要反復重新生成代碼沛慢，并且由于 MBG 覆蓋生成代碼和追加方式生成 XML赡若，導致每次重新生成都需要大量的比對修改。除了這個問題外颠焦，還有一個問題斩熊，僅僅基礎的增刪改查等方法，就已經(jīng)產(chǎn)生了大量的 XML 內(nèi)容伐庭，還沒有添加一個自己手寫的方法粉渠，代碼可能就已經(jīng)幾百行了分冈，內(nèi)容多，看著比較礙事霸株。
因為很多人都在使用 MBG雕沉，MBG 中定義了很多常用的單表方法，為了解決前面提到的問題去件，也為了兼容 MBG 的方法避免項目重構(gòu)太多坡椒，在 MBG 的基礎上結(jié)合了部分 JPA 注解產(chǎn)生了通用 Mapper。通用 Mapper 可以很簡單的讓你獲取基礎的單表方法尤溜，也很方便擴展通用方法倔叼。使用通用 Mapper 可以極大的提高你的工作效率。
通過下面的快速入門宫莱，會讓你盡快的了解基本的用法丈攒。
通用 Mapper 誕生于 2014 年 11 月：https://blog.csdn.net/isea533/article/details/41457529
上面文章的設計思路和現(xiàn)在完全不同。
如果想要了解當前的實現(xiàn)原理授霸，可以看下面這篇巡验。
MyBatis 通用 Mapper 實現(xiàn)原理 ：https://blog.csdn.net/isea533/article/details/78493852
二、快速入門
為了讓你更快速的了解通用 Mapper 的優(yōu)勢碘耳，這里會更簡潔的讓你了解整個過程显设。
首先在 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，標記該字段為數(shù)據(jù)庫主鍵榜旦。還有一個通用 Mapper 的特殊注解 @KeySql幽七，配置的 useGeneratedKeys = true 和 MyBatis 中的 useGeneratedKeys 含義相同，意思是說使用 JDBC 的方式獲取數(shù)據(jù)庫自增的主鍵值溅呢。
該類對應數(shù)據(jù)表為 country澡屡，因為類名和數(shù)據(jù)庫名對應（當前數(shù)據(jù)庫忽略大小寫），因此不需要在類上添加 @Table(name = "country")咐旧。
經(jīng)過上面簡單的配置后驶鹉，相當于就有了 MyBatis 中的 <resultMap> 關(guān)系映射了，特別注意铣墨，這個映射關(guān)系只對通用 Mapper 有效室埋，自己手寫方法時，需要自己處理映射關(guān)系。
這部分的詳細內(nèi)容參考文檔：對象關(guān)系映射
2. 創(chuàng)建 Mapper 接口
根據(jù)上述實體類姚淆，創(chuàng)建對應的 CountryMapper 接口如下：
import tk.mybatis.mapper.common.Mapper;
public interface CountryMapper extends Mapper<Country> {
}
這里繼承了 tk.mybatis.mapper.common.Mapper 接口孕蝉，在接口上指定了泛型類型 Country。當你繼承了 Mapper 接口后腌逢，此時就已經(jīng)有了針對 Country 的大量方法降淮，方法如下：
這些方法中和 MBG 生成的大部分方法都一致，還有一部分 MBG 之外的常用方法搏讶。
3. 配置通用 Mapper
為了讓上述方法可以直接使用佳鳖，還需要配置通用 Mapper，讓項目在啟動的時候媒惕，把上述方法都自動生成好系吩，這樣在運行時就可以使用上面所有的方法。
根據(jù)不同的開發(fā)環(huán)境吓笙，需要不同的配置方式淑玫，完整的內(nèi)容可以 集成通用 Mapper巾腕，我們這里以最常見的 Spring 和 MyBatis 集成為例面睛。
在集成 Spring 的環(huán)境中使用 MyBatis 接口方式時，需要配置 MapperScannerConfigurer尊搬，在這種情況下使用通用 Mapper叁鉴，只需要修改配置如下：
<bean class="tk.mybatis.spring.mapper.MapperScannerConfigurer">
? ? <property name="basePackage" value="掃描包名"/>
? ? <!-- 其他配置 -->
</bean>
注意官方的包名和這里 tk 包名的區(qū)別：
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 只是提供了基礎的大量方法，遇到?jīng)]有的方法時弹渔，你可以正常按照 MyBatis 的用法手寫胳施，和正常用法沒有任何區(qū)別。
5. 了解更多
上面的簡單的介紹已經(jīng)可以應用到真正的項目中了肢专，但是有很多細節(jié)這里都沒有涉及舞肆，如果你準備加入通用 Mapper，你可以先按上述內(nèi)容引入項目博杖，然后通過更詳細的文檔去了解更多的細節(jié)椿胯，有很多你可能想要但是 MBG 不存在的方法，在這里都有剃根，而且如果你想實現(xiàn)自己的通用方法哩盲，可以很輕松的進行擴展。
完整文檔：https://github.com/abel533/Mapper/wiki
遇到問題提 issues: https://github.com/abel533/Mapper/issues
更多完整項目示例：https://mybatis.tk/samples.html
果子籃開發(fā)架構(gòu): http://guozilan.tk
三、最后問一句
你覺得 MyBatis 需要通用 Mapper 嗎廉油？
由于每個人對技術(shù)的掌握程度不同镣丑，對新事物的接受能力不同，因此我們都習慣于自己已經(jīng)掌握的內(nèi)容娱两，抵制未知的能力莺匠，如果你不去試試，你能回答這個問題嗎十兢？
