SpringBoot 实现启动项目后立即执行方法的几种方式

朱雀 2023-10-10 22:41 107阅读 0赞

在项目开发中某些场景必须要用到启动项目后立即执行方式的功能，如我们需要去初始化数据到redis缓存，或者启动后读取相应的字典配置等，这篇文章主要聊聊实现立即执行的几种方法。

一、CommandLineRunner和ApplicationRunner

这两者的实现方法一样，都是去继承相应的接口然后重写run方法即可，也都是SpringBoot框架所提供给我们的接口，也是项目中最常用的，比较灵活，有多个CommandLineRunner或ApplicationRunner实现类时可以通过@Order注解或实现Ordered接口重写getOrder方法实现按指定顺序执行

1. CommandLineRunner的实现

java复制代码import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;
@Component
public class CommandLineRunnerImpl implements CommandLineRunner {
    @Override
    public void run(String... args) throws Exception {
        System.out.println("CommandLineRunnerImpl方法执行");
    }
}

2. ApplicationRunner的实现

java复制代码import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.stereotype.Component;
@Component
public class ApplicationRunnerImpl implements ApplicationRunner {
    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println("ApplicationRunner方法执行");
    }

3. 多个CommandLineRunner或ApplicationRunner实现类时指定顺序执行

通过@Order注解指定，数字越小越先执行

java复制代码@Component
@Order(1) //通过order注解指定
public class ApplicationRunnerImpl implements ApplicationRunner {
    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println("ApplicationRunner方法执行");
    }
}

通过实现Ordered接口并重写getOrder方法实现，数字越小越先执行

java复制代码import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.core.Ordered;
import org.springframework.stereotype.Component;
@Component
public class ApplicationRunnerImpl implements ApplicationRunner, Ordered {
    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println("ApplicationRunner方法执行");
    }
    @Override
    public int getOrder() {
        return 1;
    }
}

CommandLineRunner或ApplicationRunner的不同

这两者的不同其实就是run方法中所接收的参数类型不同，CommandLineRunner是对我们启动jar包时所传参数不进行处理，原样返回String类型给你，ApplicationRunner是封装成了ApplicationArguments参数，通过这个类型可以更方便的判断某些参数是否存在之类的。

二、JDK所提供的@PostConstruct

@PostConstruct是JDK所提供的注解，使用该注解的方法会在服务器加载Servlet的时候运行。也可以在一个类中写多个方法并添加这个注解。

java复制代码import org.springframework.stereotype.Component;
import javax.annotation.PostConstruct;
@Component
public class PostConstructTest {
    @PostConstruct
    public void start() {
        System.out.println("@PostConstruct方法执行");
    }
    @PostConstruct
    public void start01() {
        System.out.println("@PostConstruct1111方法执行");
    }
}

三、其他方法(不常用)

1. ApplicationContextAware

java复制代码import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.stereotype.Component;
@Component
public class ApplicationContextAwareImpl implements ApplicationContextAware {
    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        System.out.println("ApplicationContextAwareImpl方法执行");
    }
}

2. ApplicationListener(会执行多次)

java复制代码import org.springframework.context.ApplicationEvent;
import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;
@Component
public class ApplicationListenerImpl implements ApplicationListener {
    @Override
    public void onApplicationEvent(ApplicationEvent event) {
        System.out.println("ApplicationListenerImpl方法执行");
    }
}

3. InitializingBean

java复制代码import org.springframework.beans.factory.InitializingBean;
import org.springframework.stereotype.Component;
@Component
public class InitializingBeanImpl implements InitializingBean {
    @Override
    public void afterPropertiesSet() throws Exception {
        System.out.println("InitializingBeanImpl方法执行");
    }
}