首頁 > 軟體

Spring建立Bean的生命週期詳析

2022-09-30 14:00:41

1.Bean 的建立生命週期

UserService.class —> 無參構造方法(推斷構造方法) —> 普通物件 —> 依賴注入(為帶有@Autowired的屬性賦值) —> 初始化前(執行帶有@PostConstruct的方法) —> 初始化(執行實現了InitializingBean介面的afterPropertiesSet方法) —> 初始化後(執行AOP相關邏輯) —> 代理物件 —> Bean

類似於:男孩 —> 依賴注入 —> 男人

大致過程如下:

  • 利用該類的構造方法來範例化得到一個物件(但是如何一個類中有多個構造方法,Spring 則會進行選擇,這個叫做推斷構造方法
  • 得到一個物件後,Spring 會判斷該物件中是否存在被@Autowired註解了的屬性,把這些屬性找出來並由 Spring 進行賦值(依賴注入
  • 依賴注入後,Spring 會判斷該物件是否實現了 BeanNameAware 介面、BeanClassLoaderAware介面、BeanFactoryAware 介面,如果實現了,就表示當前物件必須實現該介面中所定義的 setBeanName()setBeanClassLoader()setBeanFactory()方法,那麼 Spring 就會呼叫這些方法並傳入相應的引數(Aware回撥
  • Aware 回撥後,Spring 會判斷該物件中是否存在某個方法被@PostConstruct註解了,如果存在,Spring 會呼叫當前物件的此方法(初始化前
  • 緊接著,Spring 會判斷該物件是否實現了InitializingBean介面,如果實現了,就表示當前物件必須實現該介面中的afterPropertiesSet()方法,那麼 Spring 就會呼叫當前物件中的afterPropertiesSet()方法(初始化
  • 最後,Spring 會判斷當前物件需不需要進行 AOP,如果不需要那麼Bean就建立完了,如果需要進行AOP,則會進行動態代理並生成一個代理物件作為Bean(初始化後

當Spring根據UserService類來建立一個Bean時:

  • 如果不用進行AOP,那麼Bean就是UserService類的構造方法所得到的物件。
  • 如果需要進行AOP,那麼Bean就是UserService的代理類所範例化得到的物件,而不是UserService本身所得到的物件。

Bean物件建立出來後:

  • 如果當前Bean是單例Bean,那麼會把該Bean物件存入一個Map<String, Object>,Map的key為beanName,value為Bean物件。這樣下次getBean時就可以直接從Map中拿到對應的Bean物件了。(實際上,在Spring原始碼中,這個Map就是單例池
  • 如果當前Bean是原型Bean,那麼後續沒有其他動作,不會存入一個Map,下次getBean時會再次執行上述建立過程,得到一個新的Bean物件。

推斷構造方法:

  • 如果一個類裡面有無參的構造方法,那麼Spring預設就會用這個無參的構造方法。
  • 如果一個類裡面只有一個有參的構造方法,那麼Spring就會用這個有參的構造方法。
  • 如果一個類裡面有多個有參的構造方法,並且沒有無參的構造方法,那麼Spring會報錯。
  • 如果想要指定Spring用哪個構造方法,可以在該構造方法上加@Autowired

@Bean會覆蓋@Compoment

注意:

如果Spring選擇了一個有參的構造方法,Spring在呼叫這個有參構造方法時,需要傳入引數,那這個引數是怎麼來的呢?

Spring會根據入參的型別和入參的名字去Spring容器中找Bean物件(以單例Bean為例,Spring會從單例池的那個Map中去找):

  • 先根據入參型別找,如果只找到一個,那就直接用來作為入參
  • 如果根據型別找到多個,則再根據入參名字來確定唯一一個
  • 如果最終沒有找到,則會報錯,無法建立當前Bean物件

確定用哪個構造方法,確定入參的Bean物件,這個過程就叫做推斷構造方法

2.Spring AOP 大致流程

AOP就是進行動態代理,在建立一個Bean的過程中,Spring在最後一步會去判斷當前正在建立的這個Bean是不是需要進行AOP,如果需要則會進行動態代理。

如何判斷當前Bean物件需不需要進行 AOP 操作:

  • 先從Spring容器裡面找出所有的切面Bean。
  • 遍歷每一個切面Bean,再遍歷每個切面Bean中的每一個方法,看看是否寫了@Before@After 等註解。
  • 如果寫了,則判斷該方法所對應的Pointcut是否和當前Bean物件的類相匹配
  • 如果匹配,則表示當前Bean物件是需要進行 AOP 操作的。

上面第三步找到匹配的之後,會將匹配的所有方法快取起來,後面在執行切面方法的時候,可以快速從快取中拿出來,提高執行效率。

利用cglib進行AOP的大致流程:

  • 生成代理類UserServiceProxy,代理類繼承UserService
  • 代理類中重寫了父類別的方法,比如UserService中的test()方法代理類中還會有一個target屬性,該屬性的值為被代理的物件(也就是通過UserService類推斷構造方法範例化出來的物件,進行了依賴注入、初始化等步驟的物件)
  • 代理類中的test()方法被執行時的邏輯如下:
    • 執行切面邏輯(@Before)
    • 呼叫target.test()

當我們從Spring容器得到UserService的Bean物件時,拿到的就是UserServiceProxy所生成的物件,也就是代理物件。

呼叫UserService代理物件.test( ) —> 執行切面邏輯 —> target.test( ),注意target物件不是代理物件,而是被代理的物件。

UserServiceProxy(代理類) ---> 代理物件 ---> 代理物件.target = 普通物件
代理物件.test();

class UserServiceProxy extends UserService {
  
  UserService target;
  
  public void test() {
    // 執行切面邏輯 @Before --> 從匹配的切面方法的快取中拿出來
    
    target.test(); // 呼叫普通物件的test方法
    
  }
  
}

3.Spring 事務

當我們在某個方法上加了@Transactional註解後,就表示該方法在呼叫時會開啟Spring事務,而這個方法所在的類所對應的Bean物件會是該類的代理物件

Spring事務的代理物件執行某個方法時的步驟:

  • 判斷當前執行的方法是否存在@Transactional註解
  • 如果存在,則利用事務管理器(TransactionMananger)建立一個資料庫連線
  • 修改資料庫連線的 autocommit 為 false
  • 執行 target.test(),執行程式設計師所寫的業務邏輯程式碼,也就是執行 sql
  • 執行完了之後如果沒有出現異常,則提交,否則回滾

Spring事務是否會失效的判斷標準:某個加了@Transactional註解的方法被呼叫時,要判斷到底是不是直接被代理物件呼叫的,如果是則事務會生效,如果不是則會失效。

UserServiceProxy(代理類) ---> 代理物件 ---> 代理物件.target = 普通物件
代理物件.test();

class UserServiceProxy extends UserService {
  
  UserService target;
  
  public void test() {
    // 1.先看看方法上面有沒有加@Transactional
    // 2.通過事務管理器dataSource,建立一個資料庫連線conn
    // 3.設定conn.autocommit = false,表示不自動提交事務
    
    target.test(); // 呼叫普通物件的test方法
    
    conn.commit(); // 如果方法都執行成功,那就手動提交事務
    conn.rollback(); // 如果某個方法執行失敗,那就會回滾事務
    
  }
  
}

4.Spring 原始碼閱讀前戲

BeanDefinition

BeanDefinition表示Bean定義,BeanDefinition中存在很多屬性用來描述一個Bean的特點。

比如:

  • class,表示Bean型別
  • scope,表示Bean的作用域,單例或原型等
  • lazyInit:表示Bean是否是懶載入
  • initMethodName:表示Bean初始化時要執行的方法
  • destroyMethodName:表示Bean銷燬時要執行的方法還有很多…

宣告式定義 Bean:

可以通過以下幾種方式來定義Bean:

  • <bean/>
  • @Bean
  • @Component(@Service、@Controller)

也可以通過程式設計式定義 Bean

AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);

// 生成一個BeanDefinition物件,並設定beanClass為User.class,並註冊到ApplicationContext中
AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.genericBeanDefinition().getBeanDefinition();
beanDefinition.setBeanClass(User.class);
context.registerBeanDefinition("user", beanDefinition);

System.out.println(context.getBean("user"));

還可以通過BeanDefinition設定一個Bean的其他屬性

beanDefinition.setScope("prototype"); // 設定作用域
beanDefinition.setInitMethodName("init"); // 設定初始化方法
beanDefinition.setLazyInit(true); // 設定懶載入

宣告式定義和程式設計式定義的Bean,最終都會被Spring解析為對應的BeanDefinition物件,並放入Spring容器中。

BeanDefinitionReader

接下來介紹幾種在Spring原始碼中常見的BeanDefinition讀取器(BeanDefinitionReader

AnnotatedBeanDefinitionReader

可以直接把某個類轉換為BeanDefinition,並且會解析該類上的註解,比如:

AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);

AnnotatedBeanDefinitionReader annotatedBeanDefinitionReader = new AnnotatedBeanDefinitionReader(context);

// 將User.class解析為BeanDefinition
annotatedBeanDefinitionReader.register(User.class);

System.out.println(context.getBean("user"));

它能解析的註解有:@Conditional,@Scope、@Lazy、@Primary、@DependsOn、@Role、@Description

XmlBeanDefinitionReader

可以解析<bean/>標籤

AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);

        XmlBeanDefinitionReader xmlBeanDefinitionReader = new XmlBeanDefinitionReader(context);
        int i = xmlBeanDefinitionReader.loadBeanDefinitions("spring.xml");

        System.out.println(context.getBean("user"));

ClassPathBeanDefinitionScanner

ClassPathBeanDefinitionScanner是掃描器,它的作用和BeanDefinitionReader類似,可以進行掃描,掃描某個包路徑,對掃描到的類進行解析,比如,掃描到的類上如果存在 @Component 註解,那麼就會把這個類解析成為一個BeanDefinition

AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
        context.refresh();

        ClassPathBeanDefinitionScanner scanner = new ClassPathBeanDefinitionScanner(context);
        scanner.scan("cn.xx");

        System.out.println(context.getBean("user"));

BeanFactory

BeanFactory表示Bean工廠,所以很明顯,BeanFactory會負責建立Bean,並且提供獲取Bean的API。

而ApplicationContext是BeanFactory的一種,在Spring原始碼中,是這麼定義的:

public interface ApplicationContext extends EnvironmentCapable, ListableBeanFactory, HierarchicalBeanFactory,
  MessageSource, ApplicationEventPublisher, ResourcePatternResolver {
            ...
}

首先,在Java中,介面是可以多繼承的,我們發現ApplicationContext繼承了ListableBeanFactoryHierarchicalBeanFactory,而 ListableBeanFactory 和HierarchicalBeanFactory 都繼承至 BeanFactory,所以我們可以認為 ApplicationContext 繼承了BeanFactory,相當於蘋果繼承水果,寶馬繼承汽車一樣,ApplicationContext 也是 BeanFactory 的一種,擁有 BeanFactory 支援的所有功能,不過 ApplicationContext 比 BeanFactory 更加強大,ApplicationContext 還繼承了其他介面,也就表示 ApplicationContext 還擁有其他功能,比如MessageSource 表示國際化,ApplicationEventPublisher 表示事件釋出,EnvironmentCapable 表示獲取環境變數等等,關於 ApplicationContext 後面再詳細討論。

在Spring的原始碼中,當我們new一個ApplicationContext時,其底層會new一個BeanFactory,當使用ApplicationContext的某些方法時,比如getBean(),底層呼叫的就是BeanFactory的getBean()方法。

在Spring原始碼中,BeanFactory介面存在一個非常重要的實現類是:DefaultListableBeanFactory,也是非常核心的。

所以,我們可以直接使用DefaultListableBeanFactory,而不需要使用 ApplicationContext 的某個實現類,比如:

DefaultListableBeanFactory beanFactory = new DefaultListableBeanFactory();
        AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.genericBeanDefinition().getBeanDefinition();
        beanDefinition.setBeanClass(User.class);
        beanFactory.registerBeanDefinition("user", beanDefinition);
        System.out.println(beanFactory.getBean("user"));

DefaultListableBeanFactory是非常強大的,支援很多功能,可以通過檢視DefaultListableBeanFactory 的類繼承結構圖:

  • AliasRegistry:支援別名功能,一個名字可以對應多個別名
  • BeanDefinitionRegistry:可以註冊、儲存、移除、獲取某個
  • BeanDefinitionBeanFactory:Bean工廠,可以根據某個bean的名字、或型別、或別名獲取某個Bean物件
  • SingletonBeanRegistry:可以直接註冊、獲取某個單例Bean
  • SimpleAliasRegistry:它是一個類,實現了AliasRegistry介面中所定義的功能,支援別名功能
  • ListableBeanFactory:在BeanFactory的基礎上,增加了其他功能,可以獲取所有BeanDefinition的beanNames,可以根據某個型別獲取對應的beanNames,可以根據某個型別獲取{型別:對應的Bean}的對映關係
  • HierarchicalBeanFactory:在BeanFactory的基礎上,新增了獲取父BeanFactory的功能
  • DefaultSingletonBeanRegistry:它是一個類,實現了SingletonBeanRegistry介面,擁有了直接註冊、獲取某個單例Bean的功能
  • ConfigurableBeanFactory:在HierarchicalBeanFactory和SingletonBeanRegistry的基礎上,新增了設定父BeanFactory、類載入器(表示可以指定某個類載入器進行類的載入)、設定Spring EL表示式解析器(表示該BeanFactory可以解析EL表示式)、設定型別轉化服務(表示該BeanFactory可以進行型別轉化)、可以新增BeanPostProcessor(表示該BeanFactory支援Bean的後置處理器),可以合併BeanDefinition,可以銷燬某個Bean等等功能
  • FactoryBeanRegistrySupport:支援了FactoryBean的功能
  • AutowireCapableBeanFactory:是直接繼承了BeanFactory,在BeanFactory的基礎上,支援在建立Bean的過程中能對Bean進行自動裝配
  • AbstractBeanFactory:實現了ConfigurableBeanFactory介面,繼承了FactoryBeanRegistrySupport,這個BeanFactory的功能已經很全面了,但是不能自動裝配和獲取beanNames
  • ConfigurableListableBeanFactory:繼承了ListableBeanFactory、AutowireCapableBeanFactory、ConfigurableBeanFactoryAbstract
  • AutowireCapableBeanFactory:繼承了AbstractBeanFactory,實現了AutowireCapableBeanFactory,擁有了自動裝配的功能
  • DefaultListableBeanFactory:繼承了AbstractAutowireCapableBeanFactory,實現了ConfigurableListableBeanFactory介面和BeanDefinitionRegistry介面,所以DefaultListableBeanFactory的功能很強大

ApplicationContext

ApplicationContext 是個介面,實際上也是一個BeanFactory,不過比BeanFactory更加強大,比如:

  • HierarchicalBeanFactory:擁有獲取父BeanFactory的功能
  • ListableBeanFactory:擁有獲取beanNames的功能
  • ResourcePatternResolver:資源載入器,可以一次性獲取多個資源(檔案資源等等)
  • EnvironmentCapable:可以獲取執行時環境(沒有設定執行時環境的功能)
  • ApplicationEventPublisher:擁有廣播事件的功能(沒有新增事件監聽器的功能)
  • MessageSource:擁有國際化功能

ApplicationContext 有兩個比較重要的實現類:

  • AnnotationConfigApplicationContext
  • ClassPathXmlApplicationContext

AnnotationConfigApplicationContext

  • ConfigurableApplicationContext:繼承了ApplicationContext介面,增加了 新增事件監聽器、新增BeanFactoryPostProcessor、設定Environment,獲取ConfigurableListableBeanFactory等功能
  • AbstractApplicationContext:實現了ConfigurableApplicationContext介面
  • GenericApplicationContext:繼承了AbstractApplicationContext,實現了BeanDefinitionRegistry介面,擁有所有ApplicationContext的功能,並且可以註冊BeanDefinition,注意這個類中有一個屬性(DefaultListableBeanFactory beanFactory)
  • AnnotationConfigRegistry:可以單獨註冊某個為類為BeanDefinition(可以處理該類上的**@Configuration註解**,已經可以處理**@Bean註解**),同時可以掃描
  • AnnotationConfigApplicationContext:繼承了GenericApplicationContext,實現了AnnotationConfigRegistry介面,擁有了以上所有的功能

ClassPathXmlApplicationContext

它也是繼承了AbstractApplicationContext,但是相對於AnnotationConfigApplicationContext而言,功能沒有AnnotationConfigApplicationContext強大,比如不能註冊BeanDefinition

資源載入

ApplicationContext還擁有資源載入的功能,比如,可以直接利用ApplicationContext獲取某個檔案的內容:

AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);

        Resource resource = context.getResource("file:/Users/xiexu/Library/Mobile Documents/com~apple~CloudDocs/SSM/day01/src/main/java/cn/xx/domain/User.java");
        System.out.println(resource.contentLength());

        Resource resource1 = context.getResource("https://www.baidu.com");
        System.out.println(resource1.contentLength());
        System.out.println(resource1.getURL());

        Resource resource2 = context.getResource("classpath:spring.xml");
        System.out.println(resource2.contentLength());
        System.out.println(resource2.getURL());

				// 可以一次性獲取多個
        Resource[] resources = context.getResources("classpath:cn/xx/domain/*.class");
        for (Resource resource3 : resources) {
            System.out.println(resource3.contentLength());
            System.out.println(resource3.getFilename());
        }

事件釋出

先定義一個事件監聽器:

		@Bean
    public ApplicationListener applicationListener() {
        return new ApplicationListener() {
            @Override
            public void onApplicationEvent(ApplicationEvent event) {
                System.out.println("接收到了一個事件");
            }
        };
    }

然後釋出一個事件:

AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);

        context.publishEvent("kkk");

型別轉化

在Spring原始碼中,有可能需要把String轉成其他型別,所以在Spring原始碼中提供了一些技術來更方便的做物件的型別轉化,關於型別轉化的應用場景, 後續看原始碼的過程中會遇到很多。

PropertyEditor

這其實是JDK中提供的型別轉化工具

public class StringToUserPropertyEditor extends PropertyEditorSupport implements PropertyEditor {

    @Override
    public void setAsText(String text) throws IllegalArgumentException {
        User user = new User();
        user.setName(text);
        this.setValue(user);
    }

}
StringToUserPropertyEditor propertyEditor = new StringToUserPropertyEditor();
propertyEditor.setAsText("1");
User value = (User) propertyEditor.getValue();
System.out.println(value);

在Spring容器中註冊 PropertyEditor:

		@Bean
    public CustomEditorConfigurer customEditorConfigurer() {
        CustomEditorConfigurer customEditorConfigurer = new CustomEditorConfigurer();
        Map<Class<?>, Class<? extends PropertyEditor>> propertyEditorMap = new HashMap<>();

        /**
         * 表示StringToUserPropertyEditor可以將String轉化成User型別,
         * 在Spring原始碼中,如果發現當前物件是String,而需要的型別是User,
         * 就會使用該PropertyEditor來做型別轉化
         */
        propertyEditorMap.put(User.class, StringToUserPropertyEditor.class);
        customEditorConfigurer.setCustomEditors(propertyEditorMap);
        return customEditorConfigurer;
    }

假設現在有如下 Bean:

@Component
public class Test {

    @Value("xiaoming")
    private User user;

    public void test() {
        System.out.println(user);
        System.out.println(user.getName());
    }
}

ConversionService

Spring中提供的型別轉化服務,它比PropertyEditor更強大

public class StringToUserConverter implements ConditionalGenericConverter {

    @Override
    public boolean matches(TypeDescriptor sourceType, TypeDescriptor targetType) {
        return sourceType.getType().equals(String.class) && targetType.getType().equals(User.class);
    }

    @Override
    public Set<ConvertiblePair> getConvertibleTypes() {
        return Collections.singleton(new ConvertiblePair(String.class, User.class));
    }

    @Override
    public Object convert(Object source, TypeDescriptor sourceType, TypeDescriptor targetType) {
        User user = new User();
        user.setName((String) source);
        return user;
    }

}
DefaultConversionService conversionService = new DefaultConversionService();
conversionService.addConverter(new StringToUserConverter());
User value = conversionService.convert("1", User.class);
System.out.println(value);

在Spring中註冊ConversionService:

		@Bean
    public ConversionServiceFactoryBean conversionService() {
        ConversionServiceFactoryBean conversionServiceFactoryBean = new ConversionServiceFactoryBean();
        conversionServiceFactoryBean.setConverters(Collections.singleton(new StringToUserConverter()));

        return conversionServiceFactoryBean;
    }

TypeConverter

整合了PropertyEditor和ConversionService的功能,是Spring內部用的:

SimpleTypeConverter typeConverter = new SimpleTypeConverter();
        typeConverter.registerCustomEditor(User.class, new StringToUserPropertyEditor());
        User value = typeConverter.convertIfNecessary("xxx", User.class);
        System.out.println(value);
        System.out.println(value.getName());
SimpleTypeConverter typeConverter = new SimpleTypeConverter();
        DefaultConversionService conversionService = new DefaultConversionService();
        conversionService.addConverter(new StringToUserConverter());
        typeConverter.setConversionService(conversionService);
        User value = typeConverter.convertIfNecessary("xxx", User.class);
        System.out.println(value);
        System.out.println(value.getName());

OrderComparator

OrderComparator是Spring所提供的一種比較器,可以根據@Order註解或實現Ordered介面來進行值的比較,從而可以進行排序。

public class A implements Ordered {

    @Override
    public int getOrder() {
        return 3;
    }

    @Override
    public String toString() {
        return this.getClass().getSimpleName();
    }
}
public class B implements Ordered {

    @Override
    public int getOrder() {
        return 2;
    }

    @Override
    public String toString() {
        return this.getClass().getSimpleName();
    }
}
public class Main {

    public static void main(String[] args) {
        A a = new A(); // order=3
        B b = new B(); // order=2

        OrderComparator comparator = new OrderComparator();
        System.out.println(comparator.compare(a, b));  // 1

        List list = new ArrayList<>();
        list.add(a);
        list.add(b);

        // 按order值升序排序
        list.sort(comparator);

        System.out.println(list);  // B,A
    }

}

另外,Spring中還提供了一個OrderComparator的子類:AnnotationAwareOrderComparator,它支援用@Order來指定order值。

比如:

@Order(3)
public class A {

    @Override
    public String toString() {
        return this.getClass().getSimpleName();
    }

}
@Order(2)
public class B {

    @Override
    public String toString() {
        return this.getClass().getSimpleName();
    }

}
public class Main {

    public static void main(String[] args) {
        A a = new A(); // order=3
        B b = new B(); // order=2

        AnnotationAwareOrderComparator comparator = new AnnotationAwareOrderComparator();
        System.out.println(comparator.compare(a, b)); // 1

        List list = new ArrayList<>();
        list.add(a);
        list.add(b);

        // 按order值升序排序
        list.sort(comparator);

        System.out.println(list); // B,A
    }

}

BeanPostProcessor

BeanPostProcess 表示Bean的後置處理器,我們可以定義一個或多個BeanPostProcessor

@Component
public class XiexuBeanPostProcessor implements BeanPostProcessor {

    @Override
    public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
        if ("user".equals(beanName)) {
            System.out.println("初始化前");
        }
        return bean;
    }

    @Override
    public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
        if ("user".equals(beanName)) {
            System.out.println("初始化後");
        }
        return bean;
    }

}

一個BeanPostProcessor可以在任意一個Bean初始化前以及初始化後去額外的做一些使用者自定義的邏輯,當然,我們可以通過判斷beanName來進行鍼對性處理(針對某個Bean,或某部分Bean)。

我們可以通過定義BeanPostProcessor來干涉Spring建立Bean的過程。

BeanFactoryPostProcessor

BeanFactoryPostProcessor表示Bean工廠的後置處理器,其實和BeanPostProcessor類似,BeanPostProcessor是干涉Bean的建立過程,BeanFactoryPostProcessor是干涉BeanFactory的建立過程。

比如,我們可以這樣定義一個BeanFactoryPostProcessor:

@Component
public class XiexuBeanFactoryPostProcessor implements BeanFactoryPostProcessor {

    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
        System.out.println("加工beanFactory");
    }
}

可以在postProcessBeanFactory()方法中對BeanFactory進行加工。

FactoryBean

上面提到,我們可以通過BeanPostPorcessor來干涉Spring建立Bean的過程,但是如果我們想一個Bean完完全全由我們自己來創造,也是可以的,比如通過FactoryBean:

@Component
public class XiexuFactoryBean implements FactoryBean {

    @Override
    public Object getObject() throws Exception {
        User user = new User();

        return user;
    }

    @Override
    public Class<?> getObjectType() {
        return User.class;
    }
}

通過上面這段程式碼,我們自己創造了一個User物件,並且它將成為Bean。但是通過這種方式創造出來的User的Bean,只會經過初始化後,其他Spring的生命週期步驟是不會經過的,比如依賴注入。

注意:單例池裡面還是原來的xiexuFactoryBean,而通過getObject()方法返回的userBean是存放在factoryBeanObjectCache裡面(快取)。

AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);
        // 如果beanName加上&,表示獲取的是單例池裡面的XiexuFactoryBean
        Object bean1 = context.getBean("&xiexuFactoryBean");
        System.out.println(bean1); // cn.xx.domain.XiexuFactoryBean@2de8284b

        // 如果beanName沒有加上&,表示獲取的是factoryBeanObjectCache快取裡面的userBean
        Object bean2 = context.getBean("xiexuFactoryBean");
        System.out.println(bean2); // cn.xx.domain.User@396e2f39

有同學可能會想到,通過@Bean也可以自己生成一個物件作為Bean,那麼和FactoryBean的區別是什麼呢?其實在很多場景下他倆是可以替換的,但是站在原理層面來說,區別也很明顯,@Bean定義的Bean是會經過完整的Bean生命週期的。

ExcludeFilter 和 IncludeFilter

這兩個Filter是Spring掃描過程中用來過濾的。ExcludeFilter 表示排除過濾器IncludeFilter 表示包含過濾器

比如以下設定,表示掃描cn.xx這個包下面的所有類,但是排除UserService類,

就算UserService類上面有@Component註解也不會成為Bean。

@ComponentScan(value = "cn.xx", 
        excludeFilters = {@ComponentScan.Filter(
                type = FilterType.ASSIGNABLE_TYPE, 
                classes = UserService.class)})
public class AppConfig {
}

再比如以下設定,就算UserService類上沒有@Component註解,它也會被掃描成為一個Bean。

@ComponentScan(value = "cn.xx",
        includeFilters = {@ComponentScan.Filter(
                type = FilterType.ASSIGNABLE_TYPE,
                classes = UserService.class)})
public class AppConfig {
}

FilterType分為:

  • ANNOTATION:表示是否包含某個註解
  • ASSIGNABLE_TYPE:表示是否是某個類
  • ASPECTJ:表示是否符合某個Aspectj表示式
  • REGEX:表示是否符合某個正規表示式
  • CUSTOM:自定義

在Spring的掃描邏輯中,預設會新增一個AnnotationTypeFilterincludeFilters,表示預設情況下在Spring掃描過程中會認為類上有@Component註解的就是Bean。

MetadataReader、ClassMetadata、AnnotationMetadata

在Spring中需要去解析類的資訊,比如類名、類中的方法、類上的註解,這些都可以稱之為類的後設資料,所以Spring中對類的後設資料做了抽象,並提供了一些工具類。

MetadataReader表示類的後設資料讀取器,預設實現類為SimpleMetadataReader。比如:

public class Test {

    public static void main(String[] args) throws IOException {
        SimpleMetadataReaderFactory simpleMetadataReaderFactory = new SimpleMetadataReaderFactory();

        // 構造一個MetadataReader
        MetadataReader metadataReader = simpleMetadataReaderFactory.getMetadataReader("cn.xx.service.impl.UserServiceImpl");

        // 得到一個ClassMetadata,並獲取了類名
        ClassMetadata classMetadata = metadataReader.getClassMetadata();

        System.out.println(classMetadata.getClassName());

        // 獲取一個AnnotationMetadata,並獲取類上的註解資訊
        AnnotationMetadata annotationMetadata = metadataReader.getAnnotationMetadata();
        for (String annotationType : annotationMetadata.getAnnotationTypes()) {
            System.out.println(annotationType);
        }
    }
}

5.Spring之Bean生命週期原始碼解析

Spring 掃描底層流程(doScan方法)

  • 掃描包路徑,得到包路徑下的所有class檔案物件(注意,這裡不是指Class物件,而是檔案物件,可以理解為File物件)
  • 利用ASM技術解析每個class檔案物件,得到class後設資料資訊
  • 如果當前類和某個excludeFilter匹配,那就排除這個類;如果當前類和某個includeFilter匹配,那就獲取這個類(預設情況下,Spring會有一個@Component註解的includeFilter)
  • 進一步進行條件註解@Conditional的匹配篩選
  • 都匹配成功後,根據當前類生成一個ScannedGenericBeanDefinition
  • 然後判斷如果該類不是頂級類或者靜態內部類,則不通過;如果該類是抽象類或者介面類,則不通過;如果該類是抽象類並且該類中有@Lookup註解的方法,則通過。
  • 最終掃描到某些BeanDefinition
  • 遍歷每個BeanDefinition,解析每個類的@Scope內容並設定到對應的BeanDefinition中
  • 設定AnnotationBeanNameGenerator生成beanName(解析@Component註解所指定的beanName,如果沒有指定則預設生成「該類名字的第一個字母小寫」;如果該類的前兩個字母都是大寫,則beanName就是該類的名字)
  • 給BeanDefinition物件中的屬性賦預設值
  • 解析@Lazy@Primary@DependsOn@Role@Description 等註解並賦值給BeanDefinition對應的屬性
  • 判斷當前beanName是否存在Spring容器中,如果不存在則把beanName和BeanDefinition註冊到Spring容器中(也就是存入beanDefinitionMap);如果存在則會有兩種方案:
    • 如果已經存在的BeanDefinition對應的型別和掃描到的BeanDefinition對應的型別相同的話(相容),則直接返回false而不會丟擲異常。
    • 如果已經存在的BeanDefinition對應的型別和掃描到的BeanDefinition對應的型別不相同的話(不相容),則會報錯並丟擲異常。
  • 掃描結束。

生成BeanDefinition

  • 首先通過ResourcePatternResolver獲得指定包路徑下的所有.class檔案(Spring原始碼中將此檔案包裝成了Resource物件)
  • 遍歷每個Resource物件利用MetadataReaderFactory解析Resource物件得到MetadataReader(在Spring原始碼中MetadataReaderFactory具體的實現類為CachingMetadataReaderFactory,MetadataReader的具體實現類為SimpleMetadataReader)
  • 利用MetadataReader進行excludeFiltersincludeFilters,以及條件註解@Conditional的篩選(某個類上是否存在@Conditional註解,如果存在則呼叫註解中所指定的類的match方法進行匹配,匹配成功則通過篩選,匹配失敗則pass掉)
  • 篩選通過後,基於metadataReader生成ScannedGenericBeanDefinition再基於metadataReader判斷對應的類是不是介面或抽象類
  • 如果篩選通過,就表示掃描到了一個Bean,將ScannedGenericBeanDefinition加入結果集

注意:

上面說的是通過掃描得到BeanDefinition物件,我們還可以通過直接定義BeanDefinition,或解析spring.xml檔案的<bean>,或者@Bean註解得到BeanDefinition物件。

MetadataReader 表示類的後設資料讀取器,主要包含了一個AnnotationMetadata,功能有

  • 獲取類的名字
  • 獲取父類別的名字
  • 獲取所實現的所有介面名
  • 獲取所有內部類的名字
  • 判斷是不是抽象類
  • 判斷是不是介面
  • 判斷是不是一個註解
  • 獲取擁有某個註解的方法集合
  • 獲取類上新增的所有註解資訊
  • 獲取類上新增的所有註解型別集合

注意:

CachingMetadataReaderFactory解析某個.class檔案得到MetadataReader物件是利用 ASM 技術,並沒有載入這個類到JVM中。並且最終得到的ScannedGenericBeanDefinition物件,它的 beanClass 屬性儲存的是當前類的名字,而不是class物件。(beanClass屬性的型別是Object,它即可以儲存類的名字,也可以儲存類物件)

合併BeanDefinition

通過掃描得到所有的BeanDefinition之後,就可以根據BeanDefinition建立Bean物件了。在Spring中支援父子BeanDefinition,和Java子父類別類似。

父子BeanDefinition實際上用得比較少,例如:這麼定義的情況下,child是單例Bean。

<bean id="parent" class="com.zhouyu.service.Parent" scope="prototype"/>
<bean id="child" class="com.zhouyu.service.Child"/>

但如果是下面這樣,child就是原型Bean了。

<bean id="parent" class="com.zhouyu.service.Parent" scope="prototype"/>
<bean id="child" class="com.zhouyu.service.Child" parent="parent"/>

因為child的父BeanDefinition是parent,所以會繼承parent上所定義的scope屬性。

所以在根據child來生成Bean物件之前,需要進行BeanDefinition的合併,才能得到完整的child的BeanDefinition。

載入類

BeanDefinition合併之後,就可以去建立Bean物件了,而建立Bean就必須範例化物件,而範例化就必須先載入當前BeanDefinition所對應的class,在AbstractAutowireCapableBeanFactory類的createBean()方法中,一開始就會呼叫:

public boolean hasBeanClass() {
		// 判斷當前BeanDefinition的beanClass屬性,是不是Class型別
		return (this.beanClass instanceof Class);
	}

如果beanClass屬性的型別是Class,那麼就直接返回;如果不是,則會根據類名進行載入(doResolveBeanClass方法所做的事情)

	@Override
	@Nullable
	public ClassLoader getBeanClassLoader() {
		return this.beanClassLoader;
	}

	@Nullable
	private ClassLoader beanClassLoader = ClassUtils.getDefaultClassLoader();

先利用BeanFactory所設定的類載入器來載入類,如果沒有設定,則預設使用ClassUtils.getDefaultClassLoader()所返回的類載入器來進行載入。

/**
	 * 獲取預設的類載入器
	 */
	@Nullable
	public static ClassLoader getDefaultClassLoader() {
		ClassLoader cl = null;

		/**
		 * 優先獲取執行緒中的類載入器
		 * 一開始,tomcat會將自定義的類載入器設定到執行緒上下文中,
		 * 然後當你走到這一步的時候,就可以獲取到執行緒中的tomcat自定義類載入器
		 */
		try {
			cl = Thread.currentThread().getContextClassLoader();
		} catch (Throwable ex) {
		}

		// 如果執行緒上下文中的類載入器為空,那就獲取ClassUtils類所對應的類載入器
		if (cl == null) {
			cl = ClassUtils.class.getClassLoader();
			if (cl == null) { // 如果類載入器等於null,就說明是引導類載入器
				// ClassUtils類是被Bootstrap類載入器載入的,則獲取系統類載入器
				try {
					cl = ClassLoader.getSystemClassLoader();
				} catch (Throwable ex) {
				}
			}
		}
		// 返回類載入器
		return cl;
	}

ClassUtils.getDefaultClassLoader()

  • 優先返回當前執行緒中的類載入器
  • 如果當前執行緒中的類載入器為空,則返回ClassUtils類的類載入器
  • 如果ClassUtils類的類載入器為空,那麼表示是Bootstrap類載入器載入的ClassUtils類,那麼則返回系統類載入器

範例化前

當前BeanDefinition對應的類載入成功後,就可以範例化物件了,但是…

在範例化物件之前,Spring提供了一個擴充套件點,允許使用者來控制是否在某些Bean範例化之前做一些啟動動作。

這個擴充套件點叫InstantiationAwareBeanPostProcessor.postProcessBeforeInstantiation( )

比如:

@Component
public class ZhouyuBeanPostProcessor implements InstantiationAwareBeanPostProcessor {

 @Override
 public Object postProcessBeforeInstantiation(Class<?> beanClass, String beanName) throws BeansException {
    if ("userService".equals(beanName)) {
     System.out.println("範例化前");
    }
    return null;
  }
  
}

以上程式碼會導致,在userService這個Bean範例化前,會進行列印。

注意:postProcessBeforeInstantiation()是有返回值的,如果這麼實現:

@Component
public class ZhouyuBeanPostProcessor implements InstantiationAwareBeanPostProcessor {

 @Override
 public Object postProcessBeforeInstantiation(Class<?> beanClass, String beanName) throws BeansException {
    if ("userService".equals(beanName)) {
     System.out.println("範例化前");
     return new UserService();
    }
  	return null;
 }
  
}

userService這個Bean在範例化前會直接返回一個由我們所定義的UserService物件。如果是這樣,表示不需要Spring來範例化了,並且後續的Spring依賴注入也不會進行了,會跳過一些步驟,直接執行初始化後這一步。

範例化

在這個步驟中就會根據BeanDefinition去建立一個物件了。

BeanDefinition的後置處理

Bean物件範例化之後,接下來就應該給物件的屬性賦值了。在真正給屬性賦值之前,Spring又提供了一個擴充套件點MergedBeanDefinitionPostProcessor.postProcessMergedBeanDefinition( ),可以對此時的BeanDefinition進行加工,比如:

@Component
public class ZhouyuMergedBeanDefinitionPostProcessor implements MergedBeanDefinitionPostProcessor {

 @Override
 public void postProcessMergedBeanDefinition(RootBeanDefinition beanDefinition, Class<?> beanType, String beanName) {
  if ("userService".equals(beanName)) {
   beanDefinition.getPropertyValues().add("orderService", new OrderService()); // 注入屬性
  }
 }
  
}

在Spring原始碼中,AutowiredAnnotationBeanPostProcessor 就是一個MergedBeanDefinitionPostProcessor,它的postProcessMergedBeanDefinition()方法中會去查詢注入點,並快取在AutowiredAnnotationBeanPostProcessor物件的一個Map中(injectionMetadataCache)。

範例化後

在處理完BeanDefinition後,Spring又設計了一個擴充套件點:InstantiationAwareBeanPostProcessor.postProcessAfterInstantiation( ),比如:

@Component
public class ZhouyuInstantiationAwareBeanPostProcessor implements InstantiationAwareBeanPostProcessor {

 @Override
 public boolean postProcessAfterInstantiation(Object bean, String beanName) throws BeansException {

  if ("userService".equals(beanName)) {
   UserService userService = (UserService) bean;
   userService.test();
  }

  return true;
 }
}

上述程式碼就是對userService所範例化出來的物件進行處理。

注意:這個擴充套件點在Spring原始碼中基本沒有怎麼使用。

6.處理屬性

/**
 * 這裡會呼叫AutowiredAnnotationBeanPostProcessor的postProcessProperties()方法,會直接給物件中的屬性賦值
 * AutowiredAnnotationBeanPostProcessor內部並不會處理pvs,直接返回了
 * 並不會處理pvs指的是:
 * 如果當前bean的某些屬性已經通過postProcessMergedBeanDefinition方法注入了,那麼該屬性上面的@Autowired註解應該是無效的,
 * 因為程式設計師已經將自定義的值設定到屬性裡面去了
 */

這個步驟中,就會處理@Autowired@Resource@Value等註解,也是通過**InstantiationAwareBeanPostProcessor.postProcessProperties( )**擴充套件點來實現的。

比如:我們甚至可以實現一個自己的自動注入功能

@Component
public class ZhouyuInstantiationAwareBeanPostProcessor implements InstantiationAwareBeanPostProcessor {

	@Override
	public PropertyValues postProcessProperties(PropertyValues pvs, Object bean, String beanName) throws BeansException {
		if ("userService".equals(beanName)) {
			for (Field field : bean.getClass().getFields()) {
				if (field.isAnnotationPresent(ZhouyuInject.class)) {
					field.setAccessible(true);
					try {
						field.set(bean, "123");
					} catch (IllegalAccessException e) {
						e.printStackTrace();
					}
				}
			}
		}

		return pvs;
	}
}

7.執行Aware

完成了屬性賦值之後,Spring會執行一些回撥,包括:

  • BeanNameAware:回傳beanName給bean物件
  • BeanClassLoaderAware:回傳classLoader給bean物件
  • BeanFactoryAware:回傳beanFactory給物件

8.初始化前

初始化前,也是Spring提供的一個擴充套件點:BeanPostProcessor.postProcessBeforeInitialization( ),比如:

@Component
public class ZhouyuBeanPostProcessor implements BeanPostProcessor {

 @Override
 public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
  if ("userService".equals(beanName)) {
   System.out.println("初始化前");
  }

  return bean;
 }
}

利用初始化前,可以對已經進行了依賴注入的Bean進行處理。

在Spring原始碼中:

  • InitDestroyAnnotationBeanPostProcessor 會在初始化前這個步驟中執行@PostConstruct的方法,
  • ApplicationContextAwareProcessor 會在初始化前這個步驟中進行其他Aware的回撥:
    • EnvironmentAware:回傳環境變數
    • EmbeddedValueResolverAware:回傳預留位置解析器
    • ResourceLoaderAware:回傳資源載入器
    • ApplicationEventPublisherAware:回傳事件釋出器
    • MessageSourceAware:回傳國際化資源
    • ApplicationStartupAware:回傳應用其他監聽物件,可忽略
    • ApplicationContextAware:回傳Spring容器ApplicationContext

初始化

  • 檢視當前Bean物件是否實現了InitializingBean介面,如果實現了就呼叫其afterPropertiesSet()方法
  • 執行BeanDefinition中指定的初始化方法

初始化後

這是Bean建立生命週期中的最後一個步驟,也是Spring提供的一個擴充套件點:BeanPostProcessor.postProcessAfterInitialization( ),比如:

@Component
public class ZhouyuBeanPostProcessor implements BeanPostProcessor {

 @Override
 public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
  if ("userService".equals(beanName)) {
   System.out.println("初始化後");
  }

  return bean;
 }
}

可以在這個步驟中,對Bean進行最終處理,Spring中的AOP就是基於初始化後實現的,初始化後返回的物件才是最終的Bean物件

9.總結BeanPostProcessor

範例化前:InstantiationAwareBeanPostProcessor.postProcessBeforeInstantiation()

範例化:MergedBeanDefinitionPostProcessor.postProcessMergedBeanDefinition()

範例化後:InstantiationAwareBeanPostProcessor.postProcessAfterInstantiation()

自動注入:InstantiationAwareBeanPostProcessor.postProcessProperties()

Aware物件

初始化前:BeanPostProcessor.postProcessBeforeInitialization()

初始化

初始化後:BeanPostProcessor.postProcessAfterInitialization()

到此這篇關於Spring建立Bean的生命週期詳析的文章就介紹到這了,更多相關Spring建立Bean內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com!


IT145.com E-mail:sddin#qq.com