值表达式基础

值表达式是 Spring 表达式语言 (SpEL) 和属性占位符解析的组合。它们将编程表达式的强大求值能力与借助于属性占位符解析从 Environment（如配置属性）获取值的简单性结合起来。

表达式应由受信任的输入定义，例如注解值，而不应由用户输入确定。

范围

值表达式在跨注解的上下文中使用。Spring Data 在两个主要上下文提供值表达式求值功能：

映射模型注解：例如 Spring Data 模块中自带映射模型及相应实体读取器（如 MongoDB、Elasticsearch、Cassandra、Neo4j）的 @Document、@Field、@Value 及其他注解。基于提供自身映射模型库（JPA、LDAP）的模块不支持在映射注解中使用值表达式。

以下代码演示了如何在映射模型注解上下文中使用表达式。
示例 1. @Document 注解用法
@Document("orders-#{tenantService.getOrderCollection()}-${tenant-config.suffix}") class Order { // … }

Repository 查询方法：主要通过 @Query。

以下代码演示了如何在 Repository 查询方法上下文中使用表达式。

示例 2. @Query 注解用法

class OrderRepository extends Repository<Order, String> {

  @Query("select u from User u where u.tenant = ?${spring.application.name:unknown} and u.firstname like %?#{escape([0])}% escape ?#{escapeCharacter()}")
  List<Order> findContainingEscaped(String namePart);
}

请查阅您所使用的模块文档，以确定实际的按名称/按索引参数绑定语法。通常，表达式以 :#{…}/:${…} 或 ?#{…}/?${…} 为前缀。

表达式语法

值表达式可以由单独的 SpEL 表达式、属性占位符或混合了各种表达式（包括字面量）的复合表达式定义。

示例 3. 表达式示例

#{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、属性占位符和字面量的复合表达式。

使用值表达式为您的代码带来了很大的灵活性。这样做需要在每次使用时对表达式进行求值，因此值表达式求值会对性能产生影响。

Spring 表达式语言 (SpEL) 和属性占位符解析详细解释了 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 表达式：

示例 4. 表达式求值示例

#{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 找到真实的上下文扩展示例。

属性占位符

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