Spring系列：使用SpEL表达式

type

Post

status

Published

date

Dec 22, 2023

slug

summary

Spring系列：SPEL表达式

一、Spel概述

Spring 表达式语言全称为 “Spring Expression Language”，缩写为 “SpEL”，类似于 Struts2x 中使用的 OGNL 表达式语言，能在运行时构建复杂表达式、存取对象图属性、对象方法调用等等，并且能与 Spring 功能完美整合，如能用来配置 Bean 定义。

SpEL 是单独模块，只依赖于 core 模块，不依赖于其他模块，可以单独使用。

Spel能干什么?

表达式语言的作用是给静态 Java 语言增加了动态功能，可以在运行时查询和操作数据，尤其是数组列表型数据，因此可以缩减代码量，优化代码结构。SpEL支持如下表达式：

一、基本表达式： 字面量表达式、关系，逻辑与算数运算表达式、字符串连接及截取表达式、三目运算及 Elivis 表达式、正则表达式、括号优先级表达式；

二、类相关表达式： 类类型表达式、类实例化、instanceof 表达式、变量定义及引用、赋值表达式、自定义函数、对象属性存取及安全导航表达式、对象方法调用、Bean 引用；

三、集合相关表达式： 内联List、内联数组、集合，字典访问、列表，字典，数组修改、集合投影、集合选择；不支持多维内联数组初始化；不支持内联字典定义；

四、其他表达式：模板表达式。

注：SpEL表达式中的关键字是不区分大小写的。

二、SpEL基础

SpEL 用法

SpEL 有三种用法：

使用 @Value 注解

XML 配置

在代码块中使用 Expression。下面详细介绍下这种用法。

SpEL在求表达式值时一般分为四步，其中第三步可选：首先构造一个解析器，其次解析器解析字符串表达式，在此构造上下文，最后根据上下文得到表达式运算后的值。

1、Hello World

纯字面意义的字符串输出，体验使用的基本步骤。

2、字符串方法的字面调用

在表达式中调用字符串的普通方法和构造方法。

3、针对特定对象解析表达式

SpEL 更常见的用法是提供针对特定对象实例（称为根对象）进行评估的表达式字符串。案例演示如何从 Inventor 类的实例中检索名称属性或创建布尔条件。

代码分析：

创建解析器：SpEL 使用 ExpressionParser 接口创建解析器，这里使用默认实现 SpelExpressionParser。

解析表达式：使用 ExpressionParser 的 parseExpression 来把用户自定义的表达式 name 解析为 Expression 对象。

构造上下文（可跳过）：使用 EvaluationContext 来构建上下文对象，并传入用户自定义对象 tesla。

求值：通过 Expression 接口的 getValue 方法，根据上下文或者用户自定义对象 tesla 获取返回值。

SpEL原理及接口

SpEL提供简单的接口从而简化用户使用，在介绍原理前让我们学习下几个概念：

用户表达式： 用户自定义的表达式，如 1+1!=2 。

解析器： ExpressionParser 接口，负责将用户表达式解析成 SpEL 认识的表达式对象。

表达式对象： Expression 接口，SpEL的核心，表达式语言都是围绕表达式进行的。

评估上下文：EvaluationContext 接口，表示当前表达式对象操作的对象，表达式的评估计算是在上下文上进行的。上下文其实就是设置好某些变量的值，执行表达式时根据这些设置好的内容区获取值。

理解了这些概念后，让我们看下SpEL如何工作的。

工作原理

首先定义表达式 1+2。

定义解析器 ExpressionParser 实现，SpEL提供默认实现 SpelExpressionParser 。

SpelExpressionParser 解析器内部使用 Tokenizer类进行词法分析，即把字符串流分析为记号流，记号在 SpEL 使用Token类来表示。
有了记号流后，解析器便可根据记号流生成内部抽象语法树；在 SpEL 中语法树节点由 SpelNode 接口实现代表：如 OpPlus 表示加操作节点、IntLiteral 表示 int 型字面量节点；使用 SpelNodel 实现组成了抽象语法树。
对外提供 Expression 接口来简化表示抽象语法树，从而隐藏内部实现细节，并提供 getValue 简单方法用于获取表达式值。SpEL提供默认实现为 SpelExpression 。

定义表达式上下文对象（可选），SpEL 使用 EvaluationContext 接口表示上下文对象，用于设置根对象、自定义变量、自定义函数、类型转换器等，SpEL提供默认实现 StandardEvaluationContext 。

使用表达式对象根据上下文对象（可选）求值（调用表达式对象的getValue方法）获得结果。

接下来让我们看下SpEL的主要接口吧。

ExpressionParser接口

表示解析器，默认实现是 org.springframework.expression.spel.standard包中的SpelExpressionParser 类，使用 parseExpression 方法将字符串表达式转换为 Expression 对象，对于 ParserContext 接口用于定义字符串表达式是不是模板，及模板开始与结束字符：

来看下示例：

在此我们演示的是使用 ParserContext 的情况，此处定义了 ParserContext 实现：定义表达式是模块，表达式前缀为 #{，后缀为 }；使用 parseExpression 解析时传入的模板必须以 #{ 开头，以 } 结尾，如 #{'Hello '}#{'World!'}。

默认传入的字符串表达式不是模板形式，如之前演示的Hello World。

EvaluationContext接口

表示上下文环境，默认实现是 org.springframework.expression.spel.support.StandardEvaluationContext 类，使用 setRootObject 方法来设置根对象，使用 setVariable 方法来注册自定义变量，使用 registerFunction 来注册自定义函数等等。

Expression接口

表示表达式对象，默认实现是 org.springframework.expression.spel.standard.SpelExpression，提供 getValue 方法用于获取表达式值，提供setValue方法用于设置对象值。

了解了SpEL原理及接口，接下来的事情就是SpEL语法了。

三、SpEL语法

1、基本表达式

字面量表达式

SpEL支持的字面量包括：字符串、数字类型（int、long、float、double）、布尔类型、null类型。

类型	示例
字符串	String str1 = parser.parseExpression("'Hello World!'").getValue(String.class);
数字类型	int int1 = parser.parseExpression("1").getValue(Integer.class); long long1 = parser.parseExpression("-1L").getValue(long.class); float float1 = parser.parseExpression("1.1").getValue(Float.class); double double1 = parser.parseExpression("1.1E+2").getValue(double.class); int hex1 = parser.parseExpression("0xa").getValue(Integer.class); long hex2 = parser.parseExpression("0xaL").getValue(long.class);
布尔类型	boolean true1 = parser.parseExpression("true").getValue(boolean.class); boolean false1 = parser.parseExpression("false").getValue(boolean.class);
null类型	Object null1 = parser.parseExpression("null").getValue(Object.class);

输出

算数运算表达式

SpEL支持加(+)、减(-)、乘(*)、除(/)、求余（%）、幂（^）运算。

类型	示例
加减乘除	int result1 = parser.parseExpression("1+2-3*4/2").getValue(Integer.class);//-3
求余	int result2 = parser.parseExpression("4%3").getValue(Integer.class);//1
幂运算	int result3 = parser.parseExpression("2^3").getValue(Integer.class);//8

SpEL还提供求余（MOD）和除（DIV）而外两个运算符，与“%”和“/”等价，不区分大小写。

关系表达式

等于（==）、不等于(!=)、大于(>)、大于等于(>=)、小于(<)、小于等于(<=)，区间（between）运算。

如parser.parseExpression("1>2").getValue(boolean.class);将返回false；

而parser.parseExpression("1 between {1, 2}").getValue(boolean.class);将返回true。

between运算符右边操作数必须是列表类型，且只能包含2个元素。第一个元素为开始，第二个元素为结束，区间运算是包含边界值的，即 xxx>=list.get(0) && xxx<=list.get(1)

。

SpEL同样提供了等价的“EQ” 、“NE”、 “GT”、“GE”、 “LT” 、“LE”来表示等于、不等于、大于、大于等于、小于、小于等于，不区分大小写。

输出

逻辑表达式

且（and或者&&）、或(or或者||)、非(!或NOT)。

输出

字符串连接及截取表达式

使用“+”进行字符串连接，使用“'String'[0] [index]”来截取一个字符，目前只支持截取一个，如“'Hello ' + 'World!'”得到“Hello World!”；而“'Hello World!'[0]”将返回“H”。

三目运算

三目运算符 **“表达式1?表达式2:表达式3”**用于构造三目运算表达式，如“2>1?true:false”将返回true；

Elivis运算符

Elivis运算符**“表达式1?:表达式2”**从Groovy语言引入用于简化三目运算符的，当表达式1为非null时则返回表达式1，当表达式1为null时则返回表达式2，简化了三目运算符方式“表达式1? 表达式1:表达式2”，如“null?:false”将返回false，而“true?:false”将返回true；

正则表达式

使用“str matches regex，如“'123' matches '\d{3}'”将返回true；

括号优先级表达式

使用“(表达式)”构造，括号里的具有高优先级。

2、类相关表达式

类类型表达式

使用“T(Type)”来表示java.lang.Class实例，“Type”必须是类全限定名，“java.lang”包除外，即该包下的类可以不指定包名；使用类类型表达式还可以进行访问类静态方法及类静态字段。

具体使用方法如下：

输出

对于java.lang包里的可以直接使用“T(String)”访问；其他包必须是类全限定名；可以进行静态字段访问如“T(Integer).MAX_VALUE”；也可以进行静态方法访问如“T(Integer).parseInt('1')”。

类实例化

类实例化同样使用java关键字“new”，类名必须是全限定名，但java.lang包内的类型除外，如String、Integer。

实例化完全跟Java内方式一样，运行输出

instanceof表达式

SpEL支持instanceof运算符，跟Java内使用同义；如“'haha' instanceof T(String)”将返回true。

输出

变量定义及引用

变量定义通过EvaluationContext接口的setVariable(variableName, value)方法定义；在表达式中使用"#variableName"引用；除了引用自定义变量，SpE还允许引用根对象及当前上下文对象，使用"#root"引用根对象，使用"#this"引用当前上下文对象；

输出

使用“#variable”来引用在EvaluationContext定义的变量；除了可以引用自定义变量，还可以使用“#root”引用根对象，“#this”引用当前上下文对象，此处“#this”即根对象。

自定义函数

目前只支持类静态方法注册为自定义函数；SpEL使用StandardEvaluationContext的registerFunction方法进行注册自定义函数，其实完全可以使用setVariable代替，两者其实本质是一样的；

此处可以看出“registerFunction”和“setVariable”都可以注册自定义函数，但是两个方法的含义不一样，推荐使用“registerFunction”方法注册自定义函数。

运行输出

表达式赋值

使用Expression#setValue方法可以给表达式赋值

运行输出

对象属性存取及安全导航表达式

对象属性获取非常简单，即使用如“a.property.property”这种点缀式获取，SpEL对于属性名首字母是不区分大小写的；SpEL还引入了Groovy语言中的安全导航运算符“(对象|属性)?.属性”，用来避免“?.”前边的表达式为null时抛出空指针异常，而是返回null；修改对象属性值则可以通过赋值表达式或Expression接口的setValue方法修改。

运行输出

对象方法调用

对象方法调用更简单，跟Java语法一样；如“'haha'.substring(2,4)”将返回“ha”；而对于根对象可以直接调用方法；

Bean引用

SpEL支持使用“@”符号来引用Bean，在引用Bean时需要使用BeanResolver接口实现来查找Bean，Spring提供BeanFactoryResolver实现。

运行输出

3、集合相关表达式

内联List

从Spring3.0.4开始支持内联List，使用{表达式，……}定义内联List，如“{1,2,3}”将返回一个整型的ArrayList，而“{}”将返回空的List，对于字面量表达式列表，SpEL会使用java.util.Collections.unmodifiableList方法将列表设置为不可修改。

输出

内联数组

和Java 数组定义类似，只是在定义时进行多维数组初始化。

集合，字典元素访问

SpEL目前支持所有集合类型和字典类型的元素访问，使用“集合[索引]”访问集合元素，使用“map[key]”访问字典元素；

列表，字典，数组元素修改

可以使用赋值表达式或Expression接口的setValue方法修改；

输出

集合投影

在SQL中投影指从表中选择出列，而在SpEL指根据集合中的元素中通过选择来构造另一个集合，该集合和原集合具有相同数量的元素；SpEL使用“（list|map）.![投影表达式]”来进行投影运算：

对于集合或数组使用如上表达式进行投影运算，其中投影表达式中“#this”代表每个集合或数组元素，可以使用比如“#this.property”来获取集合元素的属性，其中“#this”可以省略。

Map投影最终只能得到List结果，如上所示，对于投影表达式中的“#this”将是Map.Entry，所以可以使用“value”来获取值，使用“key”来获取键。

集合选择

在SQL中指使用select进行选择行数据，而在SpEL指根据原集合通过条件表达式选择出满足条件的元素并构造为新的集合，SpEL使用“(list|map).?[选择表达式]”，其中选择表达式结果必须是boolean类型，如果true则选择的元素将添加到新集合中，false将不添加到新集合中。

输出

对于集合或数组选择，如“#collection.?[#this>4]”将选择出集合元素值大于4的所有元素。选择表达式必须返回布尔类型，使用“#this”表示当前元素。

输出

对于字典选择，如“#map.?[#this.key != 'a']”将选择键值不等于”a”的，其中选择表达式中“#this”是Map.Entry类型，而最终结果还是Map，这点和投影不同；集合选择和投影可以一起使用，如“#map.?[key != 'a'].![value+1]”将首先选择键值不等于”a”的，然后在选出的Map中再进行“value+1”的投影。