Spring Boot————Web应用启动时自动执行ApplicationListener用法

最新推荐文章于 2025-05-20 17:46:54 发布

转载最新推荐文章于 2025-05-20 17:46:54 发布 · 3.3k 阅读

文章标签：

#Spring Boot #ApplicationListener

Spring & Spring Boot 专栏收录该内容

36 篇文章

订阅专栏

本文介绍如何在Spring项目启动时执行初始化任务，避免重复执行问题。通过实现ApplicationListener接口并监听ContextRefreshedEvent事件，确保仅在rootapplicationcontext初始化完成时调用逻辑代码。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

原文：《web服务启动spring自动执行ApplicationListener的用法》

引言

我们知道，一般来说一个项目启动时需要加载或者执行一些特殊的任务来初始化系统，通常的做法就是用servlet去初始化，但是servlet在使用Spring bean时不能直接注入，还需要在web.xml配置，比较麻烦。今天介绍一下使用spring启动初始化的方法。其实很简单，只需两步就可以了。

在开发时有时候需要在整个应用开始运行时执行一些特定代码，比如初始化环境，准备测试数据、加载一些数据到内存等等。

在spring中可以通过ApplicationListener来实现相关的功能，加载完成后触发contextrefreshedevent事件（上下文件刷新事件）

但是这个时候，会存在一个问题，在web 项目中（spring mvc），系统会存在两个容器，一个是root application context ,另一个就是我们自己的 projectName-servlet context（作为root application context的子容器）。

这种情况下，就会造成onApplicationEvent方法被执行两次。为了避免上面提到的问题，我们可以只在root application context初始化完成后调用逻辑代码，其他的容器的初始化完成，则不做任何处理，修改后代码。

实现方式

1、实现ApplicationListener接口：

public class Init implements ApplicationListener<ContextRefreshedEvent>{

    @Override
    public void onApplicationEvent(ContextRefreshedEvent event) {
        //root application context 没有parent
        if(event.getApplicationContext().getDisplayName().equals("RootWebApplicationContext")){
            //TODO 这里写下将要初始化的内容
        }
    }
}

2、将Init类注册到Spring 容器中

@Configuration
public class ListenerConfig {

    @Bean
    public Init init() {
        return new Init();
    }
}

或通过注解方式：

@Component
public class Init implements ApplicationListener<ContextRefreshedEvent> {
    // 省略内部代码
}

二次调用问题

上面第一步中的实现代码已经通过判断父容器来解决了二次调用的问题，关于二次调用的解释，可以参考下面这篇文章：

《Spring ApplicationListener使用方法及问题》