SpringBoot 常用读取配置文件的 3 种方法!

我们在SpringBoot框架进行项目开发中该如何优雅的读取配置呢?或者说对于一些List或者Map应该如何配置呢?
【SpringBoot 常用读取配置文件的 3 种方法!】本篇主要解决如下几个问题:
1、Spring Boot有哪些常用的读取配置文件方式?
1)使用 @Value 读取配置文件
2) 使用 @ConfigurationProperties 读取配置文件
3)使用 Environment 读取配置文件
2、一些复杂的数据结构,如List、Map , 如何配置?如何读取呢?
前言Spring Boot默认的配置文件有两种格式: application.propertiesapplication.yml 。查找顺序是首先从application.properties 查找,
如果找不到,再查找 application.yml 。优先级:application.properties > application.yml 。
以yml中rabbitmq的配置为例,配置文件如下:
rabbitmq:host: 127.0.0.1password: rootport: 5672username: root一、使用 @Value 读取配置文件这种方法适用于对象的参数比较少的情况
我们可以直接在对象的属性上使用 @Value 注解 , 同时以 ${} 的形式传入配置文件中对应的属性 。同时需要在该类的上方使用 @Configuration 注解,将该类作为配置
文件加入,在启动项目的时候实现注入 。
@Configurationpublic class RabbitmqProperties {@Value("${rabbitmq.host}")private String rabbitmqHost;@Value("${rabbitmq.port}")private String rabbitmqPort;@Value("${rabbitmq.username}")private String rabbitmqUsername;@Value("${rabbitmq.password}")private String rabbitmqPassword;}如果哪里需要用到,通过 @Autowired 注入进去就可以获取属性值了
@Componentpublic class PropertiesTest {@Autowiredprivate RabbitmqProperties rabbitmqProperties;}二、使用 @ConfigurationProperties 读取配置文件如果对象的参数比较多情况下,推荐使用 @ConfigurationProperties 会更简单一些,不需要在每一个字段的上面的使用@Value注解 。
@ConfigurationProperties注解声明当前类为配置读取类
prefix="rabbitmq" 表示读取前缀为rabbitmq的属性
示例如下:
@ConfigurationProperties(prefix = "rabbitmq")public class RabbitmqProperties {private String host;private String port;private String username;private String password;}这里有一点需要注意: 必须保证属性名称和字段一模一样,且类需要提供字段的setter方法
注意 如果仅仅只是使用了 @ConfigurationProperties 注解是没有效果的,它并不会将这个配置注入容器中,它还需要和注入容器的注解一起使用 。
这里有两种方法实现将它注入到容器中
1、类上添加@Configuration注解除了@Configuration , 也可以是@Controller、@RestController、@Service、@Componet等注解,加入到Ioc容器里 。
@Setter@Configuration@ConfigurationProperties(prefix = "rabbitmq")public class RabbitmqProperties {private String host;private String port;private String username;private String password;}同样哪里需要用到,通过 @Autowired 注入进去就可以获取属性值了
2、使用@EnableConfigurationProperties注解通过 @EnableConfigurationProperties 注解可以将指定的配置读取类的对象加载到Spring容器,也就是说,在其他配置类上使用一个@EnableConfigurationProperties注解,
来将配置文件的参数和RabbitmqProperties类的属性绑定 。这样就不需要在RabbitmqProperties类上使用@Configuration注解了
@Configuration@EnableConfigurationProperties(RabbitmqProperties.class)public class RabbitmqConfig {@Autowiredprivate RabbitmqProperties prop;@Beanpublic Rabbitmq rabbitmq() {Rabbitmq mq = new Rabbitmq();mq.setHost(prop.getHost());mq.setPort(prop.getPort());mq.setUsername(prop.getUsername());mq.setPassword(prop.getPassword());return mq;}}3、使用@ConfigurationPropertiesScan扫描在 Spring Boot 2.2.0.RELEASE 中提供了一个扫描注解@ConfigurationPropertiesScan 。它可以扫描特定包下所有的被@ConfigurationProperties标记的配置类,
并将它们进行IoC注入 。
@ConfigurationPropertiesScan@SpringBootApplicationpublic class MainApplication {public static void main(String[] args) {SpringApplication.run(MainApplication.class, args);}}三、使用 Environment 读取配置文件Environment 是 SpringCore 中的一个用于读取配置文件的类 , 将此类使用 @Autowired 注入到类中就可以使用它的getProperty方法来获取某个配置项的值 。
如下代码所示:
@SpringBootApplicationpublic class MainApplication implements InitializingBean {@Autowiredprivate Environment environment;public static void main(String[] args) {SpringApplication.run(MainApplication.class, args);}@Overridepublic void afterPropertiesSet() {String username = environment.getProperty("rabbitmq.username");System.out.println("rabbitmq当前用户名为:" + username);}}

推荐阅读