为啥mybatis的mapper只有接口没有实现类，但它却能工作？

吕一明 MarkerHub 2022-11-04

说起mybatis，大伙应该都用过，有些人甚至底层源码都看过了。在mybatis中，mapper接口是没有实现类的，取而代之的是一个xml文件。也就是说我们调用mapper接口，其实是使用了mapper.xml中定义sql完成数据操作。

大家有没想过，为什么mapper没有实现类，它是如何和xml关联起来的？

一个简单的例子

ok，别急，现在我们已经抛出问题，现在我们从demo开始，再结合我们所拥有的知识点出发，一一剖析整个过程。

先来搞个简单的查询：

UserMapper一个接口：

User findById(Long id);

userMapper.xml的sql语句

<mappernamespace="com.lfq.UserMapper">
<selectid="findById"resultType="com.lfq.User">
select * * from user where id = #{id}
</select>
</mapper>

猜想

我们知道，接口是不直接被初始化的，但是可以被实现，所以new对象的时候是初始化实现类，然后接口再引用该对象。那么调用接口的方法实际上就是调用被引用对象的方法，也就是实现类的方法。

那么，UserMapper.findById被调用时候，不禁有这两个疑问？

被引用的对象是谁呢？
接口被调用时候发生了什么？

我们先来回答第二个问题，既然找不到实现类，UserMapper有没可能被代理起来呢，findById方法调用时候，我们找到代理对象来执行就行了。

代理有两种方式：

静态代理
动态代理

而静态代理基本是不可能的了，静态代理需要对UserMapper所有的方法进行重写。那么只能是动态代理，动态代理接口的所有方法，每次接口被调用，就会进入动态代理对象的invoke方法，然后加载xml中的sql完成操作数据库，再返回结果。

再然后说到动态代理，常见的方式有以下2种方式：

JDK动态代理：
利用反射机制生成一个实现代理接口的匿名类，在调用具体方法前调用InvokeHandler来处理。
CGlib动态代理：
利用ASM（开源的Java字节码编辑库，操作字节码）开源包，将代理对象类的class文件加载进来，通过修改其字节码生成子类来处理。

所以，动态代理代理还是对象类，那么我们只有接口，不能new，哪来的对象呢？别忘了，我们还有反射机制，我们是不是可以通过反射给接口生成对象，还记得Class.*forName*吗。

综合上面的猜想：

第一步：通过反射机制给接口生成对象

第二步：动态代理反射对象，这样接口被调用，就会触发动态代理

嗯，好像有点道理，我果然是个天才！

知识点：动态代理

动态代理有几种实现方式，这里我们就先讲JDK动态代理，使用步骤如下：

新建一个接口
创建代理类，实现java.lang.reflect.InvocationHandler接口
接口测试

接口我们就用UserMapper，我们来写个代理对象。

publicclassTest{
// 接口
staticinterfaceSubject{
void sayHi();
void sayHello();
}
// 默认实现类（我们可以反射生成）
staticclassSubjectImplimplementsSubject{
@Override
publicvoid sayHi() {
System.out.println("hi");
}
@Override
publicvoid sayHello() {
System.out.println("hello");
}
}
// jkd动态代理
// 原创：公众号：java思维导图
staticclassProxyInvocationHandlerimplementsInvocationHandler{
privateSubject target;
publicProxyInvocationHandler(Subject target) {
this.target=target;
}
@Override
publicObject invoke(Object proxy, Method method, Object[] args) throwsThrowable{
System.out.print("say:");
return method.invoke(target, args);
}
}
publicstaticvoid main(String[] args) {
Subject subject=newSubjectImpl();
Subject subjectProxy=(Subject) Proxy.newProxyInstance(subject.getClass().getClassLoader(), subject.getClass().getInterfaces(), newProxyInvocationHandler(subject));
subjectProxy.sayHi();
subjectProxy.sayHello();
}
}

ok，一个简单的动态代理例子送给你们，上面代码中关键生成动态代理对象的关键代码是：

Proxy.newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler h);

loader: 用哪个类加载器去加载代理对象
interfaces:动态代理类需要实现的接口
h:动态代理方法在执行时，会调用h里面的invoke方法去执行

源码分析

好啦，上面该做的准备已经都准备好了，我们对mybatis的这个mapper接口大概都有些思路了，下面我们去正式验证一下，那么肯定就要去看源码了。我们只是去验证上面的mapper接口问题，所以不需要去看全部的代码，当然如果你看整个流程下来的话，会更加清晰。

论证猜想，我们可以采用结果导向的方式去看源码，从获取mapper那里开始看，也就是

SqlSession sqlSession = sqlSessionFactory.openSession();
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);

主要从sqlSession.getMapper(UserMapper.class);这里开始，先看整个UserMapper是不是被动态代理的。ok，我们进入代码中：

org.apache.ibatis.session.SqlSessionManager#getMapper

@Override
public<T> T getMapper(Class<T> type) {
return getConfiguration().getMapper(type, this);
}

继续走到Configuration方法里，Configuration是mybatis所有配置相关的地方，mybatis-cfg.xml、UserMapper.xml等文件都会被预先加载到Configuration里。

org.apache.ibatis.session.Configuration#getMapper

public<T> T getMapper(Class<T> type, SqlSession sqlSession) {
return mapperRegistry.getMapper(type, sqlSession);
}

这时候，我们发现Configuration里面出现了一个mapperRegistry，翻译过来可以理解为mapper的注册器，其实在加载UserMapper.xml的时候，我们就需要在mapperRegistry里面进行注册，所有，我们可以从这里面进行获取。继续走~

org.apache.ibatis.binding.MapperRegistry#getMapper

public<T> T getMapper(Class<T> type, SqlSession sqlSession) {
//获取mapper代理工厂
// 原创：公众号：java思维导图
finalMapperProxyFactory<T> mapperProxyFactory = (MapperProxyFactory<T>) knownMappers.get(type);
if(mapperProxyFactory == null) {
thrownewBindingException("Type "+ type + " is not known to the MapperRegistry.");
}
try{
return mapperProxyFactory.newInstance(sqlSession);
} catch(Exception e) {
thrownewBindingException("Error getting mapper instance. Cause: "+ e, e);
}
}

ok，这里分为了两步：

knownMappers.get(type);
获取已知的加载过的mapper中获取出mapper代理工厂
mapperProxyFactory.newInstance(sqlSession);
代理工厂生成动态代理返回

我们一步步分析，别急，knownMappers其实是个map，根据userMapper.class获取MapperProxyFactory：

Map<Class<?>, MapperProxyFactory<?>> knownMappers

所以knownMappers必然是源码前面的步骤中set进去的。我们先找找，到底是哪里set进去的。找呀找，找到这里：

org.apache.ibatis.builder.xml.XMLMapperBuilder#bindMapperForNamespace

privatevoid bindMapperForNamespace() {
Stringnamespace= builderAssistant.getCurrentNamespace();
if(namespace!= null) {
Class<?> boundType = null;
try{
//反射生成namespace的对象
// 原创：公众号：java思维导图
boundType = Resources.classForName(namespace);
} catch(ClassNotFoundException e) {
//ignore, bound type is not required
}
if(boundType != null) {
if(!configuration.hasMapper(boundType)) {
// Spring may not know the real resource name so we set a flag
// to prevent loading again this resource from the mapper interface
// look at MapperAnnotationBuilder#loadXmlResource
configuration.addLoadedResource("namespace:"+ namespace);// namespace:com.lfq.UserMapper
configuration.addMapper(boundType);
}
}
}
}

我们看这个boundType，是通过Resources.classForName(namespace);生成的class，Resources.classForName底层其实就是调用Class.forName生成的反射对象，而参数是namespace，namespacne不正是com.lfq.UserMapper嘛：

<mappernamespace="com.lfq.UserMapper">

完美！！Class.forName（com.lfq.UserMapper）生成反射对象。论证了我们第一点猜想。生成的boundType在被configuration.addMapper(boundType)；所以就有了：

org.apache.ibatis.session.Configuration#addMapper

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

org.apache.ibatis.binding.MapperRegistry#addMapper

public<T> void addMapper(Class<T> type) {
if(type.isInterface()) {
if(hasMapper(type)) {
thrownewBindingException("Type "+ type + " is already known to the MapperRegistry.");
}
boolean loadCompleted = false;
try{
/**
* TODO 将mapper接口包装成mapper代理
* 原创：公众号：java思维导图
*/
knownMappers.put(type, newMapperProxyFactory<>(type));
//解析接口上的注解或者加载mapper配置文件生成mappedStatement（com/lfq/UserMapper.java）
MapperAnnotationBuilder parser = newMapperAnnotationBuilder(config, type);
// 开始解析
parser.parse();
// 加载完成标记
loadCompleted = true;
} finally{
if(!loadCompleted) {
knownMappers.remove(type);
}
}
}
}

上面的代码，就给我论证了这个MapperProxyFactory是哪里来的，MapperProxyFactory里面其实就一个参数mapperInterface，就是反射生成的这个对象。ok，第一个猜想已经论证完毕，接着我们看刚才说到的第二点：动态代理。

回到mapperProxyFactory.newInstance(sqlSession); 这个MapperProxyFactory就是我们刚刚new出来的，我们打开newInstance方法看看：

org.apache.ibatis.binding.MapperProxyFactory#newInstance(MapperProxy)

public T newInstance(SqlSession sqlSession) {
//MapperProxy为InvocationHandler的实现类
// 原创：公众号：java思维导图
finalMapperProxy<T> mapperProxy = newMapperProxy<>(sqlSession, mapperInterface, methodCache);
//真实生成代理
return newInstance(mapperProxy);
}
protected T newInstance(MapperProxy<T> mapperProxy) {
//采用JDK自带的Proxy代理模式生成
return(T) Proxy.newProxyInstance(mapperInterface.getClassLoader(), newClass[] { mapperInterface }, mapperProxy);
}

终于在里面看到Proxy.newProxyInstance了，好激动呀。又论证了第二点的动态代理猜想上面代码中，首先把sqlSession, mapperInterface, methodCache三个参数封装到MapperProxy中，而MapperProxy是实现了InvocationHandler接口的方法，因此动态代理被调用的时候，会进入到MapperProxy的invoke方法中。

sqlSession是必须的，因为操作数据库需要用到sqlsession。具体invoke里面的内容，我们不做多分析啦，刚兴趣的同学自己去看下源码哈。可以猜想：找到对应的sql，然后执行sql操作，哈哈哈。

总结

好啦，今天的内容就到这里啦~

如果你喜欢我的文章，欢迎关注我的公众号：MarkerHub，给我点个在看或者转发一下，万分感谢哈！

（完）

【推荐阅读】

终于有人把 Docker 讲清楚了，万字详解！

将20M文件从30秒压缩到1秒，我是如何做到的？

Spring MVC 到 Spring BOOT的简化之路

好文！必须点赞

观察｜官方通报陕西蒲城一职校学生坠亡：事发前与舍友发生口角和肢体冲突认定该生系高空坠落死亡

桐城一派｜倒在“跨年夜”的龚书记，13个字换来免职调查冤不冤？

比佟丽娅还恋爱脑，怀孕7次流产4次，目睹丈夫背叛却选择原谅

市管干部“龚书记”免职迷局

讣告！又一知名女星在家中去世，终年54岁，曾是无数人白月光…

为啥mybatis的mapper只有接口没有实现类，但它却能工作？

您可能也对以下帖子感兴趣

观察｜官方通报陕西蒲城一职校学生坠亡：事发前与舍友发生口角和肢体冲突 认定该生系高空坠落死亡

桐城一派｜倒在“跨年夜”的龚书记，13个字换来免职调查冤不冤？

比佟丽娅还恋爱脑，怀孕7次流产4次，目睹丈夫背叛却选择原谅

市管干部“龚书记”免职迷局

讣告！又一知名女星在家中去世，终年54岁，曾是无数人白月光…

生成图片，分享到微信朋友圈

为啥mybatis的mapper只有接口没有实现类，但它却能工作？

您可能也对以下帖子感兴趣

观察｜官方通报陕西蒲城一职校学生坠亡：事发前与舍友发生口角和肢体冲突认定该生系高空坠落死亡