在Spring框架中，有多种方法可以获取配置文件中的值。

发表于 2023-06-13 分类于 Java Learning 阅读次数：

使用 @value 在Spring框架中， @Value 注解用于为类的字段、方法参数或方法返回值注入值

使用`@value`

在Spring框架中，@Value注解用于为类的字段、方法参数或方法返回值注入值。这些值可以是字面量、环境变量、系统属性或者配置文件中的属性。

1、注入字面量

1 2	@Value("Hello World") private String greeting;

这个例子中，@Value将直接把字面量”Hello World”注入到字段greeting中。

2、注入环境变量或系统属性

1 2	@Value("#{systemProperties['java.home']}") private String javaHome;

这个例子中，@Value将把系统属性java.home的值注入到字段javaHome中。

3、注入配置文件中的属性

1 2	@Value("${app.database.url}") private String databaseUrl;

这个例子中，@Value将把application.properties或application.yml配置文件中的app.database.url属性的值注入到字段databaseUrl中。

4、注入使用SpEL表达式计算的值

1 2	@Value("#{T(java.lang.Math).PI}") private double pi;

这个例子中，@Value将把SpEL表达式T(java.lang.Math).PI计算的值（即π的值）注入到字段pi中。

SpEL 是 Spring Expression Language（Spring 表达式语言）的缩写。它是一种强大的表达式语言，由 Spring 框架提供，并集成到许多 Spring 组件中。

5、注入方法参数

@Bean
public MyBean myBean(@Value("${app.bean.name}") String beanName) {
    return new MyBean(beanName);
}

这个例子中，@Value将把配置文件中的app.bean.name属性的值注入到myBean方法的参数beanName中。

注意，如果使用@Value注入配置文件中的属性，你需要确保配置文件已被Spring加载，通常，Spring Boot应用会自动加载application.properties或application.yml文件。另外，你可以使用:指定一个默认值，如果配置文件中没有给定属性的值，就会使用这个默认值，例如：@Value("${app.database.url:jdbc:h2:mem:testdb}")。

使用 `@ConfigurationProperties`

在Spring Boot中，@ConfigurationProperties注解用于从application.properties或application.yml配置文件中读取配置项，并自动赋值给带有该注解的类的实例属性。

@Configuration
@ConfigurationProperties(prefix="myapp")
public class MyAppProperties {

    private String name;
    private String description;

    // Getters and setters are required
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }
}

在上述示例中，定义了一个类MyAppProperties，并添加了@Configuration和@ConfigurationProperties(prefix="myapp")注解。这样，该类的实例将被Spring Boot自动配置，并会将配置文件中以”myapp.”为前缀的配置项的值赋给相应的属性。

假设application.properties文件中有如下配置：

1 2	myapp.name=My Application myapp.description=A sample application

那么，Spring Boot将自动创建MyAppProperties的实例，并将”myapp.name”的值（”My Application”）赋给name属性，将”myapp.description”的值（”A sample application”）赋给description属性。

需要注意的是，使用@ConfigurationProperties的类必须有getter和setter方法，因为Spring使用这些方法来读取和设置属性的值。另外，类必须被Spring管理，可以使用@Component或@Configuration等注解标记类以使其成为Spring的bean。

@ConfigurationProperties注解提供了以下优点：

类型安全：属性值会根据字段的类型进行自动转换，如果类型不匹配，Spring Boot在启动时就会报错，这有助于发现潜在的问题。
集合支持：可以方便地将配置项的值绑定到集合类型（如List、Set、Map）的字段。
配置文件中的属性值支持复杂的嵌套结构，这在使用@Value注解时是不支持的。
提供了丰富的元数据支持，例如在IDE中，可以有自动完成和文档提示等功能，有助于提高开发效率。
支持验证：可以在使用@ConfigurationProperties的类上添加JSR 303的验证注解，如@NotNull、@Min、@Max等，来对配置项的值进行校验。

使用 `Environment` 对象

Spring框架的 Environment 接口是Spring 3.1中引入的，用于封装应用程序的环境属性。它提供了访问应用程序环境的所有配置的方式，包括系统环境变量、系统属性、JNDI变量、Servlet上下文参数、配置文件参数等。

你可以将 Environment 对象注入到你的bean中，然后使用它的方法（如 getProperty()）来获取这些属性的值。下面是一个示例：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

    @Autowired
    private Environment env;

    public void doSomething() {
        String javaHome = env.getProperty("java.home");
        String appDatabaseUrl = env.getProperty("app.database.url");
        
        // use the properties...
    }
}

在这个例子中，Environment 对象被注入到 MyBean 类中，然后在 doSomething() 方法中使用 getProperty() 方法获取了两个属性的值：系统属性 “java.home” 和配置文件中的 “app.database.url”。

注意 getProperty() 方法返回的是一个 String 类型的值，如果你知道属性值的类型，你可以使用 Environment 的其他方法来获取特定类型的值，如 getProperty(key, Integer.class)。

另外，你可以使用 containsProperty() 方法来检查一个属性是否存在，使用 getRequiredProperty() 方法来获取一个必需的属性（如果属性不存在，这个方法会抛出一个异常）。

请注意，Environment 对象在获取配置文件参数时，并不支持 @ConfigurationProperties 提供的类型安全配置绑定、复杂类型和列表的注入等高级特性。

使用@value

使用 @ConfigurationProperties

使用 Environment 对象

使用`@value`

使用 `@ConfigurationProperties`

使用 `Environment` 对象