如何在 Spring YAML 配置中转义 SpEL 美元符号？

Question

在 Spring YAML 配置文件中，我需要一个类似的参数

csv:
  file:
    pattern: /some/path/${app-name}.csv

${app-name} 在运行时被 Java 代码动态替换，我不希望 Spring 在启动时替换它。

为此，我需要转义 $ 字符，以便 Spring 不会将其解释为 SpEL。

以下答案不在 YAML 中有效：

• \$How to escape EL dollar signs?

• #{'$'}Escape property reference in Spring property file

• Could not read properties if it contains dollar symbol (${var})

我尝试了所有的组合，比如

pattern: /some/path/\${app-name}.csv
pattern: "/some/path/\${app-name}.csv"
pattern: /some/path/#{'$'}{app-name}.csv
pattern: "/some/path/#{'$'}{app-name}.csv"

并且它们都不产生包含所请求字符串的变量，带有美元符号但没有转义字符。

请注意它是 YAML 配置。在 YAML 文件中，# 是行注释字符，从该字符开始的所有内容都将被忽略。如果我使用\#，则\ 会被传递给字符串。

添加：Spring project open issue 9628 自 2008 年 6 月 25 日起开放：

目前无法注入不会被 PropertyPlaceholderConfigurer 拾取的 ${...} 表达式。理想情况下，我们应该能够注入一个包含 ${...} 的字符串以供以后在其目标 bean 中使用，而无需 PropertyPlaceholderConfigurer 的参与。

Answer 1

使用空键和美元符号$ 的组合作为默认值：

csv:
  file:
    pattern: /some/path/${:$}{app-name}.csv

Answer 2

Spring 目前不提供属性占位符的转义机制，有一个open issue（于 2008 年 6 月 25 日开放）。在 cmets 中，提到了这种解决方法（我不确定它是否适用于 YAML）：

csv:
  file:
    pattern: /some/path/#{'$'}{app-name}.csv

请注意，当在空格之后或行首使用时，YAML 中的 # 会开始注释。

Answer 3

您需要使用#{'$'}，并且当您使用 yaml 时，您需要用双引号将值括起来：

csv:
  file:
    pattern: "/some/path/#{'$'}{app-name}.csv"

Answer 4

我也遇到了同样的问题。因此，您可以使用 yaml 文字样式符号 "|" 或使用 literal_strip "|-" 来解决此问题，如下例所示。

application.yml

csv:
  file:
    pattern: |-
      /some/path/${app-name}.csv

---

实际上我的问题是在 yml 中配置一个公式，然后在 java 中动态解析表达式。在这里分享解决方案。

我选择spring el方案，使用spring版本5.0.9.RELEASE。

我在yml中定义了一个公式，

score:
  formula: |-
    10 * #x + #y

然后在一个spring组件bean中，

@Value("${score.formula}")
String scoreFormula;

最后使用spring el，

ExpressionParser parser = new SpelExpressionParser();
EvaluationContext context = SimpleEvaluationContext.forReadOnlyDataBinding().build();

context.setVariable("x", 1);
context.setVariable("y", 1);
Integer score = parser.parseExpression(scoreFormula).getValue(context,Integer.class);

---

参考

yaml-multi-line

Answer 5

实际上，没有一个答案对我有用。但是，添加双美元符号对我来说很好：

csv:
  file:
    pattern: /some/path/$${app-name}.csv

Answer 6

为什么不尝试使用${sys:$}，虽然丑但有效。我想没有人会用$作为key。

Answer 7

我遇到了同样的问题，我只是找到了 dumb 聪明的解决方案 定义一个名为 DollarSign 或简称为 ds 的属性。

ds: "$"

然后像这样使用它，${ds} 将在运行时被$ 替换。

csv:
  file:
    pattern: /some/path/${ds}{app-name}.csv

当它起作用时有点有趣。

Answer 8

答案实际上取决于您将值注入代码的准确程度。由于您尚未提供它，我将仅列出各种工作技术。

1. 你可以使用@Value注解来注入你的属性。因为，unlike @ConfigurationProperties, @Value does SpEL evaluation，你必须逃避你的价值。

application.yml:

csv:
  file:
    pattern: /some/path/#{'$'}{app-name}.csv

TestController.java：

@RestController
public class TestController {
    @Value("${csv.file.pattern}") private String pattern;
    @GetMapping("pattern") public ResponseEntity<String> getPattern() {
        return ResponseEntity.ok(pattern);
    }
}

对/pattern 的GET 将产生/some/path/#{app-name}.csv 的输出，正如您所需要的那样

1. 您可以使用@ConfigurationProperties，这实际上取决于您如何构建配置对象。不过，一般来说，@ConfigurationProperties 不需要转义，因为默认情况下它们不支持 SpEL。但是，以下方法有效，因此如果您的设置不同，请修改它：

application.yml:

csv:
  file:
    pattern: /some/path/#{app-name}.csv

Config.java：

@ConfigurationProperties(prefix = "csv.file")
public class Config {
    private String pattern;
    public String getPattern() { return pattern; }
    public void setPattern(String pattern) { this.pattern = pattern; }
}

TestController.java：

@RestController
public class TestController {
    @Autowired private Config config;
    @GetMapping("pattern") public ResponseEntity<String> getPattern() {
        return ResponseEntity.ok(config.getPattern());
    }
}

同样，对 /pattern 的 GET 将导致输出 /some/path/#{app-name}.csv

您最有可能在 Config.java 中有一些不同的结构（发布相关代码，也许？），这可能会导致属性无法正确处理。