Spring Boot使用方法小札（3）：应用启动后做一些事

有时候我们需要在应用启动或者重启后做一些工作，比如删除一些临时文件或者Redis中的缓存，这在没有使用Spring Boot之前，在Spring框架下是通过ApplicationListener监听器来实现的，在Spring Boot下也有一些办法，可以通过使用CommandLineRunner和ApplicationRunner接口来实现。

在这两个接口中都有run()方法，在Spring Boot程序启动后会检测程序中是否有CommandLineRunner和ApplicationRunner接口的实例，如果存在，则会执行对应实现类中的run()方法，而且只执行一次。

Spring Boot程序启动过程中会实例化ApplicationContext，然后创建所有的Bean。

如果存在多个CommandLineRunner和ApplicationRunner接口的实例，那么它们的执行顺序可以通过@Order注解和Ordered接口来标识，数字越小，优先级越高。

看如下实例：

TaskRunner类：

    public class TaskRunner implements ApplicationRunner, Ordered {
private static final Logger logger = LoggerFactory.getLogger(TaskRunner.class);

@Override
public int getOrder() {
return 2;
        }

@Override
public void run(ApplicationArguments args) throws Exception {
            logger.info("task runner");
        }
    }

StartupRunner类：

    @Order(1)
public class StartupRunner implements CommandLineRunner {
private static final Logger logger = LoggerFactory.getLogger(StartupRunner.class);

@Autowired
@Qualifier("primaryDataSource")
private DataSource primaryDataSource;

@Autowired
@Qualifier("secondaryDataSource")
private DataSource secondDataSource;

@Override
public void run(String... args) throws Exception {
            logger.info("startup runner");
            System.out.print(primaryDataSource.getConnection().getMetaData().getURL());
            System.out.print(secondDataSource.getConnection().getMetaData().getURL());
        }
    }

然后在Application主类中定义这两个bean，由于@SpringBootApplication注解中包含@Configuration注解，所以@Bean注解在其中也会起作用，如下：

    @SpringBootApplication
public class SpringBootTemplateApplication {

public static void main(String[] args) {
            SpringApplication.run(SpringBootTemplateApplication.class, args);
        }

@Bean
public StartupRunner startupRunner(){
return new StartupRunner();
        }

@Bean
public TaskRunner taskRunner(){
return new TaskRunner();
        }
    }

输出如下：

可以看出由于StartupRunner类优先级较高所以先运行，TaskRunner后运行。

关于CommandLineRunner和ApplicationRunner的区别，在官方文档中是这么说的：

Interface used to indicate that a bean should run when it is contained within
a SpringApplication. Multiple CommandLineRunner beans can be defined
within the same application context and can be ordered using the Ordered
interface or @Order annotation.
If you need access to ApplicationArguments instead of the raw String array consider using ApplicationRunner.

其实没有很大区别，如果想要更详细地获取命令行参数，那就使用ApplicationRunner接口。