OGNL表达式

OGNL表达式语言

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

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

 

Struts 2中的OGNL Context实现者为ActionContext，它结构示意图如下:

                               |--request  

                               |--application  

OGNL  context ------ | ValueStack(值栈,它是根对象)   

                               |--session  

                               |--attr  

                               |--parameters

当Struts2接受一个请求时，会迅速创建ActionContext，ValueStack，action。然后把action存放进ValueStack，所以action的实例变量可以被OGNL访问。

 

访问上下文（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"/>

由于ValueStack(值栈)是Struts 2中OGNL的根对象，如果用户需要访问值栈中的对象，在JSP页面可以直接通过下面的EL表达式访问ValueStack(值栈)中对象的属性：

${foo} //获得值栈中某个对象的foo属性

如果访问其他Context中的对象，由于他们不是根对象，所以在访问时，需要添加#前缀。

l  application对象：用于访问ServletContext，例如#application.userName或者#application['userName']，相当于调用ServletContext的getAttribute("username")。

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

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

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

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

为何使用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;

    }

 }

采用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栈顶的值赋给变量。

对于集合类型，OGNL表达式可以使用in和not in两个元素符号。其中，in表达式用来判断某个元素是否在指定的集合对象中；not
in判断某个元素是否不在指定的集合对象中，如下所示。

采用OGNL表达式判断对象是否存在于集合中

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>

 

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));

      }

}

 

property标签

property标签用于输出指定值：

<s:set name="name" value="'kk'" />

<s:property value="#name"/>

default：可选属性，如果需要输出的属性值为null，则显示该属性指定的值

escape：可选属性，指定是否格式化HTML代码。

value：可选属性，指定需要输出的属性值，如果没有指定该属性，则默认输出ValueStack栈顶的值。

 

iterator标签

iterator标签用于对集合进行迭代，这里的集合包含List、Set和数组。会把当前迭代的标签置于栈顶

<s:set name="list" value="{'zhangming','xiaoi','liming'}" />

<s:iterator value="#list"status="st"><!--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()，返回当前被迭代元素是否是最后一个元素。

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>

 

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
 

表单标签_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>

表单标签_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>

表单标签_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" checked="checked"/><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>

表单标签_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>

 

<s:token />标签防止重复提交

<s:token />标签防止重复提交，用法如下：

第一步：在表单中加入<s:token />

<s:form action="helloworld_other" method="post" namespace="/test">

  <s:textfield name="person.name"/><s:token/><s:submit/>

  </s:form>

第二步：

<action name="helloworld_*" class="cn.itcast.action.HelloWorldAction" method="{1}">

       <interceptor-ref name="defaultStack" />

        <interceptor-ref name="token" />

        <result name="invalid.token">/WEB-INF/page/message.jsp</result> 

        <result>/WEB-INF/page/result.jsp</result>       

</action>

以上配置加入了“token”拦截器和“invalid.token”结果，因为“token”拦截器在会话的token与请求的token不一致时，将会直接返回“invalid.token”结果。

在debug状态,控制台出现下面信息,是因为Action中并没有struts.token和struts.token.name属性,我们不用关心这个错误：

严重: ParametersInterceptor - [setParameters]: Unexpected Exception caught setting 'struts.token' on 'class xxx: Error setting expression 'struts.token' with value '[Ljava.lang.String;@39f16f'

严重: ParametersInterceptor - [setParameters]: Unexpected Exception caught setting 'struts.token.name'