评估
本节介绍了 SpEL 接口及其表达式语言的编程使用。完整的语言参考可在语言参考中找到。
以下代码演示了如何使用 SpEL API 来评估字面字符串表达式 Hello World。
-
Java
-
Kotlin
ExpressionParser parser = new SpelExpressionParser();
Expression exp = parser.parseExpression("'Hello World'"); (1)
String message = (String) exp.getValue();
| 1 | 消息变量的值是 "Hello World"。 |
val parser = SpelExpressionParser()
val exp = parser.parseExpression("'Hello World'") (1)
val message = exp.value as String
| 1 | 消息变量的值是 "Hello World"。 |
您最可能使用的 SpEL 类和接口位于 org.springframework.expression 包及其子包中,例如 spel.support。
ExpressionParser 接口负责解析表达式字符串。在前面的例子中,表达式字符串是用单引号括起来的字符串字面量。Expression 接口负责评估定义的表达式字符串。调用 parser.parseExpression(…) 和 exp.getValue(…) 时可能抛出的两种异常分别是 ParseException 和 EvaluationException。
SpEL 支持广泛的功能,例如调用方法、访问属性和调用构造函数。
在以下方法调用示例中,我们对字符串字面量 Hello World 调用 concat 方法。
-
Java
-
Kotlin
ExpressionParser parser = new SpelExpressionParser();
Expression exp = parser.parseExpression("'Hello World'.concat('!')"); (1)
String message = (String) exp.getValue();
| 1 | message 的值现在是 "Hello World!"。 |
val parser = SpelExpressionParser()
val exp = parser.parseExpression("'Hello World'.concat('!')") (1)
val message = exp.value as String
| 1 | message 的值现在是 "Hello World!"。 |
以下示例演示了如何访问字符串字面量 Hello World 的 Bytes JavaBean 属性。
-
Java
-
Kotlin
ExpressionParser parser = new SpelExpressionParser();
// invokes 'getBytes()'
Expression exp = parser.parseExpression("'Hello World'.bytes"); (1)
byte[] bytes = (byte[]) exp.getValue();
| 1 | 此行将字面量转换为字节数组。 |
val parser = SpelExpressionParser()
// invokes 'getBytes()'
val exp = parser.parseExpression("'Hello World'.bytes") (1)
val bytes = exp.value as ByteArray
| 1 | 此行将字面量转换为字节数组。 |
SpEL 还支持使用标准点号表示法(例如 prop1.prop2.prop3)的嵌套属性以及相应的属性值设置。也可以访问公共字段。
以下示例展示了如何使用点号表示法获取字符串字面量的长度。
-
Java
-
Kotlin
ExpressionParser parser = new SpelExpressionParser();
// invokes 'getBytes().length'
Expression exp = parser.parseExpression("'Hello World'.bytes.length"); (1)
int length = (Integer) exp.getValue();
| 1 | 'Hello World'.bytes.length 给出字面量的长度。 |
val parser = SpelExpressionParser()
// invokes 'getBytes().length'
val exp = parser.parseExpression("'Hello World'.bytes.length") (1)
val length = exp.value as Int
| 1 | 'Hello World'.bytes.length 给出字面量的长度。 |
可以调用 String 的构造函数而不是使用字符串字面量,如下例所示。
-
Java
-
Kotlin
ExpressionParser parser = new SpelExpressionParser();
Expression exp = parser.parseExpression("new String('hello world').toUpperCase()"); (1)
String message = exp.getValue(String.class);
| 1 | 从字面量构造一个新的 String 并将其转换为大写。 |
val parser = SpelExpressionParser()
val exp = parser.parseExpression("new String('hello world').toUpperCase()") (1)
val message = exp.getValue(String::class.java)
| 1 | 从字面量构造一个新的 String 并将其转换为大写。 |
请注意通用方法的使用:public <T> T getValue(Class<T> desiredResultType)。使用此方法无需将表达式的值转换为所需的返回类型。如果无法将值转换为类型 T 或使用已注册的类型转换器进行转换,则会抛出 EvaluationException。
SpEL 更常见的用法是提供一个表达式字符串,该字符串根据特定的对象实例(称为根对象)进行评估。以下示例展示了如何从 Inventor 类的实例中检索 name 属性,以及如何在布尔表达式中引用 name 属性。
-
Java
-
Kotlin
// Create and set a calendar
GregorianCalendar c = new GregorianCalendar();
c.set(1856, 7, 9);
// The constructor arguments are name, birthday, and nationality.
Inventor tesla = new Inventor("Nikola Tesla", c.getTime(), "Serbian");
ExpressionParser parser = new SpelExpressionParser();
Expression exp = parser.parseExpression("name"); // Parse name as an expression
String name = (String) exp.getValue(tesla);
// name == "Nikola Tesla"
exp = parser.parseExpression("name == 'Nikola Tesla'");
boolean result = exp.getValue(tesla, Boolean.class);
// result == true
// Create and set a calendar
val c = GregorianCalendar()
c.set(1856, 7, 9)
// The constructor arguments are name, birthday, and nationality.
val tesla = Inventor("Nikola Tesla", c.time, "Serbian")
val parser = SpelExpressionParser()
var exp = parser.parseExpression("name") // Parse name as an expression
val name = exp.getValue(tesla) as String
// name == "Nikola Tesla"
exp = parser.parseExpression("name == 'Nikola Tesla'")
val result = exp.getValue(tesla, Boolean::class.java)
// result == true
理解 EvaluationContext
在评估表达式时,EvaluationContext API 用于解析属性、方法或字段,并帮助执行类型转换。Spring 提供了两种实现。
SimpleEvaluationContext-
公开了 SpEL 语言特性和配置选项的一个子集,适用于不需要完整 SpEL 语言语法且应受到有意义限制的表达式类别。示例包括但不限于数据绑定表达式和基于属性的过滤器。
StandardEvaluationContext-
公开了完整的 SpEL 语言特性和配置选项。您可以使用它指定默认根对象并配置所有可用的评估相关策略。
SimpleEvaluationContext 旨在仅支持 SpEL 语言语法的一个子集。例如,它排除了 Java 类型引用、构造函数和 bean 引用。它还要求您明确选择表达式中属性和方法的支持级别。创建 SimpleEvaluationContext 时,您需要选择在 SpEL 表达式中数据绑定所需的支持级别。
-
数据绑定的只读访问
-
数据绑定的读写访问
-
自定义
PropertyAccessor(通常不是基于反射的),可能与DataBindingPropertyAccessor结合使用
方便的是,SimpleEvaluationContext.forReadOnlyDataBinding() 通过 DataBindingPropertyAccessor 启用对属性的只读访问。类似地,SimpleEvaluationContext.forReadWriteDataBinding() 启用对属性的读写访问。或者,通过构建器配置自定义访问器(通过 SimpleEvaluationContext.forPropertyAccessors(…)),可能禁用赋值,并可选地通过构建器激活方法解析和/或类型转换器。
类型转换
默认情况下,SpEL 使用 Spring Core 中可用的转换服务(org.springframework.core.convert.ConversionService)。此转换服务附带许多用于常见转换的内置转换器,但它也完全可扩展,因此您可以在类型之间添加自定义转换。此外,它支持泛型。这意味着,当您在表达式中使用泛型类型时,SpEL 会尝试进行转换以维护它遇到的任何对象的类型正确性。
这在实践中意味着什么?假设使用 setValue() 进行赋值以设置 List 属性。该属性的实际类型是 List<Boolean>。SpEL 识别出列表的元素需要在放入其中之前转换为 Boolean。以下示例展示了如何做到这一点。
-
Java
-
Kotlin
class Simple {
public List<Boolean> booleanList = new ArrayList<>();
}
Simple simple = new Simple();
simple.booleanList.add(true);
EvaluationContext context = SimpleEvaluationContext.forReadOnlyDataBinding().build();
// "false" is passed in here as a String. SpEL and the conversion service
// will recognize that it needs to be a Boolean and convert it accordingly.
parser.parseExpression("booleanList[0]").setValue(context, simple, "false");
// b is false
Boolean b = simple.booleanList.get(0);
class Simple {
var booleanList: MutableList<Boolean> = ArrayList()
}
val simple = Simple()
simple.booleanList.add(true)
val context = SimpleEvaluationContext.forReadOnlyDataBinding().build()
// "false" is passed in here as a String. SpEL and the conversion service
// will recognize that it needs to be a Boolean and convert it accordingly.
parser.parseExpression("booleanList[0]").setValue(context, simple, "false")
// b is false
val b = simple.booleanList[0]
解析器配置
可以通过使用解析器配置对象(org.springframework.expression.spel.SpelParserConfiguration)来配置 SpEL 表达式解析器。配置对象控制某些表达式组件的行为。例如,如果您索引到集合中,并且指定索引处的元素是 null,SpEL 可以自动创建该元素。这在使用由属性引用链组成的表达式时非常有用。同样,如果您索引到集合中并指定一个大于集合当前大小的索引,SpEL 可以自动增长集合以适应该索引。为了在指定索引处添加元素,SpEL 将尝试使用元素类型的默认构造函数创建元素,然后设置指定值。如果元素类型没有默认构造函数,则会将 null 添加到集合中。如果没有内置转换器或自定义转换器知道如何设置值,则 null 将保留在集合中指定索引处。以下示例演示了如何自动增长 List。
-
Java
-
Kotlin
class Demo {
public List<String> list;
}
// Turn on:
// - auto null reference initialization
// - auto collection growing
SpelParserConfiguration config = new SpelParserConfiguration(true, true);
ExpressionParser parser = new SpelExpressionParser(config);
Expression expression = parser.parseExpression("list[3]");
Demo demo = new Demo();
Object o = expression.getValue(demo);
// demo.list will now be a real collection of 4 entries
// Each entry is a new empty String
class Demo {
var list: List<String>? = null
}
// Turn on:
// - auto null reference initialization
// - auto collection growing
val config = SpelParserConfiguration(true, true)
val parser = SpelExpressionParser(config)
val expression = parser.parseExpression("list[3]")
val demo = Demo()
val o = expression.getValue(demo)
// demo.list will now be a real collection of 4 entries
// Each entry is a new empty String
默认情况下,SpEL 表达式不能包含超过 10,000 个字符;但是,maxExpressionLength 是可配置的。如果您以编程方式创建 SpelExpressionParser,则可以在创建提供给 SpelExpressionParser 的 SpelParserConfiguration 时指定自定义的 maxExpressionLength。如果您希望设置在 ApplicationContext 中解析 SpEL 表达式时使用的 maxExpressionLength(例如,在 XML bean 定义、@Value 等中),您可以将名为 spring.context.expression.maxLength 的 JVM 系统属性或 Spring 属性设置为您的应用程序所需的最大表达式长度(请参阅支持的 Spring 属性)。
SpEL 编译
Spring 为 SpEL 表达式提供了一个基本编译器。表达式通常是解释执行的,这在评估期间提供了很大的动态灵活性,但不能提供最佳性能。对于偶尔使用表达式来说,这很好,但是,当被 Spring Integration 等其他组件使用时,性能可能非常重要,并且对动态性没有实际需求。
SpEL 编译器旨在解决此需求。在评估期间,编译器会生成一个 Java 类,该类在运行时体现表达式行为,并使用该类实现更快的表达式评估。由于表达式周围缺乏类型,编译器在执行编译时使用从表达式的解释评估中收集的信息。例如,它纯粹从表达式中不知道属性引用的类型,但在第一次解释评估期间,它会发现它是哪种类型。当然,基于此类派生信息进行编译可能会导致以后出现问题,如果各种表达式元素的类型随时间变化。因此,编译最适合那些类型信息在重复评估时不会更改的表达式。
考虑以下基本表达式。
someArray[0].someProperty.someOtherProperty < 0.1
由于上述表达式涉及数组访问、一些属性解引用和数值运算,性能提升可能非常明显。在一个示例微基准测试中,运行 50,000 次迭代,使用解释器评估需要 75 毫秒,而使用表达式的编译版本仅需要 3 毫秒。
编译器配置
编译器默认不开启,但您可以通过两种不同的方式开启它。您可以通过解析器配置过程(前面讨论过)开启它,或者在 SpEL 用法嵌入到另一个组件中时使用 Spring 属性。本节讨论这两种选项。
编译器可以在三种模式之一中运行,这些模式捕获在 org.springframework.expression.spel.SpelCompilerMode 枚举中。模式如下。
OFF-
编译器已关闭,所有表达式都将在 解释 模式下进行评估。这是默认模式。
IMMEDIATE-
在即时模式下,表达式会尽快编译,通常在第一次解释评估之后。如果编译后的表达式评估失败(例如,由于类型更改,如前所述),表达式评估的调用者会收到异常。如果各种表达式元素的类型随时间变化,请考虑切换到
MIXED模式或关闭编译器。 MIXED-
在混合模式下,表达式评估会随着时间在 解释 和 编译 之间悄无声息地切换。在几次成功的解释运行后,表达式会被编译。如果编译后的表达式评估失败(例如,由于类型更改),该失败将在内部捕获,并且系统将切换回给定表达式的解释模式。基本上,调用者在
IMMEDIATE模式下收到的异常将改为在内部处理。稍后,编译器可能会生成另一个编译形式并切换到它。这种在解释和编译模式之间切换的循环将继续,直到系统确定继续尝试没有意义——例如,当达到某个失败阈值时——此时系统将永久切换到给定表达式的解释模式。
存在 IMMEDIATE 模式是因为 MIXED 模式可能导致具有副作用的表达式出现问题。如果编译后的表达式在部分成功后崩溃,它可能已经做了影响系统状态的事情。如果发生这种情况,调用者可能不希望它在解释模式下悄无声息地重新运行,因为表达式的一部分可能已经运行了两次。
选择模式后,使用 SpelParserConfiguration 配置解析器。以下示例展示了如何做到这一点。
-
Java
-
Kotlin
SpelParserConfiguration config = new SpelParserConfiguration(SpelCompilerMode.IMMEDIATE,
this.getClass().getClassLoader());
SpelExpressionParser parser = new SpelExpressionParser(config);
Expression expr = parser.parseExpression("payload");
MyMessage message = new MyMessage();
Object payload = expr.getValue(message);
val config = SpelParserConfiguration(SpelCompilerMode.IMMEDIATE,
this.javaClass.classLoader)
val parser = SpelExpressionParser(config)
val expr = parser.parseExpression("payload")
val message = MyMessage()
val payload = expr.getValue(message)
当您指定编译器模式时,您还可以指定一个 ClassLoader(允许传入 null)。编译后的表达式在提供的任何 ClassLoader 下创建的子 ClassLoader 中定义。重要的是要确保,如果指定了 ClassLoader,它能够看到表达式评估过程中涉及的所有类型。如果您不指定 ClassLoader,则使用默认的 ClassLoader(通常是表达式评估期间运行的线程的上下文 ClassLoader)。
配置编译器的第二种方式是在 SpEL 嵌入到其他组件中且无法通过配置对象进行配置时使用。在这种情况下,可以通过 JVM 系统属性(或通过SpringProperties机制)将 spring.expression.compiler.mode 属性设置为 SpelCompilerMode 枚举值之一(off、immediate 或 mixed)。