关于如何在Spring容器启动的时候执行自定义方法

如何在Spring容器启动的时候执行自定义方法

---

前言

我们在开发的过程中可能会碰到需要在Spring容器启动的时候做一些自定义配置或执行自定义方法，如：初始化配置、提前加载数据到缓存做缓存预热、执行某个特定方法...在容器启动时自动执行，那么Spring提供了哪些方式可以帮助我们自动执行呢？

---

一、@PostConstruct 注解

在方法上添加@PostConstruct 注解并将类注入到Spring容器

@Slf4j
@Component
public class TestPostConstruct {
    @PostConstruct
    public void initMethod() {
        log.info("Spring容器启动时自动执行被@PostConstruct注解标注的方法！");
    }
}

二、静态代码块

@Slf4j
@Component
public class ServletContextListenerImpl {
    /**
     * 静态代码块会在依赖注入后自动执行,并优先执行
     */
    static {
        log.info("Spring容器启动时自动执行静态代码块！");
    }
}

三、实现CommandLineRunner接口，重写run方法

@Slf4j
@Component
public class CommandLineRunnerImpl implements CommandLineRunner {
    @Override
    public void run(String... args) throws Exception {
        log.info("Spring容器启动时自动执行CommandLineRunner 的 run方法！");
    }
}

四、实现ServletContextListener接口，重写contextInitialized方法

@Slf4j
@Component
public class ServletContextListenerImpl implements ServletContextListener {
    /**
    * 在初始化Web应用程序中的过滤器或Servlet之前，通知所有ServletContextListener上下文初始化
    */
    @Override
    public void contextInitialized(ServletContextEvent sce) {
        log.info("Spring容器启动时自动执行ServletContextListener 的 contextInitialized方法！");
    }
}

五、实现ServletContextAware接口，重写setServletContext方法

@Slf4j
@Component
public class ServletContextAwareImpl implements ServletContextAware {
    /**
    * 在填充bean属性之后但在初始化之前调用
    * 类似于InitializingBean's的 afterPropertiesSet或自定义init方法的回调
    */
    @Override
    public void setServletContext(ServletContext servletContext) {
        log.info("Spring容器启动时自动执行ServletContextAware 的 setServletContext方法！");
    }
}

六、@EventListener注解

@Slf4j
@Component
public class EventListenerTest {
    @EventListener
    public void onApplicationEvent(ContextRefreshedEvent event) {
        log.info("Spring容器启动时自动执行被@EventListener注解标注的方法");
    }
}

七、实现ApplicationRunner接口，重写run方法

@Slf4j
@Component
public class ApplicationRunnerImpl implements ApplicationRunner {
    /**
    * 用于指示bean包含在SpringApplication中时应运行的接口。可以定义多个ApplicationRunner bean
    * 在同一应用程序上下文中，可以使用有序接口或@order注释对其进行排序。
    */
    @Override
    public void run(ApplicationArguments args) throws Exception {
        log.info("Spring容器启动时自动执行 ApplicationRunner 的 run 方法");
        Set<String> optionNames = args.getOptionNames();
        for (String optionName : optionNames) {
            log.info("这是传过来的参数[{}]", optionName);
        }
        String[] sourceArgs = args.getSourceArgs();
        for (String sourceArg : sourceArgs) {
            log.info("这是传过来sourceArgs[{}]", sourceArg);
        }
    }
}

---

总结

以上是在Spring容器启动的时候执行自定义方法的几种方式，它们的执行顺序为：

初始化Root ApplicationContext
启动时自动执行 静态代码块
启动时自动执行 ServletContextListener 的 contextInitialized 方法
启动时自动执行 @PostConstruct 注解方法
启动时自动执行 ServletContextAware 的 setServletContext 方法

初始化线程池
Tomcat启动
启动时自动执行 @EventListener 注解方法

Application启动成功
启动时自动执行 ApplicationRunner 的 run 方法
启动时自动执行 CommandLineRunner 的 run 方法