Spring Boot 中初始化资源的方式

绝地灬酷狼 2023-07-18 14:28 37阅读 0赞

简单的一个需求，要求在项目启动过程中，完成线程池的初始化，加载初始化加载缓存等功能，你会怎么做？如果没想好答案，请接着往下看。今天介绍几种在Spring Boot中进行资源初始化的方式，帮助大家解决和回答这个问题

**一：CommandLineRunner**

定义初始化类 MyCommandLineRunner  
实现 CommandLineRunner 接口，并实现它的 run() 方法，在该方法中编写初始化逻辑  
注册成Bean，添加 @Component注解即可  
示例代码如下：

@Component
    public class MyCommandLineRunner implements CommandLineRunner {
     
        @Override
        public void run(String... args) throws Exception {
            System.out.println("...init resources by implements CommandLineRunner");
        }
        
    }

实现了 CommandLineRunner 接口的 Component 会在所有 Spring Beans 初始化完成之后， 在 SpringApplication.run() 执行之前完成。

**二：ApplicationRunner**

定义初始化类 MyApplicationRunner  
实现 ApplicationRunner 接口，并实现它的 run() 方法，在该方法中编写初始化逻辑  
注册成Bean，添加 @Component注解即可  
示例代码如下：

@Component
    public class MyApplicationRunner implements ApplicationRunner {
     
        @Override
        public void run(ApplicationArguments applicationArguments) throws Exception {
            System.out.println("...init resources by implements ApplicationRunner");
        }
     
    }

可以看到，通过实现 ApplicationRunner 接口，和通过实现 CommandLineRunner 接口都可以完成项目的初始化操作，实现相同的效果。两者之间唯一的区别是 run() 方法中自带的形参不相同，在 CommandLineRunner 中只是简单的String... args形参，而 ApplicationRunner 则是包含了 ApplicationArguments 对象，可以帮助获得更丰富的项目信息。

如图：

![format_png][]

比较：

如果项目中既有实现了 ApplicationRunner 接口的初始化类，又有实现了 CommandLineRunner 接口的初始化类，那么会是哪一个先执行呢？测试告诉我们，答案是实现了 ApplicationRunner 接口的初始化类先执行，我想这点倒是不需要大家过分去关注为什么。但如果需要改变两个初始化类之间的默认执行顺序，那么使用 @Order 注解就可以帮助我们解决这个问题。

@Component
    @Order(1)
    public class MyCommandLineRunner implements CommandLineRunner {
     
        @Override
        public void run(String... args) throws Exception {
            System.out.println("...init resources by implements CommandLineRunner");
        }
    }

@Component
    @Order(2)
    public class MyApplicationRunner implements ApplicationRunner {
     
        @Override
        public void run(ApplicationArguments applicationArguments) throws Exception {
            System.out.println("...init resources by implements ApplicationRunner");
        }
     
    }

最终，控制台中打印如下。通过控制台输出我们发现， `@Order` 注解值越小，该初始化类也就越早执行。

2020-03-29 10:27:31.450  INFO 28304 --- [           main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 8080 (http)
    ...init resources by implements CommandLineRunner
    ...init resources by implements ApplicationRunner
    2020-03-29 10:27:31.453  INFO 28304 --- [           main] cn.demo.DemoApplication          : Started DemoApplication in 6.146 seconds (JVM running for 2.977)

**三：@PostConstruct**

使用 `@PostConstruct` 注解同样可以帮助我们完成资源的初始化操作，前提是这些初始化操作不需要依赖于其它Spring beans的初始化工作。源码的注解如图：

![format_png 1][]

看到 `@PostConstruct` 注解是用在方法上的，写一个方法测试吧！！！！！

@PostConstruct
    public void postConstruct() {
        System.out.println("... PostConstruct");
    }

看看打印日志：

.   ____          _            __ _ _
     /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
    ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
     \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
      '  |____| .__|_| |_|_| |_\__, | / / / /
     =========|_|==============|___/=/_/_/_/
     :: Spring Boot ::       (v1.5.11.RELEASE)
    。。。。。。（此处省略一堆打印信息）
    ... PostConstruct
    。。。。。。（此处省略一堆打印信息）
    2020-03-29 10:28:22.300  INFO 29796 --- [           main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 8080 (http)
    ...init resources by implements CommandLineRunner
    ...init resources by implements ApplicationRunner
    2020-03-29 10:28:22.303  INFO 29796 --- [           main] cn.demo.DemoApplication          : Started DemoApplication in 6.387 seconds (JVM running for 3.267)
    ... end SpringApplication.run()

**四：综合总结：**

使用 `@PostConstruct` 注解进行初始化操作的顺序是最快的，前提是这些操作不能依赖于其它Bean的初始化完成。通过添加 `@Order` 注解，我们可以改变同层级之间不同Bean的加载顺序。

[format_png]: /images/20230528/8c0dca36ec514288acb462225a7760f6.png
[format_png 1]: /images/20230528/e781300f9db4401aa9dcc6b39b5ae69c.png