Struts2中的OGNL-白红宇

Struts2中的OGNL

阅读量：7093 次

发布时间：2019-06-28

本文共 8553 字，大约阅读时间需要 28 分钟。

一直想写一个关于struts2的系列文章，之前写过一个关struts2拦截器的随笔，以后我将陆续写写一些关于struts2的东西，这既是对自己学习的一种检验，也是给自己做一份记录，希望在这个过程中能给大家一些帮助，请大家关注。

什么是OGNL

OGNL 英文Object-Graph Navigation Language（对象导航语言），听着挺悬乎，其实就是一种表达式语言，

OGNL是一种强大的技术，它被集成在Struts2中，用来帮助数据转移和类型转换。

　　我们使用OGNL表达式将java端的数据属性和基于文本的视图层中的字符串绑定起来，这通常出现在表单输入字段的name属性或者struts2标签的各种属性中，

在通常的使用情况中，表达式语言的简单性，规范性使得学习的曲线非常低，这对于我们学习及应用，以至于实际开发当中都是非常有利。

<s：property value="name">

OGNL表达式语言是value属性双引号之间的片段，这个struts2 property标签从某个java对象的一个属性值中取值，之后将写入到HTML中代替这个标签，这是表达式语言的要点。

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

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

避免(MyType) request.getAttribute()和myBean.getMyProperty()之类的语句，使页面更简洁；

支持运算符（如+-*/），比普通的标志具有更高的自由度和更强的功能；

简单明了地表达代码逻辑，使用代码更可读与便于维护。

OGNL如何融入框架

数据进入，当请求进入框架时，它作为一个HttpServletRequest对象公开给java语言，像我们之前知道的Struts建立在servlet api上，请求参数被作为名、值对存储，名字和值都是string类型。接下来框架开始出来来源这些请求参数的的数据的转移及类型的转换。OGNL自动将数据转移到ValueStack的对象上，我们把user对象作为动作组件javabean属性公开出来，将动作对象放到valuestack上，我们已经准备好让OGNL做导航型的工作。

从拦截器的学习知道，param拦截器将会把请求的数据转移到valuestack上，这个工作微妙的地方就是将参数映射到valuestack上的一个真实属性，从图中国可以看出，你期望表达式会更像myAction.user.name,而实际只有user.name是必要的。

Struts 2中的表达式语言

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

OGNL（Object-Graph Navigation Language），可以方便地操作对象属性的开源表达式语言；

JSTL（JSP Standard Tag Library），JSP 2.0集成的标准的表达式语言；

Groovy，基于Java平台的动态语言，它具有时下比较流行的动态语言（如Python、Ruby和Smarttalk等）的一些起特性；

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的用法

　　　大家经常遇到的问题是#、%和$这三个符号的使用。下面我想通过例子讲述这个问题：

首先新建名为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

="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

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

filter-mapping

welcome-file-list

welcome-file

index.html

welcome-file

welcome-file-list

web-app

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

“#”主要有三种用途：

访问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属性，直到找到为止

用于过滤和投影（projecting)集合，如books.{?#this.price<100}；

构造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

{

privatestaticfinallong serialVersionUID =1L;

private HttpServletRequest request;

private Map<String, String> session;

private ServletContext application;

private List<Book> books;

publicvoid setServletRequest(HttpServletRequest request) {

this.request = request;

}

@SuppressWarnings("unchecked")

publicvoid setSession(Map session) {

this.session = session;

}

publicvoid 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的代码大家可以在我前一文章《》看到。

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

@ page language

java

contentType

text/html; charset=utf-8

pageEncoding

utf-8

@ taglib prefix

uri

/struts-tags

DOCTYPE html PUBLIC "-//W3C//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

访问OGNL上下文和Action上下文

parameters:

s:property

value

="#parameters.userName"

/></

request.userName:

s:property

value

="#request.userName"

/></

session.userName:

s:property

value

="#session.userName"

/></

application.userName:

s:property

value

="#application.userName"

/></

attr.userName:

s:property

value

="#attr.userName"

/></

用于过滤和投影（projecting)集合

Books more than $35

s:iterator

value

="books.{?#this.price > 35}"

s:property

value

="title"

- $

s:property

value

="price"

/></

s:iterator

The price of "Code Complete, Second Edition" is:

s:property

value

="books.{?#this.title=='Code Complete, Second Edition'}.{price}[0]"

/></

构造Map

s:set

name

="foobar"

value

="#{'foo1':'bar1', 'foo2':'bar2'}"

The value of key "foo1" is

s:property

value

="#foobar['foo1']"

/></

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