值表达式基础知识

ChatGPT-4o-mini 中英对照 Value Expressions Fundamentals

值表达式是 Spring 表达式语言 (SpEL) 和 属性占位符解析 的结合体。它们将强大的编程表达式求值与通过属性占位符解析从 Environment 获取配置属性等值的简便性结合在一起。

表达式应通过受信任的输入（例如注释值）来定义，而不是通过用户输入来确定。

范围

Value Expressions 用于注解中的不同上下文。Spring Data 提供了两种主要的 Value Expression 评估上下文：

• 映射模型注解: 如 @Document、@Field、@Value 以及其他在 Spring Data 模块中提供的注解，这些模块附带了各自的映射模型和相应的实体读取器，如 MongoDB、Elasticsearch、Cassandra、Neo4j。基于提供自己映射模型的库（JPA、LDAP）构建的模块不支持映射注解中的值表达式。

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

  示例 1. @Document 注解用法

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

  java

• 仓库查询方法: 主要通过 @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);
  }

  java

备注

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

表达式语法

值表达式可以通过单一的 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>

none

• 使用单个 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);

java

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)

kotlin

SpEL 表达式

SpEL 表达式遵循模板风格，其中表达式应该被包含在 #{…} 格式中。表达式的求值是通过 EvaluationContext 完成的，该上下文由 EvaluationContextProvider 提供。上下文本身是一个强大的 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;
	}

}

java

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

kotlin

一旦上述显示的扩展注册完成，你就可以使用其导出的方法、属性和根对象来评估 SpEL 表达式：

示例 4. 表达式求值示例

#{add(1, 2)}                                             // <1>
#{extensionMethod()}                                     // <2>
#{aliasedMethod()}                                       // <3>
#{key}                                                   // <4>
#{rootObjectInstanceMethod()}                            // <5>

none

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

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

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

• 评估 key 属性，结果为 Hello。

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

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

属性占位符

${…} 形式的属性占位符通常指通过 Environment 提供的 PropertySource 中的属性。属性用于解析系统属性、应用配置文件、环境配置或由密钥管理系统提供的属性源。你可以在 Spring 框架的 @Value 使用文档 中找到有关属性占位符的更多详细信息。