值表达式基础

值表达式是 Spring Expression Language (SpEL) 和属性占位符解析的组合。它们结合了程序化表达式的强大求值能力和通过属性占位符解析从 Environment 获取值（例如配置属性）的简单性。

表达式应该由可信的输入（例如注解值）定义，而不是由用户输入决定。

范围

值表达式在各种注解上下文中被使用。Spring Data 在两个主要上下文提供值表达式求值：

映射模型注解：例如 @Document, @Field, @Value 以及 Spring Data 模块中附带自己映射模型和相应实体读取器的其他注解，如 MongoDB, Elasticsearch, Cassandra, Neo4j。依赖于提供自身映射模型库（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	使用一个求值为 `2-hello-world` 的静态 SpEL 表达式的值表达式。
3	使用单个属性占位符的值表达式。
4	由字面值 `orders-` 和属性占位符 `${tenant-config.suffix}` 组成的复合表达式。
5	使用 SpEL、属性占位符和字面值的复合表达式。

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

Spring Expression Language (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 用法的文档中找到更多关于属性占位符的详细信息。