属性、数组、列表、映射和索引器
Spring 表达式语言(Spring Expression Language)提供了对对象图导航和各种结构索引的支持。
数值索引值是从零开始的,例如在 Java 中访问数组的第 n 个元素时。
:::提示
有关如何使用空安全运算符导航对象图和索引到各种结构的详细信息,请参阅安全导航运算符部分。
:::
属性导航
你可以通过在对象图中使用句点来导航属性引用,以指示嵌套的属性值。Inventor 类的实例 pupin 和 tesla 已填充了示例中使用的类部分中列出的数据。为了在对象图中向下导航并获取特斯拉的出生年份和普平的出生城市,我们使用以下表达式:
- 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,第 n 个元素将直接通过 list.get(n) 访问。
对于任何其他类型的 Collection,第 n 个元素将通过使用其 Iterator 迭代集合并返回遇到的第 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)
映射索引
通过在中括号内指定键值来获取映射(map)中的内容。在下面的示例中,由于 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)