Mybatis源码剖析 之 Mapper代理方式

回顾下写法:

public static void main(String[] args) {
    //前三步都相同
        InputStream inputStream = Resources.getResourceAsStream("sqlMapConfig.xml");
        SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(inputStream);
        SqlSession sqlSession = factory.openSession();
    //这⾥不再调⽤SqlSession的api,⽽是获得了接⼝对象，调⽤接⼝中的⽅法。
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        List<User> list = mapper.getUserByName("tom");
    }

思考一个问题，通常的Mapper接口我们都没有实现的方法却可以使用，是为什么呢？答案很简单动态代理。

        开始之前介绍一下MyBatis初始化时对接口的处理：MapperRegistry是Configuration中的一个属性，它内部维护一个HashMap用于存放mapper接口的工厂类，每个接口对应一个工厂类。

mappers中可以配置接口的包路径，或者某个具体的接口类。

<mappers>
        <mapper class="com.lagou.mapper.UserMapper"/>
        <package name="com.lagou.mapper"/>
</mappers>

        当解析mappers标签时，它会判断解析到的是mapper配置文件时，会再将对应配置文件中的增删 改查标签 封装成MappedStatement对象，存入mappedStatements中。(上文介绍了)当判断解析到接口时，会建此接口对应的MapperProxyFactory对象，存入HashMap中，key =接口的字节码对象，value =此接口对应的MapperProxyFactory对象。 

1、getmapper() 

进入 sqlSession.getMapper(UserMapper.class )中

    //DefaultSqlSession 中的 getMapper
    public <T> T getMapper(Class<T> type) {
        return configuration.<T>getMapper(type, this);
    }
    //configuration 中的给 g etMapper
    public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
        return mapperRegistry.getMapper(type, sqlSession);
    }
    //MapperRegistry 中的 g etMapper
    public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
//从 MapperRegistry 中的 HashMap 中拿 MapperProxyFactory
        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);
        }
    }
    //MapperProxyFactory 类中的 newInstance ⽅法
    public T newInstance(SqlSession sqlSession) {
    //创建了 JDK动态代理的Handler类
        final MapperProxy<T> mapperProxy = new MapperProxy<>(sqlSession, mapperInterface, methodCache);
    //调⽤了重载⽅法
        return newInstance(mapperProxy);
    }
    //MapperProxy 类，实现了 InvocationHandler 接⼝
    public class MapperProxy<T> implements InvocationHandler, Serializable {
        //省略部分源码
        private final SqlSession sqlSession;
        private final Class<T> mapperInterface;
        private final Map<Method, MapperMethod> methodCache;
        //构造，传⼊了 SqlSession，说明每个session中的代理对象的不同的！
        public MapperProxy(SqlSession sqlSession, Class<T> mapperInterface, Map<Method, MapperMethod> methodCache) {
            this.sqlSession = sqlSession;
            this.mapperInterface = mapperInterface;
            this.methodCache = methodCache;
        }
//省略部分源码
    }

2、invoke()

        在动态代理返回了示例后，我们就可以直接调用mapper类中的方法了，但代理对象调用方法，执行是在MapperProxy中的invoke方法中

    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        try {
            //如果是Object定义的⽅法，直接调⽤
            if (Object.class.equals(method.getDeclaringClass())) {
                return method.invoke(this, args);
            } else if (isDefaultMethod(method)) {
                return invokeDefaultMethod(proxy, method, args);
            }
        } catch (Throwable t) {
            throw ExceptionUtil.unwrapThrowable(t);
        }
        // 获得 MapperMethod 对象
        final MapperMethod mapperMethod = cachedMapperMethod(method);
        //重点在这：MapperMethod最终调⽤了执⾏的⽅法
        return mapperMethod.execute(sqlSession, args);
    }

进入execute方法：

 public Object execute(SqlSession sqlSession, Object[] args) {
        Object result;
        //判断mapper中的⽅法类型，最终调⽤的还是SqlSession中的⽅法 switch
        (command.getType()) {
            case INSERT: {
                //转换参数
                Object param = method.convertArgsToSqlCommandParam(args);
                //执⾏INSERT操作
                // 转换 rowCount
                result = rowCountResult(sqlSession.insert(command.getName(), param));
                break;
            }
            case UPDATE: {
                //转换参数
                Object param = method.convertArgsToSqlCommandParam(args);
                // 转换 rowCount
                result = rowCountResult(sqlSession.update(command.getName(), param));
                break;
            }
            case DELETE: {
                //转换参数
                Object param = method.convertArgsToSqlCommandParam(args);
                // 转换 rowCount
                result = rowCountResult(sqlSession.delete(command.getName(), param));
                break;
            }
            case SELECT:
                //⽆返回，并且有ResultHandler⽅法参数，则将查询的结果，提交给 ResultHandler 进⾏处理
                if (method.returnsVoid() && method.hasResultHandler()) {
                    executeWithResultHandler(sqlSession, args);
                    result = null;
                    //执⾏查询，返回列表
                } else if (method.returnsMany()) {
                    result = executeForMany(sqlSession, args);
                    //执⾏查询，返回Map
                } else if (method.returnsMap()) {
                    result = executeForMap(sqlSession, args);
                    //执⾏查询，返回Cursor
                } else if (method.returnsCursor()) {
                    result = executeForCursor(sqlSession, args);
                    //执⾏查询，返回单个对象
                } else {
                    //转换参数
                    Object param = method.convertArgsToSqlCommandParam(args);
                    //查询单条
                    result = sqlSession.selectOne(command.getName(), param);
                    if (method.returnsOptional() &&
                            (result == null || !method.getReturnType().equals(result.getClass()))) {
                        result = Optional.ofNullable(result);
                    }
                }
                break;
            case FLUSH:
                result = sqlSession.flushStatements();
                break;
            default:
                throw new BindingException("Unknown execution method for: " + command.getName());
        }
        //返回结果为null，并且返回类型为基本类型，则抛出BindingException异常
        if(result ==null&&method.getReturnType().isPrimitive() &&!method.returnsVoid()){
            throw new BindingException("Mapper method '" + command.getName() + "attempted to return null from a method with a primitive return type(" + method.getReturnType() + "). ");
        }
        //返回结果
        return result;
    }