浅谈SpringBoot中的Bean初始化方法 @PostConstruct

目录

• 注解说明
• 代码示例
• 注解示例
• 错误示例
• 正确示例
• SpringBoot @PostConstruct虽好，也要慎用
• 1 问题的产生
• 2 案例模拟
• 3 总结

注解说明

• 使用注解： @PostConstruct
• 效果：在Bean初始化之后（构造方法和@Autowired之后）执行指定操作。经常用在将构造方法中的动作延迟。
• 备注：Bean初始化时候的执行顺序： 构造方法 -> @Autowired -> @PostConstruct

代码示例

注解示例

@Component
public class PostConstructTest1 {
    @Autowired
    PostConstructTest2 postConstructTest2;
    public PostConstructTest1() {
//        postConstructTest2.hello();
    }
    @PostConstruct
    public void init() {
        // some init function
    }
}

在Bean的初始化操作中，有时候会遇到调用其他Bean的时候报空指针错误。这时候就可以将调用另一个Bean的方法这个操作放到@PostConstruct注解的方法中，将其延迟执行。

错误示例

    @Component
    public class PostConstructTest1 {
        @Autowired
        PostConstructTest2 postConstructTest2;
        public PostConstructTest1() {
            postConstructTest2.hello();
        }
    }

    @Component
    public class PostConstructTest2 {
        public void hello() {
            System.out.println(\"hello, i am PostConstructTest2\");
        }
    }

正确示例

    @Component
    public class PostConstructTest1 {
        @Autowired
        PostConstructTest2 postConstructTest2;
        public PostConstructTest1() {
            postConstructTest2.hello();
        }
    }

@Component
public class PostConstructTest1 {
    @Autowired
    PostConstructTest2 postConstructTest2;
    public PostConstructTest1() {
//        postConstructTest2.hello();
    }
    @PostConstruct
    public void init() {
        postConstructTest2.hello();
    }
}

SpringBoot @PostConstruct虽好，也要慎用

做过SpringBoot开发的话，肯定对@PostConstruct比较熟悉。在一个Bean组件中，标记了@PostConstruct的方法会在Bean构造完成后自动执行方法的逻辑。

1 问题的产生

先说下SpringBoot中Bean的加载过程，简单点说就是SpringBoot会把标记了Bean相关注解（例如@Component、@Service、@Repository等）的类或接口自动初始化全局的单一实例，如果标记了初始化顺序会按照用户标记的顺序，否则按照默认顺序初始化。在初始化的过程中，执行完一个Bean的构造方法后会执行该Bean的@PostConstruct方法（如果有），然后初始化下一个Bean。

那么： 如果@PostConstruct方法内的逻辑处理时间较长，就会增加SpringBoot应用初始化Bean的时间，进而增加应用启动的时间。因为只有在Bean初始化完成后，SpringBoot应用才会打开端口提供服务，所以在此之前，应用不可访问。

2 案例模拟

为了模拟上面说的情况，在SpringBoot项目中建两个组件类ComponentOne和ComponentTwo。耗时的初始化逻辑放在ComponentOne中，并设置ComponentOne的初始化顺序在ComponentTwo之前。完整代码如下：

@Component
@Order(Ordered.HIGHEST_PRECEDENCE)
public class ComponentOne {
    private Logger logger = LoggerFactory.getLogger(this.getClass());
    public ComponentOne() {
        this.logger.info(\"ComponentOne 初始化完成\");
    }
    @PostConstruct
    public void init() {
        this.logger.info(\"ComponentOne 模拟耗时逻辑开始\");
        try {
        	//这里休眠5秒模拟耗时逻辑
            Thread.sleep(1000 * 5);
        } catch (InterruptedException e) {
            logger.info(\"模拟逻辑耗时失败\", e);
        }
        this.logger.info(\"ComponentOne 模拟耗时逻辑完成\");
    }
}

@Component
@Order(Ordered.HIGHEST_PRECEDENCE + 1)
public class ComponentTwo {
    private Logger logger = LoggerFactory.getLogger(this.getClass());
    public ComponentTwo() {
        this.logger.info(\"ComponentTwo 初始化完成\");
    }
    @PostConstruct
    public void init() {
        this.logger.info(\"ComponentTwo 初始化完成后处理\");
    }
}

启动应用，初始化部分日志如下：

3 总结

所以，如果应用有一些初始化操作，有以下几点建议：

• 轻量的逻辑可放在Bean的@PostConstruct方法中
• 耗时长的逻辑如果放在@PostConstruct方法中，可使用独立线程执行
• 初始化操作放在CommandLineRunner或ApplicationRunner的实现组件中

以上为个人经验，希望能给大家一个参考，也希望大家多多支持。