Struts2的OGNL

1.OGNL表达式语言
OGNL是Object Graphic Navigation Language（对象图导航语言）的缩写，它是一个开源项目。 Struts 2框架使用OGNL作为默认的表达式语言。

相对EL表达式，它提供了平时我们需要的一些功能，如：
支持对象方法调用，如xxx.sayHello()；
支持类静态方法调用和值访问，表达式的格式为@[类全名（包括包路径）]@[方法名 | 值名]，例如：@java.lang.String@format('foo %s', 'bar')或@cn.itcast.Constant@APP_NAME；
操作集合对象。

Ognl 有一个上下文（Context）概念，说白了上下文就是一个MAP结构，它实现了java.utils.Map接口，在Struts2中上下文（Context）的实现为ActionContext，下面是上下文（Context）的结构示意图

2.访问上下文（Context）中的对象需要使用#符号标注命名空间，如#application、#session

另外OGNL会设定一个根对象（root对象），在Struts2中根对象就是ValueStack（值栈） 。如果要访问根对象（即ValueStack）中对象的属性，则可以省略#命名空间，直接访问该对象的属性即可。

在struts2中，根对象ValueStack的实现类为OgnlValueStack，该对象不是我们想像的只存放单个值，而是存放一组对象。在OgnlValueStack类里有一个List类型的root变量，就是使用他存放一组对象
|--request  
|--application  
context ------|--OgnlValueStack root变量[action, OgnlUtil, ... ]  
|--session  
|--attr  
|--parameters

在root变量中处于第一位的对象叫栈顶对象。通常我们在OGNL表达式里直接写上属性的名称即可访问root变量里对象的属性，搜索顺序是从栈顶对象开始寻找，如果栈顶对象不存在该属性，就会从第二个对象寻找，如果没有找到就从第三个对象寻找，依次往下访问，直到找到为止。
大家注意： Struts2中，OGNL表达式需要配合Struts标签才可以使用。如：<s:property value="name"/>

3.由于ValueStack(值栈)是Struts 2中OGNL的根对象，如果用户需要访问值栈中的对象，在JSP页面可以直接通过下面的EL表达式访问ValueStack(值栈)中对象的属性：
${foo} //获得值栈中某个对象的foo属性

如果访问其他Context中的对象，由于他们不是根对象，所以在访问时，需要添加#前缀。
application对象：用于访问ServletContext，例如#application.userName或者#application['userName']，相当于调用ServletContext的getAttribute("username")。

session对象：用来访问HttpSession，例如#session.userName或者#session['userName']，相当于调用session.getAttribute("userName")。

request对象：用来访问HttpServletRequest属性（attribute）的Map，例如#request.userName或者#request['userName']，相当于调用request.getAttribute("userName")。

parameters对象：用于访问HTTP的请求参数，例如#parameters.userName或者#parameters['userName']，相当于调用request.getParameter("username")。

attr对象：用于按page->request->session->application顺序访问其属性。

4.为何使用EL表达式能够访问valueStack中对象的属性

原因是Struts2对HttpServletRequest作了进一步的封装。简略代码如下：

public class StrutsRequestWrapper extends HttpServletRequestWrapper {
public StrutsRequestWrapper(HttpServletRequest req) {
super(req);
}
public Object getAttribute(String s) {
......
ActionContext ctx = ActionContext.getContext();
Object attribute = super.getAttribute(s);//先从request范围获取属性值
if (ctx != null) {
if (attribute == null) {//如果从request范围没有找到属性值,即从ValueStack中查找对象的属性值
......
ValueStack stack = ctx.getValueStack();
attribute = stack.findValue(s);
......
}
}
return attribute;
}
}

5.采用OGNL表达式创建List/Map集合对象

如果需要一个集合元素的时候（例如List对象或者Map对象），可以使用OGNL中同集合相关的表达式。
使用如下代码直接生成一个List对象：
<s:set name="list" value="{'zhangming','xiaoi','liming'}" />
<s:iterator value="#list" id="n">
<s:property value="n"/><br>
</s:iterator>

生成一个Map对象：
<s:set name="foobar" value="#{'foo1':'bar1', 'foo2':'bar2'}" />
<s:iterator value="#foobar" >
<s:property value="key"/>=<s:property value="value"/><br>
</s:iterator>

Set标签用于将某个值放入指定范围。
scope：指定变量被放置的范围，该属性可以接受application、session、request、 page或action。如果没有设置该属性，则默认放置在OGNL Context中。
value：赋给变量的值.如果没有设置该属性,则将ValueStack栈顶的值赋给变量。

6.采用OGNL表达式判断对象是否存在于集合中
对于集合类型，OGNL表达式可以使用in和not in两个元素符号。其中，in表达式用来判断某个元素是否在指定的集合对象中；not in判断某个元素是否不在指定的集合对象中，如下所示。
in表达式：
<s:if test="'foo' in {'foo','bar'}">
在
</s:if>
<s:else>
不在
</s:else>

not in表达式：
<s:if test="'foo' not in {'foo','bar'}">
不在
</s:if>
<s:else>
在
</s:else>

7.OGNL表达式的投影功能
除了in和not in之外，OGNL还允许使用某个规则获得集合对象的子集，常用的有以下3个相关操作符。
?：获得所有符合逻辑的元素。
^：获得符合逻辑的第一个元素。
$：获得符合逻辑的最后一个元素。
例如代码：
<s:iterator value="books.{?#this.price > 35}">
<s:property value="title" /> - $<s:property value="price" /><br>
</s:iterator>
在上面代码中，直接在集合后紧跟.{}运算符表明用于取出该集合的子集，{}内的表达式用于获取符合条件的元素，this指的是为了从大集合books筛选数据到小集合，需要对大集合books进行迭代，this代表当前迭代的元素。本例的表达式用于获取集合中价格大于35的书集合。
public class BookAction extends ActionSupport {
private List<Book> books;
....
@Override
public String execute() {
books = new LinkedList<Book>();
books.add(new Book("A735619678", "spring", 67));
books.add(new Book("B435555322", "ejb3.0",15));
}
}

8.property标签
property标签用于输出指定值：
<s:set name="name" value="'kk'" />
<s:property value="#name"/>
default：可选属性，如果需要输出的属性值为null，则显示该属性指定的值
escape：可选属性，指定是否格式化HTML代码。
value：可选属性，指定需要输出的属性值，如果没有指定该属性，则默认输出ValueStack栈顶的值。
id：可选属性，指定该元素的标识

9. iterator标签
iterator标签用于对集合进行迭代，这里的集合包含List、Set和数组。
<s:set name="list" value="{'zhangming','xiaoi','liming'}" />
<s:iterator value="#list" status="st">
<font color=<s:if test="#st.odd">red</s:if><s:else>blue</s:else>>
<s:property /></font><br>
</s:iterator>
value：可选属性，指定被迭代的集合，如果没有设置该属性，则使用ValueStack栈顶的集合。
id：可选属性，指定集合里元素的id。
status：可选属性，该属性指定迭代时的IteratorStatus实例。该实例包含如下几个方法：
int getCount()，返回当前迭代了几个元素。
int getIndex()，返回当前迭代元素的索引。
boolean isEven()，返回当前被迭代元素的索引是否是偶数
boolean isOdd()，返回当前被迭代元素的索引是否是奇数
boolean isFirst()，返回当前被迭代元素是否是第一个元素。
boolean isLast()，返回当前被迭代元素是否是最后一个元素。

10.if/elseif/else标签
<s:set name="age" value="21" />
<s:if test="#age==23">
23
</s:if>
<s:elseif test="#age==21">
21
</s:elseif>
<s:else>
都不等
</s:else>

10.url标签

<s:url action="helloworld_add" namespace="/test"><s:param name="personid" value="23"/></s:url>
生成类似如下路径：
/struts/test/helloworld_add.action?personid=23
红色部分为内容路径。

当标签的属性值作为字符串类型处理时， “%”符号的用途是计算OGNL表达式的值。
<s:set name="myurl" value="'http://www.foshanshop.net'"/>
<s:url value="#myurl" /><br>
<s:url value="%{#myurl}" />
输出结果：
#myurl
http://www.foshanshop.net

11.表单标签_checkboxlist复选框

如果集合为list
<s:checkboxlist name="list" list="{'Java','.Net','RoR','PHP'}" value="{'Java','.Net'}"/>
生成如下html代码：
<input type="checkbox" name="list" value="Java" checked="checked"/><label>Java</label>
<input type="checkbox" name="list" value=".Net" checked="checked"/><label>.Net</label>
<input type="checkbox" name="list" value="RoR"/><label>RoR</label>
<input type="checkbox" name="list" value="PHP"/><label>PHP</label>

如果集合为MAP
<s:checkboxlist name="map" list="#{1:'瑜珈用品',2:'户外用品',3:'球类',4:'自行车'}" listKey="key" listValue="value" value="{1,2,3}"/>
生成如下html代码：
<input type="checkbox" name="map" value="1" checked="checked"/><label>瑜珈用品</label>
<input type="checkbox" name="map" value="2" checked="checked"/><label>户外用品</label>
<input type="checkbox" name="map" value="3" checked="checked"/><label>球类</label>
<input type="checkbox" name="map" value="4"/><label>自行车</label>

12. 表单标签_checkboxlist复选框
如果集合里存放的是javabean
<%
Person person1 = new Person(1,"第一个");
Person person2 = new Person(2,"第二个");
List<Person> list = new ArrayList<Person>();
list.add(person1);
list.add(person2);
request.setAttribute("persons",list);
%>
<s:checkboxlist name="beans" list="#request.persons" listKey="personid" listValue="name"/>
Personid和name为Person的属性

生成如下html代码：
<input type="checkbox" name=“beans" value="1"/><label>第一个</label>
<input type="checkbox" name=“beans" value="2"/><label>第二个</label>

13.表单标签_radio单选框
该标签的使用和checkboxlist复选框相同。
如果集合里存放的是javabean(personid和name为Person的属性)
< s:radio name="beans" list="#request.persons" listKey="personid" listValue="name"/>
生成如下html代码：
<input type="radio" name="beans" id="beans1" value="1"/><label>第一个</label>
<input type="radio" name="beans" id="beans2" value="2"/><label>第二个</label>
如果集合为MAP
<s:radio name="map" list="#{1:'瑜珈用品',2:'户外用品',3:'球类',4:'自行车'}" listKey="key" listValue="value“ value="1"/>
生成如下html代码：
<input type="radio" name="map" id="map1" value="1"/><label for="map1">瑜珈用品</label>
<input type="radio" name="map" id="map2" value="2"/><label for="map2">户外用品</label>
<input type="radio" name="map" id="map3" value="3"/><label for="map3">球类</label>
<input type="radio" name="map" id="map4" value="4"/><label for="map4">自行车</label>
如果集合为list
<s:radio name="list" list="{'Java','.Net'}" value="'Java'"/>
生成如下html代码：
<input type="radio" name="list" checked="checked" value="Java"/><label>Java</label>
<input type="radio" name="list" value=".Net"/><label>.Net</label>

14.表单标签_select下拉选择框
<s:select name="list" list="{'Java','.Net'}" value="'Java'"/>
<select name="list" id="list">
<option value="Java" selected="selected">Java</option>
<option value=".Net">.Net</option>
</select>
<s:select name="beans" list="#request.persons" listKey="personid" listValue="name"/>
<select name="beans" id="beans">
<option value="1">第一个</option>
<option value="2">第二个</option>
</select>
<s:select name="map" list="#{1:'瑜珈用品',2:'户外用品',3:'球类',4:'自行车'}" listKey="key" listValue="value" value="1"/>
<select name="map" id="map">
<option value="1" selected="selected">瑜珈用品</option>
<option value="2">户外用品</option>
<option value="3">球类</option>
<option value="4">自行车</option>
</select>

__________________________________________________________________________

 

其实 OGNL 获取 Context 中的对象中的属性的方法很简单： person.name 就可以获取 person 对象的 name 属性的值。 OGNL 会从当前 valueStack 开始查找所要求的属性，一直往上层查找，直到找到为止。

除此之外， Struts2 还提供了一些命名对象，它们存在于 Stack Context 中，所以访问这些对象时需要使用 # 前缀来指明。

1 ， parameters 对象，用于访问 HTTP 请求参数。如 #parameters['foo'] 或 #parameters.foo ，用于返回调用 HttpServletRequest.getParameter("foo") 的返回值。

2 ， request 对象，用于访问 HttpServletRequest 的属性。如 #request['foo'] 或 #request.foo ，用于返回调用 HttpServletRequest.getAttribute("foo") 的返回值。

3 ， session 对象，用于访问 HttpSession 的属性。如 #session['foo'] 或 #session.foo ，用于返回调用 HttpSession.getAttribute("foo") 的返回值。

4 ， application 对象，用于访问 ServletContext 的属性。如 #application['foo'] 或 #application.foo ，用于返回调用 ServletContext.getAttribute("foo") 的返回值。

5 ， attr 对象，如果可以访问到，则访问 PageContext ，否则将依次搜索如下对象： HttpServletRequest, HttpSession , ServletContext 中的属性。

OGNL 表达式还可以直接生成一个集合，如：

{e1,e2,e3} 可以生成一个 List ；多个元素之间以英文逗号分隔。

#{key1:value1,key2:value2} 可以生成一个 Map ； key-value 之间以英文冒号分隔，多个元素之间以英文逗号分隔。

OGNL 还提供了两个元素符： in 和 not in ， in 判断某个元素是否在指定的集合中， not in 判断某个元素是否不在指定集合中。如下例：

<s:if test="'foo'" in {'foo','fooo'} > 包含 </s>

<s:if test="'foo'" not in {'foo','fooo'} > 不包含 </s>

除此之后， OGNL 还允许通过某个规则取得集合的子集。取得子集时有如下 3 个操作符：

1 ， ? 取出所有符合选择逻辑的元素

2 ， ^ 取出符合选择逻辑的第一个元素

3 ， $ 取出符合选择逻辑的最后一个元素

如以下代码： person.relatives.{? #this.gender == 'male'}

直接在集合后紧跟 .{} 运算符表明用于取出该集合的子集，在 {} 内使用 ? 表明取出所有符合选择逻辑的元素，而 #this 代表集合里元素。因此，上面代码的含义是：取出 person 里所有的 gender 等于 male 的 relatives 的属性的集合。

OGNL 支持基本的 Lambda( λ ) 表达式语法。通过这种 Lambda 表达式语法，可以让我们在 OGNL 表达式中使用一些简单的函数。如下面的斐波那契数列：

   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 表达式来求该数列中第 11 个元素的值：

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

用 OGNL 表达式取出 valueStack 中的值的方式为 ${requtestScope.username};

 

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

OGNL就是<s:property value="username"/>标签中value里的内容。

<li>访问值栈中的action的普通属性: username = <s:property value="username"/> </li>
   <li>访问值栈中对象的普通属性(get set方法)：<s:property value="user.age"/> | <s:property value="user['age']"/> | <s:property value="user[\"age\"]"/> | wrong: <%--<s:property value="user[age]"/>--%></li>
   <li>访问值栈中对象的普通属性(get set方法): <s:property value="cat.friend.name"/></li>
   <li>访问值栈中对象的普通方法：<s:property value="password.length()"/></li>
   <li>访问值栈中对象的普通方法：<s:property value="cat.miaomiao()" /></li>
   <li>访问值栈中action的普通方法：<s:property value="m()" /></li>
   <hr />
   <li>访问静态方法：<s:property value="@com.bjsxt.struts2.ognl.S@s()"/></li>
   <li>访问静态属性：<s:property value="@com.bjsxt.struts2.ognl.S@STR"/></li>
   <li>访问Math类的静态方法：<s:property value="@@max(2,3)" /></li>
   <hr />
   <li>访问普通类的构造方法：<s:property value="new com.bjsxt.struts2.ognl.User(8)"/></li>
   <hr />
   <li>访问List:<s:property value="users"/></li>
   <li>访问List中某个元素:<s:property value="users[1]"/></li>
   <li>访问List中元素某个属性的集合:<s:property value="users.{age}"/></li>
   <li>访问List中元素某个属性的集合中的特定值:<s:property value="users.{age}[0]"/> | <s:property value="users[0].age"/></li>
   <li>访问Set:<s:property value="dogs"/></li>
   <li>访问Set中某个元素:<s:property value="dogs[1]"/></li>
   <li>访问Map:<s:property value="dogMap"/></li>
   <li>访问Map中某个元素:<s:property value="dogMap.dog101"/> | <s:property value="dogMap['dog101']"/> | <s:property value="dogMap[\"dog101\"]"/></li>
   <li>访问Map中所有的key:<s:property value="dogMap.keys"/></li>
   <li>访问Map中所有的value:<s:property value="dogMap.values"/></li>
   <li>访问容器的大小：<s:property value="dogMap.size()"/> | <s:property value="users.size"/> </li>
   <hr />
   <li>投影(过滤)：<s:property value="users.{?#this.age==1}[0]"/></li>
   <li>投影：<s:property value="users.{^#this.age>1}.{age}"/></li>
   <li>投影：<s:property value="users.{$#this.age>1}.{age}"/></li>
   <li>投影：<s:property value="users.{$#this.age>1}.{age} == null"/></li>
   <hr />
   <li>[]:<s:property value="[0].username"/></li>