Spring 注解面面通 之 @PostConstruct 应用解析以及与afterPropertiesSet、init-method对比

最新推荐文章于 2024-08-18 02:47:11 发布
最新推荐文章于 2024-08-18 02:47:11 发布
阅读量3.7k 收藏 10
点赞数 8
分类专栏： Spring 全面解析 文章标签： Spring PostConstruct init-method Initializing Bean
本文为博主原创文章，未经博主允许不得转载。
本文链接：https://blog.csdn.net/securitit/article/details/111353318
版权

  简介

  JSR-250规范为Bean初始化之后/销毁之前方法指定了两个注解：@PostConstruct和@PreDestroy，这两个注解可以应用在方法级别上，@PostConstruct注释方法在Bean实例化之后、应用注入之前调用，@PreDestroy注释方法在Bean实例销毁之前调用。

  @PostConstruct和@PreDestroy规范中要去较为严格，但Spring在实现时，并未完全按照其规范实现，在Spring中应用@PostConstruct和@PreDestroy这两个注解，以实现约束为准即可。

  注意事项

  InitializingBean注意事项：

  ① Bean必须实现InitializingBean接口。

  ② Bean的afterPropertiesSet不能使用@PostConstruct注释。

  init-method注意事项：

  ① init-method指定属性不能为空。

  ② Bean不可以实现InitializingBean接口或Bean的init-method方法名不可以为afterPropertiesSet。

  ③ Bean的init-method方法不能使用@PostConstruct注释。

  @PostConstruct注意事项：

  ① 可以应用于任何可见性的方法：public、package-protected、protected或private。

  ② 不能注释在InitializingBean.afterPropertiesSet()和init-method方法上，可能导致后两者失效。

  演示示例

  @PostConstruct、InitializingBean和init-method都可以用作Bean初始化相关操作，示例将一起演示这三种方式。

  1) 建InitTestBean，用于进行初始化相关的测试。

  ① 实现InitializingBean接口，重写afterPropertiesSet()方法。

  ② 添加initMethod()方法，用于进行init-method的配置。

  ③ 添加postConstructor()方法，用于@PostConstruct注解注释。

package com.arhorchin.securitit.initbean;

import javax.annotation.PostConstruct;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.InitializingBean;

/**
 * @author Securitit.
 * @note Bean初始化测试.
 */
public class InitTestBean implements InitializingBean {

    /**
     * logger.
     */
    private Logger logger = LoggerFactory.getLogger(InitTestBean.class);
    
    @Override
    public void afterPropertiesSet() throws Exception {
        logger.info("调用InitializingBean的afterPropertiesSet方法.");
    }
    
    public void initMethod() throws Exception {
        logger.info("调用init-method的initMethod方法.");
    }
    
    @PostConstruct
    public void postConstructor() throws Exception {
        logger.info("调用@PostConstruct注释的方法.");
    }

}

  2) 在Spring的配置文件中增加Bean声明，并指定init-method属性。

<bean class="com.arhorchin.securitit.initbean.InitTestBean" init-method="initMethod"></bean>

  3) 运行程序查看效果，可以看到如下的输出。

2020-12-17 14:42:12 INFO [c.a.s.i.InitTestBean] 调用@PostConstruct注释的方法.
2020-12-17 14:42:12 INFO [c.a.s.i.InitTestBean] 调用InitializingBean的afterPropertiesSet方法.
2020-12-17 14:42:12 INFO [c.a.s.i.InitTestBean] 调用init-method的initMethod方法.

  从运行结果可以看出：

  ① @PostConstruct先于InitializingBean.afterPropertiesSet()。

  ② InitializingBean.afterPropertiesSet()先于init-method的initMethod()。

  自定义注解示例

  @PostConstruct和@PreDestroy实现关键在于org.springframework.beans.factory.annotation.InitDestroyAnnotationBeanPostProcessor，而InitDestroyAnnotationBeanPostProcessor允许通过setInitAnnotationType(...)和setDestroyAnnotationType(...)来自定义初始化和销毁注解类型。

  1) 自定义注解@DefPostConstruct，用于进行演示。

package com.arhorchin.securitit.initbean;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author Securitit.
 * @note 自定义初始化注解.
 */
@Documented
@Retention (RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface DefPostConstruct {

}

  2) 建DefApplicationContextAware，实现ApplicationContextAware，用于通过InitDestroyAnnotationBeanPostProcessor的setInitAnnotationType(...)和setDestroyAnnotationType(...)设置初始化和销毁注解类型。

package com.arhorchin.securitit.initbean;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.annotation.InitDestroyAnnotationBeanPostProcessor;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;

/**
 * @author Securitit.
 * @note 用于测试自定义注解的ApplicationContextAware.
 */
public class DefApplicationContextAware implements ApplicationContextAware {

    /**
     * logger.
     */
    private Logger logger = LoggerFactory.getLogger(DefApplicationContextAware.class);

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        InitDestroyAnnotationBeanPostProcessor initDestroy = null;
        
        initDestroy = applicationContext.getBean(InitDestroyAnnotationBeanPostProcessor.class);
        logger.info("BeanPostProcessor.postProcessBeforeInitialization调用.Bean名称：" + initDestroy);
        initDestroy.setInitAnnotationType(DefPostConstruct.class);
        initDestroy.setDestroyAnnotationType(DefPreDestroy.class);
    }

}

  3) 修改InitTestBean，用于进行初始化相关的测试。

package com.arhorchin.securitit.initbean;

import javax.annotation.PostConstruct;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.InitializingBean;

/**
 * @author Securitit.
 * @note Bean初始化测试.
 */
public class InitTestBean implements InitializingBean {

    /**
     * logger.
     */
    private Logger logger = LoggerFactory.getLogger(InitTestBean.class);
    
    @Override
    public void afterPropertiesSet() throws Exception {
        logger.info("调用InitializingBean的afterPropertiesSet方法.");
    }
    
    public void initMethod() throws Exception {
        logger.info("调用init-method的initMethod方法.");
    }
    
    @DefPostConstruct
    public void postConstructor() throws Exception {
        logger.info("调用@PostConstruct注释的方法.");
    }

}

  4) 在Spring的配置文件中增加Bean声明，并指定init-method属性，同时配置DefApplicationContextAware。

<!-- 配置 ApplicationContextAware -->
<bean
	class="com.arhorchin.securitit.initbean.DefApplicationContextAware"></bean>
<!-- 配置 InitTestBean -->
<bean class="com.arhorchin.securitit.initbean.InitTestBean"
    init-method="initMethod"></bean>

  5) 运行程序查看效果，可以看到如下的输出。

2020-12-17 17:01:08 INFO [c.a.s.i.DefApplicationContextAware] ApplicationContextAware.setApplicationContext调用.Bean：org.springframework.context.annotation.CommonAnnotationBeanPostProcessor@3027f7ce
2020-12-17 17:01:08 INFO [c.a.s.i.InitTestBean] 调用@DefPostConstruct注释的方法.
2020-12-17 17:01:08 INFO [c.a.s.i.InitTestBean] 调用InitializingBean的afterPropertiesSet方法.
2020-12-17 17:01:08 INFO [c.a.s.i.InitTestBean] 调用init-method的initMethod方法.

  可以看到，自定义注解同样达到了与@PostConstruct注解相同的效果。

  总结

  本文对@PostConstruct的应用进行了演示，同时一并演示了InitializingBean和init-method，并通过示例验证了三者之间的调用顺序，充分了解这点，还是十分有用的。

  源码解析基于spring-framework-5.0.5.RELEASE版本源码。

  若文中存在错误和不足，欢迎指正！

securitit
关注
专栏目录
Spring注解(生命周期)
art_code的博客
04-04 1772
Spring注解(生命周期) 对于上面的知识图解，需要一点一点的研究。 首先核心容器： 控制反转 和 依赖注入 创建工程： maven仓库搜索 spring context ： 引入后 <!-- https://mvnrepository.com/artifact/org.springframework/spring...
Spring的接口InitializingBean、BeanPostProcessor以及注解@PostConstruct、bean的init-method的执行先后顺序
qq_23876769的博客
01-20 5964
InitializingBean     InitializingBean接口为bean提供了初始化方法的方式，它只包括afterPropertiesSet方法，凡是继承该接口的类，在初始化bean的时候都会执行该方法。 public class MyServiceImpl implements MyService, InitializingBean { @Override public...
源码深入解析spring 的初始化方法 initMethod (标有注解的@postConstruct的方法)–极度细致!
12-22
一.说在前面（结论思考） @postConstruct 所标注的方法 内部是靠的spring提供的两个后置处理器（InitDestroyAnnotationBeanPostProcessor 和 CommonAnnotationBeanPostProcessor）共同 协调分布处理完成的。 这2点也是网上绝大部人没讲明白的，很多人都只是说到一个，其实我之前看源码也是以为一个，结果，后面由于xxx 我发现了是两个！！还有就是他们各种如何协调作用完成工作的？是各自又是在 bean 的生命周期的哪一个阶段`起的作用？ 二.弄清InitDestroyAnnotationBeanPostProcesso
PostConstruct 注解详解
最新发布
weixin_32752827的博客
08-18 37
@PostConstruct 是一个标记注解，用于指定在对象创建后需要立即执行的方法。它被用于标注一个非静态的void方法，该方法将在依赖注入完成后自动调用。 使用场景： 初始化配置：@PostConstruct可用于执行初始化配置，例如加载配置文件、创建数据库连接等。 注册监听器：@PostConstruct可用于注册...
@PostConstruct与afterPropertiesSet
qq_37436172的博客
01-31 3023
PostConstract和afterPropertiesSet都是在bean的属性注入完毕之后才执行，都可以用来进行bean 的初始化@PostConstract是通过BeanPostProcessor的前置方法中执行的（我们也可以参考这个自定义注解实现），略早于通过继承InitializingBean的afterPropertiesSet初始化方法。
spring中Constructor、@Autowired、@PostConstruct的顺序
热门推荐
u014515854的博客
12-18 5万+
其实从依赖注入的字面意思就可以知道，要将对象p注入到对象a，那么首先就必须得生成对象p与对象a，才能执行注入。所以，如果一个类A中有个成员变量p被@Autowired注解，那么@Autowired注入是发生在A的构造方法执行完之后的。 如果想在生成对象时候完成某些初始化操作，而偏偏这些初始化操作又依赖于依赖注入，那么就无法在构造函数中实现。为此，可以使用@PostConstruct注解一个方
Spring中构造器、init-method、@PostConstruct、afterPropertiesSet孰先孰后，自动注入发生时间以及单例多例的区别、SSH线程安全问题...
weixin_34192732的博客
08-04 1425
　　 　　首先明白，spring的IOC功能需要是利用反射原理，反射获取类的无参构造方法创建对象，如果一个类没有无参的构造方法spring是不会创建对象的。在这里需要提醒一下，如果我们在class中没有显示的声明构造方法，默认会生成一个无参构造方法，但是当我们显示的声明一个有参构造方法的时候，JVM不会帮我们生成无参构造方法,所以我们声明一个带参数的构造方法也需要声明一个无参构造方法。(题外话:...
@PostConstruct、init-method和afterPropertiesSet三种初始化bean的执行顺序
weixin_46374887的博客
07-07 1426
三种方式可以实现bean的生命周期初始化回调 1.在方法上加@PostConstruct注解 2.在xml中配置init-method方法 3.实现InitializingBean接口，并重写afterPropertiesSet方法 那么这三种方式同时存在时，它们的执行顺序如何呢？ @Component @Data public class A implements InitializingBean{ @Autowired private B b; public A(){
@PostConstruct注解用来获取springbean对象.txt
06-07
获取springbean对象
Spring定时任务中@PostConstruct被多次执行异常的分析与解决
08-29
在Spring框架中，`@PostConstruct` 是一个用于标记初始化方法的注解，该方法会在对象完全初始化并准备好服务之前调用。然而，在Spring定时任务（如使用`@Scheduled`注解的方法）中，如果遇到`@PostConstruct`被多次...
Spring注解驱动开发之使用@PostConstruct和@PreDestroy指定初始化和销毁前后的方法
桐花思雨
10-03 837
在之前的文章中，我们介绍了如何使用@Bean注解指定初始化和销毁的方法，也介绍了使用和来处理bean的初始化和销毁。除此之外，在JDK中还提供了两个注解能够在bean创建完成且属性赋值完成之后初始化方法之前执行一些工作和在容器销毁bean之前通知我们进行一些工作。
源码解析：init-method、@PostConstruct、afterPropertiesSet孰先孰后
炎黄的专栏
05-29 3759
Spring 容器中的 Bean 是有生命周期的，Spring 允许在 Bean 在初始化完成后以及Bean 销毁前执行特定的操作，常用的设定方式有以下三种： 通过实现InitializingBean/DisposableBean 接口来定制初始化之后/销毁之前的操作方法；通过 元素的 init-method/destroy-method属性指定初始化之后 /销毁之前调用的操作方法；在指定方
@PostConstruct
weixin_45518808的博客
05-23 392
@PostConstruct
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值