MyBatis的通俗理解:SqlSession.getMapper()源碼解讀
什么是 MyBatis？
直接看官方文檔：https://mybatis.org/mybatis-3/zh/index.html
從上面我們了解到：
1、MyBatis 是一款優(yōu)秀的持久層框架
2、MyBatis 避免了幾乎所有的 JDBC 代碼和手動設置參數(shù)以及獲取結(jié)果集。
原理解析
1、程序員和Mybatis 和數(shù)據(jù)的關系：人通過mybatis框架來操作數(shù)據(jù)庫。
2、思考問題并解決
問題1：首先我們必須告訴MyBatis要怎么操作數(shù)據(jù)庫？
我們把可以通過XML配置文件或者注解的方式，MyBatis提供了一個類Configuration， Mybatis 讀取XML配置文件后會將內(nèi)容放在一個Configuration類中，Configuration類會存在整個Mybatis生命周期，以便重復讀取。
問題2：想要Mybatis與數(shù)據(jù)庫打交道，就要有一個類似于JDBC的Connection對象，在MyBatis中叫SqlSesion，所以我們要有一個SqlSession。
Mybatis 讀取XML配置文件后會將內(nèi)容放在一個Configuration類中，SqlSessionFactoryBuilder會讀取Configuration類中信息創(chuàng)建SqlSessionFactory。SqlSessionFactory創(chuàng)建SqlSession。
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
SqlSession sqlSession=null;
try{
sqlSession=sqlSessionFactory.openSession();
//some code
sqlSession.commit();
} catch(Exception ex){
sqlSession.roolback();
} finally{
if(sqlSession!=null){
sqlSession.close();
}
}關于SqlSessionFactory的創(chuàng)建，Mybatis采用構造模式來完成創(chuàng)建。
- 第一步：XMLConfigBuilder解析XML配置，讀出配置參數(shù)，存入Configuration類中。
- 第二步：Configuration類創(chuàng)建SqlSessionFactory。（DefaultSqlSessionFactory的構造函數(shù)傳入Configuration類）
深入了解：SqlSessionFactoryBuilder.builder（inputStream）
//該方法.builder中的主要內(nèi)容：
XMLConfigBuilder parser = new XMLConfigBuilder(reader, environment, properties);
SqlSessionFactory localSqlSessionFactory = build(parser.parse());
//build(parser.parse())方法實則為：
public SqlSessionFactory build(Configuration config) {
return new DefaultSqlSessionFactory(config);
}問題3：SqlSession能干什么？
SqlSession用途主要有兩種
①. 獲取對應的Mapper，讓映射器通過命名空間和方法名稱找到對應的SQL，發(fā)送給數(shù)據(jù)庫執(zhí)行后返回結(jié)果。
RoleMapper roleMapper = sqlSession.getMapper(RoleMapper.class); Role role = roleMapper.getRole(1L);
②. 直接使用SqlSession，通過命名信息去執(zhí)行SQL返回結(jié)果，該方式是IBatis版本留下的，SqlSession通過Update、Select、Insert、Delete等方法操作。
Role role = (Role)sqlSession.select("com.mybatis.mapper.RoleMapper.getRole",1L);Mybatis底層利用JDK動態(tài)代理技術實現(xiàn)該接口，底層最后還是使用的IBatis中SqlSession通過Update、Select、Insert、Delete等方法操作。
問題4：上面說到Mybatis底層利用JDK動態(tài)代理技術實現(xiàn)該接口，但是我們在使用MyBatis的時候，都是只寫接口不用寫實現(xiàn)類，為什么呢？
為什么要使用動態(tài)代理？可以在不修改別代理對象代碼的基礎上，通過擴展代理類，進行一些功能的附加與增強。
我們先看看傳統(tǒng)的JDK動態(tài)代理：
1、首先有一個接口
public interface Calculate {
void add(int i, int j);
}2、然后是接口的實現(xiàn)類
public class CalculateImp implements Calculate {
@Override
public void add(int i, int j) {
System.out.println("result = " + (i + j));
}
}3、代理類實現(xiàn)InvocationHandler
public class CalculateProxy implements InvocationHandler {
private Object target;
//總要讓我知道要代理誰吧：構造方法中把傳入一個代理類的實例
public CalculateProxy(Object target) {
this.target = target;
}
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
System.out.println("====== Before() ======");
method.invoke(target, args);
System.out.println("====== After () ======");
return null;
}
}4、拿到代理對象，操作接口方法
public class test {
public static void main(String[] args) {
InvocationHandler handler = new CalculateProxy(new CalculateImp());
Calculate calculateProxy =
(Calculate) Proxy.newProxyInstance(Calculate.class.getClassLoader(),
new Class[]{Calculate.class},
handler);
calculateProxy.add(10,20);
}
}Proxy.newProxyInstance()方法有三個參數(shù)：
1. 類加載器(Class Loader)
2. 需要實現(xiàn)的接口數(shù)組
3. InvocationHandler接口。所有動態(tài)代理類的方法調(diào)用，都會交由InvocationHandler接口實現(xiàn)類里的invoke()方法去處理。這是動態(tài)代理的關鍵所在。
回到我們之前的問題，我們并沒有接口實現(xiàn)類，那沒有實現(xiàn)類還為什么還能調(diào)用方法操作。其實是這樣的：
操作數(shù)據(jù)庫主要是通過SQL語句，那么只要找到SQL語句然后執(zhí)行不就可以！
通過例子分析：
BlogMapper mapper = session.getMapper(BlogMapper.class); Blog blog = mapper.selectBlog(1);
這里 mapper 可以調(diào)用selectBlog(1) 這個方法，說明 mapper 是個對象，因為對象才具有方法行為實現(xiàn)啊。BlogMapper接口是不能實例化的，更沒有具體方法實現(xiàn)。
我們并沒有定義一個類，讓它實現(xiàn)BlogMapper接口，而在這里它只是通過調(diào)用session.getMapper() 所得到的。
由此，我們可以推斷：肯定是session.getMapper() 方法內(nèi)部產(chǎn)生了BlogMapper的實現(xiàn)類。有什么技術可以根據(jù)BlogMapper 接口生成了一個實現(xiàn)類呢？想到這里，對于有動態(tài)代理 。
Mapper 接口的注冊
我們既然能夠從SqlSession中得到BlogMapper接口的，那么我們肯定需要先在哪里把它放進去了，然后 SqlSession 才能生成我們想要的代理類啊。
我們可以從getMapper()聯(lián)系，可能會有一個setMapper()或者addMapper()方法。確實是有！
configuration.addMapper(BlogMapper.class);
跟著這個 addMapper 方法的代碼實現(xiàn)是這樣的：
public <T> void addMapper(Class<T> type) {
mapperRegistry.addMapper(type);
}我們看到這里 mapper 實際上被添加到 mapperRegistry （mapper注冊器）中。繼續(xù)跟進代碼：
public class MapperRegistry {
private final Map<Class<?>, MapperProxyFactory<?>> knownMappers
= new HashMap<Class<?>, MapperProxyFactory<?>>();
public <T> void addMapper(Class<T> type) {
if (type.isInterface()) { // 只添加接口
if (hasMapper(type)) { // 不允許重復添加
throw new BindingException("Type " + type + " is already known to the MapperRegistry.");
}
boolean loadCompleted = false;
try {
knownMappers.put(type, new MapperProxyFactory<T>(type)); // 注意這里
MapperAnnotationBuilder parser = new MapperAnnotationBuilder(config, type);
parser.parse();
loadCompleted = true;
} finally {
if (!loadCompleted) {
knownMappers.remove(type);
}
}
}
}
}我們首先看到MapperRegistry類，有一個私有屬性knowMappers，它是一個HashMap 。
其Key 為當前Class對象，value 為一個MapperProxyFactory實例
在MapperRegistry類的addMapper()方法中，knownMappers.put(type, new MapperProxyFactory<T>(type));相當于把：諸如BlogMapper之類的Mapper接口被添加到了MapperRegistry 中的一個HashMap中。
并以 Mapper 接口的 Class 對象作為 Key , 以一個攜帶Mapper接口作為屬性的MapperProxyFactory實例作為value 。
MapperProxyFactory從名字來看，好像是一個工廠，用來創(chuàng)建Mapper Proxy的工廠。
上面我們已經(jīng)知道，Mapper 接口被到注冊到了MapperRegistry中——放在其名為knowMappers 的HashMap屬性中，我們在調(diào)用Mapper接口的方法的時候，是這樣的：
BlogMapper mapper = session.getMapper(BlogMapper.class);
這里，我們跟蹤一下session.getMapper() 方法的代碼實現(xiàn)，這里 SqlSession 是一個接口，他有兩個實現(xiàn)類，
一個是DefaultSqlSession,另外一個是SqlSessionManager,
這里我們用的是DefaultSqlSession. 為什么是DefaultSqlSession呢？因為我們在初始化SqlSessionFactory的時候所調(diào)用的SqlSessionFactoryBuilder的build()方法里邊配置的就是DefaultSqlSession, 所以，我們進入到DefaultSession類中，看看它對session.getMapper(BlogMapper.class)是怎么實現(xiàn)的：
public class DefaultSqlSession implements SqlSession {
private Configuration configuration;
@Override
public <T> T getMapper(Class<T> type) {
return configuration.<T>getMapper(type, this); //最后會去調(diào)用MapperRegistry.getMapper
}
}如代碼所示，這里的 getMapper 調(diào)用了 configuration.getMapper , 這一步操作其實最終是調(diào)用了MapperRegistry,而此前我們已經(jīng)知道，MapperRegistry是存放了一個HashMap的，我們繼續(xù)跟蹤進去看看，那么這里的get，肯定是從這個hashMap中取數(shù)據(jù)。
我們來看看代碼：
public class MapperRegistry {
private final Map<Class<?>, MapperProxyFactory<?>> knownMappers = new HashMap<Class<?>, MapperProxyFactory<?>>();// Mapper 映射
public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
final MapperProxyFactory<T> mapperProxyFactory =
(MapperProxyFactory<T>) knownMappers.get(type);
try {
return mapperProxyFactory.newInstance(sqlSession); // 重點看這里
} catch (Exception e) {
}
}
}我們調(diào)用的session.getMapper(BlogMapper.class);最終會到達上面這個方法，這個方法，根據(jù)BlogMapper的class對象,以它為key在knowMappers 中找到了對應的value —— MapperProxyFactory(BlogMapper) 對象，然后調(diào)用這個對象的newInstance()方法。
根據(jù)這個名字，我們就能猜到這個方法是創(chuàng)建了一個對象，代碼是這樣的：
public class MapperProxyFactory<T> { //映射器代理工廠
private final Class<T> mapperInterface;
private Map<Method, MapperMethod> methodCache = new ConcurrentHashMap<Method, MapperMethod>();
public MapperProxyFactory(Class<T> mapperInterface) {
this.mapperInterface = mapperInterface;
}
// 刪除部分代碼，便于閱讀
@SuppressWarnings("unchecked")
protected T newInstance(MapperProxy<T> mapperProxy) {
//使用了JDK自帶的動態(tài)代理生成映射器代理類的對象
return (T) Proxy.newProxyInstance(
mapperInterface.getClassLoader(),
new Class[] { mapperInterface },
mapperProxy);
}
public T newInstance(SqlSession sqlSession) {
final MapperProxy<T> mapperProxy = new MapperProxy<T>(sqlSession, mapperInterface, methodCache);
return newInstance(mapperProxy);
}
}看到這里，就清楚了，最終是通過Proxy.newProxyInstance產(chǎn)生了一個BlogMapper的代理對象。
Mybatis 為了完成 Mapper 接口的實現(xiàn)，運用了代理模式。
具體是使用了JDK動態(tài)代理，這個Proxy.newProxyInstance方法生成代理類的三個要素是：
- ClassLoader —— 指定當前接口的加載器即可
- 當前被代理的接口是什么 —— 這里就是 BlogMapper
- 代理類是什么 —— 這里就是 MapperProxy
代理模式中，代理類(MapperProxy)中才真正的完成了方法調(diào)用的邏輯。
我們貼出MapperProxy的代碼，如下：
public class MapperProxy<T> implements InvocationHandler, Serializable {// 實現(xiàn)了InvocationHandler
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
//代理以后，所有Mapper的方法調(diào)用時，都會調(diào)用這個invoke方法
if (Object.class.equals(method.getDeclaringClass())) {
try {
return method.invoke(this, args); // 注意1
} catch (Throwable t) {
throw ExceptionUtil.unwrapThrowable(t);
}
}
final MapperMethod mapperMethod = cachedMapperMethod(method); // 使用了緩存
//執(zhí)行CURD
return mapperMethod.execute(sqlSession, args); // 注意2
}
}我們調(diào)用的 Blog blog = mapper.selectBlog(1); 實際上最后是會調(diào)用這個MapperProxy的invoke方法。
這段代碼中，if 語句先判斷，我們想要調(diào)用的方法是否來自Object類，這里的意思就是，如果我們調(diào)用toString()方法，那么是不需要做代理增強的，直接還調(diào)用原來的method.invoke()就行了。
只有調(diào)用selectBlog()之類的方法的時候，才執(zhí)行增強的調(diào)用——即mapperMethod.execute(sqlSession, args);這一句代碼邏輯。
而mapperMethod.execute(sqlSession, args);這句最終就會執(zhí)行增刪改查了，代碼如下：
public Object execute(SqlSession sqlSession, Object[] args) {
Object result;
if (SqlCommandType.INSERT == command.getType()) { //insert 處理，調(diào)用SqlSession的insert
Object param = method.convertArgsToSqlCommandParam(args);
result = rowCountResult(sqlSession.insert(command.getName(), param));
} else if (SqlCommandType.UPDATE == command.getType()) { // update
Object param = method.convertArgsToSqlCommandParam(args);
result = rowCountResult(sqlSession.update(command.getName(), param));
} else if (SqlCommandType.DELETE == command.getType()) { // delete
Object param = method.convertArgsToSqlCommandParam(args);
result = rowCountResult(sqlSession.delete(command.getName(), param));
} else if (SqlCommandType.SELECT == command.getType()) {
// 刪除部分代碼
} else {
throw new BindingException("Unknown execution method for: " + command.getName());
}
// 刪除部分代碼
return result;
}再往下一層，就是執(zhí)行JDBC那一套了，獲取鏈接，執(zhí)行，得到ResultSet，解析ResultSet映射成JavaBean。
總結(jié)一下各個過程
1、Mybatis 讀取XML配置文件后會將內(nèi)容放在一個Configuration類中，SqlSessionFactoryBuilder會讀取Configuration類中信息創(chuàng)建SqlSessionFactory。
2、在初始化SqlSessionFactory時，Mapper 接口進行注冊，注冊在了名為 MapperRegistry 類的 HashMap中，key = Mapper class， value = 創(chuàng)建當前Mapper的工廠。
3、SqlSessionFactory創(chuàng)建SqlSession。
4、SqlSession中可以通過getMapper()拿到代理對象，SqlSession.getMapper 運用了 JDK動態(tài)代理，產(chǎn)生了目標Mapper接口的代理對象。
5. 動態(tài)代理的 代理類是 MapperProxy ，這里邊mapperMethod.execute(sqlSession, args)最終完成了增刪改查方法的調(diào)用。
最后
以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關文章
用Java做開發(fā)經(jīng)常需要處理圖片。本文就來看一下如何保存圖片到本地并生成縮略圖2021-05-05
這篇文章主要介紹了win10 64位 jdk1.8的方法教程詳解，本文給大家介紹的非常詳細，對大家的工作或?qū)W習具有一定的參考借鑒價值,需要的朋友可以參考下2020-03-03
這篇文章主要為大家介紹了使用FutureTask結(jié)合線程池輕松解決接口超時問題的巧妙用法,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-11-11
布隆過濾器(Bloom Filter)的Java實現(xiàn)方法
下面小編就為大家?guī)硪黄悸∵^濾器(Bloom Filter)的Java實現(xiàn)方法。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2016-12-12
Springboot2.x 使用 Log4j2 異步打印日志的實現(xiàn)
這篇文章主要介紹了Springboot2.x 使用 Log4j2 異步打印日志的實現(xiàn),文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2020-12-12
這篇文章主要介紹了Java中的"goto"語句妙用，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-11-11
Java SpringMVC框架開發(fā)之數(shù)據(jù)導出Excel文件格式實例詳解
這篇文章主要介紹了Java基礎開發(fā)之數(shù)據(jù)導出Excel文件格式實例詳解,需要的朋友可以參考下2020-02-02
《蜘蛛紙牌》(Ancient?Spider)?是由Oberon?Games開發(fā)的一款休閑益智類游戲。本文將利用Java語言實現(xiàn)這一經(jīng)典游戲，需要的可以參考一下2022-05-05
這篇文章主要介紹了SpringBoot整合Hbase的實現(xiàn)示例，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2020-12-12
外觀模式為多個復雜的子系統(tǒng)，提供了一個一致的界面，使得調(diào)用端只和這個接口發(fā)生調(diào)用，而無須關系這個子系統(tǒng)內(nèi)部的細節(jié)。本文將通過示例詳細為大家講解一下外觀模式，需要的可以參考一下2023-02-02