|
对于最新的稳定版本，请使用 Spring Data JPA 3.5.2！ |
值表达式基础知识
值表达式是 Spring 表达式语言 （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 { // … } -
仓库查询方法：主要通过
@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 表达式、属性占位符或混合各种表达式（包括文字）的复合表达式定义。
#{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应用程序接口。
实例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 表达式遵循模板样式，其中表达式应包含在#{…}格式。
表达式使用EvaluationContext由EvaluationContextProvider.
上下文本身是一个强大的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 表达式：
#{add(1, 2)} (1)
#{extensionMethod()} (2)
#{aliasedMethod()} (3)
#{key} (4)
#{rootObjectInstanceMethod()} (5)| 1 | 调用方法add声明者MyExtension导致3因为该方法会添加两个数字参数并返回总和。 |
| 2 | 调用方法extensionMethod声明者MyExtension导致Hello World. |
| 3 | 调用方法aliasedMethod.
该方法作为函数公开并重定向到该方法extensionMethod声明者MyExtension导致Hello World. |
| 4 | 评估key属性导致Hello. |
| 5 | 调用方法rootObjectInstanceMethod在根对象实例上CustomExtensionRootObject. |
您可以在以下位置找到现实生活中的上下文扩展SecurityEvaluationContextExtension.
属性占位符
表单后面的属性占位符${…}请参阅通常由PropertySource通过Environment.
属性可用于解析系统属性、应用程序配置文件、环境配置或机密管理系统提供的属性源。
您可以在以下位置找到有关属性占位符的更多详细信息Spring Framework 的文档@Value用法.