OGNL
是
Object-Graph Navigation Language
的缩写,它是一种功能强大的表达式语言(
Expression Language
,简称为
EL
),通过它简单一致的表达式语法,可以存取对象的任意属性,调用对象的方法,遍历整个对象的结构图,实现字段类型转化等功能。它使用相同的表达式去存取对象的属性。
XWork
遵循“不要重复地发明同一个轮子”的理论,它的表达式语言核心用的就是这个
OGNL
。我们先来看看一个简单的例子:
还记得我们用户注册的那个例子吗?我们输入框的
name
用到的名字就是
OGNL
的表达式,比如:用户名的输入框:“
<input type="text" name="user.username">
”,在用户注册成功之后我们要显示用户注册的信息,用了“
<ww:property value="user.username"/>
”。
Input
输入框里的“
user.username
”,它解析成
Java
语句为:
getUser().setUsername();
,
property
标签里的“
user.username
”解析为
Java
语句:
getUser.getUsername();
。
我们的两个表达式都是相同的,但前一个保存对象属性的值,后一个是取得对象属性的值。表达式语言简单、易懂却又功能强大,关于
OGNL
更多的介绍可以去
http://www.ognl.org
,那里有很详细的文档
OGNL
在框架中的应用,最主要是支持我们的值堆栈(
Value Stack
)——
OgnlValueStack
,它主要的功能是通过表达式语言来存取对象的属性。用户界面输入数据,它会根据保存表达式将数据依次保存到它堆栈的对象中,业务操作完成,结果数据会通过表达式被获取、输出。
还记得我们用户注册的例子吗?下面我们用一段程序来演示它向
OgnlValueStack
中保存、取得数据的步骤:
//
DemoRegisterValueStack
package
example.register;
import
com.opensymphony.xwork.util.OgnlValueStack;
public
class DemoRegisterValueStack {
public void demo(){
RegisterAction action = new RegisterAction();
OgnlValueStack valueStack= new OgnlValueStack();
valueStack.push(action);
valueStack.setValue("user.username","Babydavic");
System.out.println("username = "+valueStack.findValue("user.username"));
}
public static void main(String[] args) {
DemoRegisterValueStack demoValueStack = new DemoRegisterValueStack();
demoValueStack.demo();
}
}
我们来看一看它的
demo()
方法:
1、
创建我们的
Action
(
RegisterAction
)类的对象
action
,将
action
对象压入堆栈
valueStack
中。在
WebWrok
中
Action
的创建、入栈
是在
DefaultActionInvocation
构造函数中进行的,详细介绍见:
ServletDispatcher
原理。
2、
通过表达式语言,调用堆栈对象的
get()
、
set()
方法,设置该对象的值。
public void setValue(String expr, Object value)
语句:
valueStack.setValue("user.username","Babydavic");
的作用等同于:
action.getUser().setUsername("Babydavic");
3、
通过表达式语言,去堆栈对象中查找我们前面保存的值,并在控制台打印。
valueStack.findValue("user.username")
等同与语句
:
action.getUser().getUsername()
最后控制台打印的结果:
username = Babydavic
CompoundRoot
在
OgnlValueStack
中,一个堆栈其实是一个
List
。查看
OgnlValueStack
你会发现,堆栈就是
com.opensymphony.xwork.util.CompoundRoot
类的对象:
public
class CompoundRoot extends ArrayList {
//~ Constructors /////////////////////////////////////
public CompoundRoot() {
}
public CompoundRoot(List list) {
super(list);
}
//~ Methods ////////////////////////////////////////////
public CompoundRoot cutStack(int index) {
return new CompoundRoot(subList(index, size()));
}
public Object peek() {
return get(0);
}
public Object pop() {
return remove(0);
}
public void push(Object o) {
add(0, o);
}
}
我们通过表达式向堆栈对象操作时,我们并不知道堆栈中有哪些对象。
OgnlValueStack
会根据堆栈由上向下的顺序(先入栈在下面,最后入栈在最上面)依次去查找与表达式匹配的对象方法,找到即进行相应的存取操作。假设后面对象也有相同的方法,将不会被调用。
下面我们看一个对
OgnlValueStack
操作的程序,它主要演示了如何对
Map
对象的存取和
OgnlValueStack
堆栈的原理
package
example.register;
import
com.opensymphony.xwork.util.OgnlValueStack;
public
class DemoGroupValueStack {
public void demoAction(){
DemoGroupAction action = new DemoGroupAction();
OgnlValueStack valueStack= new OgnlValueStack();
valueStack.push(action);
User zhao = new User();
zhao.setUsername("zhao");
User qian = new User();
qian.setUsername("qian");
valueStack.setValue("users['zhao']",zhao);
valueStack.setValue("users['qian']",qian);
System.out.println("users['zhao'] = "+valueStack.findValue("users['zhao']"));
System.out.println("users['qian'] = "+valueStack.findValue("users['qian']"));
System.out.println("users size = "+valueStack.findValue("users.size"));
System.out.println("allUserName[0] = "+valueStack.findValue("allUserName[0]"));
}
public void demoModels(){
User model_a = new User();
model_a.setUsername("model_a");
User model_b = new User();
model_b.setUsername("model_b");
User model_c = new User();
model_c.setUsername("model_c");
OgnlValueStack valueStack= new OgnlValueStack();
valueStack.push(model_a);
valueStack.push(model_b);
valueStack.push(model_c);
System.out.println("username = "+valueStack.findValue("username"));
System.out.println("[1].username = "+valueStack.findValue("[1].username"));
System.out.println("[0].toString = "+valueStack.findValue("[0]"));
System.out.println("[1].toString = "+valueStack.findValue("[1]"));
System.out.println("[2].toString = "+valueStack.findValue("[2]"));
}
public static void main(String[] args) {
DemoGroupValueStack demoValueStack = new DemoGroupValueStack();
demoValueStack.demoAction();
demoValueStack.demoModels();
}
}
package
example.register;
import
java.util.ArrayList;
import
java.util.HashMap;
import
java.util.List;
import
java.util.Map;
public
class DemoGroupAction {
private Map users = new HashMap();
public Map getUsers(){
return this.users;
}
public List getAllUserName(){
return new ArrayList(users.keySet());
}
public String execute(){
//
执行业务操作
return null;
}
public String toString(){
return users.toString();
}
}
注意:
1
、
Map
属性的存取,它的表达式语言如:
users['zhao']
,注意它用
’’
来引用
HashMap
的
key
字符串。
2
、
demoModels
()
方法演示了
OgnlValueStack
中堆栈的原理,请特别注意它的
[0].toString
、
[1].toString
、
[2].toString
,它们依次调用堆栈中对象的
toString()
方法,并逐一的减少堆栈最上面的对象。
控制台输出的结果如下:
users size = 2
allUserName[0] = qian
username = model_c
[1].username = model_b
[0].toString = [username=model_c;password=null;email=null;age=0, username=model_b;password=null;email=null;age=0, username=model_a;password=null;email=null;age=0]
[1].toString = [username=model_b;password=null;email=null;age=0, username=model_a;password=null;email=null;age=0]
[2].toString = [username=model_a;password=null;email=null;age=0]