评估

本节介绍 SpEL 接口的编程使用及其表达式语言。完整的语言参考可以在 语言参考 中找到。

以下代码演示了如何使用 SpEL API 评估文字字符串表达式 Hello World。

  • Java

  • Kotlin

ExpressionParser parser = new SpelExpressionParser();
Expression exp = parser.parseExpression("'Hello World'"); (1)
String message = (String) exp.getValue();
1 message 变量的值为 "Hello World"。 
val parser = SpelExpressionParser()
val exp = parser.parseExpression("'Hello World'") (1)
val message = exp.value as String
1 message 变量的值为 "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接口用于在评估表达式时解析属性、方法或字段，并帮助执行类型转换。Spring 提供了两种实现。

  • SimpleEvaluationContext：公开了一组基本的 SpEL 语言功能和配置选项，适用于不需要完整 SpEL 语言语法范围的表达式类别，并且应该有意义地限制。示例包括但不限于数据绑定表达式和基于属性的过滤器。

  • StandardEvaluationContext：公开完整的 SpEL 语言功能和配置选项。您可以使用它来指定默认的根对象，并配置所有可用的与评估相关的策略。

SimpleEvaluationContext旨在仅支持 SpEL 语言语法的子集。它排除了 Java 类型引用、构造函数和 Bean 引用。它还要求您明确选择表达式中属性和方法的支持级别。默认情况下，create() 静态工厂方法仅启用对属性的读访问。您还可以获得一个构建器来配置所需的精确支持级别，针对以下一项或多项组合。

  • 仅自定义PropertyAccessor（不使用反射）

  • 用于只读访问的数据绑定属性

  • 用于读写的数据绑定属性

类型转换

默认情况下，SpEL 使用 Spring 核心（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将保留在数组或列表中指定索引处。以下示例演示了如何自动扩展列表。

  • 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：在混合模式下，表达式会随着时间的推移在解释模式和编译模式之间无缝切换。在经过一定数量的解释运行后，它们会切换到编译形式，如果编译形式出现问题（例如类型更改，如前所述），表达式会自动切换回解释形式。一段时间后，它可能会生成另一个编译形式并切换到它。基本上，用户在 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）。

编译器限制

Spring 不支持编译所有类型的表达式。主要关注点是可能在性能关键环境中使用的常见表达式。以下类型的表达式无法编译。

  • 涉及赋值的表达式

  • 依赖于转换服务的表达式

  • 使用自定义解析器或访问器的表达式

  • 使用重载运算符的表达式

  • 使用数组构造语法表达式的表达式

  • 使用选择或投影的表达式

将来可能会支持编译其他类型的表达式。