Spring源碼解析容器初始化構造方法

前言

Spring框架被廣泛應用於我們的日常工作中,但是很長時間以來我都是隻會使用,不懂它的作用原理。通過最近一段時間的閱讀源碼,個人發現通過閱讀源碼,能夠幫助我們瞭解Spring的設計理念,並且對Java編程中的一些設計模式更加熟悉,所以記錄一下自己對Spring源碼的理解。

在開始進行源碼學習前,首先再回顧一下三種Spring編程風格:

  • 基於Schema,即通過xml標簽的配置方式
  • 基於Annotation的註解技術,使用@Component等註解配置bean
  • 基於Java Config,簡單來說就是使用@Configuration@Bean進行配置

基於註解的方式需要通過xml或java config來開啟。

在使用xml時,需要手動開啟對註解的支持:

<context: annotation-config/> 

當然,如果在xml中配置瞭掃描包,現在也可以光添加下面這一行,這行代碼中已經包含瞭註解的開啟功能。

<context: component-sacn base-package="com"/>

如果你使用的是下面AnnotationConfigApplicationContext這種方式,那麼就不需要添加任何操作瞭,其中已經包含瞭對註解的支持。

AnnotationConfigApplicationContext ctx
	=new AnnotationConfigApplicationContext(SpringConfig.class);

在實際使用過程中,三種方式是可以混合使用的,不存在沖突。按照下面這種方式作為AnnotationConfigApplicationContext傳入的配置文件,即可實現三種風格的統一使用:

@Configuration
@ComponentScan("com")
@ImportResource("classpath:spring.xml") 
public class SpringConfig{
}

之前也有小夥伴對我說,在開始學習Spring的時候,差點因為配置繁雜的xml被勸退,我也翻閱瞭一下網上spring入門的技術文章,確實很多還是停留在使用xml的方式上。但是其實如果你翻閱一下spring5的官方文檔,可以看出官方是推薦我們使用註解的方式的。

尤其是現在的Spring Boot更多的是基於註解,省略瞭很多配置的過程,對新手更加友好,降低瞭勸退率,所以本文將基於註解的方式進行源碼解析,另外再說明一下本文基於spring-framework-5.0.x源碼。

使用註解的方式初始化一個Spring環境,隻需要下面一行代碼:

AnnotationConfigApplicationContext context
    = new AnnotationConfigApplicationContext(SpringConfig.class);

如果看一下它的構造方法,那麼可以將它做的工作拆分為三步,為瞭便於理解可以寫成下面的形式,並分為三大模塊分別進行說明。

構造方法

首先看一下AnnotationConfigApplicationContext的繼承關系:

AnnotationConfigApplicationContext繼承瞭GenericApplicationContext,那麼我們先看GenericApplicationContext的構造方法:

public GenericApplicationContext() {
  this.beanFactory = new DefaultListableBeanFactory();
}

在這裡初始化瞭一個beanFactory的實現類DefaultListableBeanFactory,這就是我們常提到的spring中重要的bean工廠,這裡面存放瞭很多非常重要的數據結構。這裡先列出比較重要的beanDefinitionMap,會在後面頻繁使用:

private final Map<String, BeanDefinition> beanDefinitionMap = new ConcurrentHashMap<>(256);
private volatile List<String> beanDefinitionNames = new ArrayList<>(256);

在上面的這個beanDefinitionMap中就維護瞭beanNameBeanDefinition的對應關系,beanDefinitionNames則是一個存放beanName的List。

AnnotationConfigApplicationContext的構造方法開始分析:

public AnnotationConfigApplicationContext() {
  this.reader = new AnnotatedBeanDefinitionReader(this);
  this.scanner = new ClassPathBeanDefinitionScanner(this);
}

首先實例化瞭一個AnnotatedBeanDefinitionReader對象,看一下AnnotatedBeanDefinitionReader的構造函數:

public AnnotatedBeanDefinitionReader(BeanDefinitionRegistry registry) {
  this(registry, getOrCreateEnvironment(registry));
}

那麼,為什麼在這能夠將AnnotationConfigApplicationContext對象作為BeanDefinitionRegistry傳入呢?

回頭看一下繼承關系那張圖,AnnotationConfigApplicationContext繼承瞭BeanDefinitionRegistry,並且最終實現瞭接口BeanFactoryBeanFactory可以說是Spring中的頂層類,它是一個工廠,能夠產生bean對象,提供瞭一個非常重要的方法getBean,會在後面講到。

到這,我們可以得出一個結論:

BeanDefinitionRegistry可以等同於AnnotationConfigApplicationContext ,看做spring的上下文環境。

AnnotatedBeanDefinitionReader在實例化時,會調用registerAnnotationConfigProcessors方法。先看前半段代碼:

public static Set<BeanDefinitionHolder> registerAnnotationConfigProcessors(
    BeanDefinitionRegistry registry, @Nullable Object source) {
    DefaultListableBeanFactory beanFactory = unwrapDefaultListableBeanFactory(registry);
    if (beanFactory != null) {
      if (!(beanFactory.getDependencyComparator() instanceof AnnotationAwareOrderComparator)) {
        beanFactory.setDependencyComparator(AnnotationAwareOrderComparator.INSTANCE);
      }
      if (!(beanFactory.getAutowireCandidateResolver() instanceof ContextAnnotationAutowireCandidateResolver)) {
        beanFactory.setAutowireCandidateResolver(new ContextAnnotationAutowireCandidateResolver());
      }
}

在這裡先獲取在父類構造函數中實例好的beanFactory,並為它填充一些屬性:

  • AnnotationAwareOrderComparator:主要用於排序,解析@order@Priority註解
  • ContextAnnotationAutowireCandidateResolver:提供處理延遲加載的功能

再看後半段代碼,下面生成瞭6個重要類的BeanDefinitionHolder,並存放到一個Set中:

 Set<BeanDefinitionHolder> beanDefs = new LinkedHashSet<>(8);
    if (!registry.containsBeanDefinition(CONFIGURATION_ANNOTATION_PROCESSOR_BEAN_NAME)) {
      RootBeanDefinition def = new RootBeanDefinition(ConfigurationClassPostProcessor.class);
      def.setSource(source);
      beanDefs.add(registerPostProcessor(registry, def, CONFIGURATION_ANNOTATION_PROCESSOR_BEAN_NAME));
    }

    if (!registry.containsBeanDefinition(AUTOWIRED_ANNOTATION_PROCESSOR_BEAN_NAME)) {
      RootBeanDefinition def = new RootBeanDefinition(AutowiredAnnotationBeanPostProcessor.class);
      def.setSource(source);
      beanDefs.add(registerPostProcessor(registry, def, AUTOWIRED_ANNOTATION_PROCESSOR_BEAN_NAME));
    }

    if (!registry.containsBeanDefinition(REQUIRED_ANNOTATION_PROCESSOR_BEAN_NAME)) {
      RootBeanDefinition def = new RootBeanDefinition(RequiredAnnotationBeanPostProcessor.class);
      def.setSource(source);
      beanDefs.add(registerPostProcessor(registry, def, REQUIRED_ANNOTATION_PROCESSOR_BEAN_NAME));
    }

    // Check for JSR-250 support, and if present add the CommonAnnotationBeanPostProcessor.
    if (jsr250Present && !registry.containsBeanDefinition(COMMON_ANNOTATION_PROCESSOR_BEAN_NAME)) {
      RootBeanDefinition def = new RootBeanDefinition(CommonAnnotationBeanPostProcessor.class);
      def.setSource(source);
      beanDefs.add(registerPostProcessor(registry, def, COMMON_ANNOTATION_PROCESSOR_BEAN_NAME));
    }

    // Check for JPA support, and if present add the PersistenceAnnotationBeanPostProcessor.
    if (jpaPresent && !registry.containsBeanDefinition(PERSISTENCE_ANNOTATION_PROCESSOR_BEAN_NAME)) {
      RootBeanDefinition def = new RootBeanDefinition();
      try {
        def.setBeanClass(ClassUtils.forName(PERSISTENCE_ANNOTATION_PROCESSOR_CLASS_NAME,
            AnnotationConfigUtils.class.getClassLoader()));
      }
      catch (ClassNotFoundException ex) {
        throw new IllegalStateException(
            "Cannot load optional framework class: " + PERSISTENCE_ANNOTATION_PROCESSOR_CLASS_NAME, ex);
      }
      def.setSource(source);
      beanDefs.add(registerPostProcessor(registry, def, PERSISTENCE_ANNOTATION_PROCESSOR_BEAN_NAME));
    }

    if (!registry.containsBeanDefinition(EVENT_LISTENER_PROCESSOR_BEAN_NAME)) {
      RootBeanDefinition def = new RootBeanDefinition(EventListenerMethodProcessor.class);
      def.setSource(source);
      beanDefs.add(registerPostProcessor(registry, def, EVENT_LISTENER_PROCESSOR_BEAN_NAME));
    }

    if (!registry.containsBeanDefinition(EVENT_LISTENER_FACTORY_BEAN_NAME)) {
      RootBeanDefinition def = new RootBeanDefinition(DefaultEventListenerFactory.class);
      def.setSource(source);
      beanDefs.add(registerPostProcessor(registry, def, EVENT_LISTENER_FACTORY_BEAN_NAME));
    }

    return beanDefs;
  }

這裡是使用RootBeanDefinition來將普通類轉換為BeanDefinition,並進一步封裝成BeanDefinitionHolder。封裝成BeanDefinitionHolder的操作在registerPostProcessor方法中:

 private static BeanDefinitionHolder registerPostProcessor(
      BeanDefinitionRegistry registry, RootBeanDefinition definition, String beanName) {
    definition.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
    registry.registerBeanDefinition(beanName, definition);
    return new BeanDefinitionHolder(definition, beanName);
  }

通過registerBeanDefinition方法將BeanDefinition註冊到spring環境中,這個操作其實就是執行瞭上面的beanDefinitionMapput操作:

this.beanDefinitionMap.put(beanName, beanDefinition);

在上面的操作全部完成後,在還沒有實例化用戶自定義的bean前,已經有瞭6個spring自己定義的beanDefinition

用於實現spring自身的初始化:

這裡有必要對BeanDefinition進行一下說明,它是對具有屬性值的bean實例的一個說明,或者說是定義。就像是在java類加載的過程,普通java文件要先生成字節碼文件,再加載到jvm中生成class對象,spring初始化過程中首先要將普通類轉化為BeanDefinition,然後再實例化為bean。

在實例化AnnotatedBeanDefinitionReader完成後,實例化瞭一個ClassPathBeanDefinitionScanner,可以用來掃描包或者類,並將掃描到的類轉化為BeanDefinition。但是翻閱源碼,我們可以看到實際上掃描包的工作不是這個scanner對象來完成的,而是在後面spring自己實例化瞭一個ClassPathBeanDefinitionScanner來負責的。

這裡的scanner僅僅是對外提供一個擴展,可以讓我們能夠在外部調用AnnotationConfigApplicationContext對象的scan方法,實現包的掃描,

例如:

context.scan("com.hydra");

到這裡,AnnotationConfigApplicationContext的構造函數就執行完瞭,下一篇,我們來詳細說說接下來被調用的register方法。

到此這篇關於Spring源碼解析容器初始化構造方法的文章就介紹到這瞭,更多相關Spring構造方法內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!

推薦閱讀: