Scala中结合SnakeYAML与Jackson的YAML解析如何实现环境变量插值

现有YAML解析实现 #

当前为了兼顾SnakeYAML与Jackson生态的优势，解析逻辑已经跑通以下能力：

• 底层使用SnakeYAML做YAML源解析，完整支持YAML内置锚点、别名语法，可配置关闭重复键校验
• 解析出的通用对象结构转换为Jackson JsonNode对象，方便后续做节点遍历、取值等操作

现有能力缺口 #

当前解析链路不支持YAML文件内的环境变量插值，即YAML文本中书写的${环境变量名}格式占位符，会被当作普通字符串解析，无法自动替换为对应系统环境变量的实际值。
典型使用场景为：YAML中书写占位符引用系统环境变量，解析后自动得到变量的实际值，无需手动替换文件内容。

适配环境变量插值的实现方案 #

采用最小侵入的改造方式，不改动原有SnakeYAML锚点支持、Jackson节点转换的核心逻辑，仅在SnakeYAML解析前增加YAML文本的占位符替换步骤：

1. 放弃直接将文件输入流传给SnakeYAML的方式，先将YAML文件内容完整读取为字符串
2. 编写通用占位符替换逻辑，匹配所有${XXX}格式的占位符，从System.getenv()中读取对应值完成替换
3. 将替换完成的YAML字符串传入原有解析链路，后续逻辑完全保持不变

具体代码实现 #

占位符替换工具方法：

import scala.util.matching.Regex

def replaceEnvPlaceholders(rawYaml: String): String = {
  // 匹配符合环境变量命名规则的${KEY}格式占位符
  val placeholderPattern: Regex = """\$\{([A-Za-z_][A-Za-z0-9_]*)\}""".r
  placeholderPattern.replaceAllIn(rawYaml, matchGroup => {
    val envKey = matchGroup.group(1)
    // 从系统环境变量中取值，未找到时抛出明确错误提示
    Option(System.getenv(envKey)).getOrElse(
      throw new IllegalArgumentException(s"环境变量 $envKey 未配置，无法完成YAML插值")
    )
  })
}

原有parseYaml方法的改动点：

def parseYaml(yamlFilePath: String): JsonNode = {
  val loaderOptions = new LoaderOptions
  loaderOptions.setAllowDuplicateKeys(false)
  val yaml = new Yaml(loaderOptions)
  val mapper = new ObjectMapper().registerModules(DefaultScalaModule)

  // 新增：读取原始YAML文本并完成环境变量插值
  val rawYamlContent = scala.io.Source.fromFile(yamlFilePath, "UTF-8").mkString
  val processedYaml = replaceEnvPlaceholders(rawYamlContent)
  
  // 原有解析逻辑保持不变，仅替换入参为处理后的YAML字符串
  val yamlObj = yaml.loadAs(processedYaml, classOf[Any])
  val jsonString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(yamlObj)
  val jsonObj = mapper.readTree(jsonString)
  jsonObj
}

实现效果 #

改造完成后，待解析YAML中书写的path_value: ${PATH}这类占位符，会在解析阶段自动替换为系统环境变量的实际值，最终输出的JsonNode结构完全符合预期，且原有锚点解析能力不受任何影响。

适配注意事项 #

• 若环境变量值本身包含YAML特殊字符（如冒号、换行、双引号），需在YAML书写时对值用引号包裹，避免替换后破坏YAML语法结构
• 可根据业务需求扩展替换逻辑，比如支持占位符默认值语法${KEY:-default}、同时支持Java系统属性（System.getProperty()）的取值逻辑

内容的提问来源于stack exchange，提问作者Abhishek Kanaparthi