SpringBoot 读取配置文件的4种方式

文章目录

  • [1. @Value 注解读取单个属性](#1. @Value 注解读取单个属性)
  • [2. 使用 @ConfigurationProperties 注解](#2. 使用 @ConfigurationProperties 注解)
  • [3. 通过 Environment 对象读取属性](#3. 通过 Environment 对象读取属性)
  • [4. 使用 @PropertySource 注解加载额外的配置文件](#4. 使用 @PropertySource 注解加载额外的配置文件)

在 Spring Boot 中,application.yml 文件用于配置应用程序的属性,Spring Boot 默认会从 src/main/resources 目录下的 application.propertiesapplication.yml 文件中读取配置。读取 application.yml 文件中的配置可以通过以下几种常用的方法进行:

  1. @Value: 适合读取简单的单一属性。
  2. @ConfigurationProperties: 适合读取复杂的配置集。
  3. Environment: 适合在运行时动态访问配置。
  4. @PropertySource : 加载 .properties 文件。

1. @Value 注解读取单个属性

@Value 注解用于读取单一简单的配置属性,该注解可以直接应用于字段、构造函数或方法参数上,不要求提供 Setter 方法。

  1. application.yml 配置文件中添加如下配置:

    yml 复制代码
    app:
      name: MyApp
      keys:
        - key1
        - key2
  2. 使用 @Value 注解从配置文件中读取单个属性值:

    1. 字段注入 :将 @Value 注解应用于字段,Spring 将直接将配置值注入到字段中。

      java 复制代码
      @Component
      public class MyComponent {
      
          @Value("${app.name}")
          private String name;
      
      }
    2. 构造函数注入@Value 也可以用于构造函数参数。

      java 复制代码
      @Component
      public class MyComponent {
      
          private final String name;
      
          public MyComponent(@Value("${app.name}") String name) {
              this.name = name;
          }
      
      }
    3. 方法参数注入@Value 注解用于方法参数。

      java 复制代码
      @Component
      public class MyComponent {
      
          private String name;
      
          @Value("${app.name}")
          public void setKeys(String name) {
              this.name = name;
          }
      
      }

注意: @Value 注解无法处理复杂的配置,如集合,如下处理会在应用启动时抛出 IllegalArgumentException 异常:Could not resolve placeholder 'app.keys' in value "${app.keys}"

java 复制代码
@Value("${app.keys}")
private List<String> keys;

2. 使用 @ConfigurationProperties 注解

@ConfigurationProperties 用于将配置文件中的属性绑定到 Java 对象中。适合处理结构化的配置,比如嵌套的属性或复杂的属性集合。

  1. application.yml 配置文件中添加如下配置:

    yml 复制代码
    app:
      name: MyApp
      keys:
        - key1
        - key2
  2. 在类上使用 @ConfigurationProperties 注解,并指定前缀,该类会直接映射配置文件中的属性名一致属性:

    java 复制代码
    @Component
    @ConfigurationProperties(prefix = "app")
    public class AppProperties {
    
        private List<String> keys;
    
    }

注意: @ConfigurationProperties 读取配置时需要确保配置文件中的属性名与 Java 类中的属性名匹配。

3. 通过 Environment 对象读取属性

Environment 是 Spring 中用于管理和访问配置属性、配置文件和环境变量的一个抽象接口,该对象提供了一种管理和访问配置属性、激活的配置文件和环境变量的统一方式。我们可以在任何 Spring 管理的 bean 中通过注入 Environment 对象来获取配置属性。

  1. application.yml 配置文件中添加如下配置:

    yml 复制代码
    app:
      name: MyApp
      keys:
        - key1
        - key2
  2. 在类中注入 Environment 对象,使用env.getProperty(String key)来检索属性的值。

    java 复制代码
    @Component
    public class MyComponent {
    
        @Autowired
        private Environment env;
    
        public void printConfig() {
            String port = env.getProperty("server.port");
            System.out.println("Server Port: " + port);
        }
    }

注意: Environment 在加载 YML 配置文件时,会将每个元素视为单独的键。

application.yml 文件中的配置:

yml 复制代码
yamlCopy Codeapp:
  keys:
    - key1
    - key2
    - key3

Environment 中,将被处理为:

  • app.keys[0] 对应 key1
  • app.keys[1] 对应 key2
  • app.keys[2] 对应 key3

因此对于复杂配置需要特殊处理,例如获取集合元素需要使用类似数组索引的语法来访问 YAML 文件中的列表元素。

4. 使用 @PropertySource 注解加载额外的配置文件

@PropertySource 注解是 Spring Framework 提供的一个注解,用于加载额外 .properties 配置文件或其他资源文件中的属性到 Spring 的 Environment 中。

  1. src/main/resources 目录下创建 config.properties 的属性文件:

    properties 复制代码
    app.name=MyApp
    app.version=1.0.0
  2. 在配置类上使用 @PropertySource 注解来加载配置文件:

    java 复制代码
    @Configuration
    @PropertySource("classpath:config.properties")
    //@PropertySource({"classpath:config.properties", "classpath:another-config.properties"})
    public class AppConfig {
        
    }
  3. 使用 @Value 注解或 Environment 对象获取属性:

    java 复制代码
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.stereotype.Component;
    
    @Component
    public class MyComponent {
    
        @Value("${app.name}")
        private String appName;
    
        @Autowired
        private Environment env;
    
        public void printAppInfo() {
            System.out.println("App Name: " + appName);
            String appVersion = env.getProperty("app.version");
            System.out.println("App Version: " + appVersion);
        }
    }

注意: 如果需要加载多个属性文件,可以在 @PropertySource 注解中使用 value 属性指定多个文件路径:

java 复制代码
@PropertySource({"classpath:config.properties", "classpath:another-config.properties"})
  1. 路径classpath: 前缀表示文件在类路径中。如果文件位于文件系统的其他位置,你可以使用文件系统路径,例如 file:/path/to/config.properties
  2. 覆盖@PropertySource 加载的属性文件中的属性会覆盖同名的系统属性,但不会覆盖由 Spring Boot 的 application.propertiesapplication.yml 文件中定义的属性。
  3. 顺序:如果多个属性文件定义了同一个属性,后加载的文件中的属性值会覆盖先加载的文件中的值。
相关推荐
哞哞不熬夜6 分钟前
JavaEE--SpringIoC
java·开发语言·spring boot·spring·java-ee·maven
滑水滑成滑头7 分钟前
**点云处理:发散创新,探索前沿技术**随着科技的飞速发展,点云处理技术在计算机视觉、自动驾驶、虚拟现实等领域的应用愈发广
java·python·科技·计算机视觉·自动驾驶
千里马-horse16 分钟前
fastddsgen.jar 简介
java·jar·fast dds·fastddsgen
TT哇16 分钟前
【Maven】Maven设置国内源
java·maven
我是天龙_绍42 分钟前
java 中的 Lombok
后端
hwangsy43 分钟前
SpringCloud gateway偶发creationTime key must not be null
后端
初见00144 分钟前
Spring事务失效的十大陷阱与终极解决方案
后端·架构
dyj0951 小时前
【Devops-Jenkins自动将Java Maven工程编译成jar、并打成Docker镜像,并上传Harbor】
java·jenkins·devops
子夜master1 小时前
玩转EasyExcel,看这一篇就够了!!(合并导入 自定义导出 动态表头 合并单元格)
后端
gordon~91 小时前
Spring 的bean是安全的吗
java·安全·spring·bean