在SpringBoot中，怎么在应用程序启动或退出时执行初始化或者清理工作？

Posted 2022-12-07 DreamMakers

在SpringBoot中，怎么在程序启动或退出时执行初始化或者清理工作？

有的时候我们需要在应用程序启动的时候执行一些资源初始化的工作，或者在应用程序退出的时候进行一些资源释放的工作，那么该如何做呢？这篇文章针对两个问题做一个汇总说明。

怎么在应用程序启动时执行一些初始化工作？

我们在开发中可能会有这样的情景。需要在容器启动的时候执行一些内容。比如读取配置文件，数据库连接之类的。SpringBoot给我们提供了两个接口来帮助我们实现这种需求。这两个接口分别为CommandLineRunner和ApplicationRunner。他们的执行时机为容器启动完成的时候。

这两个接口中有一个run方法，我们只需要实现这个方法即可。
这两个接口的不同之处在于：ApplicationRunner中run方法的参数为ApplicationArguments，而CommandLineRunner接口中run方法的参数为String数组。

下面我写两个简单的例子，来看一下这两个接口的实现。

（1）通过CommandLineRunner接口实现

package com.majing.test.springbootdemo.init;

import org.springframework.boot.CommandLineRunner;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

@Component
@Order(1)
public class CommandLineRunnerTest implements CommandLineRunner 
    @Override
    public void run(String... args) throws Exception 
        System.out.println("这是测试CommandLineRunner的示例。");
    

（2）通过ApplicationRunner接口实现

package com.majing.test.springbootdemo.init;

import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

@Component
@Order(2)
public class ApplicationRunnerTest implements ApplicationRunner 
    @Override
    public void run(ApplicationArguments args) throws Exception 
        System.out.println("这是测试ApplicationRunner接口");
    

上面的初始化工作我们可以定义多个，当然正常情况下我们会定义一个然后在这一个里面按照先后顺序执行相应的逻辑，但是如果定义了多个，而我们由希望按照指定的顺序执行，那么该怎么做呢？

@Order注解：如果有多个实现类，而你需要他们按一定顺序执行的话，可以在实现类上加上@Order注解。@Order(value=整数值)。SpringBoot会按照@Order中的value值从小到大依次执行。

如下所示，如果不加@Order注解，那么我本地运行的顺序是先执行ApplicationRunner而后运行CommandLineRunner，但是加了@Order之后就按照我指定的顺序执行了。

怎么在应用程序退出时执行一些资源释放逻辑？

和在启动时执行一些初始化工作类似，在应用程序退出时，我们也可以通过一些方式来执行一些逻辑，这里也提供两种方式。

（1）通过实现DisposableBean接口

package com.majing.test.springbootdemo.init;

import org.springframework.beans.factory.DisposableBean;
import org.springframework.stereotype.Component;

@Component
public class ExitCode implements DisposableBean 
    @Override
    public void destroy() throws Exception 
        System.out.println("执行ExitCode中的退出代码");
    

（2）通过@PreDistroy注解

package com.majing.test.springbootdemo.init;

import org.springframework.stereotype.Component;

import javax.annotation.PreDestroy;

@Component
public class AnnotationPreDistroyExitCode 
    @PreDestroy
    public void exit()
        System.out.println("执行AnnotationPreDistroyExitCode中的exit()退出代码");
    

执行后的先后顺序如下：

但是需要注意的是，对于通过上面两种方式实现的退出，在执行顺序上不能进行控制，即使使用了@Order注解，肯定是先执行实现了DisposableBean接口的类，之后才是执行使用@PreDistroy注解的方法。