【SpringBoot系列】读取yml文件的几种方式

Dear 丶 2024-03-22 15:30 30阅读 0赞

Spring Boot读取yml文件的主要方式有以下几种:

1.@Value注解

我们可以在bean的属性上使用@Value注解,直接读取yml中的值,如:

application.yml:

  1. name: Zhangsan

Bean:

  1. public class MyBean {
  2. @Value("${name}")
  3. private String name;
  4. }

2.Environment对象

我们可以通过注入Environment对象来读取yml值,如:

  1. @Autowired
  2. private Environment environment;
  3. public void doSomething() {
  4. String name = environment.getProperty("name");
  5. }

3.@ConfigurationProperties注解

我们可以使用@ConfigurationProperties注解将yml中的值映射到bean的属性上,如:

application.yml:

  1. my:
  2. name: Zhangsan
  3. age: 18

Bean:

  1. @Component
  2. @ConfigurationProperties(prefix = "my")
  3. public class MyProps {
  4. private String name;
  5. private int age;
  6. // getter and setter
  7. }

4.YmlPropertySourceFactory

我们可以使用YmlPropertySourceFactory来加载yml文件,然后像普通Properties一样读取值,如:

  1. @Bean
  2. public static PropertySourcesPlaceholderConfigurer properties() {
  3. YamlPropertiesFactoryBean factory = new YamlPropertiesFactoryBean();
  4. factory.setResources(new ClassPathResource("application.yml"));
  5. factory.getObject().forEach((k, v) -> System.out.println(k + ": " + v));
  6. return factory;
  7. }

5.@YamlComponent注解

如果yml文件中用—分隔了多个文档,我们可以使用@YamlComponent注解将每份文档映射到一个bean上,如:

application.yml:

  1. my:
  2. name: Zhangsan
  3. ---
  4. my:
  5. name: Lisi

Beans:

  1. @Component("first")
  2. @YamlComponent(value = "my.first")
  3. public class FirstProps {
  4. private String name;
  5. }
  6. @Component("second")
  7. @YamlComponent(value = "my.second")
  8. public class SecondProps {
  9. private String name;
  10. }

这就是Spring Boot读取yml文件的主要5种方式,可以根据需要选择使用。yml作为Spring Boot默认的配置文件格式,理解如何操纵yml文件将有助于我们实现系统配置的灵活性。

写在最后

如果大家对相关文章感兴趣,可以关注公众号”架构殿堂”,会持续更新AIGC,java基础面试题, netty, spring boot,spring cloud等系列文章,一系列干货随时送达!

发表评论

表情:
评论列表 (有 0 条评论,30人围观)

还没有评论,来说两句吧...

相关阅读