Ognl 对象图导航语言

## 一、OGNL 表达式语言

OGNL 是 Object Graphic Navigation Language（对象图导航语言）的缩写，它是一个开源项目。 Struts 2 框架使用 OGNL 作为默认的表达式语言。MyBatis同样使用的是OGNL表达式引擎来解析变量。OGNL(Object-Graph Notation Language)是一种用于在Java对象之间进行动态交互的语言，它允许开发人员使用类似于XML语法的方式来访问和操作对象的属性和方法。MyBatis中的OGNL表达式可以方便地嵌入到SQL语句中，实现动态SQL的功能。

相对 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）的结构示意图
![](/media/202305/2023-05-11_163524_4791770.43553834964378524.png)

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

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

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

在 struts2 中，根对象 ValueStack 的实现类为 OgnlValueStack，该对象不是我们想像的只存放单个值，而是存放一组对象。在 OgnlValueStack 类里有一个 List 类型的 root 变量，就是使用他存放一组对象

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

由于 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 顺序访问其属性。

## 二、为何使用 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 表达式判断对象是否存在于集合中

对于集合类型，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));
  }
}
```