SpringBoot 初始化之7招式

背景

在日常开发时，我们常常需要 在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://blog.51cto.com/14254788/2416429

时间： 2024-10-08 18:22:05

SpringBoot 初始化之7招式的相关文章

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

目录 背景 1. @PostConstruct 注解 2. InitializingBean 接口 3. @Bean initMethod方法 4. 构造器注入 5. ApplicationListener 6. CommandLineRunner 7. ApplicationRunner 测试代码 参考文档 背景 在日常开发时,我们常常需要 在SpringBoot 应用启动时执行某一段逻辑,如下面的场景: 获取一些当前环境的配置或变量 向数据库写入一些初始数据 连接某些第三方系统,确认对方可以

Java正则速成秘籍（一）之招式篇

目录 导读 概述 Pattern类 Matcher类 校验文本是否与正则规则匹配 案例:lookingAt vs find vs matches 查找匹配正则规则的文本位置 案例:使用start().end().group() 查找所有匹配正则条件的子序列 替换匹配正则规则的文本 案例:replaceFirst vs replaceAll 案例:appendReplacement.appendTail和replaceAll 案例:quoteReplacement和replaceAll,解决特殊字

【游戏】侠客风云传所有npc招式及功体一览

小虾米镇楼 此贴招式及功体介绍时会采用官方排名(不代表实战测试排名,仅供娱乐)从第100~1名,所有可实战角色都会测试,一百名开外的角...http://weibo.com/2015/p/1001603885094615032130http://weibo.com/2015/p/1001603885094698911497http://weibo.com/2015/p/1001603885094698919696http://weibo.com/2015/p/100160388509470311

内修敏捷开发心法 + 外炼持续整合招式

说好的软件质量 提升软件质量是我们一直追求的理想,但软件开发唯一不变的真理就是变,为了应付变化多端的软件开发过程,敏捷开发提倡了一种拥抱变化的软件开发理念,少说也替软件开发人员带来了不少小确幸. 这些软件开发模型与方法论,最终的目的在于软件开发管理与质量的提升,与其说质量提升倒不如说是维持一定的水平.虽然敏捷开发有很多不同的方法论 (例如 Scrum, XP 等等),但我们注意到这些方法论都一定会提到「持续整合 (Continuous Integration)」这个概念.持续整合到底是何方神圣?

太极拳养生 太极拳招式你知道多少

养生导读:近年来,越来越多人都喜欢练习太极拳,中老年人占的比重最多,因为中老年人有多余的时间,并且长期练习太极拳还能强身健体.今天大家跟着小编一起来了解下太极拳的招式. 太极拳真的对很多的老年人和身体素质比较差的人,比较好的,希望大家多多的进行太极拳练习,这样你的身体会越来越好的呢. 太极拳是锻炼身体.增强体质的有效方法之一.其实此项运动老少皆宜,要学会也不难,今天就教大家练习时尚潮人必学的太极拳招式,一起来学习一下吧! 1.太极站桩 双手自然抱住肚脐下三寸小腹丹田,用意念想着丹田,入静,吐故纳

2015重磅炸弹——【视频】Android设计招式之美

本年度的第二颗重磅炸弹紧跟着来了!适合掌握Android开发基础,希望进一步提升自己能力的朋友! Android设计招式之美,高焕堂老师主讲,总共54节课. 为了方便大家观看,直接传了MP4格式的视频文件,不想下载的朋友可以在线观看. 链接: http://pan.baidu.com/s/1i38B5fJ 密码: kj65 望支持,谢谢!

解密DNSPOD应对DDoS攻击招式！

近期,安全专家Incapsula在最新版<DDoS威胁环境报告>指出,如今实施DDoS攻击的人只有两类:一类是专业网络黑客,而另一类就是所谓的botter.简言之,booter就是僵尸网络出租服务(botnet-for-hire serviceonline),几乎40%的网络攻击是由这些僵尸网络造成的. DDoS攻击现状越发严重 根据Verisign iDefense的最新安全调查报告,在2015年第一季度,DDoS攻击变得更加猖獗,相比2014年同比增长达7%. 由Akamai发布的<

Shell常用招式大全之入门篇

本文为shell的一个系列教程,分为入门篇.命令篇.实战篇 教程里尽量减少复杂的文字描述,不求全,但求精,以实例为主,目标是让读者快速上手shell. 以下为本教程的第一部分<入门篇>,欢迎读者拍砖及找BUG,后续会根据反馈进行修改及补充. CSDN的Markdown生成的目录显示符号有一点小问题,大家以详细内容中的标题为准. 入门篇 第一招 HelloWorld 第一式echo 第二招 判断 第一式if 判断原理 第二式test 和 文件测试 字符串比较 整数比较 第三式 第三招循环 第一式

springboot 初始化 web 项目 启动报错。。。一直解决不了

1. 一个简单的SpringBoot项目,启动时报错信息: ERROR 18688 --- [cat-startStop-1] org.apache.catalina.core.ContainerBase : A child container failed during start java.util.concurrent.ExecutionException: org.apache.catalina.LifecycleException: Failed to start component