MyBatis运行原理(三)接口式编程及创建代理对象原理分析

太过爱你忘了你带给我的痛 2022-05-30 10:22 187阅读 0赞

### 一、面向接口开发步骤 ###

1.  定义代理接口，将操作数据库的方法定义在代理接口中。
2.  在SQL 映射文件中编写SQL 语句。
3.  将SQL 映射文件注册在MyBatis 的全局配置文件中。
4.  编写测试代码。

### 二、环境准备 ###

数据库表结构：

DROP TABLE IF EXISTS `t_employee`;
    CREATE TABLE `t_employee` ( `id` int(11) NOT NULL AUTO_INCREMENT, `username` varchar(30) DEFAULT NULL, `gender` char(1) DEFAULT NULL, `email` varchar(20) DEFAULT NULL, PRIMARY KEY (`id`) ) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8;

在`pom.xml`中添加依赖：

<dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis</artifactId>
                <version>3.4.5</version>
            </dependency>
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.1.39</version>
            </dependency>
            
            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>1.2.17</version>
            </dependency>
            
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>4.12</version>
            </dependency>

项目工程目录：  
![这里写图片描述][70]

### 三、开发过程 ###

这里就不提供log4j 相关的配置信息了，有兴趣的可以自行百度搜索。

员工类`Employee`

public class Employee { 
        private Integer id;
        private String username;
        private Character gender;
        private String email;
    
        /** 省略get 、set与toString 方法 */
    }

接口`EmployeeMapper`

public interface EmployeeMapper { 
    
        /*** * 根据id 获取Employee 的信息 * * @param id * @return */
        Employee getEmpById(Integer id);
    }

SQL 映射文件`EmployeeMapper.xml`

<?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
    
    <mapper namespace="com.jas.mybatis.mapper.EmployeeMapper">
        <select id="getEmpById" resultType="com.jas.mybatis.bean.Employee">
            
            select * from t_employee where id = #{id}
        </select>
    </mapper>

MyBatis 全局配置文件`mybatis-config.xml`

<?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
    
    <configuration>
        <environments default="development">
            <environment id="development">
                <transactionManager type="JDBC"/>
                
                <dataSource type="POOLED">
                    <property name="driver" value="com.mysql.jdbc.Driver"/>
                    <property name="url" value="jdbc:mysql://localhost:3306/mybatis-study"/>
                    <property name="username" value="root"/>
                    <property name="password" value="1234"/>
                </dataSource>
            </environment>
        </environments>
    
        
        <mappers>
            <mapper resource="EmployeeMapper.xml"/>
        </mappers>
    </configuration>

测试代码

public class MyBatisTest {
    
        @Test
        public void helloWorld() throws Exception{
            String resource = "mybatis-config.xml";
            InputStream is = Resources.getResourceAsStream(resource);
            // 创建SqlSessionFactory 对象
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
            // 创建SqlSession 对象
            SqlSession sqlSession = sqlSessionFactory.openSession();
            // 利用sqlSession.getMapper() 方法创建EmployeeMapper 对象
            EmployeeMapper employeeMapper = sqlSession.getMapper(EmployeeMapper.class);
            // 调用EmployeeMapper 中的getEmpById() 方法获取数据库信息
            Employee employee = employeeMapper.getEmpById(2);
            // 关闭sqlSession 对象
            sqlSession.close();
            System.out.println(employee);
        }
    
    }

测试结果  
![这里写图片描述][70 1]  
不知道大家有没有一个疑问：`EmployeeMapper`不是一个接口吗，为什么可以生成一个对象呢？原因是在调用`sqlSession.getMapper()`方法时，底层利用JDK 的动态代理方式为`EmployeeMapper`接口生成了一个代理对象。在下面会进行其底层的原理分析。

关于JDK 动态代理可参考博文：[http://blog.csdn.net/codejas/article/details/79218302][http_blog.csdn.net_codejas_article_details_79218302]

### 四、为什么MyBatis要提供面向接口的开发方式 ###

到这里我们知道MyBatis 提供了面向接口方式编程，但是为什么要这么做呢？这里就要提及一些关于设计模式方面的知识。我们知道一个设计原则：面向抽象编程，其实面向接口编程就是面向抽象编程。面向抽象编程可以降低代码之间的耦合，使代码更加具有弹性，从而提高程序扩展性。

### 五、`sqlSession.getMapper()` 方法创建接口代理对象原理解析 ###

这里采用DUBUG 的方式深入MyBatis 的源码内部去探索`sqlSession.getMapper(EmployeeMapper.class)`创建对象的过程。

1.执行`sqlSession.getMapper(EmployeeMapper.class)`时，调用的是`DefaultSqlSession`中的`getMapper(Class<T> type)`方法。

/** DefaultSqlSession 中的方法 */
    @Override
      public <T> T getMapper(Class<T> type) {
        return configuration.<T>getMapper(type, this);
      }

2.`DefaultSqlSession`中的`getMapper(Class<T> type)`方法调用了`Configuration`中的  
`getMapper(Class<T> type, SqlSession sqlSession)`方法。

/** Configuration 中的方法 */
    public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
        return mapperRegistry.getMapper(type, sqlSession);
      }

3.接着调用`MapperRegistry`类中的`getMapper(Class<T> type, SqlSession sqlSession)`方法，在这个方法中创建了一个`MapperProxyFactory`对象，然后调用`MapperProxyFactory` 类的`newInstance(sqlSession)`方法。

/** MapperRegistry 中的方法 */
    public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
        final MapperProxyFactory<T> mapperProxyFactory = (MapperProxyFactory<T>) knownMappers.get(type);
        if (mapperProxyFactory == null) {
          throw new BindingException("Type " + type + " is not known to the MapperRegistry.");
        }
        try {
          return mapperProxyFactory.newInstance(sqlSession);
        } catch (Exception e) {
          throw new BindingException("Error getting mapper instance. Cause: " + e, e);
        }
      }

4.下面是在`MapperProxyFactory` 类中关于`newInstance(sqlSession)`方法的调用过程，在这个方法中首先创建了一个`MapperProxy<T>`对象。

/** MapperProxyFactory 中的方法 */
    public T newInstance(SqlSession sqlSession) {
        final MapperProxy<T> mapperProxy = new MapperProxy<T>(sqlSession, mapperInterface, methodCache);
        return newInstance(mapperProxy);
      }

5.下面是创建`MapperProxy<T>`对象的过程，仔细看你会发现`MapperProxy<T>`类实现了`InvocationHandler`接口，这个`InvocationHandler`接口是`Proxy`的一个辅助类，用于帮助`Proxy`创建代理对象。

/** MapperProxy<T> 类的构造函数 */
    public MapperProxy(SqlSession sqlSession, Class<T> mapperInterface, Map<Method, MapperMethod> methodCache) {
        this.sqlSession = sqlSession;
        this.mapperInterface = mapperInterface;
        this.methodCache = methodCache;
      }

6.创建完`MapperProxy<T>`对象后，接着调用`MapperProxyFactory`自身类中的另一个`newInstance(MapperProxy<T> mapperProxy)`方法，在`newInstance(MapperProxy<T> mapperProxy)` 中最终完成代理类的创建。然后一步步返回，把代理对象的引用赋给`employeeMapper`。到这里`EmployeeMapper`接口的代理对象就算是创建完成了。

/** MapperProxyFactory 中的方法 */
     protected T newInstance(MapperProxy<T> mapperProxy) {
        return (T) Proxy.newProxyInstance(mapperInterface.getClassLoader(), new Class[] { mapperInterface }, mapperProxy);
      }

建议大家自己动手DEBUG 一下，只有动手了才是自己的。  
最终执行结果图：  
![这里写图片描述][70 2]  
调用过程时序图：  
![这里写图片描述][70 3]

### 六、总结 ###

这篇博客前半部分主要介绍了MyBatis 接口式编程的使用方法，后半部分对MyBatis 接口式编程创建接口代理对象的过程进行了深入探究。如果你对后半部分的调用过程不是很理解，大可不必先急于了解其中的过程，首先会使用就可以了。学习不可一蹴而就，慢慢积累，过了一段时间，你自然就会理解了。希望这篇博客可以为你提供帮助。

[70]: /images/20220530/3ca74c8691214d60aced3e43f00d75da.png
[70 1]: /images/20220530/e004fc70658c4a61ae280a3b63513316.png
[http_blog.csdn.net_codejas_article_details_79218302]: http://blog.csdn.net/codejas/article/details/79218302
[70 2]: /images/20220530/f41fa4d0cb294d8e815ecdef9293f10e.png
[70 3]: /images/20220530/857ed2cd31a5481bac222819824dbfe2.png