第二大脑

主题

2026-08-25
807
3.9m

Mybatis 接口 Mapper 内的方法为什么不能重载？ ​

Mybatis Mapper

动态代理的功能：通过拦截器方法回调，对目标 target 方法进行增强。

言外之意就是为了增强目标 target 方法。上面这句话没错，但也不要认为它就是真理，殊不知，动态代理还有投鞭断流的霸权，连目标 target 都不要的科幻模式。

1. 自定义 JDK 动态代理之投鞭断流实现自动映射器 Mapper ​

首先定义一个 pojo。

java
public class User {
    private Integer id;
    private String name;
    private int age;
    public User(Integer id, String name, int age) {
        this.id = id;
        this.name = name;
        this.age = age;
    }
    // getter setter
}

再定义一个接口 UserMapper.java。

java
public interface UserMapper {
    public User getUserById(Integer id); 
}

接下来看看如何使用动态代理之投鞭断流，实现实例化接口并调用接口方法返回数据的。

自定义一个 InvocationHandler。

java
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
public class MapperProxy implements InvocationHandler {
    @SuppressWarnings("unchecked")
    public <T> T newInstance(Class<T> clz) {
        return (T) Proxy.newProxyInstance(clz.getClassLoader(), new Class[] { clz }, this);
    }
    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        if (Object.class.equals(method.getDeclaringClass())) {
            try {
                // 诸如hashCode()、toString()、equals()等方法，将target指向当前对象this
                return method.invoke(this, args);
            } catch (Throwable t) {
            }
        }
        // 投鞭断流
        return new User((Integer) args[0], "zhangsan", 18);
    }
}

上面代码中的 target，在执行 Object.java 内的方法时，target 被指向了 this，target 已经变成了傀儡、象征、占位符。在投鞭断流式的拦截时，已经没有了 target。

写一个测试代码：

java
public static void main(String[] args) {
    MapperProxy proxy = new MapperProxy();
    UserMapper mapper = proxy.newInstance(UserMapper.class);
    User user = mapper.getUserById(1001);
    System.out.println("ID:" + user.getId());
    System.out.println("Name:" + user.getName());
    System.out.println("Age:" + user.getAge());
    System.out.println(mapper.toString());
}

output：

bash
ID:1001
Name:zhangsan
Age:18
x.y.MapperProxy@6bc7c054

这便是 Mybatis 自动映射器 Mapper 的底层实现原理。

2. Mybatis 自动映射器 Mapper 的源码分析 ​

首先编写一个测试类：

java
public static void main(String[] args) {
    SqlSession sqlSession = MybatisSqlSessionFactory.openSession();
    try {
        StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class);
        List<Student> students = studentMapper.findAllStudents();
        for (Student student : students) {
            System.out.println(student);
        }
    } finally {
        sqlSession.close();
    }
}

Mapper 长这个样子：

java
public interface StudentMapper {
    List<Student> findAllStudents();
    Student findStudentById(Integer id);
    void insertStudent(Student student);
}

org.apache.ibatis.binding.MapperProxy.java 部分源码。

java
public class MapperProxy<T> implements InvocationHandler, Serializable {
    private static final long serialVersionUID = -6424540398559729838L;
    private final SqlSession sqlSession;
    private final Class<T> mapperInterface;
    private final Map<Method, MapperMethod> methodCache;
    public MapperProxy(SqlSession sqlSession, Class<T> mapperInterface, Map<Method, MapperMethod> methodCache) {
        this.sqlSession = sqlSession;
        this.mapperInterface = mapperInterface;
        this.methodCache = methodCache;
    }
    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        if (Object.class.equals(method.getDeclaringClass())) {
            try {
                return method.invoke(this, args);
            } catch (Throwable t) {
                throw ExceptionUtil.unwrapThrowable(t);
            }
        }
        // 投鞭断流
        final MapperMethod mapperMethod = cachedMapperMethod(method);
        return mapperMethod.execute(sqlSession, args);
    }
    // ...

org.apache.ibatis.binding.MapperProxyFactory.java 部分源码。

java
public class MapperProxyFactory<T> {
    private final Class<T> mapperInterface;
    @SuppressWarnings("unchecked")
    protected T newInstance(MapperProxy<T> mapperProxy) {
        return (T) Proxy.newProxyInstance(mapperInterface.getClassLoader(), new Class[] { mapperInterface }, mapperProxy);
    }
}

这便是 Mybatis 使用动态代理之投鞭断流。

3. 接口 Mapper 内的方法能重载（overLoad）吗？（重要） ​

类似下面：

java
public User getUserById(Integer id);
public User getUserById(Integer id, String name);

答案：不能。

原因：在投鞭断流时，Mybatis 使用 package+Mapper+method 全限名作为 key，去 xml 内寻找唯一 sql 来执行的。类似：key=x.y.UserMapper.getUserById，那么，重载方法时将导致矛盾。对于 Mapper 接口，Mybatis 禁止方法重载（overLoad）。

更新: 2020-10-26 09:30:04
原文: <https://www.yuque.com/fcant/notes/mefxmx&gt;

最近更新