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

Spring 表达式语言提供对导航对象图和索引到各种结构的支持。

数值索引值从零开始，例如在 Java 中访问数组的第 n 个元素时。
有关如何使用空安全运算符导航对象图和索引到各种结构的详细信息，请参阅安全导航运算符部分。

属性导航

您可以通过使用句点表示嵌套属性值来导航对象图中的属性引用。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 表达式语言支持通过允许开发人员实现并将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)