Spring集成第三方组件-Mybatis

一、mybatis简介

Mybaits是java语言一个ORM框架。官网介绍如下:

MyBatis 是一款优秀的持久层框架,它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO(Plain Old Java Objects,普通老式 Java 对象)为数据库中的记录。

mybatis把SQL抽离到了xml中(此处不考虑使用注解声明SQL方式,因为违背了SQL可配置的原则,不推崇),如下所示:

<?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="org.mybatis.example.BlogMapper">
  <select id="selectBlog" resultType="Blog">
    select * from Blog where id = #{id}
  </select>
</mapper>

使用时,有几种不同的方式:

1)直接通过XML中的命名空间直接通过

SqlSession session = sqlSessionFactory.openSession()
Blog blog = (Blog) session.selectOne("org.mybatis.example.BlogMapper.selectBlog", 101);

2)定义一个与之相对应的java接口作为DAO层使用。

package org.mybatis.example;
public interface BlogMapper {
  Blog selectBlog(int id);
}

使用时通过接口执行操作:

SqlSession session = sqlSessionFactory.openSession()
BlogMapper mapper = session.getMapper(BlogMapper.class);
Blog blog = mapper.selectBlog(101);

目前第二种方式比较常用,更符合ORM的使用习惯。

二、Spring通过MapperScan注解集成Mybatis

spring使用可以通过配置文件和注解来集成mybatis,此处只探究注解方式的实现机制。

1. MapperScan注解,设置扫描包

MapperScan使用如下,只需要在某个Bean上加伤@MapperScan即可:

@SpringBootApplication  
@MapperScan("pers.kivi.demo.mapper")  
public class App {  
    public static void main(String[] args) {  
       SpringApplication.run(App.class, args);  
    }  
}  

观察MapperScan注解发现其通过Import注解引入了MapperScannerRegistrar:

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(MapperScannerRegistrar.class)
public @interface MapperScan {
    ...
}
2.@Import的解析时机

org.springframework.context.support.AbstractApplicationContext#invokeBeanFactoryPostProcessors调用时,会调用ConfigurationClassPostProcessor这个内置的BeanFactoryPostProcessor对传入的配置类进行级联的解析,把符合条件的类解析为BeanDefinition注册到beanDefinitionMap中。

其中就包含对@Import注解的解析,ConfigurationClassPostProcessor会调用其registerBeanDefinitions方法注册bean定义。

3. MapperScannerRegistrar

该接口是ImportBeanDefinitionRegistrar的子类,职责是负责注册BeanDefinitionBeanFactory

public class MapperScannerRegistrar implements ImportBeanDefinitionRegistrar, ResourceLoaderAware {
  private ResourceLoader resourceLoader;

  @Override
  public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
    AnnotationAttributes annoAttrs = AnnotationAttributes.fromMap(importingClassMetadata.getAnnotationAttributes(MapperScan.class.getName()));
    ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);
    
    /**
    * 设置属性至scanner,忽略此处逻辑
    */
    
    
    List<String> basePackages = new ArrayList<String>();
    for (String pkg : annoAttrs.getStringArray("value")) {
      if (StringUtils.hasText(pkg)) {
        basePackages.add(pkg);
      }
    }
    for (String pkg : annoAttrs.getStringArray("basePackages")) {
      if (StringUtils.hasText(pkg)) {
        basePackages.add(pkg);
      }
    }
    for (Class<?> clazz : annoAttrs.getClassArray("basePackageClasses")) {
      basePackages.add(ClassUtils.getPackageName(clazz));
    }
        scanner.doScan(StringUtils.toStringArray(basePackages));
   }
}

从源码可以发现,MapperScannerRegistrar使用ClassPathMapperScanner来扫描传入的package,解析并注册BeanDefinition。

4.ClassPathBeanDefinitionScanner

ClassPathBeanDefinitionScanner继承了ClassPathBeanDefinitionScanner来扫描BeanDefinition,但是为了把Mybatis声明的Mapper接口扫描为BeanDefinition,其重写了isCandidateComponent方法。

然后把扫描到的Bean定义的class通过processBeanDefinitions方法设置为MapperFactoryBeans

package org.mybatis.spring.mapper;
public class ClassPathMapperScanner extends ClassPathBeanDefinitionScanner {
    /**
   * Calls the parent search that will search and register all the candidates.
   * Then the registered objects are post processed to set them as
   * MapperFactoryBeans
   */
  @Override
  public Set<BeanDefinitionHolder> doScan(String... basePackages) {
    /**
    * 调用父类doScan方法进行扫描并注册BeanDefinition
    */
    Set<BeanDefinitionHolder> beanDefinitions = super.doScan(basePackages);
    
    /**
    * 把已经注册的Mybatis的Mapper接口的BeanDefinition的class修改为MapperFactoryBeans
    */
        processBeanDefinitions(beanDefinitions);
    return beanDefinitions;
  }
  
  private void processBeanDefinitions(Set<BeanDefinitionHolder> beanDefinitions) {
    GenericBeanDefinition definition;
    for (BeanDefinitionHolder holder : beanDefinitions) {
      definition = (GenericBeanDefinition) holder.getBeanDefinition();

      // the mapper interface is the original class of the bean
      // but, the actual class of the bean is MapperFactoryBean
      definition.getConstructorArgumentValues().addGenericArgumentValue(definition.getBeanClassName());
      definition.setBeanClass(this.mapperFactoryBean.getClass());
            
      /**
      *设置其他BeanDefinition属性
      */
    }
  }
  
  @Override
  protected boolean isCandidateComponent(AnnotatedBeanDefinition beanDefinition) {
    return beanDefinition.getMetadata().isInterface() && beanDefinition.getMetadata().isIndependent();
  }  
}  
5. MapperFactoryBeans

不出意外MapperFactoryBean肯定是一个FactoryBean,负责对接口生成对应的代理实例。

public class MapperFactoryBean<T> extends SqlSessionDaoSupport implements FactoryBean<T> {
    ... 
    
  @Override
  public T getObject() throws Exception {
    return getSqlSession().getMapper(this.mapperInterface);
  }
  
  ...
}

三、Spring创建Bean时机

Spring会在org.springframework.context.support.AbstractApplicationContext#finishBeanFactoryInitialization方法中对非BeanFactoryPostProcessorApplicationListener类型等的普通Bean进行初始化。如果发现某BeanDefinitino的类型是FactoryBean,则会继续调用getObject方法创建具体实例。

至此完成Mybatis的Mapper集成进Spring的Context管理。

四、总结

Spring内部提供了太多的扩展点供增强使用,例如:

1)BeanFactoryPostProcessor可以用来增强BeanDefinition的加载;

2)BeanPostProcessor可以用来增强Bean创建过程;

3)Aware可以使Bean织入Spring的一些Bean;

4)EventListener/ApplicationEventMulticaster可以用来实现广播自己的事件;

5)Xml配置文件直至自定义schema的NameSpaceHandler,来进行BeanDefinition注册;

等等。

我们实际开发的时候多了解里面的机制,就可以做到更低耦合,更优雅的功能扩展和实现。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,126评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,254评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,445评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,185评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,178评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,970评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,276评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,927评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,400评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,883评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,997评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,646评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,213评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,204评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,423评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,423评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,722评论 2 345