Spring Boot--06--InitializingBean 和 @PostConstruct

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档

InitializingBean

1.InitializingBean简介：

• InitializingBean是Spring提供的拓展性接口，
• InitializingBean接口为bean提供了属性初始化后的处理方法，它只有一个afterPropertiesSet方法，凡是继承该接口的类，在bean的属性初始化后都会执行该方法。

2.InitializingBean用法

• 自定义MyInitializingBean实现InitializingBean接口

@Component
public class MyInitializingBean implements InitializingBean {
    @Override
    public void afterPropertiesSet() throws Exception {
        System.out.println("我是启动时加载...");
    }
}

3.应用

@ConfigurationProperties(prefix="uploadfile.ftp.upload")
@Configuration
@Getter
@Setter
@Slf4j
public class UploadFileFtpProperties implements InitializingBean {

    @NotBlank(message = "ip must not null")
    private String ip;
    @NotNull(message = "port must not null")
    private Integer port;
    @NotBlank(message = "user must not null")
    private String user;
    @NotBlank(message = "pwd must not null")
    private String pwd;
    @NotBlank(message = "uploadDir must not null")
    private String uploadDir;

    /**
     * 相关文件名
     */
    /**上传的基础数据文件名: FK00006D.CAR*/
    @NotBlank(message = "uploadFileName must not null")
    private String uploadFileName;
    /**存储本地上传文件临时文件夹*/
    @NotBlank(message = "uploadLocalDir must not null")
    private String uploadLocalDir;

    private Long fizeSize;

    private int pageSize;


    private Long clearday;

    /**
     *规范版本号
     */
    private String version;
    /**
     * 源数据系统标识
     */
    private String sysID;

    @Override
    public void afterPropertiesSet() throws Exception {
        String config = JSON.toJSONString(this);
        log.info("北斗营销系统报表下传，配置属性：{}",config);
        try {
            JSRValidatorUtil.validate(this);
        } catch (Exception e) {
            throw new IllegalArgumentException("请检查报表下传是否存在必填项为空！");
        }
    }


    /**
     *
     * @param executeDate
     * @return 文件名称
     */
    public String getAllFileName(String uploadFileName){
        return MessageFormat.format(this.uploadFileName, uploadFileName);
    }

}

@PostConstruct 注解

1.简介

• @PostConstruct 注解是 javax.annotation 包下的注解，通过在方法上添加 @PostConstruct 注解，该方法会在 Bean 初始化完成后自动被调用。
• 它的作用和 InitializingBean 接口的 afterPropertiesSet()方法类似，用于执行一些初始化逻辑。因此，只需要在需要执行初始化操作的方法上添加 @PostConstruct 注解，就可以替代实现 InitializingBean 接口的方式。例如：

public class MyBean {
    @PostConstruct
    public void init() {
        // 初始化操作
    }
}

在上述代码中，init() 方法会在 MyBean 对象的创建和属性设置完成后自动被调用。

2.执行顺序比较

• 构造方法
• @PostConstruct 注解
• 实现InitializingBean方法afterPropertiesSet
• bean初始化init方法执行顺序

@Component
public class MyInitializingBean implements InitializingBean {

    public MyInitializingBean() {
        System.out.println("我是MyInitializingBean构造方法执行...");
    }

    @Override
    public void afterPropertiesSet() throws Exception {
        System.out.println("我是afterPropertiesSet方法执行...");
    }

    @PostConstruct
    public void postConstruct() {
        System.out.println("我是postConstruct方法执行...");
    }

    public void init(){
        System.out.println("我是init方法执行...");
    }

    @Bean(initMethod = "init")
    public MyInitializingBean test() {
        return new MyInitializingBean();
    }
}

通过启动日志我们可以看出执行顺序优先级：构造方法 > postConstruct >afterPropertiesSet > init方法。

在Spring初始化bean的时候，如果该bean实现了InitializingBean接口，并且同时在配置了init-method，系统则是先调用afterPropertieSet()方法，然后再调用init-method中指定的方法。

那么这种方式在spring中是怎么实现的呢，通过查看Spring加载bean的源码类AbstractAutowiredCapableBeanFactory可以看出其中的奥妙，AbstractAutowiredCapableBeanFactory类中的invokeInitMethods说的非常清楚，如下：

protected void invokeInitMethods(String beanName, final Object bean, RootBeanDefinition mbd) throws Throwable {
    //判断该bean是否实现了实现了InitializingBean接口，如果实现了InitializingBean接口，则只掉调用bean的afterPropertiesSet方法
    boolean isInitializingBean = (bean instanceof InitializingBean);
    if (isInitializingBean && (mbd == null || !mbd.isExternallyManagedInitMethod("afterPropertiesSet"))) {
        if (logger.isDebugEnabled()) {
            logger.debug("Invoking afterPropertiesSet() on bean with name '" + beanName + "'");
        }
         
        if (System.getSecurityManager() != null) {
            try {
                AccessController.doPrivileged(new PrivilegedExceptionAction<Object>() {
                    public Object run() throws Exception {
                        //直接调用afterPropertiesSet
                        ((InitializingBean) bean).afterPropertiesSet();
                        return null;
                    }
                },getAccessControlContext());
            } catch (PrivilegedActionException pae) {
                throw pae.getException();
            }
        }                
        else {
            //直接调用afterPropertiesSet
            ((InitializingBean) bean).afterPropertiesSet();
        }
    }
    if (mbd != null) {
        String initMethodName = mbd.getInitMethodName();
        //判断是否指定了init-method方法，如果指定了init-method方法，则再调用制定的init-method
        if (initMethodName != null && !(isInitializingBean && "afterPropertiesSet".equals(initMethodName)) &&
                !mbd.isExternallyManagedInitMethod(initMethodName)) {
            //进一步查看该方法的源码，可以发现init-method方法中指定的方法是通过反射实现
            invokeCustomInitMethod(beanName, bean, mbd);
        }
    }
}

小结：

1. Spring为bean提供了两种初始化bean的方式，实现InitializingBean接口，实现afterPropertiesSet方法，或者在配置文件中通过init-method指定，两种方式可以同时使用。
2. 实现InitializingBean接口是直接调用afterPropertiesSet方法，比通过反射调用init-method指定的方法效率要高一点，但是init-method方式消除了对spring的依赖。
3. 如果调用afterPropertiesSet方法时出错，则不调用init-method指定的方法。