詳細SpringBoot生命週期介面的使用

2022-05-26 18:02:59

一背景

最近在做一個專案啟動時載入設定到SpringBoot容器中的功能，看到了Spring中有很多在容器初始化時的介面，這些介面或註解包括InitializingBean、@PostConstruct、SmartInitializingSingleton、BeanPostProcess等等，這麼多都可以在初始化時使用，但是他們有什麼區別呢，下面就來說說他們之間的區別

二 SpringBoot 生命週期介面

@PostConstruct

這個註解在實際的開發中有較多的用到
```
@Component
public class TestP {

    @PostConstruct
    public void test() {
        System.out.println("@PostConstruct");
    }
```
這樣在容器啟動過程中就回執行列印，看起來他像是物件的構造方法，其實他的作用是，當一個物件A中存在@Autowire修飾的依賴B時，正常來說，物件會先執行自己的構造方法，然後再去注入依賴，但是我們現在有一種情況，在物件範例化時，要執行構造方法，但是構造方法中用到依賴B,這個時候用 @PostConstruct就能解決這個問題。
```
public class TestP implements InitializingBean, SmartInitializingSingleton {
    @Autowired
    Context context;
    ```
    public TestP () {
        System.out.println(context);
    }
    ```
    @PostConstruct
    public void test() {
        System.out.println(context);
        System.out.println("@PostConstruct");
    }
```
輸出

null
com.example.demo1.bean.Context@4f96a58
@PostConstruct

InitializingBean

他提供bean初始化的回撥處理功能，看下這個介面的原始碼

protected void invokeInitMethods(String beanName, final Object bean, RootBeanDefinition mbd) throws Throwable {
 boolean isInitializingBean = (bean instanceof InitializingBean);

//判斷該bean是否實現了實現了InitializingBean介面，如果實現了InitializingBean介面，則只掉呼叫bean的afterPropertiesSet方法
 if (isInitializingBean && (mbd == null || !mbd.isExternallyManagedInitMethod("afterPropertiesSet"))) {
     if (logger.isDebugEnabled()) {
         logger.debug("Invoking afterPropertiesSet() on bean with name '" + beanName + "'");
     }

     if (System.getSecurityManager() != null) {
         try {
             AccessController.doPrivileged(new PrivilegedExceptionAction<Object>() {
                 public Object run() throws Exception {
                     //直接呼叫afterPropertiesSet
                     ((InitializingBean) bean).afterPropertiesSet();
                     return null;
                 }
             },getAccessControlContext());
         } catch (PrivilegedActionException pae) {
             throw pae.getException();
         }
     }                
     else {
         //直接呼叫afterPropertiesSet
         ((InitializingBean) bean).afterPropertiesSet();
     }
 }
 if (mbd != null) {
     String initMethodName = mbd.getInitMethodName();
     //判斷是否指定了init-method方法，如果指定了init-method方法，則再呼叫制定的init-method
     if (initMethodName != null && !(isInitializingBean && "afterPropertiesSet".equals(initMethodName)) &&
             !mbd.isExternallyManagedInitMethod(initMethodName)) {
         //進一步檢視該方法的原始碼，可以發現init-method方法中指定的方法是通過反射實現
         invokeCustomInitMethod(beanName, bean, mbd);
     }
 }

可以看到，只要實現了這個介面的bean都會執行裡面的afterPropertiesSet方法,那他和 @PostConstruct有什麼區別呢，區別是他們的生命週期排序不同，@PostConstruct是對單個Bean範例化時使用，而InitializingBean是在所有spring bean範例化後對bean進行處理，⼤致的步驟是這樣的

範例化bean，這⾥會調⽤構造⽅法

填充屬性，就是依賴注⼊

初始化bean，

調⽤後置處理器，其中會執⾏@PostConstruct註解⽅法
執⾏bean的⽣命週期中的初始化回撥⽅法，也就是InitializingBean接⼝的afterPropertiesSet()⽅法

BeanPostProcess

這個介面主要是對註冊的bean中的屬性進行初始化時的修改

@Component
public class BeanPostTest implements BeanPostProcessor {
    @Override
    public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
        System.out.println("執行1--------------- - " + bean.getClass().getName() + " - " + beanName);
        return null;
    }
    @Override
    public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
        System.out.println("執行2--------------- - " + bean.getClass().getName() + " - " + beanName);
        return null;
    }
}

他和InitializingBean區別一個是執行順序不同

他有兩個方法分別在在InitializingBean執行前執行後執行，第二個區別就是InitializingBean是一個可以進一步調整bean的範例的介面，不過並不是每個類都會來執行這個介面方法，這個介面只針對當前實現類，而BeanPostProcess是針對所有bean的，每一個bean被註冊，都會被執行一次這兩個方法

SmartInitializingSingleton

這個是在spring 4.1版本才推出的介面，他的執行時時機是在單例預範例化階段結束時呼叫，並保證已經建立了所有常規單例bean,所以他的執行順序是比較靠後的，考慮到一些bean的註冊及修改使用SmartInitializingSingleton是比較穩妥的一種方式
```
 ```
 @Component
 public class GetuiAccountConfigInit implements SmartInitializingSingleton  {


     @Override
     public void afterSingletonsInstantiated() {

     }
 }
 ```
```

Commandlinerunner 這個介面是springBoot的介面，他是在所有bean都載入後才會執行的，如果實現這個介面，可以很好的在啟動時初始化資源，因為所有的bean都可以使用了

 @Component
 public class Runner implements CommandLineRunner {
     @Override
     public void run(String... args) throws Exception {
         System.out.println("執行初始化");
     }
 }

如果我們要執行的程式有順序要求，還可以使用@Order註解

 @Component
 @Order(1)
 public class OrderRunner1 implements CommandLineRunner {
     @Override
     public void run(String... args) throws Exception {
         System.out.println("The OrderRunner1 start to initialize ...");
     }
 }
 @Component
 @Order(2)
 public class OrderRunner1 implements CommandLineRunner {
     @Override
     public void run(String... args) throws Exception {
         System.out.println("The OrderRunner2 start to initialize ...");
     }
 }