Spring3的表达式语言 spel

http://blog.itpub.net/26660100/viewspace-717243/

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

表达式语言给静态Java语言增加了动态功能。

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

能干什么

表达式语言一般是用较为简单的形式完成主要的工作，减少开发的工作量。

SpEL支持如下表达式：

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

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

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

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

在Java中使用SpringEL是非常简单的，示例如下：

java代码：

public class HelloWorld {
public static void main(String[] args) {
//构造上下文：准备比如变量定义等等表达式运行需要的上下文数据
EvaluationContext context = new StandardEvaluationContext();
//创建解析器：提供SpelExpressionParser默认实现
ExpressionParser parser = new SpelExpressionParser();
//解析表达式：使用ExpressionParser来解析表达式为相应的Expression对象
Expression expression =
parser.parseExpression("('Hello' + ' World').concat(#end)");
 
//设置上下文中的变量的值
context.setVariable("end", "!SpringEL");
//执行表达式，获取运行结果
String str = (String)expression.getValue(context);
System.out.println("the str="+str);
}
}

ExpressionParser接口

表示解析器，默认实现是org.springframework.expression.spel.standard包中的SpelExpressionParser类，使用parseExpression方法将字符串表达式转换为Expression对象。

配合  ExpressionParser 接口使用的ParserContext接口用于定义字符串表达式是不是模板，及模板开始与结束字符，示例如下：

java代码：

public static void main(String[] args) {
 ExpressionParser parser = new SpelExpressionParser();
 //自定义一个解析模板的规则
    ParserContext parserContext = new ParserContext() {
        public boolean isTemplate() {             return true;        }
        public String getExpressionPrefix() {     return "#{";        }
        public String getExpressionSuffix() {     return "}";        }
    };
    String template = "#{'Hello '}#{'World!'}";
    Expression expression = parser.parseExpression(template, parserContext);
    System.out.println( expression.getValue());
}

说明

1：在此演示的是使用ParserContext的情况，此处定义了ParserContext实现：定义表达式是模块，表达式前缀为“#{”，后缀为“}”；

2：使用parseExpression解析时传入的模板必须以“#{”开头，以“}”结尾，如“#{‘Hello ’}#{‘World!’}”。

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

 

Expression接口

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

 

EvaluationContext接口

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

 

字面量表达式：

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

java代码：

1：String str1 = parser.parseExpression("'Hello World!'").getValue(String.class);
2：String str2 = parser.parseExpression("\"Hello World!\"").getValue(String.class);
3：int int1 = parser.parseExpression("1").getValue(Integer.class);
4：float float1 = parser.parseExpression("1.1").getValue(Float.class);
5：boolean true1 = parser.parseExpression("true").getValue(boolean.class);
6：Object null1 = parser.parseExpression("null").getValue(Object.class);
 

算数运算表达式 ：

SpEL支持加(+)、减(-)、乘(*)、除(/)、求余（%）、幂（^）运算，示例如下：

1：int result1 = parser.parseExpression("1+2-3*4/2").getValue(Integer.class);

2：int result2 = parser.parseExpression(“4%3”).getValue(Integer.class) ;

3：int result3 = parser.parseExpression("2^3").getValue(Integer.class);

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

关系表达式

等于（==）、不等于(!=)、大于(>)、大于等于(>=)、小于(<)、小于等于(<=)，区间（between）运算，示例如下：

1：“parser.parseExpression(”1>2“).getValue(boolean.class);”将返回false；

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

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

 

逻辑表达式：且（and）、或(or)、非(!或NOT)。 示例如下：

1：String expression1 = "2>1 and (!true or !false)";

boolean result1 = parser.parseExpression(expression1).getValue(boolean.class);

注意：逻辑运算符不支持 Java中的 && 和 ||

 

字符串连接及截取表达式

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

三目运算及Elivis运算表达式

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

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

 

正则表达式

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

 

括号优先级表达式

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

类类型表达式

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

1：访问java.lang包的类

Class result1 = parser.parseExpression("T(String)").getValue(Class.class);

2：访问其他包下的类 ：

String expression2 = "T(cn.javass.spring.chapter5.SpELTest)";

    Class result2 = parser.parseExpression(expression2).getValue(Class.class);

3：访问类的静态字段

int result3=parser.parseExpression("T(Integer).MAX_VALUE").getValue(int.class);

4：访问类的静态方法

int result4 = parser.parseExpression("T(Integer).parseInt('1')").getValue(int.class);

类实例化

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

1：String result1 = parser.parseExpression("new String('hello')").getValue(String.class);

2：Date result2 = parser.parseExpression("new java.util.Date()").getValue(Date.class);

 

instanceof表达式

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

 

变量定义及引用

1：变量通过EvaluationContext接口的setVariable(variableName, value)方法定义

2：在表达式中使用“#variableName”引用；

3：除了引用自定义变量，SpE还允许引用根对象及当前上下文对象，使用“#root”引用根对象，使用“#this”引用当前上下文对象；

示例如下：

java代码：

ExpressionParser parser = new SpelExpressionParser();
EvaluationContext context = new StandardEvaluationContext();
context.setVariable("variable", "hello1");
context.setVariable("variable", "hello2");
String result1 = parser.parseExpression("#variable").getValue(context, String.class);
System.out.println("r1=="+result1);
 
context = new StandardEvaluationContext(12);
String result2 = parser.parseExpression("#root-1").getValue(context, String.class);
System.out.println("r2=="+result2);
String result3 = parser.parseExpression("#this").getValue(context, String.class);
System.out.println("r3=="+result3);
 

输出结果：

r1==hello2

r2==11

r3==12

自定义函数

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

java代码：

ExpressionParser parser = new SpelExpressionParser();
StandardEvaluationContext context = new StandardEvaluationContext();
Method parseInt =
       Integer.class.getDeclaredMethod("parseInt", String.class);
context.registerFunction("regParseInt", parseInt);
context.setVariable("parseInt2", parseInt);
String expression1 = "#regParseInt('3') == #parseInt2('3')";
boolean result =
    parser.parseExpression(expression1).getValue(context, boolean.class);
System.out.println("result="+result);

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

赋值表达式

SpEL即允许给自定义变量赋值，也允许给跟对象赋值，直接使用“#variableName=value”即可赋值。示例如下：

java代码：

1：parser.parseExpression("#root=‘Hi'").getValue(context, String.class);
2：parser.parseExpression("#this=‘Hi'").getValue(context, String.class);
3：context.setVariable("#variable", "variable");
 

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

对象属性获取非常简单，使用如“a.property.property”这种点缀式获取，SpEL对于属性名首字母是不区分大小写的；

SpEL还引入了Groovy语言中的安全导航运算符“(对象|属性)?.属性”，用来避免当“?.”前边的表达式为null时抛出空指针异常，而是返回null；

修改属性值可以通过赋值表达式或Expression接口的setValue方法修改。

示例如下：

java代码：

UserModel um = new UserModel();
um.setUuid("User1");
um.setName("UserName1");
ExpressionParser parser = new SpelExpressionParser();
StandardEvaluationContext context = new StandardEvaluationContext();
context.setVariable("um",um);
//取值
Expression expression = parser.parseExpression("'uuid='+#um.uuid + ',name='+#um.name");
String v =  expression.getValue(context,String.class);
System.out.println("v=="+v);
//赋值
expression = parser.parseExpression("'uuid='+(#um.uuid='newUser') + ',name='+#um.name");
v =  expression.getValue(context,String.class);
System.out.println("v2=="+v);
输出结果：
v==uuid=User1,name=UserName1
v2==uuid=newUser,name=UserName1

对象方法调用

对象方法调用更简单，跟Java语法一样；如“‘Hello’.substring(1,3)”将返回“el”；而对于根对象可以直接调用方法。

Bean引用

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

java代码：

ApplicationContext ctx = new ClassPathXmlApplicationContext(
        new String[] {"applicationContext.xml"});
 
ExpressionParser parser = new SpelExpressionParser();
StandardEvaluationContext context = new StandardEvaluationContext();
context.setBeanResolver(new BeanFactoryResolver(ctx));
String result1 =
parser.parseExpression("@myBean.test()").getValue(context, String.class);

内联List

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

1：//将返回不可修改的空List

List result2 = parser.parseExpression("{}").getValue(List.class);

2：对于字面量列表也将返回不可修改的List

ExpressionParser parser =  new SpelExpressionParser();

List result1 = parser.parseExpression("{1,2,3}").getValue(List. class);

//result1.set(0, 2);//这句话会报错，因为list不可以修改

System.  out.println(result1);

3：//对于列表中只要有一个不是字面量表达式，将只返回原始List，

//不会进行不可修改处理，也就是可以修改

String expression3 = "{{1+2,2+4},{3,4+4}}";

List<list> result3 = parser.parseExpression(expression3).getValue(List.class);

result3.get(0).set(0, 1);

内联数组

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

1：//定义一维数组并初始化

int[] result1 = parser.parseExpression("new int[1]").getValue(int[].class);

2：//声明二维数组并初始化

int[] result2 = parser.parseExpression("new int[2]{1,2}").getValue(int[].class);

3：//定义多维数组但不初始化

int[][][] result3 = parser.parseExpression(expression3).getValue(int[][][].class);

4：//错误的定义多维数组，多维数组不能初始化

String expression4 = "new int[1][2][3]{{1}{2}{3}}";

int[][][] result4 = parser.parseExpression(expression4).getValue(int[][][].class);

访问元素

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

1：//SpEL内联List访问

int result1 = parser.parseExpression("{1,2,3}[0]").getValue(int.class);

//相当于result1.get(0)

 

2：//SpEL目前支持所有集合类型的访问

Collection collection = new HashSet();

collection.add(1);

collection.add(2);

EvaluationContext context2 = new StandardEvaluationContext();

context2.setVariable("collection", collection);

int result2 = parser.parseExpression("#collection[1]").getValue(context2, int.class);

3：//SpEL对Map字典元素访问的支持

Map map = new HashMap();

map.put("a", 1);

EvaluationContext context3 = new StandardEvaluationContext();

context3.setVariable("map", map);

int result3 = parser.parseExpression("#map['a']").getValue(context3, int.class);

 

元素修改

可以使用赋值表达式或Expression接口的setValue方法修改。示例如下：

1：//修改数组元素值

int[] array = new int[] {1, 2};

EvaluationContext context1 = new StandardEvaluationContext();

context1.setVariable("array", array);

int result1 = parser.parseExpression("#array[1] = 3").getValue(context1, int.class);

2：//修改集合值

Collection collection = new ArrayList();

collection.add(1);

collection.add(2);

EvaluationContext context2 = new StandardEvaluationContext();

context2.setVariable("collection", collection);

int result2 = parser.parseExpression("#collection[1] = 3").getValue(context2, int.class);

parser.parseExpression("#collection[1]").setValue(context2, 4);

result2 = parser.parseExpression("#collection[1]").getValue(context2, int.class);

3：//修改map元素值

Map map = new HashMap();

map.put("a", 1);

EvaluationContext context3 = new StandardEvaluationContext();

context3.setVariable("map", map);

int result3 = parser.parseExpression("#map['a'] = 2").getValue(context3, int.class);

集合投影

在SQL中投影指从表中选择出列，而在SpEL指从集合中的元素，通过选择来构造新的集合，该集合和原集合具有相同数量的元素，但可能属性不一样；SpEL使用“（list|map）.![投影表达式]”来进行投影运算。

1：示例集合的投影

//1.首先准备测试数据

Collection collection = new ArrayList();

UserModel um1 = new UserModel();

um1.setUuid("u1");

um1.setName("u1Name");

collection.add(um1);

UserModel um2 = new UserModel();

um2.setUuid("u2");

um2.setName("u2Name");

collection.add(um2);

//2.测试集合或数组

EvaluationContext context1 = new StandardEvaluationContext();

ExpressionParser parser = new SpelExpressionParser();

context1.setVariable("collection", collection);

Collection result1 =

parser.parseExpression("  #collection.![#this.name]").getValue(context1, Collection.class);

SpEL投影运算还支持Map投影，但Map投影最终只能得到List结果，对于投影表达式中的“#this”将是Map.Entry，所以可以使用“value”来获取值，使用“key”来获取键。 示例如下：

//1.首先准备测试数据

java代码：

UserModel um1 = new UserModel();
um1.setUuid("u1");
um1.setName("u1Name");
UserModel um2 = new UserModel();
um2.setUuid("u2");
um2.setName("u2Name");
Map<string usermodel="" style="word-wrap: break-word;"> map = new HashMap<string usermodel="" style="word-wrap: break-word;">();
map.put(um1.getUuid(),um1);   
map.put(um2.getUuid(),um2);
//2.测试Map投影
EvaluationContext context1 = new StandardEvaluationContext();
ExpressionParser parser = new SpelExpressionParser();
context1.setVariable("map", map);
Collection<string style="word-wrap: break-word;"> result1 =
parser.parseExpression("#map.![#this.value.name]").getValue(context1, Collection.class);</string></string></string>

集合筛选

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

//1：准备测试数据的过程跟上一个示例一样，就不重复了

//2.测试集合或数组的筛选

java代码：

EvaluationContext context1 = new StandardEvaluationContext();
ExpressionParser parser = new SpelExpressionParser();
context1.setVariable("collection", collection);
Collection<string style="word-wrap: break-word;"> result1 =
parser.parseExpression("#collection.?[#this.uuid.equals('u1')]").getValue(context1, Collection.class);
 </string>

//测试Map筛选

java代码：

EvaluationContext context1 = new StandardEvaluationContext();
ExpressionParser parser = new SpelExpressionParser();
context1.setVariable("map", map);
Map<string usermodel="" style="word-wrap: break-word;"> result1 =
parser.parseExpression("#map.?[#this.key=='u1']").getValue(context1, Map.class);</string>

nXml风格的配置

SpEL支持在Bean定义时使用，默认使用“#{SpEL表达式}”表示，不允许嵌套。其中“#root”根对象默认可以认为是ApplicationContext，获取根对象属性其实是获取容器中的Bean。

nXml风格的配置示例----通过SpEL表达式设置值

java代码：

<bean id="numberGuess" class="org.spring.samples.NumberGuess" style="word-wrap: break-word;">
<property name="randomNumber" value="#{ T(java.lang.Math).random() * 100.0 }" style="word-wrap: break-word;">
</property></bean>

Xml风格的配置示例----通过SpEL表达式参照其他的Bean

java代码：

<bean id="t1" class="cn.javass.spring3.hello.T2" style="word-wrap: break-word;">
    <property name="value" value="#{ T(java.lang.Math).random() * 100.0 }" style="word-wrap: break-word;">
</property></bean>
<bean id="t2" class="cn.javass.spring3.hello.T2" style="word-wrap: break-word;">
    <property name="value" value="#{ T(Double).parseDouble(t1.value) -1 }" style="word-wrap: break-word;"></property>
</bean>

上面的t1就会被解析成为参照t1这个Bean，当然也可以使用@t1来表示。

注解风格的配置

使用@Value注解来指定SpEL表达式，该注解可以放到字段、方法及方法参数上。 但是要在配置文件中使用 来开启对注解的支持。示例如下：

java代码：

public class SpELBean {
    @Value("#{ T(java.lang.Math).random() * 100.0 }")
    private String value;
    //setter和getter由于篇幅省略，自己写上
}

注意：如果同时使用了@Value和setter注入，那么setter注入将覆盖@Value的值。