@Value

@Value 通常用于注入外部化属性

@Component
public class MovieRecommender {
    private final String catalog;
    public MovieRecommender(@Value("${catalog.name}") String catalog) {
        this.catalog = catalog;
    }
}

使用以下配置：

@Configuration
@PropertySource("classpath:application.properties")
public class AppConfig { }

以及下面的 application.properties 文件：

catalog.name=MovieCatalog

在这种情况下，catalog 参数和字段将等同于 MovieCatalog 值。

Spring 提供了一个默认的宽松的嵌入式值解析器。它将尝试解析属性值，如果无法解析，属性名称（例如${catalog.name}）将被注入作为值。也就是说默认情况下如果你的配置文件中没有提供 catalog.name 这个配置项，那么 MovieRecommender.catalog 的值将会以 ${catalog.name}字符串赋值

如果你想对不存在的值保持严格的控制，你应该声明一个PropertySourcesPlaceholderConfigurer Bean，如下面的例子所示。

@Configuration
public class AppConfig {
    @Bean
    public static PropertySourcesPlaceholderConfigurer propertyPlaceholderConfigurer() {
        return new PropertySourcesPlaceholderConfigurer();
    }
}

:::tips 当使用 JavaConfig 配置 PropertySourcesPlaceholderConfigurer 时，@Bean 方法必须是静态的。 ::: 配置之后，上面那个例子如果没有配置项将会抛出一个异常，比如下面这个异常信息

Caused by: java.lang.IllegalArgumentException: Could not resolve placeholder 'catalog.name' in value "${catalog.name}"

使用上述配置可以确保在任何 ${}占位符无法解决的情况下 Spring 初始化失败。也可以使用setPlaceholderPrefix、setPlaceholderSuffix 或 setValueSeparator 等方法来定制占位符。

    @Bean
    public static PropertySourcesPlaceholderConfigurer propertyPlaceholderConfigurer() {
        final PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer();
        // 设置默认的占位符 ${} 为 $[] 
        configurer.setPlaceholderPrefix("["); 
        configurer.setPlaceholderSuffix("]");
        configurer.setValueSeparator(":");  // 变量默认值分隔符，比如 ${catalog.name:我是默认值}，如果没有配置 catalog.name 则使用 : 后面的值注入
        return configurer;
    }

:::tips Spring Boot 默认配置了一个 PropertySourcesPlaceholderConfigurer Bean，它将从application.properties 和 application.yml 文件中获取属性。 :::

Spring 提供的内置转换器支持允许自动处理简单的类型转换（例如转换为 Integer 或 int）。多个逗号分隔的值可以自动转换为字符串数组，无需额外的努力。

可以提供如下的默认值：

@Component
public class MovieRecommender {
    private final String catalog;
    public MovieRecommender(@Value("${catalog.name:defaultCatalog}") String catalog) {
        this.catalog = catalog;
    }
}

Spring BeanPostProcessor 在幕后使用一个 ConversionService 来处理将 @Value 中的字符串值转换为目标类型的过程。如果你想为你自己的自定义类型提供转换支持，你可以提供你自己的 ConversionService Bean 实例，如下例所示。

@Configuration
public class AppConfig {
    @Bean
    public ConversionService conversionService() {
        DefaultFormattingConversionService conversionService = new DefaultFormattingConversionService();
        conversionService.addConverter(new MyCustomConverter());
        return conversionService;
    }
}

当 @Value 包含一个 SpEL 表达式时，该值将在运行时被动态计算出来，如下例所示：

@Component
public class MovieRecommender {
    private final String catalog;
    public MovieRecommender(@Value("#{systemProperties['user.catalog'] + 'Catalog' }") String catalog) {
        this.catalog = catalog;
    }
}

SpEL 还支持使用更复杂的数据结构：

@Component
public class MovieRecommender {
    private final Map<String, Integer> countOfMoviesPerCatalog;
    public MovieRecommender(
            @Value("#{{'Thriller': 100, 'Comedy': 300}}") Map<String, Integer> countOfMoviesPerCatalog) {
        this.countOfMoviesPerCatalog = countOfMoviesPerCatalog;
    }
}

总结

出现了两种符号： $和 #，由于这里的总结没有相关文献，暂时从表现上来看：

• $：对应的是配置文件中的值
• #：对应的 spel 表达式，还可以引用一个 bean 中的属性，比如上面的 systemProperties