值表达式基础

Doubao 中英对照 Value Expressions Fundamentals

值表达式是 Spring 表达式语言（SpEL）与属性占位符解析的结合。它将程序化表达式的强大求值能力与借助属性占位符解析从 Environment 获取值（如配置属性）的简洁性结合在一起。

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

作用域

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

• 映射模型注解：例如 @Document、@Field、@Value，以及 MongoDB、Elasticsearch、Cassandra、Neo4j 等自带映射模型及对应 Entity Reader 的 Spring Data 模块中的其他注解。基于自带映射模型的库（JPA、LDAP）构建的模块，不在映射注解中支持值表达式。

  以下代码演示了如何在映射模型注解的上下文中使用表达式。

  示例 1. @Document 注解用法

  @Document("orders-#{tenantService.getOrderCollection()}-${tenant-config.suffix}")
  class Order {
    // …
  }

• 仓库查询方法：主要通过 @Query。

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

  示例 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>

• 使用单个 SpEL 表达式的值表达式。

• 使用静态 SpEL 表达式的值表达式，求值结果为 2-hello-world。

• 使用单个属性占位符的值表达式。

• 由字面量 orders- 和属性占位符 ${tenant-config.suffix} 组成的复合表达式。

• 混合使用 SpEL、属性占位符和字面量的复合表达式。

备注

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

Spring 表达式语言（SpEL）与属性占位符解析详细说明了 SpEL 和属性占位符的语法与能力。

解析与求值

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

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

Java

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);

Kotlin

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 注入：根对象、命名属性和函数（顶级方法）。

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

Java

@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;
	}

}

Kotlin

@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>

• 调用 MyExtension 声明的方法 add，由于该方法将两个数值参数相加并返回其和，结果为 3。

• 调用 MyExtension 声明的方法 extensionMethod，结果为 Hello World。

• 调用方法 aliasedMethod。该方法以函数形式暴露，并重定向到 MyExtension 声明的方法 extensionMethod，结果为 Hello World。

• 对属性 key 求值，结果为 Hello。

• 在根对象实例 CustomExtensionRootObject 上调用方法 rootObjectInstanceMethod。

您可以在 SecurityEvaluationContextExtension 找到真实场景的上下文扩展。

属性占位符

形如 ${…} 的属性占位符引用的通常是由 PropertySource 通过 Environment 提供的属性。属性便于对照系统属性、应用配置文件、环境配置或密钥管理系统提供的属性源进行解析。有关属性占位符的更多细节，请参阅 Spring Framework 关于 @Value 用法的文档。