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）的结构示意图

Struts 2中的OGNL Context实现者为ActionContext，它结构示意图如下:
                                     |----ValueStack(值栈。它是根对象)
                                     |----parameters
                                     |----request
OGNL Context -----------|----session
                                     |----application
                                     |----attr

当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"/>
注意：name接收的是OGNL表达式。

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

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

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

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

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

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

使用EL表达式只能访问ValueStack内的对象：
当Struts2接受一个请求时，会迅速创建ActionContext，ValueStack，action 。然后把action存放进ValueStack，所以action的实例变量可以被OGNL访问。

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

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

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

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

采用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>

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

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

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

举例如下：
<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<%@ taglib uri="/struts-tags" prefix="s" %>
<%
request.setAttribute("user", "itcast");
request.getSession().setAttribute("user_session", "itcast-session");

%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>OGNL</title>
</head>
<body>
<s:property value="#request.user"/><br>
<s:property value="#session.user_session"/><br>
<s:property value="name"/> 或 ${name }<br><br>

采用OGNL表达式创建List/Map集合对象：<br>
1)创建List集合对象：不指定scope时，默认存放在OGNL Context中：
<s:set var="list" value="{'第一个','第二个','第三个'}"/>
<!-- s:iterator标签在迭代集合时有个特点：会把当前迭代的对象放在值栈的栈顶中 -->
<s:iterator value="#list">
 <s:property/>;
</s:iterator>
<br>
2)创建Map集合对象：
<s:set var="map" value="#{'key1':'val1', 'key2':'val2','key3':300}"/>
<s:iterator value="#map">
 <s:property/>;
</s:iterator> 或
<s:iterator value="#map">
 <s:property value="key"/>=<s:property value="value"/>;
</s:iterator>
<br><br>
采用OGNL表达式判断对象是否存在于集合中(in/not in)：
<s:if test="'第一个' in #list">
在
</s:if>
<s:else>
不在
</s:else> ------

<s:if test="'第一个' in {'第一个','第二个'}">
在
</s:if>
<s:else>
不在
</s:else>
<br>

</body>
</html>