OGNL的学习指南

为了解决数据从View层传递到Controller层时的不匹配性，Struts2采纳了XWork的OGNL方案。并且在OGNL的基础上，构建了OGNLValueStack的机制，从而比较完美的解决了数据流转中的不匹配性。 

OGNL（Object Graph Navigation Language），是一种表达式语言。使用这种表达式语言，你可以通过某种表达式语法，存取Java对象树中的任意属性、调用Java对象树的方法、同时能够自动实现必要的类型转化。如果我们把表达式看做是一个带有语义的字符串，那么OGNL无疑成为了这个语义字符串与Java对象之间沟通的桥梁。 

如何使用OGNL 

让我们先研究一下OGNL的API，他来自于Ognl的静态方法：

Java代码 

1.   
2. /**  
3.  * Evaluates the given OGNL expression tree to extract a value from the given root  
4.  * object. The default context is set for the given context and root via  
5.  * <CODE>addDefaultContext()</CODE>.  
6.  *  
7.  * @param tree the OGNL expression tree to evaluate, as returned by parseExpression()  
8.  * @param context the naming context for the evaluation  
9.  * @param root the root object for the OGNL expression  
10.  * @return the result of evaluating the expression  
11.  * @throws MethodFailedException if the expression called a method which failed  
12.  * @throws NoSuchPropertyException if the expression referred to a nonexistent property  
13.  * @throws InappropriateExpressionException if the expression can't be used in this context  
14.  * @throws OgnlException if there is a pathological environmental problem  
15.  */  
16. public static Object getValue( Object tree, Map context, Object root ) throws OgnlException;   
17.   
18. /**  
19.  * Evaluates the given OGNL expression tree to insert a value into the object graph  
20.  * rooted at the given root object.  The default context is set for the given  
21.  * context and root via <CODE>addDefaultContext()</CODE>.  
22.  *  
23.  * @param tree the OGNL expression tree to evaluate, as returned by parseExpression()  
24.  * @param context the naming context for the evaluation  
25.  * @param root the root object for the OGNL expression  
26.  * @param value the value to insert into the object graph  
27.  * @throws MethodFailedException if the expression called a method which failed  
28.  * @throws NoSuchPropertyException if the expression referred to a nonexistent property  
29.  * @throws InappropriateExpressionException if the expression can't be used in this context  
30.  * @throws OgnlException if there is a pathological environmental problem  
31.  */  
32. public static void setValue( Object tree, Map context, Object root, Object value ) throws OgnlException  

Java代码 

1. /** 
2.  * Evaluates the given OGNL expression tree to extract a value from the given root 
3.  * object. The default context is set for the given context and root via 
4.  * <CODE>addDefaultContext()</CODE>. 
5.  * 
6.  * @param tree the OGNL expression tree to evaluate, as returned by parseExpression() 
7.  * @param context the naming context for the evaluation 
8.  * @param root the root object for the OGNL expression 
9.  * @return the result of evaluating the expression 
10.  * @throws MethodFailedException if the expression called a method which failed 
11.  * @throws NoSuchPropertyException if the expression referred to a nonexistent property 
12.  * @throws InappropriateExpressionException if the expression can't be used in this context 
13.  * @throws OgnlException if there is a pathological environmental problem 
14.  */  
15. public static Object getValue( Object tree, Map context, Object root ) throws OgnlException;  
16.   
17. /** 
18.  * Evaluates the given OGNL expression tree to insert a value into the object graph 
19.  * rooted at the given root object.  The default context is set for the given 
20.  * context and root via <CODE>addDefaultContext()</CODE>. 
21.  * 
22.  * @param tree the OGNL expression tree to evaluate, as returned by parseExpression() 
23.  * @param context the naming context for the evaluation 
24.  * @param root the root object for the OGNL expression 
25.  * @param value the value to insert into the object graph 
26.  * @throws MethodFailedException if the expression called a method which failed 
27.  * @throws NoSuchPropertyException if the expression referred to a nonexistent property 
28.  * @throws InappropriateExpressionException if the expression can't be used in this context 
29.  * @throws OgnlException if there is a pathological environmental problem 
30.  */  
31. public static void setValue( Object tree, Map context, Object root, Object value ) throws OgnlException  

我们可以看到，OGNL的API其实相当简单，你可以通过传递三个参数来实现OGNL的一切操作。而这三个参数，被我称为OGNL的三要素。 

那么运用这个API，我们能干点什么呢？跑个测试看看结果：

Java代码 

1.   
2. /**  
3.  * @author Downpour  
4.  */  
5. public class User {   
6.        
7.     private Integer id;   
8.        
9.     private String name;   
10.        
11.     private Department department = new Department();   
12.        
13.     public User() {   
14.            
15.     }   
16.            
17.         // setter and getters   
18. }   
19.   
20. //=========================================================================   
21.   
22. /**  
23.  * @author Downpour  
24.  */  
25. public class Department {   
26.        
27.     private Integer id;   
28.        
29.     private String name;   
30.        
31.     public Department() {   
32.            
33.     }   
34.            
35.         // setter and getters   
36. }   
37.   
38. //=========================================================================   
39.   
40. /**  
41.  * @author Downpour  
42.  */  
43. public class OGNLTestCase extends TestCase {   
44.        
45.     /**  
46.      *   
47.      * @throws Exception  
48.      */  
49.     @SuppressWarnings("unchecked")   
50.     @Test  
51.     public void testGetValue() throws Exception {   
52.            
53.         // Create root object   
54.         User user = new User();   
55.         user.setId(1);   
56.         user.setName("downpour");   
57.   
58.         // Create context   
59.         Map context = new HashMap();   
60.         context.put("introduction","My name is ");   
61.            
62.         // Test to directly get value from root object, with no context   
63.         Object name = Ognl.getValue(Ognl.parseExpression("name"), user);   
64.         assertEquals("downpour",name);   
65.            
66.         // Test to get value(parameter) from context   
67.         Object contextValue = Ognl.getValue(Ognl.parseExpression("#introduction"), context, user);   
68.         assertEquals("My name is ", contextValue);   
69.            
70.         // Test to get value and parameter from root object and context   
71.         Object hello = Ognl.getValue(Ognl.parseExpression("#introduction + name"), context, user);   
72.         assertEquals("My name is downpour",hello);   
73.                        
74.     }   
75.   
76.     /**  
77.      *   
78.      * @throws Exception  
79.      */  
80.     @SuppressWarnings("unchecked")   
81.     @Test  
82.     public void testSetValue() throws Exception {   
83.            
84.         // Create root object   
85.         User user = new User();   
86.         user.setId(1);   
87.         user.setName("downpour");   
88.            
89.                 // Set value according to the expression   
90.         Ognl.setValue("department.name", user, "dev");   
91.         assertEquals("dev", user.getDepartment().getName());   
92.            
93.     }   
94.        
95.   
96. }  

Java代码 

1. /** 
2.  * @author Downpour 
3.  */  
4. public class User {  
5.       
6.     private Integer id;  
7.       
8.     private String name;  
9.       
10.     private Department department = new Department();  
11.       
12.     public User() {  
13.           
14.     }  
15.           
16.         // setter and getters  
17. }  
18.   
19. //=========================================================================  
20.   
21. /** 
22.  * @author Downpour 
23.  */  
24. public class Department {  
25.       
26.     private Integer id;  
27.       
28.     private String name;  
29.       
30.     public Department() {  
31.           
32.     }  
33.           
34.         // setter and getters  
35. }  
36.   
37. //=========================================================================  
38.   
39. /** 
40.  * @author Downpour 
41.  */  
42. public class OGNLTestCase extends TestCase {  
43.       
44.     /** 
45.      *  
46.      * @throws Exception 
47.      */  
48.     @SuppressWarnings("unchecked")  
49.     @Test  
50.     public void testGetValue() throws Exception {  
51.           
52.         // Create root object  
53.         User user = new User();  
54.         user.setId(1);  
55.         user.setName("downpour");  
56.   
57.         // Create context  
58.         Map context = new HashMap();  
59.         context.put("introduction","My name is ");  
60.           
61.         // Test to directly get value from root object, with no context  
62.         Object name = Ognl.getValue(Ognl.parseExpression("name"), user);  
63.         assertEquals("downpour",name);  
64.           
65.         // Test to get value(parameter) from context  
66.         Object contextValue = Ognl.getValue(Ognl.parseExpression("#introduction"), context, user);  
67.         assertEquals("My name is ", contextValue);  
68.           
69.         // Test to get value and parameter from root object and context  
70.         Object hello = Ognl.getValue(Ognl.parseExpression("#introduction + name"), context, user);  
71.         assertEquals("My name is downpour",hello);  
72.                       
73.     }  
74.   
75.     /** 
76.      *  
77.      * @throws Exception 
78.      */  
79.     @SuppressWarnings("unchecked")  
80.     @Test  
81.     public void testSetValue() throws Exception {  
82.           
83.         // Create root object  
84.         User user = new User();  
85.         user.setId(1);  
86.         user.setName("downpour");  
87.           
88.                 // Set value according to the expression  
89.         Ognl.setValue("department.name", user, "dev");  
90.         assertEquals("dev", user.getDepartment().getName());  
91.           
92.     }  
93.       
94.   
95. }  

我们可以看到，简单的API，就已经能够完成对各种对象树的读取和设值工作了。这也体现出OGNL的学习成本非常低。 

在上面的测试用例中，需要特别强调进行区分的，是在针对不同内容进行取值或者设值时，OGNL表达式的不同。

Struts2 Reference 写道

The framework uses a standard naming context to evaluate OGNL expressions. The top level object dealing with OGNL is a Map (usually referred as a context map or context). OGNL has a notion of there being a root (or default) object within the context. In expression, the properties of the root object can be referenced without any special "marker" notion. References to other objects are marked with a pound sign (#).

上面这段内容摘自Struts2的Reference，我把这段话总结为以下2条规则： 
A） 针对根对象（Root Object）的操作，表达式是自根对象到被访问对象的某个链式操作的字符串表示。 
B） 针对上下文环境（Context）的操作，表达式是自上下文环境（Context）到被访问对象的某个链式操作的字符串表示，但是必须在这个字符串的前面加上#符号，以表示与访问根对象的区别。 

上面的这点区别咋看起来非常容易理解，不过一旦放到特定的环境中，就会显示出其重要性，它可以解释很多Struts2在页面展示上取值的各种复杂的表达式的现象。这一点在下一篇文章中会进行具体的分析。 

OGNL三要素 
我把传入OGNL的API的三个参数，称之为OGNL的三要素。OGNL的操作实际上就是围绕着这三个参数而进行的。
1. 表达式（Expression） 
表达式是整个OGNL的核心，所有的OGNL操作都是针对表达式的解析后进行的。表达式会规定此次OGNL操作到底要干什么。 
我们可以看到，在上面的测试中，name、department.name等都是表达式，表示取name或者department中的name的值。OGNL支持很多类型的表达式，之后我们会看到更多。 

2. 根对象（Root Object） 
根对象可以理解为OGNL的操作对象。在表达式规定了“干什么”以后，你还需要指定到底“对谁干”。 
在上面的测试代码中，user就是根对象。这就意味着，我们需要对user这个对象去取name这个属性的值（对user这个对象去设置其中的department中的name属性值）。 

3. 上下文环境（Context） 
有了表达式和根对象，我们实际上已经可以使用OGNL的基本功能。例如，根据表达式对根对象进行取值或者设值工作。 

不过实际上，在OGNL的内部，所有的操作都会在一个特定的环境中运行，这个环境就是OGNL的上下文环境（Context）。说得再明白一些，就是这个上下文环境（Context），将规定OGNL的操作“在哪里干”。 

OGNL的上下文环境是一个Map结构，称之为OgnlContext。上面我们提到的根对象（Root Object），事实上也会被加入到上下文环境中去，并且这将作为一个特殊的变量进行处理，具体就表现为针对根对象（Root Object）的存取操作的表达式是不需要增加#符号进行区分的。

 
OgnlContext不仅提供了OGNL的运行环境。在这其中，我们还能设置一些自定义的parameter到Context中，以便我们在进行OGNL操作的时候能够方便的使用这些parameter。不过正如我们上面反复强调的，我们在访问这些parameter时，需要使用#作为前缀才能进行。 

OGNL与模板 

我们在尝试了OGNL的基本操作并了解了OGNL的三要素之后，或许很容易把OGNL的操作与模板联系起来进行比较。在很多方面，他们也的确有着相似之处。 

对于模板，会有一些普通的输出元素，也有一些模板语言特殊的符号构成的元素，这些元素一旦与具体的Java对象融合起来，就会得到我们需要的输出结果。 

而OGNL看起来也是非常的类似，OGNL中的表达式就雷同于模板语言的特殊符号，目的是针对某些Java对象进行存取。而OGNL与模板都将数据与展现分开，将数据放到某个特定的地方，具体来说，就是Java对象。只是OGNL与模板的语法结构不完全相同而已。 

深入浅出OGNL 
在了解了OGNL的API和基本操作以后，我们来深入到OGNL的内部来看看，挖掘一些更加深入的知识。 

OGNL表达式 
OGNL支持各种纷繁复杂的表达式。但是最最基本的表达式的原型，是将对象的引用值用点串联起来，从左到右，每一次表达式计算返回的结果成为当前对象，后面部分接着在当前对象上进行计算，一直到全部表达式计算完成，返回最后得到的对象。OGNL则针对这条基本原则进行不断的扩充，从而使之支持对象树、数组、容器的访问，甚至是类似SQL中的投影选择等操作。 
接下来我们就来看看一些常用的OGNL表达式： 
1. 基本对象树的访问 
对象树的访问就是通过使用点号将对象的引用串联起来进行。 

例如：name，department.name，user.department.factory.manager.name 

2. 对容器变量的访问 
对容器变量的访问，通过#符号加上表达式进行。 
例如：#name，#department.name，#user.department.factory.manager.name 

3. 使用操作符号 

OGNL表达式中能使用的操作符基本跟Java里的操作符一样，除了能使用 +, -, *, /, ++, --, ==, !=, = 等操作符之外，还能使用 mod, in, not in等。 

4. 容器、数组、对象 

OGNL支持对数组和ArrayList等容器的顺序访问： 

例如：group.users[0] 

同时，OGNL支持对Map的按键值查找： 

例如：#session['mySessionPropKey'] 

不仅如此，OGNL还支持容器的构造的表达式： 

例如：{"green", "red", "blue"}构造一个List，#{"key1" : "value1", "key2" : "value2", "key3" : "value3"}构造一个Map 

你也可以通过任意类对象的构造函数进行对象新建： 

例如：new java.net.URL("http://localhost/") 

5. 对静态方法或变量的访问 

要引用类的静态方法和字段，他们的表达方式是一样的@class@member或者@class@method(args)： 

例如：@com.javaeye.core.Resource@ENABLE，@com.javaeye.core.Resource@getAllResources 

6. 方法调用 

直接通过类似Java的方法调用方式进行，你甚至可以传递参数： 

例如：user.getName()，group.users.size()，group.containsUser(#requestUser) 

7. 投影和选择 



OGNL支持类似数据库中的投影（projection） 和选择（selection）。 

投影就是选出集合中每个元素的相同属性组成新的集合，类似于关系数据库的字段操作。投影操作语法为 collection.{XXX}，其中XXX 是这个集合中每个元素的公共属性。 

例如：group.userList.{username}将获得某个group中的所有user的name的列表。 

选择就是过滤满足selection 条件的集合元素，类似于关系数据库的纪录操作。选择操作的语法为：collection.{X YYY}，其中X 是一个选择操作符，后面则是选择用的逻辑表达式。而选择操作符有三种： 
? 选择满足条件的所有元素 
^ 选择满足条件的第一个元素 
$ 选择满足条件的最后一个元素 

例如：group.userList.{? #this.name != null}将获得某个group中user的name不为空的user的列表。 

上述的所有的表达式，只是对OGNL所有表达式的大概的一个概括，除此之外，OGNL还有更多的表达式，例如lamba表达式等等。最具体的表达式的文档，大家可以参考OGNL自带的文档： 

http://www.ognl.org/2.6.9/Documentation/html/LanguageGuide/apa.html 

在撰写时，我也参考了potain同学的XWork教程以及一些网络上的一些文章，特此列出： 

http://www.lifevv.com/java/doc/20071018173750030.html 

http://blog.csdn.net/ice_fire2008/archive/2008/05/12/2438817.aspx 

OGNLContext 

OGNLContext就是OGNL的运行上下文环境。OGNLContext其实是一个Map结构，如果查看一下它的源码，就会发现，它其实实现了java.utils.Map的接口。当你在调用OGNL的取值或者设值的方法时，你可能会自己定义一个Context，并且将它传递给方法。事实上，你所传递进去的这个Context，会在OGNL内部被转化成OGNLContext，而你传递进去的所有的键值对，也会被OGNLContext接管维护，这里有点类似一个装饰器，向你屏蔽了一些其内部的实现机理。 

在OGNLContext的内部维护的东西很多，其中，我挑选2个比较重要的提一下。一个是你在调用方法时传入的Context，它会被维护在OGNL内部，并且作为存取变量的基础依据。另外一个，是在Context内部维护了一个key为root的值，它将规定在OGNLContext进行计算时，哪个元素被指定为根对象。其在进行存取时，将会被特殊对待。 

this指针 

我们知道，OGNL表达式是以点进行串联的一个字符串链式表达式。而这个表达式在进行计算的时候，从左到右，每一次表达式计算返回的结果成为当前对象，并继续进行计算，直到得到计算结果。每次计算的中间对象都会放在一个叫做this的变量里面这个this变量就称之为this指针。 

例如：group.userList.size().(#this+1).toString() 

在这个例子中，#this其实就是group.userList.size()的计算结构。 

使用this指针，我们就可以在OGNL表达式中进行一些简单的计算，从而完成我们的计算逻辑，而this指针在lamba表达式的引用中尤为广泛，有兴趣的读者可以深入研究OGNL自带的文档中lamba表达式的章节。 

默认行为和类型转化 
在我们所讲述的所有的OGNL的操作中，实际上，全部都忽略了OGNL内部帮助你完成的很多默认行为和类型转化方面的工作。 
我们来看一下OGNL在进行操作初始化时候的一个函数签名：

Java代码 

1.   
2. /**  
3.  * Appends the standard naming context for evaluating an OGNL expression  
4.  * into the context given so that cached maps can be used as a context.  
5.  *  
6.  * @param root the root of the object graph  
7.  * @param context the context to which OGNL context will be added.  
8.  * @return Context Map with the keys <CODE>root</CODE> and <CODE>context</CODE>  
9.  *         set appropriately  
10.  */  
11. public static Map addDefaultContext( Object root, ClassResolver classResolver, TypeConverter converter, MemberAccess memberAccess, Map context );  

Java代码 

1. /** 
2.  * Appends the standard naming context for evaluating an OGNL expression 
3.  * into the context given so that cached maps can be used as a context. 
4.  * 
5.  * @param root the root of the object graph 
6.  * @param context the context to which OGNL context will be added. 
7.  * @return Context Map with the keys <CODE>root</CODE> and <CODE>context</CODE> 
8.  *         set appropriately 
9.  */  
10. public static Map addDefaultContext( Object root, ClassResolver classResolver, TypeConverter converter, MemberAccess memberAccess, Map context );  

可以看到，在初始化时，OGNL还需要额外初始化一个类型转化的接口和一些其他的信息。只不过这些默认行为，由OGNL的内部屏蔽了。 

一旦需要自己定义针对某个特定类型的类型转化方式，你就需要实现TypeConverter接口，并且在OGNL中进行注册。 

同时，如果需要对OGNL的许多默认行为做出改变，则需要通过设置OGNL的全局环境变量进行。 

上述的这些内容，有些会在后面的章节涉及，有兴趣的读者，也可以参阅OGNL的源码和OGNL的文档寻求帮助