【每天学点Spring】Spring初始化之@PostConst

系统想要在Spring Bean初始化后自动做一些事，比如预加载一部分数据。通过以下四种方式都能实现该需求：

1. 使用JSR-250规范定义的@Postconstruct注解。
2. 使用Spring提供的@Bean init-method标签。
3. 实现InitializingBean接口，实现afterPropertiesset()方法。
4. 通过@EventListener来监听ContextRefreshedEvent事件（这个是在Spring Context完成后调用，但也能实现Spring启动后自动调用方法的需求）。

为什么需要使用额外的方式来加载一个类的init()方法，主要是因为我们依赖Spring来做Bean的创建，当一个Bean构造方法被调用的时候，其它的Bean并没有被注入。

例如：

@Service
public class NPEBean {
    @Autowired
    private Environment env;

    public NPEBean() {
        Assert.isNull(env, "env should be null");
    }
}

1. @PostConstruct

接口在线API：https://javadoc.io/doc/javax.annotation/javax.annotation-api/latest/javax/annotation/PostConstruct.html
注解@PostConstruct是javax里定义的，属于JSR-250规范的一部分。

注: @PostConstruct已经从jdk 11版本开始移除了，所以在使用时需要额外引入javax.annotation-api：

<dependency>
    <groupId>javax.annotation</groupId>
    <artifactId>javax.annotation-api</artifactId>
    <version>1.3.2</version>
</dependency>

@PostConstruct代码：

@Slf4j
@Service
public class InitMethodBean {
    @Autowired
    private Environment env;

    @PostConstruct
    public void postConstruct() {
        log.info("Invoke postConstruct() method, get env = {}", env.getDefaultProfiles());
    }
}

2. @Bean init-method标签

这个在比较古早的xml版本中已经实现，如<bean id="exampleInitBean" class="examples.ExampleBean" init-method="init"/>，而在Spring高版本中，可以使用注解的方式配置。

@Slf4j
public class InitMethodBean {
    @Autowired
    private Environment env;

    public void init() {
        log.info("Invoke InitMethodBean#init() method, get env = {}", env.getDefaultProfiles());
    }
}

需要额外的@Configuration来声明一个@Bean：

@Configuration
public class InitConfiguration {
    @Bean(initMethod = "init")
    public InitMethodBean getInitMethodBean() {
        return new InitMethodBean();
    }
}

3. 实现InitializingBean接口

接口位于org.springframework.beans.factory中，此方式相当于与Spring框架深度绑定了，所以官方文档上也说了并不是十分推荐用这个方式，而是推荐使用第1或是第2种方式。
官方文档：https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#beans-factory-lifecycle-initializingbean

We recommend that you do not use the InitializingBean interface, because it unnecessarily couples the code to Spring. Alternatively, we suggest using the @PostConstruct annotation or specifying a POJO initialization method.

代码示例：

@Slf4j
@Service
public class InitMethodBean implements InitializingBean {
    @Autowired
    private Environment env;

    @Override
    public void afterPropertiesSet() throws Exception {
        log.info("Invoke initializingBean#afterPropertiesSet() method, get env = {}", env.getDefaultProfiles());
    }
}

4 监听ContextRefreshedEvent事件

@Slf4j
@Service
public class InitMethodBean {
    @Autowired
    private Environment env;

    @EventListener
    public void onContextRefreshedEvent(ContextRefreshedEvent event) {
        log.info("Invoke ContextRefreshedEvent, get env = {}", env.getDefaultProfiles());
    }
}

5 以上方法加载顺序

启动后打印：

• Invoke Bean Construct, get env = null
• Invoke postConstruct() method, get env = default
• Invoke initializingBean#afterPropertiesSet() method, get env = default
• Invoke InitMethodBean#init() method, get env = default
• Tomcat started on port(s): 8080 (http) with context path ''
• Invoke ContextRefreshedEvent, get env = default

可以看出调用顺序：
构造函数 --> @PostConstruct --> InitializingBean接口 --> @Bean init-method --> Spring context启动完毕 --> 发布ContextRefreshedEvent事件

参考：
【stackoverflow】Spring @PostConstruct vs. init-method attribute：https://stackoverflow.com/questions/8519187/spring-postconstruct-vs-init-method-attribute
【stackoverflow】Why use @PostConstruct?https://stackoverflow.com/questions/3406555/why-use-postconstruct
【baeldung】Guide To Running Logic on Startup in Spring：https://www.baeldung.com/running-setup-logic-on-startup-in-spring
【cnblogs】详解InitializingBean、initMethod和@PostConstruct：https://www.cnblogs.com/cq-yangzhou/p/11947196.html