爲什麼使用OGNL
相對於其它的表達式語言,OGNL的功能更爲強大,它提供了很多高級而必需的特性,例如強大的類型轉換功能、靜態或實例方法的執行、跨集合投影,以及動態lambda表達式定義等。
OGNL基礎
OGNL表達式的計算都是圍繞OGNL上下文來進行的,OGNL上下文實際上就是一個Map對象,由ognl.OgnlContext類(實現了java.util.Map接口)來表示。OGNL上下文可以包含一個或多個JavaBean對象,在這些對象中有一個是特殊的,這個對象就是上下文的根(root)對象。如果在寫表達式的時候,沒有指定使用上下文中的哪一個對象,那麼根對象將被假定爲表達式所依據的對象。
下面我們給出一個例子程序,看看在OGNL中如何根據上下文來計算表達式的值。
Employee.java文件
package com.oyl.example;
public class Employee{
private String name;
public String getName(){
return name;
}
public void setName(String name){
this.name=name;
}
}
Manager.java文件
package com.oyl.example;
public class Manager{
private String name;
public String getName(){
return name;
}
public void setName(String name){
this.name=name;
}
}
OgnlExpression.java
package com.oyl.example;
import ognl.Ognl;
import ognl.OgnlContext;
import ognl.OgnlException;
public class OgnlExpression{
private Object expression;
public OgnlExpression(String expressionString) throws OgnlException{
expression=Ognl.parseExpression(expressionString);
}
public Object getExpression(){
return expression;
}
public Object getValue(OgnlContext context, Object rootObject)throws OgnlException{
return Ognl.getValue(getExpression(), context, rootObject);
}
public void setValue(OgnlContext context, Object rootObject, Object value) throws OgnlException{
Ognl.setValue(getExpression(), context,rootObject, value);
}
public static void main(String[] args){
Employee employee=new Employee();
employee.setName("employee");
Manager manager=new Manager();
manager.setName("manager");
//創建OGNL上下文
OgnlContext context=new OgnlContext();
//將employee對象和manager對象放到OGNL上下文中
context.put("employee",employee);
context.put("manager",manager);
//將employee對象設置爲OGNL上下文的根
context.setRoot(employee);
//表達式name,將執行employee.getName(),因爲employee對象是根對象
OgnlExpression exp=new OgnlExpression("name");
System.out.println(exp.getValue(context, context.getRoot()));
//表達式#employee.name,將執行employee.getName()
exp=new OgnlExpression("#employee.name");
System.out.println(exp.getValue(context, context.getRoot()));
//表達式#manager.name,將執行manager.getName()
//如果你訪問的不是OGNL上下文中的根對象,那麼必須在前面加上一個名稱空問,例如#manager
exp=new OgnlExpression("#manager.name");
System.out.println(exp.getValue(context, context.getRoot()));
}
}
在OGNL上下文中,只能有一個根對象,如果你訪問根對象,那麼在寫表達式的時候,直接寫對象的屬性就可以了;否則,你需要使用“#key”前綴,例如表達式#namager.name。
OGNL表達式
OGNL表達式的基礎單元就是導航鏈,通常簡稱爲鏈(chain)。最簡單的鏈由下列部分組成:
1、屬性名:如name和manager.name;
2、方法調用:如manager.hashCode(),返回manager對象的散列碼;
3、數組索引:如emals[0],返回當前對象的郵件列表中的第一個郵件地址。
所有OGNL表達式的計算都是在當前對象的上下文中,一個鏈簡單地使用鏈中先前鏈接的結果作爲下一步計算的當前對象。我們看如下所示的鏈:
name.toCharArray()[0].numericValue.toString()
這個表達式按照下列的步驟進行計算:
1、獲取根對象的name屬性;
2、在String結果上調用toCharArray()方法;
3、從char數組中提取第一個字符;
4、從提取的字符對象上行到numericValue屬性(這個字符被表示爲Character對象,Character類有一個getNumericValue()方法);
5、在Integer對象結果上調用toString()方法。
這個表達式最終結果是最後返回的toString()方法調用返回的字符串。
常量
OGNL支持的所有常量類型:
1、字符串常量:
以單引號或雙引號括起來的字符串。如"hello",'hello'。
不過要注意的是,如果是單個字符的字符串常量,必須使用雙引號。
2、字符常量:
以單引號括起來的字符。如'a'。
3、數值常量:
除了Java中的int、long、float和double外,OGNL還讓你使用“b”或“B”後綴指定BigDecimal常量,用“h”“H”後綴指定BigInteger常量。
4、布爾常量:
true和false。
5、null常量。
操作符
OGNL除了支持所有的Java操作符外,還支持以下幾種:
1、逗號,
與C語言中的逗號操作符類似。
2、花括號{}
用於創建列表,元素之間用逗號分隔。
3、in和not in
用於判斷一個值是否在集合中。
訪問JavaBean的屬性
假如有一個employee對象作爲OGNL上下文的根對象,那對於下面的表達式:
1、name
對應的java代碼是employee.getName();
2、address.country
對應的java代碼是employee.getAddress().getCountry();
訪問靜態方法和靜態字段
@class@method(args) //調用靜態方法
@class@field //調用靜態字段
其中class必須給出完整的類名(包括包名),如果省略class,那麼默認使用的類是java.util.Math,如:
@@min(5,3)
@@max(5,3)
@@PI
索引訪問
OGNL支持多種索引方式的訪問。
1、數組和列表索引
在OGNL中,數組和列表可以大致看成是一樣的。
如:array[0]、list[0]。表達式:{'zhangsan','lisi','wangwu'}[1]等。
2、JavaBean的索引屬性
要使用索引屬性,需要提供兩對setter和getter方法,一對用於數組,一對用於數組中的元素。
如:有一個索引屬性interest,它的getter和setter如下
public String[] interest;
public String[] getInterest(){ return interest;}
public void setInterest(String[] interest){ this.interest=interest;}
public String getInterest(int i){ return interest[i]}
public void setInterest(int i, String newInterest){ interest[i]=newInterest;}
對於表達式interest[2],OGNL可以正確解釋這個表達式,調用getInterest(2)方法。如果是設置的情況下,會調用setInterest(2,value)方法。
3、OGNL對象的索引屬性
JavaBean的索引屬性只能使用整型作爲索引,OGNL擴展了索引屬性的概念,可以使用任意的對象來作爲索引。
對集合進行操作
1、創建集合:
創建列表
使用花括號將元素包含起來,元素之間使用逗號分隔。如{'zhangsan','lisi','wangwu'}
創建數組
OGNL中創建數組與Java語言中創建數組類似。
創建Map
Map使用特殊的語法來創建 #{"key":value, ......}
如果想指定創建的Map類型,可以在左花括號前指定Map實現類的類名。如:
#@java.util.LinkedHashMap@{"key":"value",....}
Map通過key來訪問,如map["key"]或map.key。
2、投影
OGNL提供了一種簡單的方式在一個集合中對每一個元素聞調用相同的方法,或者抽取相同的屬性,並將結果保存爲一個新的集合,稱之爲投影。
假如employees是一個包含了employee對象的列表,那麼
#employees.{name}將返回所有僱員的名字的列表。
在投影期間,使用#this變量來引用迭代中的當前元素。
如:objects.{#this instanceof String? #this: #this.toString()}
3、選擇
OGNL提供了一種簡單的方式來使用表達式從集合中選擇某些元素,並將結果保存到新的集合中,稱爲選擇。
如#employees.{?#this.salary>3000}
將返回薪水大於3000的所有僱員的列表。
#employees.{^#this.salary>3000}
將返回第一個薪水大於3000的僱員的列表。
#employees.{$#this.salary>3000}
將返回最後一個薪水大於3000的僱員的列表。
lambda表達式
lambda表達式的語法是: :[...]。OGNL中的lambda表達式只能使用一個參數,這個參數通過#this引用。
如:
#fact= :[ #this<=1 ? 1 : #this* #fact ( #this-1) ], #fact(30)
#fib= :[#this==0 ? 0 : #this==1 ? 1 : #fib(#this-2)+#fib(#this-1)], #fib(11)
Struts2在OGNL基礎上的增強
1、值棧(ValueStack)
Struts2將OGNL上下文設置爲Struts2中的ActionContext(內部使用的仍然是OgnlContext),並將值棧設爲OGNL的根對象。
我們知道,OGNL上下文中的根對象可以直接訪問,不需要使用任何特殊的“標記”,而引用上下文中的其他對象則需要使用“#”來標記。由於值棧是上下文中的根對象,因此可以直接訪問。那麼對於值棧中的對象該如何訪問呢?Struts2提供了一個特殊的OGNLPropertyAccessor,它可以自動查找棧內的所有對象(從棧頂到棧底),直接找到一個具有你所查找的屬性的對象。也就是說,對於值棧中的任何對象都可以直接訪問,而不需要使用“#”。
假設值棧中有兩個對象:student和employee,兩個對象都有name屬性,student有學號屬性number,而employee有薪水屬性salary。employee先入棧,student後入棧,位於棧頂,那麼對於表達式name,訪問的就是student的name屬性,因爲student對象位於棧頂;表達式salary,訪問的就是employee的salary屬性。正如你所見,訪問值棧中的對象屬性或方法,無須指明對象,也不用“#”,就好像值棧中的對象都是OGNL上下文中的根對象一樣。這就是Struts2在OGNL基礎上做出的改進。
2、[N]語法
如上所述,如果想要訪問employee的name屬性,應該如何寫表達式呢?我們可以使用[N].xxx(N是從0開始的整數)這樣的語法來指定從哪一個位置開始向下查找對象的屬性,表達式[1].name訪問的就是employee對象的name屬性。
在使用[N].xxx語法時,要注意位置序號的含義,它並不是表示“獲取棧中索引爲N的對象”,而是截取從位置N開始的部分棧。
3、top關鍵字
top用於獲取棧頂的對象,結合[N].xxx語法,我們就可以獲取棧中任意位置的對象。
如:[0].top,[1].top等
4、訪問靜態成員
除了使用標準的OGNL表達式訪問靜態字段和靜態方法外,Struts2還允許你不指定完整的類名,而是通過“vs”前綴來調用保存在棧中的靜態字段和靜態方法。
@vs@FOO_PROPERTY
@vs@someMethod()
@vs1@someMethod()
vs表示ValueStack,如果只有vs,那麼將使用棧頂對象的類;如果在vs後面跟上一個數字,那麼將使用棧中指定位置處的對象類。
5、值棧中的Action實例
Struts2框架總是把Action實例放在棧頂。因爲Action在值棧中,而值棧又是OGNL中的根,所以引用Action的屬性可以省略“#”標記,這也是爲什麼我們在結果頁面中可以直接訪問Action的屬性的原因。
6、Struts2中的命名對象
Struts2還提供了一些命名對象,這些對象沒有保存在值棧中,而是保存在ActionContext中,因此訪問這些對象需要使用“#”標記。這些命名對象都是Map類型。
parameters
用於訪問請求參數。如:#parameters['id']或#parameters.id,相當於調用了HttpServletRequest對象的getParameter()方法。
注意,parameters本質上是一個使用HttpServletRequest對象中的請求參數構造的Map對象,一量對象被創建(在調用Action實例之前就已經創建好了),它和HttpServletRequest對象就沒有了任何關係。
request
用於訪問請求屬性。如:#request['user']或#request.user,相當於調用了HttpServletRequest對象的getAttribute()方法。
session
用於訪問session屬性。如:#session['user']或#session.user,相當於調用了HttpSession對象的getAttribute()方法。
application
用於訪問application屬性。如:#application['user']或#application.user,相當於調用了ServletContext的getAttribute()方法。
attr
如果PageContext可用,則訪問PageContext,否則依次搜索request、session和application對象。