springboot的启动自动执行任务实现CommandLineRunner接口

最新推荐文章于 2025-01-08 12:00:26 发布

原创最新推荐文章于 2025-01-08 12:00:26 发布 · 515 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#springboot

springboot 专栏收录该内容

10 篇文章

订阅专栏

本文介绍如何使用SpringBoot的CommandLineRunner接口在项目启动时执行初始化代码。通过实现该接口，可以确保代码仅在应用生命周期开始时运行一次。文章还解释了如何通过@Order注解控制多个实现类的执行顺序。

Springboot项目启动自动执行任务CommandLineRunner接口

Spring boot的CommandLineRunner接口主要用于实现在应用初始化后，去执行一段代码块逻辑，这段初始化代码在整个应用生命周期内只会执行一次。

***CommandLineRunner接口的作用***平常开发中有可能需要实现在项目启动后执行的功能，SpringBoot提供的一种简单的实现方案就是添加一个model并实现CommandLineRunner接口，实现功能的代码放在实现的run方法中

package org.springboot.sample.runner;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;

@Component
public class MyStartupRunner implements CommandLineRunner {

@Override
public void run(String... args) throws Exception {
System.out.println(">>>>>>>>>>>>>>>服务启动执行，执行初始化操作<<<<<<<<<<<<<");
}

}

如果有多个类实现CommandLineRunner接口，如何保证顺序

SpringBoot在项目启动后会遍历所有实现CommandLineRunner的实体类并执行run方法，如果需要按照一定的顺序去执行，那么就需要在实体类上使用一个@Order注解（或者实现Order接口）来表明顺序

package org.springboot.sample.runner;

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


@Component
@Order(value=2)
public class MyStartupRunner1 implements CommandLineRunner {

@Override
public void run(String... args) throws Exception {
System.out.println(">>>>>>>>>>>>>>>服务启动执行 666<<<<<<<<<<<<<");
}

}

package org.springboot.sample.runner;

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

@Component
@Order(value=1)
public class MyStartupRunner2 implements CommandLineRunner {

@Override
public void run(String... args) throws Exception {
System.out.println(">>>>>>>>>>>>>>>服务启动执行 123 <<<<<<<<<<<<<");
}

}

控制台显示

>>>>>>>>>>>>>>>服务启动执行 123 <<<<<<<<<<<<<
>>>>>>>>>>>>>>>服务启动执行 666<<<<<<<<<<<<<

根据控制台结果可判断，@Order 注解的执行优先级是按value值从小到大顺序。

也可以和@SpringBootApplication注解一起在启动类里使用

这种使用方式也相当的简单，参考代码如下：

@SpringBootApplication
public class SpringBootWebApplication extends SpringBootServletInitializer implements CommandLineRunner {

@Override
protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
    return application.sources(SpringBootWebApplication.class);
}

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


@Override
public void run(String... args) throws Exception {
    logger.info("Application Started !!");
}

}