Mybatis Mapper接口工作原理實例解析

KeyWords: Mybatis 原理，源碼，Mybatis Mapper 接口實現類，代理模式，動態代理，Java動態代理，

Proxy.newProxyInstance，Mapper 映射，Mapper 實現

MyBatis 是一款優秀的持久層框架，它支持定制化 SQL、存儲過程以及高級映射。MyBatis 避免了幾乎所有的 JDBC 代碼和手動設置參數以及獲取結果集。我們在使用 Mybaits 進行 ，通常只需要定義幾個 Mapper 接口，然后在編寫一個 xml 文件，我們在配置文件中寫好 sql , Mybatis 幫我們完成 Mapper 接口道具體實現的調用。以及將結果映射到 model bean 中。

我們在項目中所編寫的眾多的 Mapper 類只是一個接口(interface )，根據 Java 的多態性我們知道，可以使用接口接口作為形參，進而在運行時確定具體實現的對象是什么。但是，對于 Mapper 接口，我們并沒有編寫其實現類！Mybatis是如何找到其實現類，進而完成具體的 CRUD 方法調用的呢？原理何在？

Mapper 接口是怎么找到實現類的

為了弄清楚 Mapper 接口是如何找到實現類的，我們先回憶一下 Mybatis 是怎么使用的，根據實際的例子，進而一點點的去分析。這里的使用指的是Mybatis 單獨使用，而不是整合 spring , 因為整合 spring 的話，還需要涉及 Mapper dao 裝載到 spring 容器的問題，spring 幫忙創建數據源配置等問題。

通常我們使用 Mybatis 的主要步驟是：

構建 SqlSessionFactory ( 通過 xml 配置文件 , 或者直接編寫Java代碼) 從 SqlSessionFactory 中獲取 SqlSession 從SqlSession 中獲取 Mapper 調用 Mapper 的方法 ，例如：blogMapper.selectBlog(int blogId)

從一段代碼看起

上面我們概括了使用 Mybatis 的4個步驟。這4個步驟看起來很簡單，但是用代碼寫出來就很多。我們不妨先記著這4個步驟，再去看代碼，會容易點。

// 1. DataSource dataSource = BlogDataSourceFactory.getBlogDataSource();TransactionFactory transactionFactory = new JdbcTransactionFactory();Environment environment = new Environment('development', transactionFactory, dataSource);Configuration configuration = new Configuration(environment);configuration.addMapper(BlogMapper.class);// 添加Mapper接口SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);// 2. SqlSession session = sqlSessionFactory.openSession();try { // 3. BlogMapper mapper = session.getMapper(BlogMapper.class); // 4. Blog blog = mapper.selectBlog(1);} finally { session.close();}

在這塊代碼中，第 1 部分我們使用了 Java 編碼的形式來實現 SqlSessionFactory ，也可以使用 xml 。如果使用xml的話，上面的第一部分代碼就是這樣的：

String resource = 'org/mybatis/example/mybatis-config.xml'; // xml內容就不貼了InputStream inputStream = Resources.getResourceAsStream(resource);SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

我們本次的目標是弄清楚 “ Mapper 是如何找到實現類的 ”，我們注意上面代碼 3 , 4 的位置：

// 3. BlogMapper mapper = session.getMapper(BlogMapper.class); // 4. Blog blog = mapper.selectBlog(1);

這里 mapper 可以調用selectBlog(1) 這個方法，說明 mapper 是個對象，因為對象才具有方法行為實現啊。BlogMapper接口是不能實例化的，更沒有具體方法實現。我們并沒有定義一個類，讓它實現BlogMapper接口，而在這里它只是通過調用session.getMapper() 所得到的。由此，我們可以推斷：肯定是session.getMapper() 方法內部產生了BlogMapper的實現類。有什么技術可以根據BlogMapper 接口生成了一個實現類呢？想到這里，對于有動態代理 使用經驗的程序員來說，很容易想到，這背后肯定是基于動態代理技術，具體怎么實現的呢？下面我們來根據源碼一探究竟。

Mapper 接口的注冊

從上面的代碼中，我們知道 BlogMapper 接口的實現類是從session.getMapper中得來的，大概是基于動態代理技術實現。我們既然能夠從SqlSession中得到BlogMapper接口的，那么我們肯定需要先在哪里把它放進去了，然后 SqlSession 才能生成我們想要的代理類啊。上面代碼中有這么一行：

configuration.addMapper(BlogMapper.class);

跟著這個 addMapper 方法的代碼實現是這樣的：

public <T> void addMapper(Class<T> type) { mapperRegistry.addMapper(type); }

我們看到這里 mapper