SpringBoot - @PostConstruct 注解详解

不念不忘少年蓝@ 2023-10-08 16:28 46阅读 0赞

#### 写在前面 ####

由JDK提供了@PostConstruct注解，主要用于在Spring容器启动时执行某些操作或者任务，@PostConstruct注解一般放在BEAN的方法上，一旦BEAN初始化完成之后，将会调用这个方法。  
一般在Spring框架的项目中使用到@PostConstruct注解时，该注解的方法在整个BEAN初始化中的执行顺序为：Constructor(构造方法) -> @Autowired(依赖注入) -> @PostConstruct(注释的方法)。  
@PostConstruct：由JSR-250提供，在构造函数执行完之后执行该注解标注的方法，等价于XML配置文件中BEAN的initMethod方法；  
@PreDestory：由JSR-250提供，在BEAN销毁之前执行该注解标注的方法，等价于XML配置文件中BEAN的destroyMethod方法。

[SpringBoot - ApplicationRunner的作用是什么？][SpringBoot - ApplicationRunner]  
[SpringBoot - InitializingBean的作用是什么？][SpringBoot - InitializingBean]

#### 注解源码 ####

package javax.annotation;
    
    import java.lang.annotation.*;
    import static java.lang.annotation.ElementType.*;
    import static java.lang.annotation.RetentionPolicy.*;
    @Documented
    @Retention (RUNTIME)
    @Target(METHOD)
    public @interface PostConstruct {
        
    }

#### 使用场景 ####

使用@PostConstruct注解能够在当前类加载时，为当前类初始化一些数据。通常在Service的实现类中，如果想在当前类加载的时候进行一系列的初始化操作，这时就可以使用@PostConstruct。@PostConstruct可以在容器没有完全启动的情况下能够进行初始化操作。

#### 如何使用 ####

###### ①. 方式一 ######

@Component
    @Slf4j
    public class SimpleExampleBean {
        
        @PostConstruct
        public void init(){
        
            log.info("BEAN初始化完毕，调用INIT()...");
        }
    }

###### ②. 方式二 ######

@Slf4j
    public class MySimpleExampleBean {
        
        public void init(){
        
            log.info("BEAN初始化完毕，调用INIT()...");
        }
    }
    
    // 在配置类中通过@Bean实例化这个Bean，@Bean中的initMethod这个属性，需要指定初始化之后需要执行的方法。
    @Bean(initMethod = "init")
    public MySimpleExampleBean mySimpleExampleBean (){
        
        return new MySimpleExampleBean();
    }

#### 使用总结 ####

A. 注解修饰的方法是在依赖注入完成之后执行的；  
B. 注解修饰的方法除了应用客户端外，不能是静态的；  
C. 注解修饰的方法可以是final的；  
D. 注解可以修饰一个非静态的void()方法；  
E. 注解修饰的方法可以被public、protected、package private 或者private修饰。

#### 源码、示例及DEMO ####

[源码、示例及DEMO][DEMO]

[SpringBoot - ApplicationRunner]: https://blog.csdn.net/goodjava2007/article/details/126356485?spm=1001.2014.3001.5502
[SpringBoot - InitializingBean]: https://blog.csdn.net/goodjava2007/article/details/122245457?spm=1001.2014.3001.5502
[DEMO]: https://gitee.com/cloneme01/preflight