ApplicationContext 体系结构

前一篇文章 BeanFactory 体系结构 中,就 BeanFactory 接口的继承关系、基本的方法定义做了描述,并未对其实现类 DefaultListableBeanFactory 以及 XmlBeanFactory 的代码做分析。
在实际应用中,使用到的 Spring Ioc 容器多是 ApplicationContext 接口的实现类,最常用的几个实现类为:

  1. ClassPathXmlApplicationContext(基于 xml 配置文件的 Ioc 容器),
  2. AnnotationConfigApplicationContext(基于注解的 Ioc 容器),
  3. XmlWebApplicationContext(web应用中基于 xml 文件的 Ioc 容器)

从本篇文章开始,将从 ClassPathXmlApplicationContext 和 AnnotationConfigApplicationContext 类开始分析 Spring Ioc 容器实现的源码。

ApplicationContext 体系结构
images

从 ApplicationContext 体系结构图分析整理类继承关系如下:

ApplicationContext
    WebApplicationContext
        ConfigurableWebApplicationContext
    ConfigurableApplicationContext
        AbstractApplicationContext
            AbstractRefreshableApplicationContext
                AbstractRefreshableConfigApplicationContext
                    -- ClasspathXmlApplicationContext
                    AbstractRefreshableWebApplicationContext
                        -- XmlWebApplicationContext
            GenericApplicationContext
                -- AnnotationConfigApplicationContext   
ClassPathXmlApplicationContext 和 AnnotationConfigApplicationContext 源码分析
  • ClassPathXmlApplicationContext 构造函数

    public ClassPathXmlApplicationContext(
            String[] configLocations, boolean refresh, @Nullable ApplicationContext parent)
            throws BeansException {
    super(parent);
    // 设置配置文件
    setConfigLocations(configLocations);
    if (refresh) {
        // 1. 核心方法
        refresh();
    }
    }
    
    1. super(parent)
      调用父类 AbstractApplicationContext 的构造函数, 主要包含两部分:
    • 创建了一个 ResourceLoader 实例,这个 ResourceLoader 就是 AbstractApplicationContext

    • 设置父容器,上述初始化方式下父容器为 null

      public AbstractApplicationContext(@Nullable ApplicationContext parent) {
          this();
          setParent(parent);
      }
      
      public AbstractApplicationContext() {
          this.resourcePatternResolver = getResourcePatternResolver();
      }
      
      protected ResourcePatternResolver getResourcePatternResolver() {
          return new PathMatchingResourcePatternResolver(this);
      }
      
    1. setConfigLocations(configLocations)
      setConfigLocations主要工作有两个:创建环境对象ConfigurableEnvironment 、处理ClassPathXmlApplicationContext传入的字符串中的占位符;
    • 环境对象ConfigurableEnvironment中包含了当前JVM的profile配置信息、环境变量、 Java进程变量;
    • 处理占位符的关键是ConfigurableEnvironment、PropertyResolver、PropertyPlaceholderHelper之间的配合:
      public void setConfigLocations(@Nullable String... locations) {
          if (locations != null) {
              Assert.noNullElements(locations, "Config locations must not be null");
              this.configLocations = new String[locations.length];
              for (int i = 0; i < locations.length; i++) {
                  // 核心代码
                  this.configLocations[i] = resolvePath(locations[i]).trim();
              }
          }
          else {
              this.configLocations = null;
          }
      }
      // AbstractRefreshableConfigApplicationContext::resolvePath
      protected String resolvePath(String path) {
          return getEnvironment().resolveRequiredPlaceholders(path);
      }
      // AbstractApplicationContext::getEnvironment
      public ConfigurableEnvironment getEnvironment() {
          if (this.environment == null) {
              this.environment = createEnvironment();
          }
          return this.environment;
      }
      // AbstractApplicationContext::createEnvironment
      protected ConfigurableEnvironment createEnvironment() {
          return new StandardEnvironment();
      }
      // AbstractPropertyResolver::resolveRequiredPlaceholders
      public String resolveRequiredPlaceholders(String text) throws IllegalArgumentException {
          if (this.strictHelper == null) {
              this.strictHelper = createPlaceholderHelper(false);
          }
          return doResolvePlaceholders(text, this.strictHelper);
      }
      
  • AnnotationConfigApplicationContext 构造函数

    public AnnotationConfigApplicationContext(Class<?>... annotatedClasses) {
        this();
        register(annotatedClasses);
        refresh();
    }
    

    AnnotationConfigApplicationContext 类继承了 GenericApplicationContext 类,因此当调用 AnnotationConfigApplicationContext 的构造函数时,会默认先调用父类 GenericApplicationContext 的无参构造函数。从具体的代码中可知,在 GenericApplicationContext 的无参构造函数中初始化成员变量 beanFactory 为 DefaultListableBeanFactory。

    public GenericApplicationContext() {
        this.beanFactory = new DefaultListableBeanFactory();
    }
    
    1. this()
      从源码中可以看到,在AnnotationConfigApplicationContext的无参构造函数中会初始化 reader(基于注解的 BeanDefinition 读取器) 和 scanner(类路径的 BeanDefinition 扫描器)
    public AnnotationConfigApplicationContext() {
        this.reader = new AnnotatedBeanDefinitionReader(this);
        this.scanner = new ClassPathBeanDefinitionScanner(this);
    }
    
    1. register(annotatedClasses)
    public void register(Class<?>... annotatedClasses) {
        Assert.notEmpty(annotatedClasses, "At least one annotated class must be specified");
        this.reader.register(annotatedClasses);
    }
    
    public void register(Class<?>... annotatedClasses) {
        for (Class<?> annotatedClass : annotatedClasses) {
            registerBean(annotatedClass);
        }
    }
    
    public void registerBean(Class<?> annotatedClass) {
        doRegisterBean(annotatedClass, null, null, null);
    }
    
    <T> void doRegisterBean(Class<T> annotatedClass, @Nullable Supplier<T> instanceSupplier, @Nullable String name,
            @Nullable Class<? extends Annotation>[] qualifiers, BeanDefinitionCustomizer... definitionCustomizers) {
    
        AnnotatedGenericBeanDefinition abd = new AnnotatedGenericBeanDefinition(annotatedClass);
        //@Conditional装配条件判断是否需要跳过注册
        if (this.conditionEvaluator.shouldSkip(abd.getMetadata())) {
            return;
        }
    
        abd.setInstanceSupplier(instanceSupplier);
        //解析bean作用域(单例或者原型),如果有@Scope注解,则解析@Scope,没有则默认为singleton 
        ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(abd);
        abd.setScope(scopeMetadata.getScopeName());
        //生成bean配置类beanName
        String beanName = (name != null ? name : this.beanNameGenerator.generateBeanName(abd, this.registry));
    
        //通用注解解析到abd结构中,主要是处理Lazy, primary DependsOn, Role ,Description这五个注解
        AnnotationConfigUtils.processCommonDefinitionAnnotations(abd);
        // @Qualifier特殊限定符处理
        if (qualifiers != null) {
            for (Class<? extends Annotation> qualifier : qualifiers) {
                // 如果配置@Primary注解,则设置当前Bean为自动装配autowire时首选bean
                if (Primary.class == qualifier) {
                    abd.setPrimary(true);
                } //设置当前bean为延迟加载
                else if (Lazy.class == qualifier) {
                    abd.setLazyInit(true);
                }
                else {
                    //其他注解,则添加到abd结构中
                    abd.addQualifier(new AutowireCandidateQualifier(qualifier));
                }
            }
        }
        for (BeanDefinitionCustomizer customizer : definitionCustomizers) {
            customizer.customize(abd);
        }
    
        //根据beanName和bean定义信息封装一个beanhold,heanhold其实就是一个 beanname和BeanDefinition的映射
        BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(abd, beanName);
        definitionHolder = AnnotationConfigUtils.applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry);
        // BeanDefinitionReaderUtils.registerBeanDefinition 内部通过DefaultListableBeanFactory.registerBeanDefinition(String beanName, BeanDefinition beanDefinition)按名称将bean定义信息注册到容器中
        BeanDefinitionReaderUtils.registerBeanDefinition(definitionHolder, this.registry);
    }
    
    
总结

本篇文章介绍了 ApplicationContext 体系图,以及简要分析了 ClasspathXmlApplicationContext 和 AnnotationConfigApplicationContext 构造函数中的前两个方法,其中涉及到的一些类以及类的作用如下:

  1. ClasspathXmlApplicationContext

    类名 作用
    ConfigurableEnvironment 1.创建PropertyResolver; 2.向PropertyResolver提供环境变量、 Java进程变量
    PropertyResolver 1.创建PropertyPlaceholderHelper; 2.定义占位符的前缀和后缀(placeholderPrefix、placeholderSuffix); 3.提供getPropertyAsRawString方法给PropertyPlaceholderHelper调用,用来获取指定key对应的环境变量
    PropertyPlaceholderHelper 1.找到字符串中的占位符;2.调用PropertyResolver.getPropertyAsRawString方法,从环境变量中取出占位符对应的值;3.用环境变量的值替换占位符
  2. AnnotationConfigApplicationContext
    在构造函数的 refresh 函数之前,首先创建了 BeanFactory、AnnotatedBeanDefinitionReader、ClassPathBeanDefinitionScanner 对象,然后创建配置类本身的 BeanDefinition 信息并注册到 BeanFactory 中。

分析完 ClasspathXmlApplicationContext 和 AnnotationConfigApplicationContext 构造函数中的前两个方法后,后续的文章将继续分析最核心的方法 refresh。

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

推荐阅读更多精彩内容