Spring Boot 学习笔记《应用程序启动监听》

落日映苍穹つ 2022-11-30 04:08 173阅读 0赞

### Spring Boot 学习笔记《 应用程序启动监听》 ###

*  用途
 *  要点：
 *  设置启动参数
 *  注解方式实现
 *   *  ApplicationRunner
     *  CommandLineRunner
     *  启动日志：
 *  @Configuration 配置类 + @Bean
 *   *  启动日志：
 *  参考资料

当前测试版本 `Spring Boot 2.3.3.RELEASE`

# 用途 #

接收启动参数，控制初始化操作。例：

1.  将常用数据加载到内存
2.  清理上一次的垃圾数据
3.  启动成功发送通知
4.  等

# 要点： #

1.  优先级  
    1.1. 首先：`ApplicationRunner` 高于 `CommandLineRunner`  
    1.2. 其次：`@Component + xxxRunner接口` 高于 `@Configuration + @Bean`
2.  `@Order`控制先后  
    2.1. 像例子中在方法上使用`@Order(n)`并没有卵用。方法放在前面的先执行，亲测有效。  
    2.2. 多个`@Configuration`类之可以使用`@Order(n)`亲测试有效。

# 设置启动参数 #

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p4NTIw_size_16_color_FFFFFF_t_70_pic_center]

# 注解方式实现 #

## ApplicationRunner ##

package com.example.springbootdemo.config;
    
    import org.springframework.boot.ApplicationArguments;
    import org.springframework.boot.ApplicationRunner;
    import org.springframework.stereotype.Component;
    
    import java.util.Arrays;
    import java.util.Set;
    
    @Component
    public class MyApplicationRunner implements ApplicationRunner { 
        @Override
        public void run(ApplicationArguments args) throws Exception { 
            Set<String> names = args.getOptionNames();
            System.out.println("ApplicationRunner 收到参数 ：");
            System.out.println("参数名 ：" + names.toString());
            System.out.println("参数值 ：" + args.getOptionValues("name"));
            System.out.println("收到参数 ：" + Arrays.toString(args.getSourceArgs()));
        }
    }

## CommandLineRunner ##

package com.example.springbootdemo.config;
    
    import org.springframework.boot.CommandLineRunner;
    import org.springframework.stereotype.Component;
    
    import java.util.Arrays;
    
    @Component
    public class MyCommandLineRunner implements CommandLineRunner { 
        @Override
        public void run(String... args) throws Exception { 
            System.out.println("CommandLineRunner 收到参数 ：");
            System.out.println("收到参数 ：" + Arrays.toString(args));
        }
    }

## 启动日志： ##

ApplicationRunner 收到参数 ：
    参数名 ：[name]
    参数值 ：[jerryjin]
    收到参数 ：[--name=jerryjin]
    
    CommandLineRunner 收到参数 ：
    收到参数 ：[--name=jerryjin]

# @Configuration 配置类 + @Bean #

我故意把 `@Order(2)` 写在前面。但并没有影响顺序。

package com.example.springbootdemo.config;
    
    import org.springframework.boot.ApplicationArguments;
    import org.springframework.boot.ApplicationRunner;
    import org.springframework.boot.CommandLineRunner;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.core.annotation.Order;
    
    import java.util.Arrays;
    
    @Configuration
    public class RunnerConfig  { 
        @Bean
        @Order(2)
        public CommandLineRunner cRunner1(){ 
            return new CommandLineRunner(){ 
                @Override
                public void run(String... args) throws Exception { 
                    System.out.println("\n @Bean CommandLineRunner 1 收到参数 ：" + Arrays.toString(args));
                }
            };
        }
    
        @Bean
        @Order(1)
        public CommandLineRunner cRunner2(){ 
            return new CommandLineRunner(){ 
                @Override
                public void run(String... args) throws Exception { 
                    System.out.println("\n @Bean CommandLineRunner 2 收到参数 ：" + Arrays.toString(args));
                }
            };
        }
    
        @Bean
        @Order(2)
        public ApplicationRunner aRunner1(){ 
            return new ApplicationRunner(){ 
                @Override
                public void run(ApplicationArguments args) throws Exception { 
                    System.out.println("\n @Bean ApplicationRunner 1 收到参数 ：");
                    String.format("参数名 ：%s; 参数值 ：%s;", args.getOptionNames().toString(), args.getOptionValues("name"));
                    System.out.println("收到参数 ：" + Arrays.toString(args.getSourceArgs()));
                }
            };
        }
    
        @Bean
        @Order(1)
        public ApplicationRunner aRunner2(){ 
            return new ApplicationRunner(){ 
                @Override
                public void run(ApplicationArguments args) throws Exception { 
                    System.out.println("\n @Bean ApplicationRunner 2 收到参数 ：");
                    String.format("参数名 ：%s; 参数值 ：%s;", args.getOptionNames().toString(), args.getOptionValues("name"));
                    System.out.println("收到参数 ：" + Arrays.toString(args.getSourceArgs()));
                }
            };
        }
    
    }

## 启动日志： ##

@Component ApplicationRunner 收到参数 ：
    参数名 ：[name]
    参数值 ：[jerryjin]
    收到参数 ：[--name=jerryjin]
    
    @Bean ApplicationRunner 1 收到参数 ：
    收到参数 ：[--name=jerryjin]
    
    @Bean ApplicationRunner 2 收到参数 ：
    收到参数 ：[--name=jerryjin]
    
    @Component CommandLineRunner 收到参数 ：
    收到参数 ：[--name=jerryjin]
    
    @Bean CommandLineRunner 1 收到参数 ：[--name=jerryjin]
    
    @Bean CommandLineRunner 2 收到参数 ：[--name=jerryjin]

# 参考资料 #

[Using the ApplicationRunner or CommandLineRunner][]  
[Interface ApplicationRunner][]  
[Interface ApplicationArguments][]  
[Interface CommandLineRunner][]

[@Configuration][Configuration]  
[@Component][Component]  
[@Bean][Bean]  
[@Order][Order]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p4NTIw_size_16_color_FFFFFF_t_70_pic_center]: /images/20221124/b50b989d91c84fddb16790a7c3b60f37.png
[Using the ApplicationRunner or CommandLineRunner]: https://docs.spring.io/spring-boot/docs/2.3.3.RELEASE/reference/htmlsingle/#boot-features-command-line-runner
[Interface ApplicationRunner]: https://docs.spring.io/spring-boot/docs/current/api/org/springframework/boot/ApplicationRunner.html
[Interface ApplicationArguments]: https://docs.spring.io/spring-boot/docs/current/api/org/springframework/boot/ApplicationArguments.html
[Interface CommandLineRunner]: https://docs.spring.io/autorepo/docs/spring-boot/current/api/org/springframework/boot/CommandLineRunner.html
[Configuration]: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/context/annotation/Configuration.html
[Component]: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/stereotype/Component.html
[Bean]: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/context/annotation/Bean.html
[Order]: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/core/annotation/Order.html