Spring Boot：从YAML文件注入Map失败，求正确实现方式

你的问题情况 #

你尝试用@Value注入整个YAML的alias结构成Map，但遇到了报错，先梳理下你的场景：

你的application.yml配置 #

alias:
  name: title
  desc: description
  content: body

你尝试的代码（NamingService.kt） #

@Value("${alias}")
private var alias: Map<String, String> = emptyMap()

触发的报错 #

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

使用版本：kotlinVersion = '1.2.31'；springBootVersion = '2.0.1.RELEASE'

解决方案：用@ConfigurationProperties替代@Value #

其实@Value并不适合注入这种嵌套的配置结构，它更擅长单个属性的读取。要绑定整个Map结构，@ConfigurationProperties才是正确的选择，具体步骤如下：

1. 给你的服务类添加配置绑定注解 #

首先确保你的NamingService被Spring扫描管理（比如加上@Component），然后用@ConfigurationProperties指定配置前缀为alias：

import org.springframework.boot.context.properties.ConfigurationProperties
import org.springframework.stereotype.Component

@Component
@ConfigurationProperties(prefix = "alias")
class NamingService {
    // 这里的变量名要和YAML里的结构对应，直接用Map接收整个嵌套内容
    var alias: Map<String, String> = emptyMap()
}

2. 开启配置属性支持 #

你需要在Spring Boot的主启动类上添加@EnableConfigurationProperties注解，来启用这个功能（如果你的Spring Boot版本是2.0+，也可以直接把这个注解加到NamingService类上）：

import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.context.properties.EnableConfigurationProperties
import org.springframework.boot.runApplication

@SpringBootApplication
@EnableConfigurationProperties(NamingService::class)
class YourApplication

fun main(args: Array<String>) {
    runApplication<YourApplication>(*args)
}

3. 测试注入结果 #

现在你可以在其他Spring组件里注入NamingService，直接访问里面的alias Map了：

import org.springframework.stereotype.Service

@Service
class TestService(private val namingService: NamingService) {
    fun printAlias() {
        println(namingService.alias["name"]) // 会输出 "title"
        println(namingService.alias["desc"]) // 会输出 "description"
    }
}

为什么@Value会报错？ #

你用@Value("${alias}")的时候，Spring会去寻找一个名为alias的单个属性值，但你的alias是一个嵌套的Map结构，不是简单的字符串/数值，所以Spring找不到对应的占位符，就抛出了那个错误。而@ConfigurationProperties是专门设计用来处理这种复杂配置绑定的，能自动把嵌套的YAML结构转换成Map或者自定义对象。

内容的提问来源于stack exchange，提问作者Luís Soares