Struts2-Ognl表达式与ValueStack

Struts2-Ognl表达式与ValueStack

Ognl

概述

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

Ognl表达式与El表达式的对比：
* El表达式语言，用于页面取值，jsp页面取值的标准。(默认直接可以使用) 即应用范围更广。
* Ognl表达式语言， struts标签默认支持的表达式语言。 必须配置struts标签用，不能离开struts标签直接用。

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）操作集合对象。

ValueStack对象是JSP页面取值的核心

ValueStack, 即值栈对象。
值栈对象：
* 是整个struts数据存储的核心，或者叫中转站。在其中保存当前Action 对象和其他相关对象。
* 用户每次访问struts的action，都会创建一个Action对象、值栈对象、ActionContext对象； 然后把Action对象放入值栈中； 最后再把值栈对象放入request中，传入jsp页面。
(在request中的key: struts.valueStack)；

如何理解呢？ -> 即我们在jsp页面访问action带过来的数据时，都是从ValueStack中取出来的。

ValueStack对象的获取

ValueStack valuestack1 = (ValueStack)  request.getAttribute("struts.valueStack")
ValueStack valuestack2 = ServletActionContext.getContext().getValueStack();

ValueStack如何存储数据呢？

它包含 ObjectStack 、 ContextMap。这两个对象分别是List结构和Map结构
ObjectStack: Struts 把动作和相关对象压入 ObjectStack 中。 这个对象实际上是List结构的。
ContextMap: Struts 把各种各样的映射关系(一些 Map 类型的对象) 压入 ContextMap 中。
Struts 会把下面这些映射压入 ContextMap 中
1） parameters: 该 Map 中包含当前请求的请求参数
2） request: 该 Map 中包含当前 request 对象中的所有属性
3） session: 该 Map 中包含当前 session 对象中的所有属性
4） application:该 Map 中包含当前 application 对象中的所有属性
5） attr: 该 Map 按如下顺序来检索某个属性: request, session, application

ValueStack与Ognl表达式取值的问题

ValueStack实际是一个接口,在Struts2中利用OGNL时，实际上使用的是实现了该接口的OgnlValueStack类,这个类是Struts2利用OGNL的基础。即在向JSP页面传递了OgnlValueStack。所以在JSP与Action之间，

OgnlValueStack包含
CompoundRoot root; 是继承ArrayList的对象栈
Map

OgnlContext是Struts2的数据中心

OGNL 有一个上下文（Context）概念，说白了上下文就是一个MAP结构，它实现了 java.utils.Map 的接口。 OgnlContext对象
是ognl表达式语言的核心。

为什么这么说呢，上面看了半天的ValueStack，他应该是数据中心吧，好吧，其实我也快晕了，可是看完下面这幅图，思路应该就清晰一些了。

OgnlContext
OgnlContext是Struts2的数据中心。结构示意图如下:

即我们在Struts2想获得数据时，可以利用这个对象。
分析：
当Struts2接受一个请求时，会迅速创建ActionContext、ValueStack和Action对象。然后把action存放进ValueStack，所以 action的实例变量可以被OGNL访问。
注意
Struts2中，OGNL表达式需要配合Struts标签才可以使用。如：

// OgnlContext用法
public class OgnlDemo1 {

    /**
     * 1. Ognl表达式语言语言取值，取非根元素的值，必须用#号
     * @throws Exception
     */
    @Test
    public void testOgnl() throws Exception {
        // 创建一个Ognl上下文对象
        OgnlContext context = new OgnlContext();
        // 放入数据
        User user = new User();
        user.setId(100);
        user.setName("Jack");
        // 【往非根元素放入数据， 取值的时候表达式要用"#"】
        context.put("user", user);

        // 获取数据(map)
        // 先构建一个Ognl表达式, 再解析表达式
        Object ognl = Ognl.parseExpression("#user.name");
        Object value = Ognl.getValue(ognl, context, context.getRoot());

        System.out.println(value);
    }

    /**
     * 2. Ognl表达式语言语言取值，取根元素的值，不用带#号
     * @throws Exception
     */
    @Test
    public void testOgn2() throws Exception {
        // 创建一个Ognl上下文对象
        OgnlContext context = new OgnlContext();
        // 放入数据
        User user = new User();
        user.setId(100);
        user.setName("Jack");
        // 往根元素放入数据
        context.setRoot(user);

        // 获取数据(map)
        // 先构建一个Ognl表达式, 再解析表达式
        Object ognl = Ognl.parseExpression("address.province");
        Object value = Ognl.getValue(ognl, context, context.getRoot());

        System.out.println(value);
    }

    /**
     * 3.Ognl对 静态方法调用的支持
     * @throws Exception
     */
    @Test
    public void testOgn3() throws Exception {
        // 创建一个Ognl上下文对象
        OgnlContext context = new OgnlContext();

        // Ognl表单式语言，调用类的静态方法
        //Object ognl = Ognl.parseExpression("@Math@floor(10.9)");
        // 由于Math类在开发中比较常用，所以也可以这样写
        Object ognl = Ognl.parseExpression("@@floor(10.9)");
        Object value = Ognl.getValue(ognl, context, context.getRoot());
        System.out.println(value);
    }
}

使用Ognl在JSP页面取值

上面扯了半天，把我自己都扯晕了。 可是来到这里就好了，其实这篇博文的主要目的就是理解如何使用Ognl在JSP页面取值。

直接取值

例如：<s:property value="address"/> // 获取对象栈信息(默认从栈顶检索)，即检索范围包括Action对象的实例变量，但应提供getset方法。

使用 #xxx 取值

作用1：
“#”号主要用于访问访问Map栈信息（四大域对象的数据和请求参数），不使用#号主要用于访问List(对象栈)信息。
例如： <s:property value="#request.username"/>

作用2：
“#”号还有一个作用就是在JSP页面中构建Map集合。
格式：#{key:value,key:value…}
例如：
Struts2的radio标签主要任务是在页面中显示单选按钮

     <s:radio list="#{'male':'男','female':'女'}" name="gender"></s:radio><br/>
      运行结果源码:
       <input type="radio" name="gender" id="gendermale" value="male"/>男
       <input type="radio" name="gender" id="genderfemale" value="female"/>女

$号的作用

$号的作用
在Struts2配置文件中,引用OGNL表达式（有没有感觉很猛）
举例
ognl.xml配置文件

     <action name="ognlAction_*" class="com.suixin.ognl.OgnlAction" method="{1}">
              <result name="success">/ognl/ognl.jsp?username=${#request.username}</result>
       </action>
       在ognl.jsp中获取携带的参数：
       <s:property value="%{#parameters.username[0]}"/>

%号作用

“%”符号的作用是在当Struts2标签的属性值为OGNL表达式时OGNL表达式却被理解为字符串类型原样输出时，用于通知执行环境%{}里的是OGNL表达式。
举例
Struts2中的textfield标签主要用于在页面中显示一个文本输入框数据。类似input

      <s:textfield value="#request.username"></s:textfield>

  此时#request.username被理解为一个普通的字符串，因此直接显示。因为这里脱离了
  运行OGNL的环境即：<s:property value="OGNL表达式"/>环境。
  通知运行环境将#request.username以OGNL表达式运行：

      <s:textfield value="%{#request.username}"></s:textfield>

总结
为了方便使用%{}我们可以在任何地方都直接添加%{}来确保运行OGNL表达式：

      <s:property value="%{#request.username}"/>

再来了解一些property标签

property标签用于输出指定值：

* default：可选属性， 如果需要输出的属性值为null，则显示该属性指定的值
* escape：可选属性，指定是否格式化HTML代码。
* value： 可选属性，指定需要输出的属性值，如果没有指定该属性，则默认输出ValueStack栈顶的值。

property标签可以为ognl表达式提供运行环境。