Spring Boot 中初始化资源的几种方式

逃离我推掉我的手 2021-12-14 07:07 225阅读 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() 执行之前完成。下面通过加两行打印来验证我们的测试。

@SpringBootApplication
    public class DemoApplication {
    
        public static void main(String[] args) {
            System.out.println("... start SpringApplication.run()");
            SpringApplication.run(DemoApplication.class, args);
            System.out.println("... end SpringApplication.run()");
        }
        
    }

控制台打印结果如下。

... start SpringApplication.run()
    
      .   ____          _            __ _ _
     /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
    ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
     \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
      '  |____| .__|_| |_|_| |_\__, | / / / /
     =========|_|==============|___/=/_/_/_/
     :: Spring Boot ::       (v1.5.11.RELEASE)
    。。。。。。（此处省略一堆打印信息）
    2018-05-02 17:01:19.700  INFO 21236 --- [           main] s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s): 8080 (http)
    ...init resources by implements CommandLineRunner
    2018-05-02 17:01:19.708  INFO 21236 --- [           main] cn.mariojd.demo.DemoApplication          : Started DemoApplication in 2.282 seconds (JVM running for 3.125)
    ... end 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 对象，可以帮助获得更丰富的项目信息。

### @Order ###

如果项目中既有实现了 `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` 注解值越小，该初始化类也就越早执行。

。。。。。。（此处省略一堆打印信息）
    2018-05-02 17: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
    2018-05-02 17:27:31.453  INFO 28304 --- [           main] cn.mariojd.demo.DemoApplication          : Started DemoApplication in 2.086 seconds (JVM running for 2.977)

### @PostConstruct ###

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

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

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

启动项目，控制台中最终打印如下。

... start SpringApplication.run()
    
      .   ____          _            __ _ _
     /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
    ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
     \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
      '  |____| .__|_| |_|_| |_\__, | / / / /
     =========|_|==============|___/=/_/_/_/
     :: Spring Boot ::       (v1.5.11.RELEASE)
    
    。。。。。。（此处省略一堆打印信息）
    ... PostConstruct
    。。。。。。（此处省略一堆打印信息）
    2018-05-02 17:40: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
    2018-05-02 17:40:22.303  INFO 29796 --- [           main] cn.mariojd.demo.DemoApplication          : Started DemoApplication in 2.387 seconds (JVM running for 3.267)
    ... end SpringApplication.run()

### 文末小结 ###

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

最后送福利了，加群即可获取 群号：798891710 即可获取Java工程化、高性能及分布式、高性能、高架构、性能调优、Spring、MyBatis、Netty源码分析等多个知识点高级进阶干货的相关视频资料，等你来拿