Struts2的OGNL表达式语言

一.OGNL的概念

OGNL是Object-Graph Navigation Language的缩写，全称为对象图导航语言，是一种功能强大的表达式语言，它通过简单一致的语法，可以任意存取对象的属性或者调用对象的方法，能够遍历整个对象的结构图，实现对象属性类型的转换等功能。

Struts 2支持以下几种表达式语言：

1. OGNL（Object-Graph Navigation Language），可以方便地操作对象属性的开源表达式语言；
2. JSTL（JSP Standard Tag Library），JSP 2.0集成的标准的表达式语言；
3. Groovy，基于Java平台的动态语言，它具有时下比较流行的动态语言（如Python、Ruby和Smarttalk等）的一些起特性；
4. Velocity，严格来说不是表达式语言，它是一种基于Java的模板匹配引擎，具说其性能要比JSP好。

Struts 2默认的表达式语言是OGNL，原因是它相对其它表达式语言具有下面几大优势：

• 支持对象方法调用，如xxx.doSomeSpecial()；
• 支持类静态的方法调用和值访问，表达式的格式为@[类全名（包括包路径）]@[方法名 | 值名]，例如：@java.lang.String@format('foo %s', 'bar')或@tutorial.MyConstant@APP_NAME；
• 支持赋值操作和表达式串联，如price=100, discount=0.8, calculatePrice()，这个表达式会返回80；
• 访问OGNL上下文（OGNL context）和ActionContext；
• 操作集合对象。

二.OGNL的重要知识点

1.OGNL表达式的计算是围绕OGNL上下文进行的。

   OGNL上下文实际上就是一个Map对象，由ognl.OgnlContext类表示。它里面可以存放很多个JavaBean对象。它有一个上下文根对象。

   上下文中的根对象可以直接使用名来访问或直接使用它的属性名访问它的属性值。否则要加前缀“#key”。

2.Struts2的标签库都是使用OGNL表达式来访问ActionContext中的对象数据的。如：<s:propertyvalue="xxx"/>。

3.Struts2将ActionContext设置为OGNL上下文，并将值栈作为OGNL的根对象放置到ActionContext中。

4.值栈(ValueStack) ：

   可以在值栈中放入、删除、查询对象。访问值栈中的对象不用“#”。

   Struts2总是把当前Action实例放置在栈顶。所以在OGNL中引用Action中的属性也可以省略“#”。

5.调用ActionContext的put(key,value)放入的数据，需要使用#访问。

补充：

（一）对"上下文"概念的理解

上下文, 英文是context，其完整意思应当是concatenate-text，联系文本，在IT行业中译为上下文其实并不确切也不容易理解，尤其是对于初学者，把它翻译为“引用池”或者“引用区”更加恰当。

比如在一篇15页的部门介绍中，中华人民共和国中央广播电视总局（以下简称广电总局），这里的以下，就是下文，在第15页的时候，你看到广电总局四个字就知道具体是哪个部门而不会弄混，这就是在上文做了解释。

在java的JSP中的内置对象中的PageContext，事实上，它就是本页面的一个单独的储存区域，里面存放的是各个地方（各个范围）传过来的属性的键值对的总汇。比如说，从Application里面存储了apptime,appname等等属性，在Session中又存了sessionid sessionstate等等属性，在request范围中又存了username，password等属性的键值对，那么PageContext就会把所有能得到的属性全部集中到一个区域里，你可以通过这个小容器，接收和调用到各个范围传递过来的属性，这就是所谓的”上下文“， 你可以把它记为”引用池“！

（二）valuestack，stackContext，ActionContext之间的关系

三者之间的关系如下图所示：

1. ActionContext ：一次Action调用都会创建一个ActionContext ，调用：ActionContext context = ActionContext.getContext()
2. ValueStack ：由OGNL框架实现 ，可以把它简单的看作一个List
3. Stack Object：放入stack中的对象，一般是action。
4. Stack Context（map）：stack上下文，它包含一些列对象，包括request/session/attr/application map等。
5. EL：存取对象的任意属性，调用对象的方法，遍历整个对象结构图。

ActionContext是Action上下文，可以得到request session application。

ValueStack是值栈 存放表单中的值。

Stack Context 栈上下文 也是用来存值的。

个人看法，action context 是在action中通过actionSupport类来获取到，主要作用是获取request之类的对象，然
后valuestack和stack context都是为了使用OGNL，其中value stack 是stack
context的根对象，所以我们在JSP页面中访问value stack的内容时，是不用加#，而如果是访问stack
context的其他对象则要加上#。

由于值栈是上下文中的 根对象，因此可以直接访问。那么对于值栈中的对象该如何访问呢？Struts2提供了一个特殊的OGNLPropertyAccessor，它可以自动查找栈内的所有对象(从栈顶到栈底)，直接找到一个具有你所查找的属性的对象。也就是说，对于值栈中的任何对象都可以直接访问，而不需要使用“#”。

Struts2框架总是把Action实例放在栈顶。因为Action在值栈中，而值栈又是OGNL中的根，所以引用Action的属性可以省略“#”标记，这也是为什么我们在结果页面中可以直接访问Action的属性的原因。　　　　
 OGNL的Stack Context里除了包括ValueStack这个根之外，还包括一些命名对象，这些对象没有保存在值栈中，而是保存在ActionContext中，因此访问这些对象需要使用“#”标记。这些命名对象都是Map类型。　

• parameters：用于访问请求参数。如：#parameters['id']或#parameters.id，相当于调用了HttpServletRequest对象的getParameter()方法。注意，parameters本质上是一个使用HttpServletRequest对象中的请求参数构造的Map对象，一量对象被创建(在调用Action实例之前就已经创建好了)，它和HttpServletRequest对象就没有了任何关系。
• request对象：用于访问HttpServletRequest的属性。例如#request['foo']或者#request.foo,用于返回HttpServletRequest的getAttribute("foo")方法的返回值。
• session对象：用于访问HttpSession的属性。例如#rsession['foo']或者#session.foo，用于返回HttpSession的getAttribute("foo")方法的返回值。
• application对象：用于访问ServletContext的属性，例如#application['foo']或者#application.foo，用于返回ServletContext的getAttribute("foo")方法的返回值。
• attr对象：该对象将依次搜索如下对象：PageContext、HttpServletRequest、HttpSession、ServletContext中的属性。

StackContext“根”对象和普通命名对象的区别在于：

• 访问StackContext里的命名对象需要在对象名之前添加#前缀。
• 当访问OGNL的Stack Context里的“根”对象的属性时，可以省略对象名。

struts2对OGNL上下文的概念又做了进一步扩充，在struts2中，OGNL上下文通常如下所示：

|--request

|

|--application

|

context map---|--OgnlValueStack(root) [ user, action, OgnlUtil, ... ]

|

|--session

|

|--attr

|

|--parameters

在Struts2中，采用标准命名的上下文(Context)来处理OGNL表达式。处理OGNL的顶级对象是一个Map（也叫context
map），而OGNL在这个context中就是一个顶级对象(root)。在用法上，顶级对象的属性访问，是不需要任何标记前缀的。而其它非顶级的对象
访问，需要使用#标记。

    Struts2框架把OGNL
Context设置为我们的ActionContext。并且ValueStack作为OGNL的根对象。除value
stack之外，Struts2框架还把代表application、session、request这些对象的Map对象也放到
ActionContext中去。（这也就是Struts2建议在Action类中不要直接访问Servlet API的原因，它可以通过ActionContext对象来部分代替这些（Servlet API）功能 ，以方便对Action类进行测试！）

三、OGNL中的三个重要符号#、%、$

#符号

#符号的用途一般有三种：

1. 访问非根对象属性，例如#session.msg表达式，由于Struts 2中值栈被视为根对象，所以访问其他非根对象时，需要加#前缀。实际上，#相当于ActionContext. getContext()；#session.msg表达式相当于ActionContext.getContext().getSession(). getAttribute("msg") 。
2. 用于过滤和投影（projecting）集合，如persons.{?#this.age>25}，persons.{?#this.name=='pla1'}.{age}[0]。
3. 用来构造Map，例如示例中的#{'foo1':'bar1', 'foo2':'bar2'}。

%符号

%符号的用途是在标志的属性为字符串类型时，计算OGNL表达式的值，这个类似js中的eval，很暴力。

$符号

$符号主要有两个方面的用途：

1. 在国际化资源文件中，引用OGNL表达式，例如国际化资源文件中的代码：reg.agerange=国际化资源信息：年龄必须在${min}同${max}之间。
2. 在Struts 2框架的配置文件中引用OGNL表达式，例如：

1. <validators>
2. <field name="intb">
3. <field-validator type="int">
4. <param name="min">10</param>
5. <param name="max">100</param>
6. <message>BAction-test校验：数字必须为${min}为${max}之间！</message>
7. </field-validator>
8. </field>
9. </validators>

四、OGNL使用方式

• 访问属性

  名字属性获取:<s:property value="user.username"/><br>

  地址属性获取:<s:property value="user.address.addr"/><br>

• 访问方法

  调用值栈中对象的普通方法：<s:property value="user.get()"/><br>

• 访问静态属性和方法

  调用Action中的静态方法：<s:property value="@struts.action.LoginAction@get()"/>

  调用JDK中的类的静态方法：<s:property value="@Java.lang.Math@floor(44.56)"/><br>

  调用JDK中的类的静态方法(同上)：<s:property value="@@floor(44.56)"/><br>

  调用JDK中的类的静态方法：<s:property value="@java.util.Calendar@getInstance()"/><br>

  调用普通类中的静态属性：<s:property value="@struts.vo.Address@TIPS"/><br>

• 访问构造方法

  调用普通类的构造方法:<s:property value="new struts.vo.Student('李晓红' , '美女' , 3 , 25).username"/>

• 访问数组

  获取List:<s:property value="testList"/><br>

  获取List中的某一个元素(可以使用类似于数组中的下标获取List中的内容):

  <s:property value="testList[0]"/><br>

  获取Set:<s:property value="testSet"/><br>

  获取Set中的某一个元素(Set由于没有顺序，所以不能使用下标获取数据):

  <s:property value="testSet[0]"/><br> ×

  获取Map:<s:property value="testMap"/><br>

  获取Map中所有的键:<s:property value="testMap.keys"/><br>

  获取Map中所有的值:<s:property value="testMap.values"/><br>

  获取Map中的某一个元素(可以使用类似于数组中的下标获取List中的内容):

  <s:property value="testMap['m1']"/><br>

  获取List的大小:<s:property value="testSet.size"/><br>

• 访问集合 – 投影、选择(? ^ $)

  利用选择获取List中成绩及格的对象:<s:property value="stus.{?#this.grade>=60}"/><br>

  利用选择获取List中成绩及格的对象的username:

  <s:property value="stus.{?#this.grade>=60}.{username}"/><br>

  利用选择获取List中成绩及格的第一个对象的username:

  <s:property value="stus.{?#this.grade>=60}.{username}[0]"/><br>

  利用选择获取List中成绩及格的第一个对象的username:

  <s:property value="stus.{^#this.grade>=60}.{username}"/><br>

  利用选择获取List中成绩及格的最后一个对象的username:

  <s:property value="stus.{$#this.grade>=60}.{username}"/><br>

  利用选择获取List中成绩及格的第一个对象然后求大小:

  <s:property value="stus.{^#this.grade>=600}.{username}.size"/><br>

• 集合的伪属性

  OGNL能够引用集合的一些特殊的属性,这些属性并不是JavaBeans模式,例如size(),length()等等. 当表达式引用这些属性时,OGNL会调用相应的方法,这就是伪属性.

  

• Lambda   :[…]    格式：:[…]

  使用Lambda表达式计算阶乘:

  <s:property value="#f = :[#this==1?1:#this*#f(#this-1)] , #f(4)"/><br>

• OGNL中#的使用 #可以取出堆栈上下文中的存放的对象.

获取Paraments对象的属性：<s:property value="#parameters.username"/>

•  OGNL中%的使用

用%{}可以取出存在值堆栈中的Action对象,直接调用它的方法.

例如你的Action如果继承了ActionSupport .那么在页面标签中，用%{getText('key')}的方式可以拿出国际化信息.

OGNL中$的使用

“$”有两个主要的用途

用于在国际化资源文件中，引用OGNL表达式

在Struts 2配置文件中，引用OGNL表达式

值栈

ValueStack对象。这个对象贯穿整个Action的生命周期（每个Action类的对象实例会拥有一个ValueStack对象）。当Struts 2接收到一个.action的请求后，会先建立Action类的对象实例，但并不会调用Action方法，而是先将Action类的相应属性放到ValueStack对象的顶层节点（ValueStack对象相当于一个栈）。

在Action中获得ValueStack对象：ActionContext.getContext().getValueStack()

Top语法：使用Top获取值栈中的第二个对象:<s:property value="[1].top.对象"/>

N语法：使用N获取值栈中的第二个对象:<s:property value="[1].对象"/>

@语法：调用action中的静态方法：<s:property value="@vs1@静态方法"/> vs：值栈 1：表示第一个。