文章目录
前言
在SpringBoot启动期间会运行我们一些定制逻辑，这是一个很常见的需求，但是如何不清楚组件运行时序会导致很多的问题。
在实例化任何对象之后，我们不能简单地将逻辑包含在bean的构造函数中或调用方法中。在这些过程中，我们根本无法控制。
让我们看一下真实的例子：
@Component
public class InvalidInitExampleBean {
@Autowired
private Environment env;
public InvalidInitExampleBean() {
env.getActiveProfiles();
}
}
在这里，我们试图访问构造函数中的自动装配字段。调用构造函数时，Spring bean尚未完全初始化。这是问题，因为调用尚未初始化场当然会导致空指针异常。
方法
Spring为我们提供了一些管理这种情况的方法。
1. @PostConstruct注解
可用于批注在bean初始化后立即运行一次的方法。请记住，即使没有任何注入，带注释的方法也将由Spring执行。
这是*@PostConstruct*的作用：
@Component
public class PostConstructExampleBean {
private static final Logger LOG
= Logger.getLogger(PostConstructExampleBean.class);
@Autowired
private Environment environment;
@PostConstruct
public void init() {
LOG.info(Arrays.asList(environment.getDefaultProfiles()));
}
}
在上面的示例中，您可以看到环境实例已安全注入，然后在带注释的*@PostConstruct方法中调用，而不会引发NullPointerException*。
2. InitializingBean接口
适用于前一个类似。无需注释方法，您需要实现InitializingBean接口和*afterPropertiesSet（）*方法。
在这里，您可以看到使用InitializingBean接口实现的先前示例：
@Component
public class InitializingBeanExampleBean implements InitializingBean {
private static final Logger LOG
= Logger.getLogger(InitializingBeanExampleBean.class);
@Autowired
private Environment environment;
@Override
public void afterPropertiesSet() throws Exception {
LOG.info(Arrays.asList(environment.getDefaultProfiles()));
}
}
3. ApplicationListener
在Spring上下文已初始化之后，可以将这种方法用于运行逻辑，因此我们不关注任何特定的bean，而是等待所有它们初始化。
为了实现这一点，您需要创建一个实现*ApplicationListener *接口的bean ：
@Component
public class StartupApplicationListenerExample implements
ApplicationListener<ContextRefreshedEvent> {
private static final Logger LOG
= Logger.getLogger(StartupApplicationListenerExample.class);
public static int counter;
@Override public void onApplicationEvent(ContextRefreshedEvent event) {
LOG.info("Increment counter");
counter++;
}
}
通过使用新引入的*@EventListener*批注可以实现相同的结果：
@Component
public class EventListenerExampleBean {
private static final Logger LOG
= Logger.getLogger(EventListenerExampleBean.class);
public static int counter;
@EventListener
public void onApplicationEvent(ContextRefreshedEvent event) {
LOG.info("Increment counter");
counter++;
}
}
在此示例中，我们选择了*ContextRefreshedEvent。*确保选择适合您需求的适当活动。
4. @Bean和initMethod属性
该 和initMethod属性可用于Bean的初始化后执行的方法。
public class InitMethodExampleBean {
private static final Logger LOG = Logger.getLogger(InitMethodExampleBean.class);
@Autowired
private Environment environment;
public void init() {
LOG.info(Arrays.asList(environment.getDefaultProfiles()));
}
}
您会注意到没有实现任何特殊的接口，也没有使用任何特殊的注释。
然后，我们可以使用*@Bean*批注定义bean ：
@Bean(initMethod="init")
public InitMethodExampleBean initMethodExampleBean() {
return new InitMethodExampleBean();
}
这是bean定义在XML配置中的外观：
<bean id="initMethodExampleBean"
class="com.baeldung.startup.InitMethodExampleBean"
init-method="init">
</bean>
5. 构造函数注入
如果要使用构造函数注入来注入字段，则只需在构造函数中包含逻辑即可：
@Component
public class LogicInConstructorExampleBean {
private static final Logger LOG
= Logger.getLogger(LogicInConstructorExampleBean.class);
private final Environment environment;
@Autowired
public LogicInConstructorExampleBean(Environment environment) {
this.environment = environment;
LOG.info(Arrays.asList(environment.getDefaultProfiles()));
}
}
6. CommandLineRunner
Spring启动为CommandLineRunner接口提供了带有回调*run（）*方法的方法，该方法可以在实例化Spring应用程序上下文后在应用程序启动时调用。
让我们看一个例子：
@Component
public class CommandLineAppStartupRunner implements CommandLineRunner {
private static final Logger LOG =
LoggerFactory.getLogger(CommandLineAppStartupRunner.class);
public static int counter;
@Override
public void run(String...args) throws Exception {
LOG.info("Increment counter");
counter++;
}
}
注意：如文档中所述，可以在同一应用程序上下文中定义多个CommandLineRunner bean，并可以使用*@Ordered接口或@Order批注对其*进行排序。
7. ApplicationRunner
与CommandLineRunner相似*，* Spring引导还提供了带有Run（）方法的ApplicationRunner接口，该接口将在应用程序启动时调用。但是，我们没有传递给回调方法的原始String参数，而是有ApplicationArguments类的实例。
该ApplicationArguments接口有方法，获得的期权和简单的参数值的参数值。带有–前缀的参数是选项参数。
让我们看一个例子：
@Component
public class AppStartupRunner implements ApplicationRunner {
private static final Logger LOG =
LoggerFactory.getLogger(AppStartupRunner.class);
public static int counter;
@Override
public void run(ApplicationArguments args) throws Exception {
LOG.info("Application started with option names : {}",
args.getOptionNames());
LOG.info("Increment counter");
counter++;
}
}
结合机制
为了实现对bean的完全控制，您可能需要将上述机制结合在一起。
执行顺序如下：
- 构造函数
- 在*@PostConstruct*注解的方法
- InitializingBean的*afterPropertiesSet（）*方法
- 在XML中指定为init-method的初始化方法
让我们创建一个结合了所有机制的Spring bean：
@Component
@Scope(value = "prototype")
public class AllStrategiesExampleBean implements InitializingBean {
private static final Logger LOG
= Logger.getLogger(AllStrategiesExampleBean.class);
public AllStrategiesExampleBean() {
LOG.info("Constructor");
}
@PostConstruct
public void postConstruct() {
LOG.info("PostConstruct");
}
@Override
public void afterPropertiesSet() throws Exception {
LOG.info("InitializingBean");
}
public void init() {
LOG.info("init-method");
}
}
如果尝试实例化此bean，将能够查看与上面指定的顺序匹配的日志：
[main] INFO o.b.startup.AllStrategiesExampleBean - Constructor
[main] INFO o.b.startup.AllStrategiesExampleBean - PostConstruct
[main] INFO o.b.startup.AllStrategiesExampleBean - InitializingBean
[main] INFO o.b.startup.AllStrategiesExampleBean - init-method
翻译于：
www.baeldung.com/running-set…
🍎QQ群【837324215】
🍎关注我的公众号【Java大厂面试官】，一起学习呗🍎🍎🍎
🍎个人vx【lakernote】
