OGNL

OGNL是Object Graph Navigation Language的简称，详细相关的信息可以参考：http://www.ognl.org。这里我们只涉及Struts2框架中对OGNL的基本支持。

 

 

Struts 2默认的表达式语言是OGNL，原因是它相对其它表达式语言具有下面几大优势：

1. 支持对象方法调用，如xxx.doSomeSpecial()；
2. 支持类静态的方法调用和值访问，表达式的格式为@[类全名（包括包路径）]@[方法名 |  值名]，例如：@java.lang.String@format('foo %s', 'bar')或@tutorial.MyConstant@APP_NAME；
3. 支持赋值操作和表达式串联，如price=100, discount=0.8, calculatePrice()，这个表达式会返回80；
4. 访问OGNL上下文（OGNL context）和ActionContext；
5. 操作集合对象。

 

 #、%和$这三个符号的使用：

 

“#”主要有三种用途：

1. 访问OGNL上下文和Action上下文，#相当于ActionContext.getContext()；下表有几个ActionContext中有用的属性：

   名称	作用	例子
   parameters	包含当前HTTP请求参数的Map	#parameters.id[0]作用相当于request.getParameter("id")
   request	包含当前HttpServletRequest的属性（attribute)的Map	#request.userName相当于request.getAttribute("userName")
   session	包含当前HttpSession的属性（attribute）的Map	#session.userName相当于session.getAttribute("userName")
   application	包含当前应用的ServletContext的属性（attribute）的Map	#application.userName相当于application.getAttribute("userName")
   attr	用于按request > session > application顺序访问其属性（attribute）	#attr.userName相当于按顺序在以上三个范围（scope）内读取userName属性，直到找到为止

2. 投影（projecting)
         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的雇员的列表
4. 集合操作
         创建List
   　　　   使用花括号将元素包含起来，元素之间使用逗号分隔。如{'zhangsan','lisi','wangwu'}
   　　创建数组
   　　　　OGNL中创建数组与Java语言中创建数组类似。
   　　创建Map
   　　　　Map使用特殊的语法来创建     #{'key':'value', ......}
   　　　　如果想指定创建的Map类型，可以在左花括号前指定Map实现类的类名。如：
   　　　　#@java.util.LinkedHashMap@{'key':'value',....}
   　　　　Map通过key来访问，如map['key']或map.key。 
5. %的作用 
       标签的属性为字符串类型时，仍然计算OGNL表达式的值。如果标签属性本来就是ognl表达式，则没有用。
   <s:url value ="{#foobar['foo1']}" />因为value的属性本来是string，也就是里面写的是什么就显示什么。
   如果用%{},那么{}里面的就会被当作ognl语言来运行了。
6. $符号
   $符号主要有两个方面的用途。
      在国际化资源文件中，引用OGNL表达式，例如国际化资源文件中的代码：reg.agerange=国际化资源信息：年龄必须在${min}同${max}之间。
      在Struts 2框架的配置文件中引用OGNL表达式，例如下面的代码片断所示：
   <validators>
       <field name="intb">
               <field-validator type="int">
               <param name="min">10</param>
               <param name="max">100</param>
               <message>BAction-test校验:数字必须为${min}为${max}之间!</message>
           </field-validator>
       </field>
   </validators>

 

OGNL是一个对象，属性的查询语言。在OGNL中有一个类型为Map的Context（称为上下文），在这个上下文中有一个根元素（root），对根元素的属性的访问可以直接使用属性名字，但是对于其他非根元素属性的访问必须加上特殊符号#。

 

在Struts2中上下文为ActionContext，根元素位于Value Stack（值堆栈，值堆栈代表了一族对象而不是一个对象，其中Action类的实例也属于值堆栈的一个）。ActionContext中的内容如下图：

 

                       |--application

                       |

                       |--session

                       |

                       |--value stack(root)

 context map--|

                       |--request

                       |

                       |--parameters

                       |

                       |--attr (searches page, request, session, then application scopes)

              

因为Action实例被放在Value Stack中，而Value Stack又是根元素（root）中的一个，所以对Action中的属性的访问可以不使用标记#，而对其他的访问都必须使用#标记。

 

引用Action的属性

<s:property value="postalCode"/>

ActionContext中的其他非根（root）元素的属性可以按照如下的方式访问：

<s:property value="#session.mySessionPropKey"/> or

<s:property value="#session["mySessionPropKey"]"/> or

<s:property value="#request["mySessionPropKey"]/>

 

Action类可以使用ActionContext中的静态方法来访问ActionContext。

ActionContext.getContext().getSession().put("mySessionPropKey", mySessionObject);

 

OGNL与Collection（Lists，Maps，Sets）

 

生成List的语法为: {e1,e2,e3}.

<s:select label="label" name="name"

list="{'name1','name2','name3'}" value="%{'name2'}" />

上面的代码生成了一个HTML Select对象，可选的内容为： name1，name2，name3，默认值为：name2。

 

生成Map的语法为：#{key1:value1,key2:value2}.

<s:select label="label" name="name"

list="#{'foo':'foovalue', 'bar':'barvalue'}" />

上面的代码生成了一个HTML Select对象,foo名字表示的内容为：foovalue，bar名字表示的内容为：barvalue。

 

对于集合，OGNL提供了两个元素符：in和not in，其中in判断某个元素是否在指定集合中；not in则用于判断某个元素是否不在指定集合中。

判断一个对象是否在List内存在：

<s:if test="'foo' in {'foo','bar'}">

   muhahaha

</s:if>

<s:else>

   boo

</s:else>

 

<s:if test="'foo' not in {'foo','bar'}">

   muhahaha

</s:if>

<s:else>

   boo

</s:else>

 

取得一个List的一部分：

?  –  所有满足选择逻辑的对象

^  -   第一个满足选择逻辑的对象

$  -   最后一个满足选择逻辑的对象

例如：

person.relatives.{? #this.gender == 'male'}

上述代码取得这个人（person）所有的男性（this.gender==male）的亲戚(relatives)

 

 

Lambda 表达式

 

OGNL支持简单的Lambda表达式语法，使用这些语法可以建立简单的lambda函数。

 

例如：

Fibonacci:

if n==0 return 0;

elseif n==1 return 1;

else return fib(n-2)+fib(n-1);

fib(0) = 0

fib(1) = 1

fib(11) = 89

 

OGNL的Lambda表达式如何工作呢？

Lambda表达式必须放在方括号内部，#this表示表达式的参数。例如：

<s:property value="#fib =:[#this==0 ? 0 : #this==1 ? 1 : #fib(#this-2)+#fib(#this-1)], #fib(11)" />

 

#fib =:[#this==0 ? 0 : #this==1 ? 1 : #fib(#this-2)+#fib(#this-1)]定义了一个Lambda表达式，

#fib(11) 调用了这个表达式。

 

所以上述代码的输出为：89

 

在JSP2.1中#被用作了JSP EL（表达式语言）的特殊记好，所以对OGNL的使用可能导致问题，

一个简单的方法是禁用JSP2.1的EL特性，这需要修改web.xml文件：

<jsp-config>

    <jsp-property-group>

      <url-pattern>*.jsp</url-pattern>

      <el-ignored>true</el-ignored>

    </jsp-property-group>

</jsp-config>

 

 

4.6节 Tag 语法

代码示例：

 

表达式	含义
<p>Username: ${user.username}</p>	一个在标准上下文中的JavaBean对象，可以适用Freemarker，Velocity,JSTL EL等（不是OGNL）。
<s:textfield name="username"/>	在Value Stack中的一个username属性。
<s:url id="es" action="Hello">   <s:param name="request_locale">     es   </s:param> </s:url> <s:a href="%{es}">Espanol</s:a>	引用Value Stack中属性的另外一种方法。
<s:property   name="#session.user.username" />	Session中的user对象的username属性。
<s:select   label="FooBar" name="foo"   list="#{'username':'trillian',     'username':'zaphod'}" />	一个简单的静态Map，和put("username","trillian")一样

 

 

 

Struts2在OGNL基础上的增强
　　１、值栈(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基础上做出的改进。
　　２、[N]语法
　　　　如上所述，如果想要访问employee的name属性，应该如何写表达式呢？我们可以使用[N].xxx(N是从0开始的整数)这样的语法来指定从哪一个位置开始向下查找对象的属性，表达式[1].name访问的就是employee对象的name属性。
　　　　在使用[N].xxx语法时，要注意位置序号的含义，它并不是表示“获取栈中索引为N的对象”，而是截取从位置N开始的部分栈。
　　３、top关键字
　　　　top用于获取栈顶的对象，结合[N].xxx语法，我们就可以获取栈中任意位置的对象。
　　　　如：[0].top,[1].top等
　　４、访问静态成员
　　　　除了使用标准的OGNL表达式访问静态字段和静态方法外，Struts2还允许你不指定完整的类名，而是通过“vs”前缀来调用保存在栈中的静态字段和静态方法。
　　　　@vs@FOO_PROPERTY
　　　　@vs@someMethod()
　　　　@vs1@someMethod()
　　　　vs表示ValueStack，如果只有vs，那么将使用栈顶对象的类；如果在vs后面跟上一个数字，那么将使用栈中指定位置处的对象类。
　　５、值栈中的Action实例
　　　　Struts2框架总是把Action实例放在栈顶。因为Action在值栈中，而值栈又是OGNL中的根，所以引用Action的属性可以省略“#”标记，这也是为什么我们在结果页面中可以直接访问Action的属性的原因。
　　６、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对象。