SpringBoot中CommandLineRunner 接口详细说明

一、引言
应用场景:基于目前业务需求需要提前将部分数据加载到Spring容器中。大家可以想一下解决方案,能够想到的解决方案:

定义静态常量,随着类的生命周期加载而提前加载(这种方式可能对于工作经验较少的伙伴,选择是最多的);
实现CommandLineRunner接口;容器启动之后,加载实现类的逻辑资源,已达到完成资源初始化的任务;
@PostConstruct;在具体Bean的实例化过程中执行,@PostConstruct注解的方法,会在构造方法之后执行;
加载顺序为:Constructor > @Autowired > @PostConstruct > 静态方法;

特点:
只有一个非静态方法能使用此注解
被注解的方法不得有任何参数
被注解的方法返回值必须为void
被注解方法不得抛出已检查异常
此方法只会被执行一次
实现InitializingBean接口;重写afterPropertiesSet()方法;
以上方案供大家参考,提供一种解决思路。但是日常开发中有可能需要实现在项目启动后执行的功能,因此诞生了此篇文章。思路:SpringBoot提供的一种简单的实现方案,实现CommandLineRunner接口,实现功能的代码放在实现的run方法中加载,并且如果多个类需要夹加载顺序,则实现类上使用@Order注解,且value值越小则优先级越高。

二、实践
上面做了简单的介绍,下面我们进入实战part。
基于CommandLineRunner接口建立两个实现类为RunnerLoadOne 、RunnerLoadTwo ;并设置加载顺序;
这里使用了ClassDo对象,主要是能够体现@Order注解的加载顺序,实际应用开发中,大家根据业务需求场景适当调整(学以致用吧)。

@Component
@Order(1)
public class RunnerLoadOne implements CommandLineRunner {

    @Override
    public void run(String... args) throws Exception {
        ClassDo classDo = SpringContextUtil.getBean(ClassDo.class);
        classDo.setClassName("Java");
        System.out.println("------------容器初始化bean之后,加载资源结束-----------");
    }
}

@Component
@Order(2)
public class RunnerLoadTwo implements CommandLineRunner {
    @Override
    public void run(String... args) throws Exception {
        ClassDo bean = SpringContextUtil.getBean(ClassDo.class);
        System.out.println("依赖预先加载的资源数据:" + bean.getClassName());
    }
}



启动主实现类,看到console打印的结果如下:

2020-08-06 21:20:14.582  INFO 6612 --- [           main] o.s.j.e.a.AnnotationMBeanExporter        : Bean with name 'dataSource' has been autodetected for JMX exposure
2020-08-06 21:20:14.592  INFO 6612 --- [           main] o.s.j.e.a.AnnotationMBeanExporter        : Located MBean 'dataSource': registering with JMX server as MBean [com.zaxxer.hikari:name=dataSource,type=HikariDataSource]
2020-08-06 21:20:14.686  INFO 6612 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8666 (http) with context path ''
2020-08-06 21:20:14.693  INFO 6612 --- [           main] com.qxy.InformalEssayApplication         : Started InformalEssayApplication in 121.651 seconds (JVM running for 173.476)
------------容器初始化bean之后,加载资源结束-----------
依赖预先加载的资源数据:Java


三、源码跟踪
通过上面的实践操作,大家应该理解如何使用的,下面带着大家理解一下底层如何实现的;
常规操作,主启动类debugger走起来~

run()方法
跟进run方法后,一路F6直达以下方法
public ConfigurableApplicationContext run(String... args) {
   StopWatch stopWatch = new StopWatch();
   //设置线程启动计时器
   stopWatch.start();
   ConfigurableApplicationContext context = null;
   Collection<SpringBootExceptionReporter> exceptionReporters = new ArrayList<>();
   //配置系统属性:默认缺失外部显示屏等允许启动
   configureHeadlessProperty();
   //获取并启动事件监听器,如果项目中没有其他监听器,则默认只有EventPublishingRunListener
   SpringApplicationRunListeners listeners = getRunListeners(args);
   //将事件广播给listeners
   listeners.starting();
   try {
       //对于实现ApplicationRunner接口,用户设置ApplicationArguments参数进行封装
      ApplicationArguments applicationArguments = new DefaultApplicationArguments(
            args);
      //配置运行环境:例如激活应用***.yml配置文件      
      ConfigurableEnvironment environment = prepareEnvironment(listeners,
            applicationArguments);
      configureIgnoreBeanInfo(environment);
      //加载配置的banner(gif,txt...),即控制台图样
      Banner printedBanner = printBanner(environment);
      //创建上下文对象,并实例化
      context = createApplicationContext();
      exceptionReporters = getSpringFactoriesInstances(
            SpringBootExceptionReporter.class,
            new Class[] { ConfigurableApplicationContext.class }, context);
      //配置SPring容器      
      prepareContext(context, environment, listeners, applicationArguments,
            printedBanner);
      //刷新Spring上下文,创建bean过程中      
      refreshContext(context);
      //空方法,子类实现
      afterRefresh(context, applicationArguments);
      //停止计时器:计算线程启动共用时间
      stopWatch.stop();
      if (this.logStartupInfo) {
         new StartupInfoLogger(this.mainApplicationClass)
               .logStarted(getApplicationLog(), stopWatch);
      }
      //停止事件监听器
      listeners.started(context);
      //开始加载资源
      callRunners(context, applicationArguments);
   }
   catch (Throwable ex) {
      handleRunFailure(context, listeners, exceptionReporters, ex);
      throw new IllegalStateException(ex);
   }
   listeners.running(context);
   return context;
}




本篇文章主要是熟悉SpringBoot的CommandLineRunner接口实现原理。因此上面SpringBoot启动过程方法不做过多介绍。我们直接进入正题CallRunners()方法内部。



上面部分代码非常简单,对于Spring源码见到如此简单逻辑代码,内心是否有一丝丝的激动~

private void callRunner(CommandLineRunner runner, ApplicationArguments args) {
   try {
       //调用各个实现类中的逻辑实现
      (runner).run(args.getSourceArgs());
   }
   catch (Exception ex) {
      throw new IllegalStateException("Failed to execute CommandLineRunner", ex);
   }
}



到此结束,再跟进run()方法,就可以看到我们实现的资源加载逻辑啦~
 

  • 2
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
在使用Spring BootCommandLineRunner时,如果发现没有加载,有以下几种可能的原因: 1. 检查注解使用是否正确:在实现类上使用`@Component`或`@Configuration`注解,确保被扫描到并注册为Bean。当CommandLineRunner被作为Spring Boot应用程序的组件使用时,注解的正确使用非常重要。 2. 检查包扫描配置:如果CommandLineRunner实现类在指定的包或子包,需要确保包扫描配置正确。在`@SpringBootApplication`注解上,确保指定了正确的`scanBasePackages`或`scanBasePackageClasses`。 3. 检查依赖管理:检查项目的依赖管理和版本是否正确。Spring Boot版本和相关的依赖也可能会影响CommandLineRunner的加载。确保使用的Spring Boot版本和依赖与实现类兼容。 4. 检查Spring Boot配置:在application.properties或application.yml配置文件,确保没有禁用自动配置或修改了默认配置。有些配置项可能会禁止自动加载CommandLineRunner。 5. 检查其他程序流程:可能在应用程序的其他组件或配置,有条件判断或特定的执行流程阻止了CommandLineRunner的加载。检查业务逻辑、AOP切面、条件注解等等。 如果以上方法都没有解决问题,可以尝试在启动应用程序时打印更多的日志信息,通过分析日志来查找加载失败的具体原因。可以使用Spring Boot提供的日志配置,或通过在application.properties或application.yml添加相关配置项来输出更详细的日志信息。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值