使用 @Value

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

  • Java

  • Kotlin

@Component
public class MovieRecommender {

	private final String catalog;

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

结合以下配置:

  • Java

  • Kotlin

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

以及以下 application.properties 文件:

catalog.name=MovieCatalog

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

Spring 提供了一个默认的宽松嵌入式值解析器。它将尝试解析属性值,如果无法解析,则将属性名称(例如 ${catalog.name})作为值注入。如果您想对不存在的值保持严格控制,您应该声明一个 PropertySourcesPlaceholderConfigurer bean,如下例所示:

  • Java

  • Kotlin

@Configuration
public class AppConfig {

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

	@Bean
	fun propertyPlaceholderConfigurer() = PropertySourcesPlaceholderConfigurer()
}

当使用 JavaConfig 配置 PropertySourcesPlaceholderConfigurer 时,@Bean 方法必须是 static

使用上述配置可确保如果任何 ${} 占位符无法解析,Spring 初始化将失败。还可以使用 setPlaceholderPrefix()setPlaceholderSuffix()setValueSeparator()setEscapeCharacter() 等方法来自定义占位符语法。此外,可以通过 JVM 系统属性(或通过 SpringProperties 机制)设置 spring.placeholder.escapeCharacter.default 属性来全局更改或禁用默认转义字符。

Spring Boot 默认配置了一个 PropertySourcesPlaceholderConfigurer bean,它将从 application.propertiesapplication.yml 文件中获取属性。

Spring 提供的内置转换器支持允许自动处理简单的类型转换(例如转换为 Integerint)。多个逗号分隔的值可以自动转换为 String 数组,无需额外工作。

可以按如下方式提供默认值:

  • Java

  • Kotlin

@Component
public class MovieRecommender {

	private final String catalog;

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

Spring BeanPostProcessor 在底层使用 ConversionService 来处理将 @Value 中的 String 值转换为目标类型的过程。如果您想为自己的自定义类型提供转换支持,您可以提供自己的 ConversionService bean 实例,如下例所示:

  • Java

  • Kotlin

@Configuration
public class AppConfig {

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

	@Bean
	fun conversionService(): ConversionService {
		return DefaultFormattingConversionService().apply {
			addConverter(MyCustomConverter())
		}
	}
}

@Value 包含 SpEL 表达式 时,值将在运行时动态计算,如下例所示:

  • Java

  • Kotlin

@Component
public class MovieRecommender {

	private final String catalog;

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

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

  • Java

  • Kotlin

@Component
public class MovieRecommender {

	private final Map<String, Integer> countOfMoviesPerCatalog;

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