SpringBoot 启动时执行某些操作的 8 种方式

<<< 点赞👍🏻+关注❤️ 每天分享干货好文 >>>

前言

在真实项目开发过程中,我们经常会需要在程序启动时执行一些特定的业务操作,比如系统预热、系统初始化等。小编为大家介绍 8 种实现方式。

实现方案

一、ApplicationRunner

1. 执行时机

SpringBoot 应用完全启动后。

2. 核心特点

实现 ApplicationRunner 接口,通过 ApplicationArguments 对象访问参数,可以更方便地解析命令行参数(例如获取--key=value形式的参数值)。

如果定义了多个Runner,可以使用 @Order 注解来控制他们的执行顺序,数值越小优先级越高。

3. 代码示例
java 复制代码
@Component
@Order(1) // 执行顺序,可选
public class MyApplicationRunner implements ApplicationRunner {
    @Override
    public void run(ApplicationArguments args) throws Exception {
        // 这里写你的启动执行逻辑,例如初始化缓存
        // args 可以访问应用参数
    }
}

二、CommandLineRunner

1. 执行时机

SpringBoot 应用完全启动后。

2. 核心特点

实现 CommandLineRunner 接口,通过 String... args 直接访问命令行原始参数数组。

如果定义了多个Runner,可以使用 @Order 注解来控制他们的执行顺序,数值越小优先级越高。

3. 代码示例
java 复制代码
@Component
@Order(2) // 执行顺序,可选
public class MyCommandLineRunner implements CommandLineRunner {
    @Override
    public void run(String... args) throws Exception {
        // 这里写你的启动执行逻辑
        // args 可以访问命令行原始参数
    }
}

三、@PostConstruct 注解

1. 执行时机

Bean 初始化时,在对象依赖注入完成后执行。

2. 核心特点

注解在方法上,使用简单。

此时 Spring 容器可能还未完全初始化完毕,部分 Bean 可能尚未就绪,需注意可能的依赖问题。

3. 代码示例
java 复制代码
@Component
public class MyInitBean {
    @Autowired
    private SomeRepository repository; // 假设的仓库类,用于数据访问

    @PostConstruct
    public void init() {
        // 例如,在项目启动时从数据库加载数据到静态变量
        List<SomeData> data = repository.findAll();
        // ... 其他处理逻辑
    }
}

四、实现 InitializingBean 接口

1. 执行时机

Bean 的全部属性被设置之后执行。

2. 核心特点

实现接口的 afterPropertiesSet 方法。

@PostConstruct 类似,都是 Bean 生命周期中的初始化方法。

3. 代码示例
java 复制代码
@Component
public class MyInitializingBean implements InitializingBean {
    @Autowired
    private SomeDependency dependency;

    @Override
    public void afterPropertiesSet() throws Exception {
        // 确保属性dependency注入后,再执行初始化
        // 你的初始化逻辑
    }
}

五、实现 BeanPostProcessor 接口

1. 执行时机

在 Bean 的初始化前后执行。

2. 核心特点

实现接口的 postProcessBeforeInitialization 与 postProcessAfterInitialization 方法。

这个接口会影响所有的 bean 初始化。

3. 代码示例
java 复制代码
@Component
public class MyBeanPostProcessor implements BeanPostProcessor {
    @Override
    public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
        // 在初始化之前执行的逻辑
        System.out.println("Before Initialization: " + beanName);
        return bean; // 返回bean本身或一个新的bean实例(可选)
    }
    @Override
    public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
        // 在初始化之后执行的逻辑
        System.out.println("After Initialization: " + beanName);
        return bean; // 返回bean本身或一个新的bean实例(可选)
    }
}

六、实现 BeanFactoryPostProcessor 接口

1. 执行时机

在 Spring 容器初始化时执行,此时容器中所有的 Bean 定义已经加载完,但是 Bean 的实例还未创建。

2. 核心特点

实现接口的 postProcessBeanFactory 方法。

这个接口只会执行一次,执行时机早于 BeanPostProcessor 。

3. 代码示例
java 复制代码
@Component
public class MyBeanFactoryPostProcessor implements BeanFactoryPostProcessor {

    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
        System.out.println("******************** MyBeanFactoryPostProcessor#postProcessBeanFactory ****************");
        System.out.println("******************** bean的数量:[{}] ****************", beanFactory.getBeanDefinitionCount());
        BeanDefinition userBeanDef = beanFactory.getBeanDefinition("student");
        // 修改bean definition属性信息
    }

}

七、实现 ServletContextListener 接口

1. 执行时机

Web 应用启动初期,在初始化任何过滤器或 Servlet 时或者销毁 Web 容器时执行。

2. 核心特点

实现接口的 contextInitialized 和 contextDestroyed 方法。

适用于 Web 环境,监听 Servlet 上下文。

3. 代码示例
java 复制代码
@Component
public class MyServletContextListener implements ServletContextListener {

    @Override
    public void contextInitialized(ServletContextEvent sce) {
        // 在这里写Web应用启动时的逻辑
        // 例如,初始化一些Web应用级别的资源
    }

    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        // 在这里写Web应用关闭时的清理逻辑
    }
}

八、static 静态代码块

1. 执行时机

类被加载时执行。

2. 核心特点

仅仅是类被加载时,Bean 还未被创建。

3. 代码示例
java 复制代码
@Component
public class MyClass {
    static {
        System.out.println("执行静态代码块")
    }
}
相关推荐
ShadowYD1 小时前
Agent Loop:一个让 AI 编程 Agent 从"会写代码"进化到"闭环交付"的开源 Skill(适配国内外主流 Code Agent)
后端
考虑考虑2 小时前
nohup启动java程序
后端·自动化运维
鹿角片ljp3 小时前
LeetCode 64:最小路径和复盘|二维 DP 与 ACM 模式完整写法
java·数据结构·算法
aramae3 小时前
模拟实现strcmp()(C语言)
c语言·开发语言·后端
+VX:Fegn08954 小时前
计算机毕业设计|基于springboot + vue蛋糕店管理系统(源码+数据库+文档)
前端·数据库·vue.js·spring boot·课程设计
泡海椒4 小时前
PDF 表格样式优化:jquick-pdf 边框、圆角、背景色
java·开发语言·pdf
Beyond_System|系统之外5 小时前
【学编程】Python基础编程题100道(21-60)
开发语言·python·算法
根目录下的猫5 小时前
RK3588适配的轻量级AI模型推荐
人工智能·后端·python·目标检测
景熙55235 小时前
15.Java 8 Stream 流入门到实战
java·开发语言·数据结构