OGNL 表达式

 

Struts 2中的OGNL

本人是一个EL（Expression Language，以下译为表达式语言）的支持者。因为我对<% %>写法极为反感，忘记了在那本书上看到的一句话——“使用标志（Tag）的一个目的就是避免在JSP页面中出现过多的<%%>的语句，使页面与后台代码分离。”

表达式语言主要有以下几大好处：

1. 避免(MyType) request.getAttribute()和myBean.getMyProperty()之类的语句，使页面更简洁；
2. 支持运算符（如+-*/），比普通的标志具有更高的自由度和更强的功能；
3. 简单明了地表达代码逻辑，使用代码更可读与便于维护。

Struts 2中的表达式语言

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，原因是它相对其它表达式语言具有下面几大优势：

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

OGNL的用法

OGNL是通常要结合Struts 2的标志一起使用，如<s:property value="xx" />等。大家经常遇到的问题是#、%和$这三个符号的使用。下面我想通过例子讲述这个问题：

首先新建名为Struts2_OGNL的Web工程，配置开发环境。之前很多朋友在使用Struts 2的过程中都遇到乱码问题。当然乱码问题由来已久，而且涉及多方面的知识，所以并非三言两语可以说明白，而且互联网上也已经有很多这方便的文章，大家可以Google一下。不过，如果你在开发的过程，多注意一下，避免乱码问题也不难。乱码多数是由于编码与解码所使用的方式不同造成的，所以我建议大家将编码方式都设为“utf-8”，如<%@  page language="java" contentType="text/html; charset=utf-8" pageEncoding="utf-8" %>。另外，在配置web.xml时使用ActionContextCleanUp过滤器（Filter），如下面代码所示：

<?xml version="1.0" encoding="UTF-8"?>
<web-app id="WebApp_9" version="2.4"
    xmlns="http://java.sun.com/xml/ns/j2ee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">

    <display-name>Struts 2 OGNL</display-name>
    
    <filter>
        <filter-name>struts-cleanup</filter-name>
        <filter-class>
            org.apache.struts2.dispatcher.ActionContextCleanUp
        </filter-class>
    </filter>
    
    <filter-mapping>
        <filter-name>struts-cleanup</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
    
    <filter>
        <filter-name>struts2</filter-name>
        <filter-class>
            org.apache.struts2.dispatcher.FilterDispatcher
        </filter-class>
    </filter>

    <filter-mapping>
        <filter-name>struts2</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

    <welcome-file-list>
        <welcome-file>index.html</welcome-file>
    </welcome-file-list>

</web-app>

清单1 WebContent/WEB-INF/web.xml

“#”主要有三种用途：

1. 访问OGNL上下文和Action上下文，#相当于ActionContext.getContext()；下表有几个ActionContext中有用的属性：

名称	作用	例子
parameters	包含当前HTTP请求参数的Map	#parameters.id[0]作用相当于request.getParameter("id")
request	包含当前HttpServletRequest的属性（attribute)的Map	#request.userName相当于request.getAttribute("userName")
session	包含当前HttpSession的属性（attribute）的Map	#session.userName相当于session.getAttribute("userName")
application	包含当前应用的ServletContext的属性（attribute）的Map	#application.userName相当于application.getAttribute("userName")
attr	用于按request > session > application顺序访问其属性（attribute）	#attr.userName相当于按顺序在以上三个范围（scope）内读取userName属性，直到找到为止

2. 用于过滤和投影（projecting)集合，如books.{?#this.price<100}；
3. 构造Map，如#{'foo1':'bar1', 'foo2':'bar2'}。

下面让我们它们的具体写法，首先是Action类代码：

package tutorial.action;

import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;

import org.apache.struts2.interceptor.ServletRequestAware;
import org.apache.struts2.interceptor.SessionAware;
import org.apache.struts2.util.ServletContextAware;

import tutorial.model.Book;

import com.opensymphony.xwork2.ActionSupport;

public class OgnlAction extends ActionSupport implements ServletRequestAware, SessionAware, ServletContextAware   {
   private static final long serialVersionUID = 1L ;
   
   private HttpServletRequest request;
   private Map<String, String> session;
   private ServletContext application;
   private List<Book> books;
           
   public void setServletRequest(HttpServletRequest request) {
       this.request = request;    
   }

   @SuppressWarnings("unchecked")
   public void setSession(Map session) {
       this.session = session;        
   }

   public void setServletContext(ServletContext application) {
       this.application = application;
   }
   
   public List<Book> getBooks() {
       return books;
   }

   @Override
   public String execute() {
       request.setAttribute("userName", "Max From request");
       session.put("userName", "Max From session");
       application.setAttribute("userName", "Max From application");
       
       books = new LinkedList<Book>();
       books.add(new Book("978-0735619678", "Code Complete, Second Edition", 32.99));
       books.add(new Book("978-0596007867", "The Art of Project Management", 35.96));
       books.add(new Book("978-0201633610", "Design Patterns: Elements of Reusable Object-Oriented Software", 43.19));
       books.add(new Book("978-0596527341", "Information Architecture for the World Wide Web: Designing Large-Scale Web Sites", 25.19));
       books.add(new Book("978-0735605350", "Software Estimation: Demystifying the Black Art", 25.19));
       
       return SUCCESS;
   }
}

清单2 src/tutorial/action/OgnlAction.java

以上代码分别在request、session和application的范围内添加“userName”属性，然后再在JSP页面使用OGNL将其取回。我还创建了Book对象的列表用于演示“用于过滤和投影（projecting)集合”的功能，至于Book的代码大家可以在我前一文章《在Struts 2中实现CRUD》看到。

下面是Ognl.jsp的代码，内容如下：

<%@ page language="java" contentType="text/html; charset=utf-8" pageEncoding="utf-8" %>
<%@ taglib prefix="s" uri="/struts-tags" %>

<!DOCTYPE html PUBLIC "-//W 3C //DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <title>Struts OGNL Demo</title>
</head>
<body>    
    <h3>访问OGNL上下文和Action上下文</h3>
    <p>parameters: <s:property value="#parameters.userName" /></p>
    <p>request.userName: <s:property value="#request.userName" /></p>
    <p>session.userName: <s:property value="#session.userName" /></p>
    <p>application.userName: <s:property value="#application.userName" /></p>
    <p>attr.userName: <s:property value="#attr.userName" /></p>
    <hr />
    <h3>用于过滤和投影（projecting)集合</h3>
    <p>Books more than $35</p>
    <ul>
        <s:iterator value="books.{?#this.price > 35}">
            <li><s:property value="title" /> - $<s:property value="price" /></li>
        </s:iterator>
    </ul>
    <p>The price of "Code Complete, Second Edition" is: <s:property value="books.{?#this.title=='Code Complete, Second Edition'}.{price}[0]"/></p>
    <hr />
    <h3>构造Map</h3>
    <s:set name="foobar" value="#{'foo1':'bar1', 'foo2':'bar2'}" />
    <p>The value of key "foo1" is <s:property value="#foobar['foo1']" /></p>
</body>
</html>

清单3 WebContent/Ognl.jsp

以上代码值得注意的是“<s:property value="books.{?#this.title=='Code Complete, Second Edition'}.{price}[0]"/>”，因为“books.{?#this.title=='Code Complete, Second Edition'}.{price}”返回的值是集合类型，所以要用“[索引]”来访问其值。

最后是Struts 2的配置文件struts.xml，内容如下：

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE struts PUBLIC
    "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
    "http://struts.apache.org/dtds/struts-2.0.dtd">

<struts>
    <constant name="struts.devMode" value="true" />
    <package name="Struts2_OGNL_DEMO" extends="struts-default">
        <action name="Ognl" class="tutorial.action.OgnlAction">
            <result>/Ognl.jsp</result>
        </action>        
    </package>
</struts>

清单4 src/struts.xml

发布运行应用程序，结果如下所示：

清单5 示例运行结果1

“%”符号的用途是在标志的属性为字符串类型时，计算OGNL表达式的值。例如在Ognl.jsp中加入以下代码：

<hr />
    <h3>%的用途</h3>
    <p><s:url value="#foobar['foo1']" /></p>
    <p><s:url value="%{#foobar['foo1']}" /></p>

清单6 演示%用途的代码片段

刷新页面，结果如下所示：

清单7 示例运行结果2

“$”有两个主要的用途

1. 用于在国际化资源文件中，引用OGNL表达式，例子请参考《在Struts 2.0中国际化(i18n)您的应用程序》
2. 在Struts 2配置文件中，引用OGNL表达式，如

<action name="AddPhoto" class="addPhoto">
            <interceptor-ref name="fileUploadStack" />            
            <result type="redirect">ListPhotos.action?albumId=${albumId}</result>
        </action>

清单8 演示$用途的代码片段

总结

OGNL是一种功能很大的表达式语言，熟悉它可以使我们的开发变得更快捷。

 

 

 

 

 

 

 

 

 

 

 

 

 

# re: Struts 2中的OGNL 2007-04-28 23:01 | 轩朗=maninred

为什么要叫struts的ognl，而不叫webwork的ognl？  回复  更多评论
  

# re: Struts 2中的OGNL 2007-04-29 10:33 | qa

抱怨一下标签的设计：OGNL的使用是每个标签自己来负责的？！
在给datepicker用了OGNL出现问题，一路追下来的发现。拿value的部分俨然没考虑这一点。

考虑一下如果要改要如何下手吧，想好了提给struts2的标签组 :)  回复  更多评论
  

# re: Struts 2中的OGNL 2007-04-30 10:02 | mm

<s:set name="url" value="module/muser_main.jsp" />
<s:include value="%{#url}" />
怎么不管用呢？界面一片空白，我想动态添加
module/muser_main.jsp页面，该怎么办？
如何使用<s:include value="" />标签？  回复  更多评论
  

# re: Struts 2中的OGNL 2007-05-06 16:52 | bhfeet

期待博主出书。  回复  更多评论
  

# re: Struts 2中的OGNL[未登录] 2007-05-08 09:29 | javaman

看了楼主的struts2系列，真是受益匪浅，感谢楼主，期待更多更好的作品！~  回复  更多评论
  

# re: Struts 2中的OGNL[未登录] 2007-05-08 16:37 | javaman

你好，我最近在把一个struts1.x的项目改造成一个struts2的项目，发现在在写入数据库的时候，写到数据库里面的都是些乱码，请问在struts2中怎么解决乱码问题呢。
Email:java1982@126.com  回复  更多评论
  

# re: Struts 2中的OGNL 2007-05-08 23:15 | Max

@javaman
正如我文中所说：
---------------------------------------------------------------
之前很多朋友在使用Struts 2的过程中都遇到乱码问题。当然乱码问题由来已久，而且涉及多方面的知识，所以并非三言两语可以说明白，而且互联网上也已经有很多这方便的文章，大家可以Google一下。不过，如果你在开发的过程，多注意一下，避免乱码问题也不难。乱码多数是由于编码与解码所使用的方式不同造成的，所以我建议大家将编码方式都设为“utf-8”，如<%@ page language="java" contentType="text/html; charset=utf-8" pageEncoding="utf-8" %>。另外，在配置web.xml时使用ActionContextCleanUp过滤器（Filter），  回复  更多评论
  

# re: Struts 2中的OGNL 2007-07-04 14:50 | sasfy

<p><s:url value="#foobar['foo1']" /></p>
<p><s:url value="%{#foobar['foo1']}" /></p>

你的页面结果是
#foobar['fool']?userName=Max+From+parameters
bar?userName=Max+From+parameters

但是，我没看到什么地方给parameters赋值了啊？？？  回复  更多评论
  

# re: Struts 2中的OGNL 2007-07-04 23:14 | Max

@sasfy
“userName=Max+From+parameters”是我在例中用于请求“Ognl.action”的参数如“http://localhost:8080/Struts_OGNL/Ognl.action？userName=Max+From+parameters”。
<s:url />标签默认会将当前的请求参数加到生成的URL中。
  回复  更多评论
  

# re: Struts 2中的OGNL[未登录] 2007-07-26 12:54 | Steve

为什么我页面里提示<s:set name="foobar" value="#{'foo1':'bar1', 'foo2':'bar2'}" />这个Syntax error in EL啊
是不是要加什么包进来 啊
能我解决一下 先谢谢了哦  回复  更多评论
  

# re: Struts 2中的OGNL[未登录] 2007-07-30 10:28 | Steve

我项目中使用了过滤和投影（projecting)集合
<ul>
<s:iterator value="books.{?#this.price > 35}">
<li><s:property value="title" /> - $<s:property value="price" /></li>
</s:iterator>
</ul>
我把‘35’这个定值改成一个从Action得到的值（变化的）
象下面这样：
<ul>
<s:iterator value="books.{?#this.price >price}">
<li><s:property value="title" /> - $<s:property value="price" /></li>
</s:iterator>
</ul>
但是这种写法得不到所要的结果集  回复  更多评论
  

# re: Struts 2中的OGNL 2007-07-31 23:56 | Max

@Steve
请尝试一下更改price的名字，如minPrice,即books.{?#this.price >minPrice}  回复  更多评论
  

# re: Struts 2中的OGNL[未登录] 2007-08-03 18:26 | Steve

谢谢Max的答复，可是我还没成功
<s:property value="minprice"/>
///===》》这个是我从action 里得到的一个值
<ul>
<s:iterator value="books.{?#this.price > minprice}">
///===》》在这个过滤用时就取不到这个值了 我也想了很多法子 比如：换成#minprice，都不行

<li><s:property value="title" /> - $<s:property value="price" /></li>
</s:iterator>
</ul>
//我实在没办法了就用了一个<s:if test="price>minprice"></s:if>这样过滤的
我觉得这样有点麻烦，希望能得到更好更方便的方法
再次感谢你的回复  回复  更多评论
  

# re: Struts 2中的OGNL 2007-08-07 11:43 | Max

@Steve
你可以先定义一下ONGL变量，再通过#XX引用这个变量，如：
<s:set name="minPrice" value="minprice" />
<s:iterator value="books.{?#this.price > #minPrice}">
  回复  更多评论
  

# re: Struts 2中的OGNL 2007-08-13 11:25 | 于志兴

非常帅，谢谢~  回复  更多评论
  

# re: Struts 2中的OGNL 2007-08-13 15:09 | 地带

博主幸苦了,虽然刚开始接触struts,但是你写的很清晰  回复  更多评论
  

# re: Struts 2中的OGNL 2007-08-31 09:34 | wo

Max，你好。我有这么一个问题：
我在Action中有个path的field，并有set，get方法。在jsp中我想根据path的值include相应的页面应该如何书写？
<s:include value="<s:property value="path" />" /> 这样似乎不对。  回复  更多评论
  

# re: Struts 2中的OGNL 2007-09-06 16:09 | ZHDQ

您好,看了您的几篇文章觉的很不错,我们这里网落有问题总是掉线,很不方便,
您能吧这系列文章给我发一份吗?谢谢了
ZhouDaqingidea@gmail.com
谢谢...  回复  更多评论
  

# re: Struts 2中的OGNL[未登录] 2007-10-15 14:34 | nick

请问为什么我用books.{price}[0]取不到值啊  回复  更多评论
  

# re: Struts 2中的OGNL 2007-11-06 22:08 | Cowboy

想请问一下，
<s:set name="action" value='<s:url action="createUser"/>'/>
<s:form action="#action" method="post">
......
</s:form>

为什么使用 #action 不能获取想要的值，而只是"#action"。
改为 %{#action}" 还是不行，这是为什么？
应该使用怎样的OGNL表达式才能获取到想要的值(createUser.action)?  回复  更多评论
  

# re: Struts 2中的OGNL 2007-11-13 10:06 | java兄弟

HelloWorld.java运行的很好，为什么我又写了一个TestHello就报这个错误，请搂主赐教
严重: Could not find action or result
No result defined for action tutorial.TestWorld and result nihao - action - file:/E:/Test3/.metadata/.plugins/org.eclipse.wst.server.core/tmp0/wtpwebapps/Struts2_HelloWorld/WEB-INF/classes/struts.xml:12:61
  回复  更多评论
  

# re: Struts 2中的OGNL 2007-11-13 10:07 | java兄弟

难道一个包中只能写一个类吗？？？？  回复  更多评论
  

# re: Struts 2中的OGNL 2007-11-14 08:44 | 悟学

真的谢谢你  回复  更多评论
  

# re: Struts 2中的OGNL 2008-03-11 15:23 | lastsweetop

不错 自己写的忘记用IOC实现aware

很好很强大
  回复  更多评论
  

# re: Struts 2中的OGNL 2008-03-20 10:04 | yuan29346

写的太好了，我想把一部分贴到我的QQ空间，不知道可以不？呵呵  回复  更多评论
  

# re: Struts 2中的OGNL 2008-03-21 00:44 | 谢谢max:)

max你好,谢谢你的讲解,现在有这样一个问题请问:
Action里面有一个map已经传到页面,定义如下:
map bookCategoryMap<Ingerer,String>={"1":"计算机书籍","2":"文学书籍"}
在页面有一个book的list,在<s:iterator>中遍历book,book有一个字段category存的是int,现在要显示跟bookCategoryMap对应的字符串,如book.category为1则显示"计算机书籍",请问表达式应该怎样写? 在iterator里面总是取不到外面的map的值
谢谢!  回复  更多评论
  

# re: Struts 2中的OGNL 2008-03-22 10:55 | yuan29346

max你好:
我怎么样才能在JSP页面得到Action中的那个books列表？我把这个页面的代码复制到我的项目中，都没问题，就是在页面上得不到action中的数据，不论是request还是session 中的都不能得到，这个问题让我很困惑，是不是我那里没有配置对？
  回复  更多评论
  

# re: Struts 2中的OGNL 2008-03-22 11:31 | yuan29346

我已经把上面的问题解决了！呵呵 谢谢MAX
  回复  更多评论
  

# re: Struts 2中的OGNL 2008-05-07 21:43 | t

垃圾语法  回复  更多评论
  

# re: Struts 2中的OGNL 2008-06-04 00:45 | sway

books.{?#this.title=='Code Complete, Second Edition'}.{price}[0]
这样写让人很难理解.....
查阅了webwork和struts2的doc都没给出这种写法的解释....
books.{?#this.title=='Code Complete, Second Edition'}[0].price
这种写法似乎更容易理解,也更加符合规范.....

还望博主...解释下你所写的语句的意思.....

还有不推荐使用ServletRequestAware, SessionAware, ServletContextAware,用ActionContext吧....要不然又走回struts的老路了..呵呵....不好意思....班门弄斧了....  回复  更多评论
  

# Struts 2中的OGNL 2008-08-07 00:18 | wilson

博主您好!你讲得实在是太好了!
但是我还有一点不明白:就是标志的属性类型。我想知道的是标志的属性类型一般是什么呢？？？我想了很久都没弄明白，希望博主能帮一下忙！  回复  更多评论
  

# re: Struts 2中的OGNL 2008-08-13 14:54 | xmy

Users是一个对象，Message也是一个对象，在Message对象中有一个Users类型的属性，我现在通过Login这个action得到了一个Users对象，在登录成功页上也能得到Users对象中的属性值，但我想通过隐藏域把这个Users对象传到另一个MessageAction中得Message对象得user属性，应该如何实现？  回复  更多评论