使用SpringBoot的CommandLineRunner遇到的坑及解決

使用場景

再應用程式開發過程中，往往我們需要在容器啟動的時候執行一些操作。

Spring Boot中提供了CommandLineRunner和ApplicationRunner兩個介面來實現這樣的需求。

兩個介面的不同

引數不同，其他大體相同，可根據實際需求選擇合適的介面使用。

CommandLineRunner介面中run方法的引數為String陣列，ApplicationRunner中run方法的引數為ApplicationArguments。

特殊的場景

在啟動專案時，有時候我們所做的操作可能不是一次性的操作，有可能迴圈查詢資料庫，根據結果來處理不同的業務，亦或是監聽訊息佇列……

遇到的坑

看下面一個例子，我們啟動一個spring boot專案，正常啟動情況下，專案啟動後會列印啟動時間。

如下所示

2018-07-16 01:48:22.378  INFO 9164 --- [           main] o.s.j.e.a.AnnotationMBeanExporter        : Registering beans for JMX exposure on startup
2018-07-16 01:48:22.386  INFO 9164 --- [           main] o.s.c.support.DefaultLifecycleProcessor  : Starting beans in phase 2147483647
2018-07-16 01:48:22.386  INFO 9164 --- [           main] d.s.w.p.DocumentationPluginsBootstrapper : Context refreshed
2018-07-16 01:48:22.396  INFO 9164 --- [           main] d.s.w.p.DocumentationPluginsBootstrapper : Found 1 custom documentation plugin(s)
2018-07-16 01:48:22.417  INFO 9164 --- [           main] s.d.s.w.s.ApiListingReferenceScanner     : Scanning for api listing references
2018-07-16 01:48:22.546  INFO 9164 --- [           main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 8088 (http)
2018-07-16 01:48:22.555  INFO 9164 --- [           main] com.hello.word.WordParseApplication      : Started WordParseApplication in 3.811 seconds (JVM running for 4.486)

下面我們模擬一下啟動專案時使用CommandLineRunner，有人說CommandLineRunner是專案啟動完成後才呼叫的，我們看看現象。

/**
 * @author zhangwq
 * @date 2018/7/16 1:36
 */
@Component
public class RunService  implements CommandLineRunner {
 
    public void run(String... strings){
        int i =0;
        while(true){
            i++;
                try {
                    Thread.sleep(10000);
                    System.out.println("過去了10秒鐘……,i的值為："+i);
                } catch (InterruptedException e) {
                    e.printStackTrace();
                }
                if(i==4){ //第40秒時丟擲一個異常
                    throw new RuntimeException();
                }
                continue;
        }
    }
}

再次啟動spring boot 專案，看看紀錄檔，直接報錯，啟動異常了。

2018-07-16 01:56:43.703  INFO 7424 --- [           main] o.s.c.support.DefaultLifecycleProcessor  : Starting beans in phase 2147483647
2018-07-16 01:56:43.703  INFO 7424 --- [           main] d.s.w.p.DocumentationPluginsBootstrapper : Context refreshed
2018-07-16 01:56:43.722  INFO 7424 --- [           main] d.s.w.p.DocumentationPluginsBootstrapper : Found 1 custom documentation plugin(s)
2018-07-16 01:56:43.750  INFO 7424 --- [           main] s.d.s.w.s.ApiListingReferenceScanner     : Scanning for api listing references
2018-07-16 01:56:43.885  INFO 7424 --- [           main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 8088 (http)
過去了10秒鐘……,i的值為：1
過去了10秒鐘……,i的值為：2
過去了10秒鐘……,i的值為：3
過去了10秒鐘……,i的值為：4
2018-07-16 01:57:23.939  INFO 7424 --- [           main] utoConfigurationReportLoggingInitializer : 
 
Error starting ApplicationContext. To display the auto-configuration report re-run your application with 'debug' enabled.
2018-07-16 01:57:23.973 ERROR 7424 --- [           main] o.s.boot.SpringApplication               : Application startup failed
 
java.lang.IllegalStateException: Failed to execute CommandLineRunner
    at org.springframework.boot.SpringApplication.callRunner(SpringApplication.java:735) [spring-boot-1.5.9.RELEASE.jar:1.5.9.RELEASE]
    at org.springframework.boot.SpringApplication.callRunners(SpringApplication.java:716) [spring-boot-1.5.9.RELEASE.jar:1.5.9.RELEASE]
    at org.springframework.boot.SpringApplication.afterRefresh(SpringApplication.java:703) [spring-boot-1.5.9.RELEASE.jar:1.5.9.RELEASE]
    at org.springframework.boot.SpringApplication.run(SpringApplication.java:304) [spring-boot-1.5.9.RELEASE.jar:1.5.9.RELEASE]
    at org.springframework.boot.SpringApplication.run(SpringApplication.java:1118) [spring-boot-1.5.9.RELEASE.jar:1.5.9.RELEASE]
    at org.springframework.boot.SpringApplication.run(SpringApplication.java:1107) [spring-boot-1.5.9.RELEASE.jar:1.5.9.RELEASE]
    at com.hello.word.WordParseApplication.main(WordParseApplication.java:15) [classes/:na]
Caused by: java.lang.RuntimeException: null
    at com.zhangwq.service.RunService.run(RunService.java:24) ~[classes/:na]
    at org.springframework.boot.SpringApplication.callRunner(SpringApplication.java:732) [spring-boot-1.5.9.RELEASE.jar:1.5.9.RELEASE]
    ... 6 common frames omitted
 
2018-07-16 01:57:23.975  INFO 7424 --- [           main] ationConfigEmbeddedWebApplicationContext : Closing org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext@14a4e18: startup date [Mon Jul 16 01:56:39 CST 2018]; root of context hierarchy
2018-07-16 01:57:23.975  INFO 7424 --- [           main] o.s.c.support.DefaultLifecycleProcessor  : Stopping beans in phase 2147483647
2018-07-16 01:57:23.975  INFO 7424 --- [           main] o.s.j.e.a.AnnotationMBeanExporter        : Unregistering JMX-exposed beans on shutdown
 
Process finished with exit code 1

說明啟動CommandLineRunner的執行其實是整個應用啟動的一部分，沒有列印最後的啟動時間，說明專案是在CommandLineRunner執行完成之後才啟動完成的。

此時CommandLineRunner的run方法執行的是一個迴圈，迴圈到第四次的時候，丟擲異常，直接影響主程式的啟動。

填坑

這樣的問題該如何解決呢？這個操作影響了主執行緒，那麼我們是否可以重新開啟一個執行緒，讓他單獨去做我們想要做的操作呢。

/**
 * @author zhangwq
 * @date 2018/7/16 1:36
 */
@Component
public class RunService  implements CommandLineRunner {
 
    public void run(String... strings){
        new Thread(){
            public void run() {
                int i = 0;
                while (true) {
                    i++;
                    try {
                        Thread.sleep(10000);
                        System.out.println("過去了10秒鐘……,i的值為：" + i);
                    } catch (InterruptedException e) {
                        e.printStackTrace();
                    }
                    if (i == 4) { //第40秒時丟擲一個異常
                        throw new RuntimeException();
                    }
                    continue;
                }
            }
        }.start();
    }
}

我們再看看這次的紀錄檔是什麼樣的

2018-07-16 02:05:52.680  INFO 7148 --- [           main] o.s.c.support.DefaultLifecycleProcessor  : Starting beans in phase 2147483647
2018-07-16 02:05:52.680  INFO 7148 --- [           main] d.s.w.p.DocumentationPluginsBootstrapper : Context refreshed
2018-07-16 02:05:52.695  INFO 7148 --- [           main] d.s.w.p.DocumentationPluginsBootstrapper : Found 1 custom documentation plugin(s)
2018-07-16 02:05:52.717  INFO 7148 --- [           main] s.d.s.w.s.ApiListingReferenceScanner     : Scanning for api listing references
2018-07-16 02:05:52.815  INFO 7148 --- [           main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 8088 (http)
2018-07-16 02:05:52.819  INFO 7148 --- [           main] com.hello.word.WordParseApplication      : Started WordParseApplication in 3.406 seconds (JVM running for 4.063)
過去了10秒鐘……,i的值為：1
過去了10秒鐘……,i的值為：2
過去了10秒鐘……,i的值為：3
過去了10秒鐘……,i的值為：4
Exception in thread "Thread-10" java.lang.RuntimeException
    at com.zhangwq.service.RunService$1.run(RunService.java:26)

此時CommandLineRunner執行的操作和主執行緒是相互獨立的，丟擲異常並不會影響到主執行緒。

程式列印了啟動時間，並且CommandLineRunner中run方法報錯後，應用程式並沒有因為異常而終止。

ok，填坑成功。

總結

以上為個人經驗，希望能給大家一個參考，也希望大家多多支援it145.com。