补习系列(21)-SpringBoot初始化之7招式

目录

  • 背景
  • 1、 @PostConstruct 注解
  • 2、 InitializingBean 接口
  • 3、 @Bean initMethod方法
  • 4、 构造器注入
  • 5、 ApplicationListener
  • 6、 CommandLineRunner
  • 7、 ApplicationRunner
  • 测试代码
  • 参考文档

背景

在日常开发时，我们常常需要 在SpringBoot 应用启动时执行某一段逻辑，如下面的场景：

  • 获取一些当前环境的配置或变量
  • 向数据库写入一些初始数据
  • 连接某些第三方系统，确认对方可以工作..

在实现这些功能时，我们可能会遇到一些"坑"。 为了利用SpringBoot框架的便利性，我们不得不将整个应用的执行控制权交给容器，于是造成了大家对于细节是一无所知的。
那么在实现初始化逻辑代码时就需要小心了，比如，我们并不能简单的将初始化逻辑在Bean类的构造方法中实现，类似下面的代码：

@Component
public class InvalidInitExampleBean {

    @Autowired
    private Environment env;

    public InvalidInitExampleBean() {
        env.getActiveProfiles();
    }
}

这里，我们在InvalidInitExampleBean的构造方法中试图访问一个自动注入的env字段，当真正执行时，你一定会得到一个空指针异常(NullPointerException)。
原因在于，当构造方法被调用时，Spring上下文中的Environment这个Bean很可能还没有被实例化，同时也仍未注入到当前对象，所以并不能这样进行调用。

下面，我们来看看在SpringBoot中实现"安全初始化"的一些方法：

1、 @PostConstruct 注解

@PostConstruct 注解其实是来自于 javax的扩展包中(大多数人的印象中是来自于Spring框架)，它的作用在于声明一个Bean对象初始化完成后执行的方法。
来看看它的原始定义：

The PostConstruct annotation is used on a method that needs to be executed after dependency injection is done to perform any initialization.

也就是说，该方法会在所有依赖字段注入后才执行，当然这一动作也是由Spring框架执行的。

下面的代码演示了使用@PostConstruct的例子：

@Component
public class PostConstructExampleBean {

    private static final Logger LOG
      = Logger.getLogger(PostConstructExampleBean.class);

    @Autowired
    private Environment environment;

    @PostConstruct
    public void init() {
        //environment 已经注入
        LOG.info(Arrays.asList(environment.getDefaultProfiles()));
    }
}

2、 InitializingBean 接口

InitializingBean 是由Spring框架提供的接口，其与@PostConstruct注解的工作原理非常类似。
如果不使用注解的话，你需要让Bean实例继承 InitializingBean接口，并实现afterPropertiesSet()这个方法。

下面的代码，展示了这种用法：

@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 {
        //environment 已经注入
        LOG.info(Arrays.asList(environment.getDefaultProfiles()));
    }
}

3、 @Bean initMethod方法

我们在声明一个Bean的时候，可以同时指定一个initMethod属性，该属性会指向Bean的一个方法，表示在初始化后执行。

如下所示：

@Bean(initMethod="init")
public InitMethodExampleBean exBean() {
    return new InitMethodExampleBean();
}

然后，这里将initMethod指向init方法，相应的我们也需要在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()));
    }
}

上面的代码是基于Java注解的方式，使用Xml配置也可以达到同样的效果：

<bean id="initMethodExampleBean"
  class="org.baeldung.startup.InitMethodExampleBean"
  init-method="init">
</bean>

该方式在早期的 Spring版本中大量被使用

4、 构造器注入

如果依赖的字段在Bean的构造方法中声明，那么Spring框架会先实例这些字段对应的Bean，再调用当前的构造方法。
此时，构造方法中的一些操作也是安全的，如下：

@Component
public class LogicInConstructorExampleBean {

    private static final Logger LOG
      = Logger.getLogger(LogicInConstructorExampleBean.class);

    private final Environment environment;

    @Autowired
    public LogicInConstructorExampleBean(Environment environment) {
        //environment实例已初始化
        this.environment = environment;
        LOG.info(Arrays.asList(environment.getDefaultProfiles()));
    }
}

5、 ApplicationListener

ApplicationListener 是由 spring-context组件提供的一个接口，主要是用来监听 "容器上下文的生命周期事件"。
它的定义如下：

public interface ApplicationListener<E extends ApplicationEvent> extends EventListener {
    /**
     * Handle an application event.
     * @param event the event to respond to
     */
    void onApplicationEvent(E event);
}

这里的event可以是任何一个继承于ApplicationEvent的事件对象。 对于初始化工作来说，我们可以通过监听ContextRefreshedEvent这个事件来捕捉上下文初始化的时机。
如下面的代码：

@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++;
    }
}

在Spring上下文初始化完成后，这里定义的方法将会被执行。
与前面的InitializingBean不同的是，通过ApplicationListener监听的方式是全局性的，也就是当所有的Bean都初始化完成后才会执行方法。
Spring 4.2 之后引入了新的 @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++;
    }
}

6、 CommandLineRunner

SpringBoot 提供了一个CommanLineRunner接口，用来实现在应用启动后的逻辑控制，其定义如下：

public interface CommandLineRunner {

    /**
     * Callback used to run the bean.
     * @param args incoming main method arguments
     * @throws Exception on error
     */
    void run(String... args) throws Exception;

}

这里的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的情况下可以使用@Order注解来控制它们的顺序。

7、 ApplicationRunner

与 CommandLineRunner接口类似, Spring boot 还提供另一个ApplicationRunner 接口来实现初始化逻辑。
不同的地方在于 ApplicationRunner.run()方法接受的是封装好的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++;
    }
}

ApplicationArguments对象提供了一些非常方便的方法，可以用来直接获取解析后的参数，比如：

java -jar application.jar --debug --ip=xxxx

此时通过 ApplicationArguments的getOptionNames就会得到["debug","ip"]这样的值

测试代码

下面，通过一个小测试来演示几种初始化方法的执行次序，按如下代码实现一个复合式的Bean：

@Component
@Scope(value = "prototype")
public class AllStrategiesExampleBean implements InitializingBean {

    private static final Logger LOG
      = Logger.getLogger(AllStrategiesExampleBean.class);

    public AllStrategiesExampleBean() {
        LOG.info("Constructor");
    }

    @Override
    public void afterPropertiesSet() throws Exception {
        LOG.info("InitializingBean");
    }

    @PostConstruct
    public void postConstruct() {
        LOG.info("PostConstruct");
    }

    //在XML中定义为initMethod
    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

所以，这几种初始化的顺序为：

  1. 构造器方法
  2. @PostConstruct 注解方法
  3. InitializingBean的afterPropertiesSet()
  4. Bean定义的initMethod属性方法

参考文档

https://www.baeldung.com/running-setup-logic-on-startup-in-spring

美码师的 SpringBoot 补习系列

原文地址：https://www.cnblogs.com/littleatp/p/11123577.html

时间： 2024-08-30 09:20:21

补习系列(21)-SpringBoot初始化之7招式的相关文章

SpringBoot 初始化之7招式

背景 在日常开发时,我们常常需要 在SpringBoot 应用启动时执行某一段逻辑,如下面的场景: 获取一些当前环境的配置或变量 向数据库写入一些初始数据 连接某些第三方系统,确认对方可以工作.. 在实现这些功能时,我们可能会遇到一些"坑". 为了利用SpringBoot框架的便利性,我们不得不将整个应用的执行控制权交给容器,于是造成了大家对于细节是一无所知的.那么在实现初始化逻辑代码时就需要小心了,比如,我们并不能简单的将初始化逻辑在Bean类的构造方法中实现,类似下面的代码: @C

补习系列(15)-springboot 分布式会话原理

目录 一.背景 二.SpringBoot 分布式会话 三.样例程序 四.原理进阶 A. 序列化 B. 会话代理 C. 数据老化 小结 一.背景 在 补习系列(3)-springboot 几种scope 一文中,笔者介绍过 Session的部分,如下: 对于服务器而言,Session 通常是存储在本地的,比如Tomcat 默认将Session 存储在内存(ConcurrentHashMap)中. 但随着网站的用户越来越多,Session所需的空间会越来越大,同时单机部署的 Web应用会出现性能瓶颈

补习系列(9)-springboot 定时器，你用对了吗

目录 简介 一.应用启动任务 二.JDK 自带调度线程池 三.@Scheduled 定制 @Scheduled 线程池 四.@Async 定制 @Async 线程池 小结 简介 大多数的应用程序都离不开定时器,通常在程序启动时.运行期间会需要执行一些特殊的处理任务. 比如资源初始化.数据统计等等,SpringBoot 作为一个灵活的框架,有许多方式可以实现定时器或异步任务. 我总结了下,大致有以下几种: 使用 JDK 的 TimerTask 使用 JDK 自带调度线程池 使用 Quartz 调度

补习系列(10)-springboot 之配置读取

目录 简介 一.配置样例 二.如何注入配置 1. 缺省配置文件 2. 使用注解 3. 启动参数 还有.. 三.如何读取配置 @Value 注解 Environment 接口 @ConfigurationProperties 注解 四.不同环境中的配置 1. 区别开发.测试.发布环境 2. 声明多配置文件 参考文档 简介 在早前的博客中曾经写过 Spring 程序通过 Bean 映射实现配置信息的读取. 在SpringBoot 框架中读取配置的方式变得非常多样,这导致读者在搜寻资料时反而容易迷糊.

补习系列(1)-springboot项目基础搭建课

[TOC] 前言 springboot 最近火的不行,目前几乎已经是 spring 家族最耀眼的项目了.抛开微服务.技术社区这些推广因素不说,框架本身的确有非常多的优点.比如 更简化的配置,摒除了许多繁杂的xml配置(事实证明,越简单的东西越容易让人记住): 内置Servlet容器,不再依赖外部环境 大量的starter模块,随手拈来 支持热部署 作为一名老程序员来说,仍然需要保持一个积极学习的态度.哎,简单点说就是少点伤感,认清现实.你曾经引以为傲的某某EE 技术已经被颠覆了,赶紧换车道 ..

补习系列-springboot 实现拦截的五种姿势

目录 简介 姿势一.使用 Filter 接口 1. 注册 FilterRegistrationBean 2. @WebFilter 注解 姿势二.HanlderInterceptor 姿势三.@ExceptionHandler 注解 姿势四.RequestBodyAdvice/ResponseBodyAdvice RequestBodyAdvice 的用法 ResponseBodyAdvice 用法 姿势五.@Aspect 注解 思考 小结 简介 AOP(面向切面编程)常用于解决系统中的一些耦合

补习系列-springboot 单元测试之道

目录 目标 一.About 单元测试 二.About Junit 三.SpringBoot-单元测试 项目依赖 测试样例 四.Mock测试 五.最后 目标 了解 单元测试的背景 了解如何 利用 springboot 实现接口的测试 了解如何 利用 mokito 做代码的 mock 一.About 单元测试 单元测试其实是一种廉价的技术,是由开发者创建运行测试代码,用于对程序模块(软件设计的最小单位)进行正确性检验的一种做法. 而所谓的最小单元,就是指应用的最小可测试部件. 在面向对象领域,最小单

补习系列-springboot-restful应用

一.目标 了解 Restful 是什么,基本概念及风格: 能使用SpringBoot 实现一套基础的 Restful 风格接口: 利用Swagger 生成清晰的接口文档. 二.Restful 入门 什么是REST 摘自百科的定义:REST即表述性状态转移(英文:Representational State Transfer,简称REST) 是Roy Fielding博士(HTTP规范主要贡献者)在2000年的论文中提出来的一种软件架构风格. 是一种针对网络应用的设计和开发方式,可以降低开发的复杂

补习系列(20)-大话 WebSocket 与 &quot;尬聊&quot;的实现

目录 一.聊聊 WebSocket 二.Stomp 是个什么鬼 三.SpringBoot 整合 WebSocket A. 引入依赖 B. WebSocket 配置 C. 控制器 D. 前端实现 四.参考文档 一.聊聊 WebSocket 从HTML5技术流行至今,WebSocket已经有非常广泛的应用: 在线游戏,提供实时的操作交互体验 社交平台,与好友实时的私信对话 新闻动态,获得感兴趣的主题信息推送 ... 这些场景,都需要服务器能主动实时的给浏览器或客户端推送消息,注意关键词是主动,还有实