Struts OGNL and ValueStack

ValueStack基础：OGNL(Object Graphic Navigatino Language) 

OGNL是Struts2中使用的一种表达式语言。 
它可以用于，在JSP页面，使用标签方便的访问各种对象的属性； 
它可以用于，在Action中获取传递过来的页面中的参数（并进行类型转换）； 
它还可以用在struts2的配置文件中！ 
所以，非常有必要理解OGNL的基本机制。 

Root对象 

OGNL称为对象图导航语言。 
所谓对象图，即以任意一个对象为根，通过OGNL可以访问与这个对象关联的其它对象。 
OGNL不支持多个root对象。 

如： 

Code:

1. package cn.com.leadfar.struts2.actions;  
2. public class User {  
3.   
4.     private String username;  
5.     private Group group;  
6.   
7.     public String getUsername() {  
8.        return username;  
9.     }  
10.     public void setUsername(String username) {  
11.        this.username = username;  
12.     }  
13.     public Group getGroup() {  
14.        return group;  
15.     }  
16.     public void setGroup(Group group) {  
17.        this.group = group;  
18.     }  
19.   
20. }  

Code:

1. package cn.com.leadfar.struts2.actions;  
2. public class Group {  
3.   
4.     private String name;  
5.     private Organization org;  
6.   
7.     public String getName() {  
8.        return name;  
9.     }  
10.     public void setName(String name) {  
11.        this.name = name;  
12.     }  
13.     public Organization getOrg() {  
14.        return org;  
15.     }  
16.     public void setOrg(Organization org) {  
17.        this.org = org;  
18.     }  
19. }  

Code:

1.    
2. package cn.com.leadfar.struts2.actions;  
3. public class Organization {  
4.   
5.     private String orgId;   
6.   
7.     public String getOrgId() {  
8.        return orgId;  
9.     }  
10.     public void setOrgId(String orgId) {  
11.        this.orgId = orgId;  
12.     }  
13. }  

上面三个类，描述了通过一个User对象，可以导航到Group对象， 
进而导航到Organization对象。 
以User对象为根，一个对象图如下所示： 

Code:

1. User(root)  
2.   
3.    -- username  
4.    -- group  
5.       -- name  
6.       -- org  
7.          -- orgId  

在真实的环境下，这个对象图可能会极其复杂，但是通过基本的getters方法，都应该能够访问到某个对象的其它关联对象。 
【对象图的导航，必须通过getters方法进行导航】 
下述代码将创建一个User对象，及其相关的一系列对象： 

Code:

1. User user = new User();  
2. Group g = new Group();  
3. Organization o = new Organization();  
4.   
5. o.setOrgId("ORGID");  
6. g.setOrg(o);  
7. user.setGroup(g);  

如果通过JAVA代码来进行导航（依赖于getters方法），导航到Organization的orgId属性，如下所示： 

Java代码  

1. //用JAVA来导航访问  
2. user.getGroup().getOrg().getOrgId();  

【注意：导航的目的，是为了获取某个对象的值或设置某个对象的值或调用某个对象的方法！】 
【注意：OGNL表达式语言的真正目的，是为了在那些不能写JAVA代码的地方执行JAVA代码，或者是为了更方便地执行JAVA代码】 
利用OGNL进行导航的代码如下： 

Java代码  

1. //利用OGNL表达式访问  
2. String value = (String)Ognl.getValue("group.org.orgId", user);   

Ognl.getValue()方法的第一个参数，就是一条OGNL表达式，第二个参数是指定在表达式中需要用到的root对象！ 

ValueStack  

Struts2是通过ValueStack来进行赋值与取值的。 
ValueStack实际上就是对OGNL的封装，OGNL主要的功能就是赋值与取值。 
ValueStack中的数据，分两个部分存放：root和context 
同时ValueStack暴露相关的接口(赋值和取值)： 
void setValue(String expr, Object value); 
Object findValue(String expr); 
通过OGNL表达式对ValueStack中的数据进行操作。 

root  

ValueStack中的root对象是CompoundRoot。 
CompoundRoot继承了ArraryList，提供了额外的方法：push()和pop()方法， 
用来对root对象中所包含的数据进行存取。 
正是通过这两个方法，CompoundRoot变成了一个栈结构. 
压栈操作，将导致对象被放到CompoundRoot的第0个元素上（第0个元素是栈顶），其它对象被依次往后移动； 
出栈操作，将导致CompoundRoot的第0个元素被移除（即栈顶元素被弹出），其它对象被依次往前移动 

OGNL只能访问被压入堆栈（CompoundRoot）中的元素。 
在Struts2中，一个请求在最终到达Action的方法之前，Action对象本身会被压入 
ValueStack的CompoundRoot对象中。 
所以Action对象是CompoundRoot对象中的一个元素，可以使用OGNL表达式直接访问。 

在jSP页面中，使用<s:property value=”ognl表达式”/>标签，将CompoundRoot栈中的值取出。 
在<s:property>标签中的OGNL表达式，最终会交给ValueStack来解释。 
比如："username"就是一个OGNL表达式，意思是调用root对象的getUsername()方法。 


Context  

由于在OGNL中，不支持多个root对象，但在struts2的OGNL的表达式中， 
有可能需要访问到多个毫不相干的对象。这时候，我们把表达式中需要用到的对象放到Map中， 
传递给OGNL，进行访问。这个Map对象，称为context。 

可见valueStack对OGNL进行了扩展，使OGNL表达式可以访问到多个root对象。 

要在表达式中访问到context中的对象，需要使用“#对象名称”的语法规则。 
#表示将context对象的元素放入到CompoundRoot对象的栈顶。访问完后， 
context对象的元素会从栈顶移出，自动释放。 

当CompoundRoot栈中存在多个不相干的root对象时，使用 #root[n]. 进行访问， 
n是root对象当前在栈中的顺序。从0开始。 

请看下面的例子： 

Java代码  

1. public class UserAction extends ActionSupport{  
2.   
3.     private String username;  
4.   
5.     public String execute(){  
6.   
7.        username = "IDOL";        
8.   
9.        List list = new ArrayList();  
10.        for(int i=0; i<10; i++){  
11.            User user = new User();  
12.            user.setUsername("User"+i);  
13.            list.add(user);  
14.        }  
15.   
16.        ActionContext.getContext().put("users", list);        
17.   
18.        User u = new User();  
19.        u.setUsername("ADMIN");  
20.        ActionContext.getContext().getValueStack().push(u);        
21.   
22.        return SUCCESS;  
23.     }  
24.    

JSP Code:

1. 行1:  <s:property value="username"/> <br/>  
2. 行2:  <s:iterator value="#users">  
3. 行3:     <s:property value="username"/>  
4. 行4:     <s:property value="#root[2].username"/><br/>  
5. 行5:  </s:iterator>  
6. 行6:  <s:property value="username"/>  
7. 行7:  <s:property value="#root[1].username"/>

根据刚才的示例，我们知道，第1行的username是“ADMIN”（因为JSP在执行这行代码的时候，CompoundRoot中有两个元素：第0个是“user对象ADMIN”，第1个是“userAction对象IDOL”），因此第1行的username将取出CompoundRoot中第0个元素的username属性：ADMIN

第2行代码是iterator标签，只定义了一个value属性，iterator标签将循环访问users这个List中的User对象，并把当前循环的user对象压入到CompoundRoot中！所以，在第3行和第4行代码被执行的时候，CompoundRoot中总共有3个元素：第0个元素是被iterator标签压入的当前循环的user对象；第1个元素是“user对象ADMIN”；第2个元素是“userAction对象IDOL”，因此第3行代码的执行结果就是输出“UserX”，即当前循环的user对象的username属性！iterator标签将会依次取出List中的user对象，并不断压入/弹出user对象（每次循环，都将执行一遍压入/弹出）。而第4行代码取第2个元素的username属性，即userAction对象的username属性：IDOL。 

第5行代码执行完成之后，在CompoundRoot中将剩下2个元素，与第2行代码被执行之前一样。所以，第6行代码的输出和第1行代码的输出结果是一样的，而第7行代码将取出userAction对象的username属性：Admin

------------------------------------------------------------------------------------------------------------------------------------------------------------

可以在jsp页面使用<s:debug />标签 查看valuestack的内容

原文出处：struts2中的ValueStack学习