属性、数组、列表、映射和索引器

Spring Expression Language 支持导航对象图并对各种结构进行索引。

数值索引值是基于零的，例如在 Java 中访问数组的第 n 个元素时。
有关如何使用 null 安全运算符导航对象图并对各种结构进行索引的详细信息，请参阅安全导航运算符一节。

属性导航

您可以使用句点（.）来指示嵌套的属性值，从而在对象图内导航属性引用。Inventor 类的实例，pupin 和 tesla，已使用示例中使用的类部分列出的数据进行填充。要导航对象图的下层并获取 Tesla 的出生年份和 Pupin 的出生城市，我们使用以下表达式

  • Java

  • Kotlin

// evaluates to 1856
int year = (Integer) parser.parseExpression("birthdate.year + 1900").getValue(context);

// evaluates to "Smiljan"
String city = (String) parser.parseExpression("placeOfBirth.city").getValue(context);
// evaluates to 1856
val year = parser.parseExpression("birthdate.year + 1900").getValue(context) as Int

// evaluates to "Smiljan"
val city = parser.parseExpression("placeOfBirth.city").getValue(context) as String

属性名称的第一个字母允许不区分大小写。因此，上面示例中的表达式可以分别写成 Birthdate.Year + 1900 和 PlaceOfBirth.City。此外，属性也可以选择通过方法调用来访问 — 例如，getPlaceOfBirth().getCity() 而不是 placeOfBirth.city。

对数组和集合进行索引

可以使用方括号表示法获取数组或集合（例如，Set 或 List）的第 n 个元素，如下例所示。

如果被索引的集合是 java.util.List，则通过 list.get(n) 直接访问第 n 个元素。

对于任何其他类型的 Collection，通过使用其 Iterator 遍历集合并返回遇到的第 n 个元素来访问第 n 个元素。

  • Java

  • Kotlin

ExpressionParser parser = new SpelExpressionParser();
EvaluationContext context = SimpleEvaluationContext.forReadOnlyDataBinding().build();

// Inventions Array

// evaluates to "Induction motor"
String invention = parser.parseExpression("inventions[3]").getValue(
		context, tesla, String.class);

// Members List

// evaluates to "Nikola Tesla"
String name = parser.parseExpression("members[0].name").getValue(
		context, ieee, String.class);

// List and Array Indexing

// evaluates to "Wireless communication"
String invention = parser.parseExpression("members[0].inventions[6]").getValue(
		context, ieee, String.class);
val parser = SpelExpressionParser()
val context = SimpleEvaluationContext.forReadOnlyDataBinding().build()

// Inventions Array

// evaluates to "Induction motor"
val invention = parser.parseExpression("inventions[3]").getValue(
		context, tesla, String::class.java)

// Members List

// evaluates to "Nikola Tesla"
val name = parser.parseExpression("members[0].name").getValue(
		context, ieee, String::class.java)

// List and Array Indexing

// evaluates to "Wireless communication"
val invention = parser.parseExpression("members[0].inventions[6]").getValue(
		context, ieee, String::class.java)

对字符串进行索引

可以通过在方括号内指定索引来获取字符串的第 n 个字符，如下例所示。

字符串的第 n 个字符将求值为 java.lang.String，而不是 java.lang.Character。

  • Java

  • Kotlin

// evaluates to "T" (8th letter of "Nikola Tesla")
String character = parser.parseExpression("members[0].name[7]")
		.getValue(societyContext, String.class);
// evaluates to "T" (8th letter of "Nikola Tesla")
val character = parser.parseExpression("members[0].name[7]")
		.getValue(societyContext, String::class.java)

对映射进行索引

通过在方括号内指定键值来获取映射的内容。在以下示例中，由于 officers 映射的键是字符串，我们可以指定字符串字面量，例如 'president'

  • Java

  • Kotlin

// Officer's Map

// evaluates to Inventor("Pupin")
Inventor pupin = parser.parseExpression("officers['president']")
		.getValue(societyContext, Inventor.class);

// evaluates to "Idvor"
String city = parser.parseExpression("officers['president'].placeOfBirth.city")
		.getValue(societyContext, String.class);

String countryExpression = "officers['advisors'][0].placeOfBirth.country";

// setting values
parser.parseExpression(countryExpression)
		.setValue(societyContext, "Croatia");

// evaluates to "Croatia"
String country = parser.parseExpression(countryExpression)
		.getValue(societyContext, String.class);
// Officer's Map

// evaluates to Inventor("Pupin")
val pupin = parser.parseExpression("officers['president']")
		.getValue(societyContext, Inventor::class.java)

// evaluates to "Idvor"
val city = parser.parseExpression("officers['president'].placeOfBirth.city")
		.getValue(societyContext, String::class.java)

val countryExpression = "officers['advisors'][0].placeOfBirth.country"

// setting values
parser.parseExpression(countryExpression)
		.setValue(societyContext, "Croatia")

// evaluates to "Croatia"
val country = parser.parseExpression(countryExpression)
		.getValue(societyContext, String::class.java)

对对象进行索引

可以通过在方括号内指定属性的名称来获取对象的属性。这类似于根据键访问映射的值。以下示例演示了如何对对象进行索引以检索特定属性。

  • Java

  • Kotlin

// Create an inventor to use as the root context object.
Inventor tesla = new Inventor("Nikola Tesla");

// evaluates to "Nikola Tesla"
String name = parser.parseExpression("#root['name']")
		.getValue(context, tesla, String.class);
// Create an inventor to use as the root context object.
val tesla = Inventor("Nikola Tesla")

// evaluates to "Nikola Tesla"
val name = parser.parseExpression("#root['name']")
		.getValue(context, tesla, String::class.java)

对自定义结构进行索引

自 Spring Framework 6.2 起，Spring Expression Language 通过允许开发者实现 IndexAccessor 并将其注册到 EvaluationContext 中来支持对自定义结构进行索引。如果您希望支持依赖自定义索引访问器的表达式编译，则该索引访问器必须实现 CompilableIndexAccessor SPI。

为了支持常见的用例，Spring 提供了一个内置的 ReflectiveIndexAccessor，它是一个灵活的 IndexAccessor，使用反射从目标对象的索引结构中读取（并可选择写入）。可以通过一个 public 读取方法（读取时）或一个 public 写入方法（写入时）访问索引结构。读取方法和写入方法之间的关系基于适用于典型的索引结构实现的约定。

ReflectiveIndexAccessor 也实现了 CompilableIndexAccessor，以支持读取访问的字节码编译。但请注意，配置的读取方法必须可以通过 public 类或 public 接口调用，编译才能成功。

以下代码列表定义了一个 Color 枚举和一个 FruitMap 类型，它表现得像一个映射，但不实现 java.util.Map 接口。因此，如果您想在 SpEL 表达式中对 FruitMap 进行索引，您需要注册一个 IndexAccessor。

public enum Color {
	RED, ORANGE, YELLOW
}
public class FruitMap {

	private final Map<Color, String> map = new HashMap<>();

	public FruitMap() {
		this.map.put(Color.RED, "cherry");
		this.map.put(Color.ORANGE, "orange");
		this.map.put(Color.YELLOW, "banana");
	}

	public String getFruit(Color color) {
		return this.map.get(color);
	}

	public void setFruit(Color color, String fruit) {
		this.map.put(color, fruit);
	}
}

可以通过 new ReflectiveIndexAccessor(FruitMap.class, Color.class, "getFruit") 创建一个用于 FruitMap 的只读 IndexAccessor。注册该访问器并将 FruitMap 注册为名为 #fruitMap 的变量后，SpEL 表达式 #fruitMap[T(example.Color).RED] 将求值为 "cherry"。

可以通过 new ReflectiveIndexAccessor(FruitMap.class, Color.class, "getFruit", "setFruit") 创建一个用于 FruitMap 的读写 IndexAccessor。注册该访问器并将 FruitMap 注册为名为 #fruitMap 的变量后，可以使用 SpEL 表达式 #fruitMap[T(example.Color).RED] = 'strawberry' 将颜色红色的水果映射从 "cherry" 更改为 "strawberry"。

以下示例演示了如何注册一个 ReflectiveIndexAccessor 来对 FruitMap 进行索引，然后在 SpEL 表达式中对 FruitMap 进行索引。

  • Java

  • Kotlin

// Create a ReflectiveIndexAccessor for FruitMap
IndexAccessor fruitMapAccessor = new ReflectiveIndexAccessor(
		FruitMap.class, Color.class, "getFruit", "setFruit");

// Register the IndexAccessor for FruitMap
context.addIndexAccessor(fruitMapAccessor);

// Register the fruitMap variable
context.setVariable("fruitMap", new FruitMap());

// evaluates to "cherry"
String fruit = parser.parseExpression("#fruitMap[T(example.Color).RED]")
		.getValue(context, String.class);
// Create a ReflectiveIndexAccessor for FruitMap
val fruitMapAccessor = ReflectiveIndexAccessor(
		FruitMap::class.java, Color::class.java, "getFruit", "setFruit")

// Register the IndexAccessor for FruitMap
context.addIndexAccessor(fruitMapAccessor)

// Register the fruitMap variable
context.setVariable("fruitMap", FruitMap())

// evaluates to "cherry"
val fruit = parser.parseExpression("#fruitMap[T(example.Color).RED]")
	.getValue(context, String::class.java)