值表达式基础

值表达式是 Spring 表达式语言 (SpEL) 和 属性占位符解析 的组合。它们将强大的程序表达式评估与从 Environment 获取值的属性占位符解析的简单性相结合，例如配置属性。

预期表达式由受信任的输入（例如注释值）定义，而不是从用户输入确定。

以下代码演示了如何在注释上下文中使用表达式。

示例 1. 注释用法
@Document("orders-#{tenantService.getOrderCollection()}-${tenant-config.suffix}")
class Order {
  // …
}

值表达式可以从单个 SpEL 表达式、属性占位符或混合各种表达式（包括文字）的复合表达式定义。

示例 2. 表达式示例
#{tenantService.getOrderCollection()}                          (1)
#{(1+1) + '-hello-world'}                                      (2)
${tenant-config.suffix}                                        (3)
orders-${tenant-config.suffix}                                 (4)
#{tenantService.getOrderCollection()}-${tenant-config.suffix}  (5)
1 使用单个 SpEL 表达式的值表达式。
2 使用静态 SpEL 表达式的值表达式，评估结果为 2-hello-world。
3 使用单个属性占位符的值表达式。
4 由字面量 orders- 和属性占位符 ${tenant-config.suffix} 组成的复合表达式。
5 使用 SpEL、属性占位符和字面量的复合表达式。
使用值表达式为您的代码带来了很大的灵活性。这样做需要在每次使用时评估表达式，因此值表达式评估会影响性能。

解析和评估

值表达式由 ValueExpressionParser API 解析。ValueExpression 的实例是线程安全的，可以缓存以供以后使用，以避免重复解析。

以下示例显示了值表达式 API 的用法

解析和评估

  • Java

  • Kotlin

ValueParserConfiguration configuration = SpelExpressionParser::new;
ValueEvaluationContext context = ValueEvaluationContext.of(environment, evaluationContext);

ValueExpressionParser parser = ValueExpressionParser.create(configuration);
ValueExpression expression = parser.parse("Hello, World");
Object result = expression.evaluate(context);
val configuration = ValueParserConfiguration { SpelExpressionParser() }
val context = ValueEvaluationContext.of(environment, evaluationContext)

val parser = ValueExpressionParser.create(configuration)
val expression: ValueExpression = parser.parse("Hello, World")
val result: Any = expression.evaluate(context)

SpEL 表达式

SpEL 表达式 遵循模板样式，其中表达式应包含在 #{…} 格式中。表达式使用由 EvaluationContextProvider 提供的 EvaluationContext 进行评估。上下文本身是一个功能强大的 StandardEvaluationContext，允许进行广泛的操作，访问静态类型和上下文扩展。

确保仅解析和评估来自受信任来源（如注释）的表达式。接受用户提供的表达式可能会创建一个进入路径来利用应用程序上下文和您的系统，从而导致潜在的安全漏洞。

扩展评估上下文

EvaluationContextProvider 及其响应式变体 ReactiveEvaluationContextProvider 提供对 EvaluationContext 的访问。ExtensionAwareEvaluationContextProvider 及其响应式变体 ReactiveExtensionAwareEvaluationContextProvider 是默认实现，它们从应用程序上下文（特别是 ListableBeanFactory）确定上下文扩展。

扩展实现 EvaluationContextExtension 或 ReactiveEvaluationContextExtension 以提供扩展支持来填充 EvaluationContext。它们是根对象、属性和函数（顶级方法）。

以下示例显示了一个上下文扩展，它提供了一个根对象、属性、函数和一个别名函数。

实现 EvaluationContextExtension

  • Java

  • Kotlin

@Component
public class MyExtension implements EvaluationContextExtension {

    @Override
    public String getExtensionId() {
        return "my-extension";
    }

    @Override
    public Object getRootObject() {
        return new CustomExtensionRootObject();
    }

    @Override
    public Map<String, Object> getProperties() {

        Map<String, Object> properties = new HashMap<>();

        properties.put("key", "Hello");

        return properties;
    }

    @Override
    public Map<String, Function> getFunctions() {

        Map<String, Function> functions = new HashMap<>();

        try {
            functions.put("aliasedMethod", new Function(getClass().getMethod("extensionMethod")));
            return functions;
        } catch (Exception o_O) {
            throw new RuntimeException(o_O);
        }
    }

    public static String extensionMethod() {
        return "Hello World";
    }

    public static int add(int i1, int i2) {
        return i1 + i2;
    }

}

public class CustomExtensionRootObject {

	public boolean rootObjectInstanceMethod() {
		return true;
	}

}
@Component
class MyExtension : EvaluationContextExtension {

    override fun getExtensionId(): String {
        return "my-extension"
    }

    override fun getRootObject(): Any? {
        return CustomExtensionRootObject()
    }

    override fun getProperties(): Map<String, Any> {
        val properties: MutableMap<String, Any> = HashMap()

        properties["key"] = "Hello"

        return properties
    }

    override fun getFunctions(): Map<String, Function> {
        val functions: MutableMap<String, Function> = HashMap()

        try {
            functions["aliasedMethod"] = Function(javaClass.getMethod("extensionMethod"))
            return functions
        } catch (o_O: Exception) {
            throw RuntimeException(o_O)
        }
    }

    companion object {
        fun extensionMethod(): String {
            return "Hello World"
        }

        fun add(i1: Int, i2: Int): Int {
            return i1 + i2
        }
    }
}

class CustomExtensionRootObject {
	fun rootObjectInstanceMethod(): Boolean {
		return true
	}
}

注册上述扩展后，您可以使用其导出的方法、属性和根对象来评估 SpEL 表达式

示例 3. 表达式评估示例
#{add(1, 2)}                                             (1)
#{extensionMethod()}                                     (2)
#{aliasedMethod()}                                       (3)
#{key}                                                   (4)
#{rootObjectInstanceMethod()}                            (5)
1 调用由 MyExtension 声明的 add 方法，该方法将两个数值参数相加并返回其和，结果为 3。
2 调用由 MyExtension 声明的 extensionMethod 方法，结果为 Hello World。
3 调用 aliasedMethod 方法。该方法作为函数公开，并重定向到由 MyExtension 声明的 extensionMethod 方法，结果为 Hello World。
4 评估 key 属性，结果为 Hello。
5 在根对象实例 CustomExtensionRootObject 上调用 rootObjectInstanceMethod 方法。

您可以在 SecurityEvaluationContextExtension 中找到现实世界中的上下文扩展。

属性占位符

遵循 ${…} 格式的属性占位符引用通常由 PropertySource 通过 Environment 提供的属性。属性对于解析系统属性、应用程序配置文件、环境配置或由秘密管理系统贡献的属性源很有用。您可以在 Spring Framework 的 @Value 使用文档 中找到有关属性占位符的更多详细信息。