mybatis如何通过接口查找对应的mapper.xml及方法执行详解

本文主要介绍的是关于mybatis通过接口查找对应mapper.xml及方法执行的相关内容，下面话不多说，来看看详细的介绍：

在使用mybatis的时候，有一种方式是

BookMapper bookMapper = SqlSession().getMapper(BookMapper.class)

获取接口，然后调用接口的方法。只要方法名和对应的mapper.xml中的id名字相同，就可以执行sql。

那么接口是如何与mapper.xml对应的呢？

首先看下，在getMapper()方法是如何操作的。

在DefaultSqlSession.Java中调用了configuration.getMapper()

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

在Configuration.java中调用了mapperRegistry.getMapper(type, sqlSession)；

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

下面重点来了，在MapperRegistry.java中实现了动态代理

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);
 }
 }

这个函数分两部分来看，首先是从map集合中获取接口代理，map集合的来源，第二部分获取代理后实例化，获取接口的方法，执行sql。

对于第一部分：集合的来源。

这个MapperRegistry.java中有个方法是addMappers();共有两个重载。

public void addMappers(String packageName, Class<?> superType) {
 ResolverUtil<Class<?>> resolverUtil = new ResolverUtil<Class<?>>();
 //通过包名，查找该包下所有的接口进行遍历，放入集合中
 resolverUtil.find(new ResolverUtil.IsA(superType), packageName);
 Set<Class<? extends Class<?>>> mapperSet = resolverUtil.getClasses();
 for (Class<?> mapperClass : mapperSet) {
  addMapper(mapperClass);
 }
 }

 //解析包名下的接口
 public void addMappers(String packageName) {
 addMappers(packageName, Object.class);
 }

往上追溯该方法的调用是在SqlSessionFactory.build();时对配置文件的解析，其中对节点mappers的解析，这里先不赘述，

mapperElement(root.evalNode("mappers"));

private void mapperElement(XNode parent) throws Exception {
 if (parent != null) {
  for (XNode child : parent.getChildren()) {
  //使用package节点进行解析配置
  if ("package".equals(child.getName())) {
   String mapperPackage = child.getStringAttribute("name");
   //注册包下的接口
   configuration.addMappers(mapperPackage);
  } else {
  //使用mapper节点
   String resource = child.getStringAttribute("resource");
   String url = child.getStringAttribute("url");
   String mapperClass = child.getStringAttribute("class");
   if (resource != null && url == null && mapperClass == null) {
   ErrorContext.instance().resource(resource);
   InputStream inputStream = Resources.getResourceAsStream(resource);
   XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, resource, configuration.getSqlFragments());
   mapperParser.parse();
   } else if (resource == null && url != null && mapperClass == null) {
   ErrorContext.instance().resource(url);
   InputStream inputStream = Resources.getUrlAsStream(url);
   XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, url, configuration.getSqlFragments());
   mapperParser.parse();
   } else if (resource == null && url == null && mapperClass != null) {
   Class<?> mapperInterface = Resources.classForName(mapperClass);
   configuration.addMapper(mapperInterface);
   } else {
   throw new BuilderException("A mapper element may only specify a url, resource or class, but not more than one.");
   }
  }
  }
 }
 }

这是调用addMapper()的顺序。

同时在改方法中还有一个方法很重要

 public <T> void addMapper(Class<T> type) {
 if (type.isInterface()) {
  if (hasMapper(type)) {
  throw new BindingException("Type " + type + " is already known to the MapperRegistry.");
  }
  boolean loadCompleted = false;
  try {
  knownMappers.put(type, new MapperProxyFactory<T>(type));
  //根据接口名寻找同包下同名的xml或者mapper的namespace是该接口的xml
  //找到对用的xml后进行解析mapper节点里面的节点
  MapperAnnotationBuilder parser = new MapperAnnotationBuilder(config, type);
  parser.parse();
  loadCompleted = true;
  } finally {
  if (!loadCompleted) {
   knownMappers.remove(type);
  }
  }
 }
 }

这是通过接口的全路径来查找对应的xml。这里有两种方式解析，也就是我们平常xml文件放置位置的两种写法。

第一种是不加namespace，把xml文件放在和接口相同的路径下，同时xml的名字与接口名字相同，如接口名为Student.java，xml文件为Student.xml。在相同的包下。这种当时可以不加namespace.

第二种是加namespace,通过namespace来查找对应的xml.

到这就是接口名和xml的全部注册流程。

下面再说下第二部分就是通过动态代理获取接口名字来对应xml中的id。

主要有两个类MapperProxyFactory.java和MapperProxy.java

对于MapperProxyFactory.java

public class MapperProxyFactory<T> {

 private final Class<T> mapperInterface;
 private Map<Method, MapperMethod> methodCache = new ConcurrentHashMap<Method, MapperMethod>();
 //构造函数，获取接口类
 public MapperProxyFactory(Class<T> mapperInterface) {
 this.mapperInterface = mapperInterface;
 }

 public Class<T> getMapperInterface() {
 return mapperInterface;
 }

 public Map<Method, MapperMethod> getMethodCache() {
 return methodCache;
 }

 @SuppressWarnings("unchecked")
 protected T newInstance(MapperProxy<T> mapperProxy) {
 return (T) Proxy.newProxyInstance(mapperInterface.getClassLoader(), new Class[] { mapperInterface }, mapperProxy);
 }
//供外部调用
 public T newInstance(SqlSession sqlSession) {
 final MapperProxy<T> mapperProxy = new MapperProxy<T>(sqlSession, mapperInterface, methodCache);
 return newInstance(mapperProxy);
 }

}

在MapperProxy.java中进行方法的执行

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);
 }

 private MapperMethod cachedMapperMethod(Method method) {
 MapperMethod mapperMethod = methodCache.get(method);
 if (mapperMethod == null) {
  mapperMethod = new MapperMethod(mapperInterface, method, sqlSession.getConfiguration());
  methodCache.put(method, mapperMethod);
 }
 return mapperMethod;
 }

至此，就是mybatis所有接口和xml的加载，以及通过动态代理来进行接口的执行的过程。

总结

以上就是这篇文章的全部内容，希望本文的内容对大家的学习或者工作能带来一定的帮助，如果有疑问大家可以留言交流，谢谢大家对的支持。

# mybatis  # mapper.xml  # mapper接口  # mybatis的mapper.xml  # 详解Mybatis通用Mapper介绍与使用  # Java的MyBatis框架中对数据库进行动态SQL查询的教程  # MyBatis 执行动态 SQL语句详解  # mybatis mapper.xml中如何根据数据库类型选择对应SQL语句  # 这是  # 不加  # 第二部分  # 的是  # 是在  # 来了  # 放在  # 有个  # 相关内容  # 这就是  # 两种  # 有一种  # 遍历  # 是从  # 很重要  # 还有一个  # 来看看  # 这篇文章  # 有两种  # 谢谢大家 

相关文章： 定制建站是什么？如何实现个性化需求？  威客平台建站流程解析：高效搭建教程与设计优化方案  如何用PHP工具快速搭建高效网站？  如何通过虚拟主机快速搭建个人网站？  如何在局域网内绑定自建网站域名？  如何解决VPS建站LNMP环境配置常见问题？  商务网站制作工程师,从哪几个方面把握电子商务网站主页和页面的特色设计？  南京做网站制作公司,南京哈发网络有限公司，公司怎么样，做网页美工DIV+CSS待遇怎么样？  车管所网站制作流程,交警当场开简易程序处罚决定书，在交警网站查询不到怎么办？  nginx修改上传文件大小限制的方法  品牌网站制作公司有哪些,买正品品牌一般去哪个网站买？  专业型网站制作公司有哪些,我设计专业的，谁给推荐几个设计师兼职类的网站？  如何在香港服务器上快速搭建免备案网站？  青岛网站设计制作公司,查询青岛招聘信息的网站有哪些？  企业宣传片制作网站有哪些,传媒公司怎么找企业宣传片项目？  外贸公司网站制作哪家好,maersk船公司官网？  如何通过NAT技术实现内网高效建站？  c# await 一个已经完成的Task会发生什么  股票网站制作软件,网上股票怎么开户？  如何在万网ECS上快速搭建专属网站？  如何快速重置建站主机并恢复默认配置？  如何在阿里云ECS服务器部署织梦CMS网站？  建站之星如何通过成品分离优化网站效率？  教学网站制作软件,学习*后期制作的网站有哪些？  C++中的Pimpl idiom是什么，有什么好处？（隐藏实现）  武汉网站设计制作公司,武汉有哪些比较大的同城网站或论坛，就是里面都是武汉人的？  如何用好域名打造高点击率的自主建站？  网站制作软件免费下载安装,有哪些免费下载的软件网站？  招商网站制作流程,网站招商广告语？  如何在IIS服务器上快速部署高效网站？  深入理解Android中的xmlns:tools属性  如何在Windows 2008云服务器安全搭建网站？  如何选择香港主机高效搭建外贸独立站？  昆明网站制作哪家好,昆明公租房申请网上登录入口？  网站图片在线制作软件,怎么在图片上做链接？  建站主机如何选？高性价比方案全解析  外贸公司网站制作,外贸网站建设一般有哪些步骤？  如何在Mac上搭建Golang开发环境_使用Homebrew安装和管理Go版本  建站之星北京办公室：智能建站系统与小程序生成方案解析  如何选择高效响应式自助建站源码系统？  怎么用手机制作网站链接,dw怎么把手机适应页面变成网页？  网站制作外包价格怎么算,招聘网站上写的“外包”是什么意思？  C#怎么使用委托和事件 C# delegate与event编程方法  建站之星IIS配置教程：代码生成技巧与站点搭建指南  公司网站设计制作厂家,怎么创建自己的一个网站？  如何通过.red域名打造高辨识度品牌网站？  如何在建站宝盒中设置产品搜索功能？  独立制作一个网站多少钱,建立网站需要花多少钱？  网页设计网站制作软件,microsoft office哪个可以创建网页？  制作宣传网站的软件,小红书可以宣传网站吗？