【每天学点Spring】Spring初始化之@PostConstruct、init-method、InitializingBean

系统想要在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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,634评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,951评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,427评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,770评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,835评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,799评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,768评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,544评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,979评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,271评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,427评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,121评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,756评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,375评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,579评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,410评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,315评论 2 352

推荐阅读更多精彩内容