基于Mapper接口動態(tài)代理實現(xiàn)原理

本文作者:孔維勝,叩丁狼高級講師。原創(chuàng)文章,轉(zhuǎn)載請注明出處。

基于Mapper接口動態(tài)代理實現(xiàn)原理

看文章前的技術(shù)要求

在學(xué)習(xí)MyBatis的初級篇之前,有兩個前提要求,第一.必須學(xué)會使用IDEA,因為在文章中,使用的工具為IDEA,文章中的案例也都是基于IDEA的。第二.必須學(xué)會使用MAVEN,因為在案例中需要的jar包,都是通過MAVEN來管理的。

文章中的案例的開發(fā)環(huán)境

JDK 1.8

IDEA 2017.3

MySQL 5.1.38

Apache Maven 3.5.0

Tomcat 9.0.6

MyBatis 3.4.6

文章中的案例需要的表和數(shù)據(jù)

我們使用MyBatis的目的最終是訪問數(shù)據(jù)庫,所以在數(shù)據(jù)庫方面,我們先創(chuàng)建相應(yīng)的數(shù)據(jù)庫,表,導(dǎo)入相關(guān)的數(shù)據(jù)。如:

1.創(chuàng)建mybatis數(shù)據(jù)庫。

2.在mybatis數(shù)據(jù)庫中創(chuàng)建department(部門表)。

DROP TABLE IF EXISTS `department`;
CREATE TABLE `department` (
  `id` bigint(10) NOT NULL AUTO_INCREMENT COMMENT '部門ID',
  `name` varchar(20) DEFAULT NULL COMMENT '部門名稱',
  `sn` varchar(20) DEFAULT NULL COMMENT '部門縮寫',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=5 DEFAULT CHARSET=utf8;

3.準(zhǔn)備department(部門表相關(guān)的數(shù)據(jù))

INSERT INTO `department` VALUES (1, '人力資源', 'HR_DEPT');
INSERT INTO `department` VALUES (2, '銷售部', 'SALE_DEPT');
INSERT INTO `department` VALUES (3, '開發(fā)部', 'DEVELOP_DEPT');
INSERT INTO `department` VALUES (4, '財務(wù)部', 'FINANCE_DEPT');

案例的相關(guān)代碼

原生DAO的方式

這里就不貼代碼了,我們直接看代碼圖。如:


原生DAO的案例代碼圖.png

看源碼之前的回顧與思考

回顧:

在看這篇文章之前,我們先來回顧一下,沒有使用基于Mapper接口動態(tài)代理的方式。我們是通過采用原生DAO的方式來調(diào)用Mybatis的接口的。存在什么問題呢?我們先來看一段代碼:

@Override
public List<Department> selectAll() {
     // 獲取sqlSession對象
     SqlSession sqlSession = MyBatisUtil.openSession();
     // 執(zhí)行SQL 參數(shù)的內(nèi)容:(namespace的值 + "." + sql 的 id值)
     List<Department> empList =
               sqlSession.selectList("cn.wolfcode.mapper.DepartmentMapper.selectAll");
     // 關(guān)閉資源
     sqlSession.close();
     return empList;
    }

這是一個操作數(shù)據(jù)庫中的刪除方法。我們都知道selectList方法中的參數(shù)。參數(shù)是找到sql語句的唯一標(biāo)識(namespace + "." + sql 的 id值)。

思考:

上述的寫法,其實是存在硬編碼問題的。為何這樣講呢?我們試想一下,如果namespace 或者 sql的id的值,任何一個被修改了,那么在代碼中就要相應(yīng)的跟著修改。所以我們應(yīng)該從這里找到線索,或者突破,目的是解決存在的硬編碼的問題。

如果能讓selectList方法中的參數(shù),通過調(diào)用什么方法自動組裝起來,而不是寫死在其中,這樣解決硬編碼的思路就有了,我們可以定義一個規(guī)則,不讓用戶隨意的去填寫namespace的值 和 sql的id的值。我們把這兩個值給約束起來,編寫時很有規(guī)律可循,規(guī)定必須使用什么命名方式,這樣一來,我們就可以很容易獲取到它們。

所以我們首要解決的問題是定義什么規(guī)則,既要有規(guī)律性,還要保證唯一性。我們現(xiàn)有的有DAO接口和對應(yīng)的實現(xiàn)類。所以從現(xiàn)有資源上尋找突破口。

sql的id的值的思考:

先來說一下sql的id,我們都知道sql的id是用來區(qū)分sql語句的。在同一個映射文件中,要保證其唯一性。那么我們現(xiàn)有的資源,DAO接口就和我們的sql的id的命名要求相符合,在一個接口中,抽象方法是重復(fù)的。我們就可以利用這一點,讓方法的名稱作為sql的id,這樣也確保了在一個mapper文件中sql的id的值不會重復(fù)。

namespace值的思考:

再來說一下namespace,我一定要確保這值必須是唯一的,因為sql的id的值在整個項目中可能出現(xiàn)重復(fù)的現(xiàn)象。DAO接口中的方法名稱被我們利用上了。讓方法做了sql的id的值,那么我們還可以利用DAO接口的權(quán)限定名作為namespace的值,因為DAO接口的權(quán)限定名也是唯一的,這樣一來也是符合我們的需求的。

所以綜上所述,我們使用DAO的接口的權(quán)限定名作為namespace的值,使用接口中的方法名作為sql的id的值,這樣我們把規(guī)則制定好了。接下來就是如何獲取namespace的值和sql的id的值的問題。

獲取namespace的值和sql的id的值的問題思考:

這個獲取的問題還是很好解決的,因為我們前面學(xué)過反射技術(shù),我只要拿到DAO接口的字節(jié)碼對象,我就可以獲取對應(yīng)的權(quán)限定名和里面的方法名稱。
我們可以把獲取的操作封裝到一個方法中,調(diào)用該方法就可以獲取selectList方法中的參數(shù)。如:

public static String getParams(Class clz, String methodName) {
        // 獲取字節(jié)碼對象的權(quán)限定名
        String canonicalName = clz.getCanonicalName();
        // 拼接數(shù)據(jù)
        return canonicalName + "." + methodName;
 }

存在一個不足的地方,就是要在每次執(zhí)行selectList方法之前調(diào)用一次該方法獲取參數(shù)。

那思考以前學(xué)過的知識中,有沒有一種方式,在執(zhí)行selectList方法之前,進(jìn)行攔截。讓其真正執(zhí)行的是我的攔截的邏輯。是有的,可以使用代理對象。

在java中我們學(xué)過代理類(Proxy)。在使用這個Proxy是有個前提的,就是在java中規(guī)定,要想產(chǎn)生一個對象的代理對象,那么這個對象必須要有一個接口,而我們正好是符合要求的。所以我們可以使用代理類來完成參數(shù)的拼接。

代理類的定義:

定義一個類實現(xiàn)InvocationHandler接口。覆寫invoke方法,我們就可以在invoke方法中完成操作。

既然使用代理類,可以完成參數(shù)的拼接,那么在DAO的實現(xiàn)類中,除了參數(shù)的拼接,還有就是使用SqlSesion對象調(diào)用方法查詢數(shù)據(jù)了。那么我們何不讓代理類連查詢數(shù)據(jù)的功能都一并完成呢。 這樣我們的實現(xiàn)類都可以不用寫了。

因此最終我們讓代理對象,幫我們完成參數(shù)的拼接并訪問數(shù)據(jù)庫返回結(jié)果。所以我們需要往代理類中傳入接口的字節(jié)碼對象(為了獲取接口的權(quán)限定名)和sqlSession對象(為了調(diào)用查詢方法)。在這里我們通過構(gòu)造器傳入這兩個參數(shù)。

代碼如下:

public class MyMapperProxy<T> implements InvocationHandler {

    private Class<T> mapperInterface;
    private SqlSession sqlSession;

    public MyMapperProxy(Class<T> mapperInterface , SqlSession sqlSession){
        this.mapperInterface = mapperInterface;
        this.sqlSession = sqlSession;
    }

    //針對不同的 sql 類型,需要調(diào)用 sqlSession 不同的方法
    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
   //接口方法中的參數(shù)也有很多情況 ,這里只考慮沒有有參數(shù)的情況 
   List<T> list= sqlSession.selectList(
                mapperInterface.getCanonicalName() +"."+ method .getName());
        //返回位也有很多情況,這里不做處理直接返回
        return list;
    }
}

注意:不管外部調(diào)用調(diào)用代理對象的什么方法,最終都是調(diào)用invoke方法(這相當(dāng)于invoke方法攔截到了代理對象的方法調(diào)用)。所以我們把邏輯放入到invoke方法中。

定義了好代理類,接下來我們就可以創(chuàng)建一個我們需要的代理對象。 如:

  MyMapperProxy myMapperProxy = new MyMapperProxy(IDepartmentDAO.class,sqlSession);

下面我們就可以使用Proxy類調(diào)用newProxyInstance方法來獲取mapper的接口的代理接口。然后由代理接口去調(diào)用相應(yīng)的方法。

完整的代碼如下:

 @Test
    public void testProxy() {
        // 獲取 sqlSession
        SqlSession sqlSession = factory.openSession();
        // 創(chuàng)建代理對象
        MyMapperProxy myMapperProxy = new MyMapperProxy(IDepartmentDAO.class, sqlSession);
        // 獲取 UserMapper接口
        IDepartmentDAO instance = (IDepartmentDAO) Proxy.newProxyInstance(
                Thread.currentThread().getContextClassLoader(),// 類加載器
                new Class[]{IDepartmentDAO.class},// 接口的字節(jié)碼對象
                myMapperProxy); //自定義的代理類
        // 調(diào)用 selectAllEmployee 方法
        List<Department> departmentList = instance.selectAll();
        // 遍歷結(jié)果
        departmentList.stream().forEach(System.out::println);
    }

以上我們是通過自己的分析,自己寫了一個簡易版的處理方式。這里就不貼完整代碼了,我們直接看代碼圖。


簡易版的動態(tài)代理的案例代碼圖.png

那么我們看看MyBatis給我們提供的基于Mappper動態(tài)代理的真實調(diào)用方式是怎么樣的。

基于Mapper動態(tài)代理的方式

這里就不貼代碼了,我們直接看代碼圖。如:


Mapper動態(tài)代理的案例代碼圖.png

我們通過debug來看一下源碼執(zhí)行流程:

  • 1 . 通過sqlSession對象調(diào)用getMapper方法,傳入接口的字節(jié)碼對象。如:


    DepartmentTest.png
  • 2 . 在默認(rèn)的DefaultSqlSession類中,沒有具體的處理,而是調(diào)用了全局配置對象(configuration)中的getMapper方法,并把當(dāng)前對象(DefaultSqlSession)作為參數(shù)傳入getMapper方法中。如:


    DefaultSqlSession.png
  • 3 . 在全局配置對象(configuration)中,并沒有處理方法,而是交給了mapper的注冊對象(mapperRegistry)去處理。如:


    Configuration.png
  • 4 . 回憶之前在解析mapper的映射文件時,定義一個map容器(knownMappers),把接口的字節(jié)碼對象作為key,接口的代理工廠作為value。

    在mapper的注冊類(MapperRegistry)中,先取出mapper的代理工廠。通過調(diào)用newInstance方法,把sqlSession對象作為參數(shù)傳入。如:


    MapperRegistry.png
  • 5 . 把sqlSession,mapper的字節(jié)碼對象作為參數(shù),創(chuàng)建代理類對象。如:


    MapperProxyFactory.png
  • 6 . 然后把代理類對象作為參數(shù),底層通過JDK的動態(tài)代理,返回mapper的代理對象。


    MapperProxyFactory.png
  • 7 .通過調(diào)用getMapper方法返回了DepartmentMapper的代理對象。接著調(diào)用selectAll方法。如:


    DepartmentTest.png
  • 8 . 執(zhí)行selectAll方法,最終被代理類中的invoke方法攔截。條件不滿足,最終執(zhí)行execute方法。如:


    MapperProxy.png
  • 9 . 在execute方法中,先判斷方法的類型,我們這里是查詢方法,所以進(jìn)入SELECT中,然后再判斷方法的返回結(jié)果類型,我們是查詢的全部數(shù)據(jù),所以執(zhí)行executeForMany方法。如:


    MapperMethod.png
  • 10 .在這個方法中最終還是通過sqlSession對象調(diào)用selectList方法,來獲取數(shù)據(jù)。如:
    MapperMethod.png

通過分析源碼,發(fā)現(xiàn)源碼中的做法和我們最初思考的,設(shè)計的,也很類似,底層都是利用JDK的動態(tài)代理方式。接下來我們再用一個完整的流程圖來結(jié)束這篇文章。
如:


Mapper動態(tài)代理的原理分析.png

想獲取更多技術(shù)干貨,請前往叩丁狼官網(wǎng):http://www.wolfcode.cn/all_article.html

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容