Struts 2 概要说明

原创 2007年09月28日 15:53:00
概要
也 许每一本关于技术的书都应该有一个叫做HelloWorld的示例,应为这非常直观的表现了技术的特性。这本书也不特殊,在这一节中主要涉及一些 Strut 2 的基本特性的说明,包括,如何下载建立开发工程,一个Hello World JSP表示页面,使用标签,建立Action类,选择结果类型,校验输入数据,本地化输出。最后会给出一个包含上述特性的示例:用户登录

需要了解的技术
  • Java
  • Filters, JSP, and Tag Libraries
  • JavaBeans
  • HTML and HTTP
  • Web Containers (such as Tomcat)
  • XML

下载Struts 2 建立开发工程
这里的内容包括下载Struts2 框架,和建立一个简单的工程。

可以从Apache Struts 的官方站点(http://struts.apache.org)下载发布版本,当前最新的版本是2.0.9。下载的版本中包含struts2-core.jar和相关的依赖类库文件,示例程序,HTML格式的文档,和全部的源代码。

有三种方式建立struts2项目:使用空白的模板工程,使用Maven2的原型,或者万全手动的建立。

使用空白的模板工程
在 发布版本的apps目录下有一个空白的Web应用程序,这就是空白的Struts2模板工程。可以讲struts2-blank-2.x.war拷贝到服 务器的Webapps目录,服务器会自动的讲war文件解开,形成一个struts-blank-2.x的目录,这个目录可以作为Struts2工程开发 的基础。这个目录用有一个简单的批处理文件可以用来编译Java源文件,这个批处理文件的位置为:struts2-blank-2.x/WEB-INF/ src/java/example/build.bat
当然,由于war文件和zip文件具有相同的格式,所以也可以使用winzip,winrar,7-zip等工具将struts2-blank-2.x.war解压缩到一个目录中。

struts2-blank-2.x.war解压缩之后的目录结构为:
struts2-blank-2.x/
├─example                                         JSP文件目录
├─META-INF
└─WEB-INF                                        WEB-INF目录
    ├─classes                                      class文件目录
    │  └─example
    ├─lib                                             jar文件目录
    └─src                                            源代码目录
        └─java
            └─example

其中lib中的文件的列表为:
commons-logging-1.0.4.jar                   日志记录接口,可以配置选择使用jdk1.4 log 或者 log4j
freemarker-2.3.8.jar                            所有标签的模板都是用Freemarker编写
ognl-2.6.11.jar                                  Objet Graph NavigationLanguage,Struts2表达式的基础。
struts2-core-2.0.9.jar                         struts2框架类库
xwork-2.0.4.jar                                  xwork类库,struts2的基础

使用Maven原型建立Struts2应用
使用Maven的用户可以使用如下命令建立Struts2 的应用(为了方便阅读在在不同的行显示了如下内容,在开发中通常在一行书写完所有内容):

mvn archetype:create -DgroupId=tutorial /
                       -DartifactId=tutorial /
                       -DarchetypeGroupId=org.apache.struts /
                       -DarchetypeArtifactId=struts2-archetype-starter /
                       -DarchetypeVersion=2.0.9-SNAPSHOT /
                       -DremoteRepositories=http://people.apache.org/repo/m2-snapshot-repository
在使用不同版本的Struts2的时候可以灵活调整上述原型的版本。
使用Maven建立的Struts2应用的目录结构如下:
tutorial
└─src
    ├─main
    │  ├─java
    │  │  └─tutorial
    │  ├─resources
    │  └─webapp
    │      ├─jsp
    │      ├─styles
    │      └─WEB-INF
    │          └─decorators
    └─test
        ├─java
        │  └─tutorial
        └─resources

手动建立Struts2 应用

第一步,建立文件结构
/tutorial/
/tutorial/META-INF/
/tutorial/WEB-INF/
/tutorial/WEB-INF/classes/
/tutorial/WEB-INF/classes/struts.xml
/tutorial/WEB-INF/lib/
/tutorial/WEB-INF/web.xml

第二步,拷贝必要的jar文件到/tutorial/WEB-INF/lib/

第三步,添加配置文件
web.xml Java Web应用程序配置文件,在这个文件中定义了Struts 2 的过滤器
struts.xml    Struts2 框架的配置文件,在这个配置文件中定义了Action,Result,和程序的拦截器(Interceptor)

第四步,web.xml文件内容
<?xml version="1.0"?>
<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd">

<web-app>
  <display-name>My Application</display-name>
  <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>
</web-app>
第五步,struts.xml 文件内容
<!DOCTYPE struts PUBLIC
    "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
    "http://struts.apache.org/dtds/struts-2.0.dtd">

<struts>
    <!-- Configuration for the default package. -->
    <package name="default" extends="struts-default">
         ...
    </package>
</struts>

Hello World 页面
一下建立一个HelloWorld页面。
当 想Struts2提交一个请求的时候,输入的数据并没有直接送给下一个页面,而是送给了一个你提供的Java类。这种Java类被称为Action。当 Action执行之后,Struts2会选择一个结果作为返回,通常情况下是一个JSP页面,但是也可以是PDF文件,Excel表单或者Java Applet窗口。

假如你想创建一个Hello World 示例,这个示例显示一个欢迎消息。那么首先你需要按照上一节的内容建立一个空的tutorial工程,之后还需要做如下内容:
  1. 创建一个JSP页面来显示欢迎消息
  2. 创建一个Action类来生成欢迎消息
  3. 创建一个配置项来关联上述的Action和JSP页面

创建一个JSP页面
<%@ taglib prefix="s" uri="/struts-tags" %>

<html>
    <head>
        <title>Hello World!</title>
    </head>
    <body>
        <h2><s:property value="message" /></h2>
    </body>
</html>

第一行引入了struts2的标签库,在之后的页面中可以使用s标签了。这行在几乎所有的struts2应用的jsp页面中都会出现
<s:property value="message" /> 表示要将上下文环境中的message输出,这里的上下文暂时可以理解为对应Action中的属性。

创建Action类
package tutorial;
import com.opensymphony.xwork2.ActionSupport;
public class HelloWorld extends ActionSupport {

    public static final String MESSAGE = "Struts is up and running ...";

    public String execute() throws Exception {
        setMessage(MESSAGE);
        return SUCCESS;
    }

    private String message;

    public void setMessage(String message){
        this.message = message;
    }

    public String getMessage() {
        return message;
    }
}

上述的Action类中有一个message属性,用来显示。
execute方法用来处理业务操作,这里只是讲MESSAGE赋值给message属性。

创建配置项关联JSP和Action
<!DOCTYPE struts PUBLIC
"-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
"http://struts.apache.org/dtds/struts-2.0.dtd">
<struts>
<package name="tutorial" extends="struts-default">
<action name="HelloWorld" class="tutorial.HelloWorld">
<result>/HelloWorld.jsp</result>
</action>
<!-- Add your actions here -->
</package>
</struts>
使用 Maven 2 的情况下可以使用命令: mvn jetty:run 来部署运行Web程序。
现在将程序部署,运行如下链接:
http://localhost:8080/tutorial/HelloWorld.action
可以看到如下输出页面:



工作原理
当浏览器发送请求 http://localhost:8080/tutorial/HelloWorld.action 的时候,在服务器上发生了如下事件:

  1. 服务器接收到对HelloWorld.action的请求,根据web.xml文件中的配置,所有以.action结尾的请求都会被 org.apache.struts2.dispatcher.FilterDispatcher过滤,所以这个请求被发送给 FilterDispatcher,FilterDispatcher是Struts 2 框架的入口点。
  2. Struts 2 框架查找HelloWorld.action对应的Java 类,发现是HelloWorld.java,之后Struts 2 框架实例化了一个HelloWorld类,并且调用了这个类的execute方法。
  3. execute方法设置了message的内容,并且返回SUCCESS。框架却定返回值SUCCESS,并且找到对应的内容HelloWorld.jsp,并且通知服务器将HelloWorld.jsp作为返回内容。
  4. 在HelloWorld.jsp被处理的过程中,<s:property value="message" />标签的内容被替换为HelloWorld 的getMessage方法调用的结果
  5. 根据HelloWorld.jsp内容生成的HTML内容被发回到请求的浏览器。

编写HelloWorld Action类的测试类
可以使用JUnit编写Testcase来测试HelloWorld,应为HelloWorld Action类是一个POJO类,所以不需要Mock对象来模拟HTTP环境。

package tutorial;
import junit.framework.TestCase;
import com.opensymphony.xwork2.Action;
import com.opensymphony.xwork2.ActionSupport;

public class HelloWorldTest extends TestCase {
  public void testHelloWorld() throws Exception {

    HelloWorld hello_world = new HelloWorld();
    String result = hello_world.execute();

    assertTrue("Expected a success result!",
      ActionSupport.SUCCESS.equals(result));

    assertTrue("Expected the default message!",
      HelloWorld.MESSAGE.equals(hello_world.getMessage()));

    }
}

使用标签
所有的JSP标签都是为了产生动态的内容,Struts2 的标签库也不例外。

例如需要产生一个如下的页面:


需要如下的代码:
<%@ taglib prefix="s" uri="/struts-tags" %>
<html>
<head>
    <title>Welcome</title>
    <link href="<s:url value="/css/tutorial.css"/>" rel="stylesheet"
          type="text/css"/>css
</head>
<body>
<h3>Commands</h3>
<ul>
    <li><a href="<s:url action="Register"/>">Register</a></li>
    <li><a href="<s:url action="Logon"/>">Sign On</a></li>
</ul>
</body>
</html>

另外一个常见的页面是低于选择的页面,如下:

需要如下的代码:
<body>
<h2><s:property value="message"/></h2>

<h3>Languages</h3>
<ul>
    <li>
        <s:url id="url" action="HelloWorld">
            <s:param name="request_locale">en</s:param>
        </s:url>
        <s:a href="%{url}">English</s:a>
    </li>
    <li>
        <s:url id="url" action="HelloWorld">
            <s:param name="request_locale">es</s:param>
        </s:url>
        <s:a href="%{url}">Espanol</s:a>
    </li>
</ul>
</body>

代码工作原理
"%{url}"将会使用s:url标签定义的内容。在Welcoem和HelloWorld页面,我们使用了两个不同的Struts 2 标签来创建了三种类型的链接
  • 资源链接
  • 链接
  • 带参数的链接

我们依次看不同的链接:

资源链接
在head内部,我们使用url标签插入了一个css的链接:

<link href="<s:url value="/css/tutorial.css"/>"
  rel="stylesheet" type="text/css"/>
因为上述链接使用了绝对路径,那么我们就可以随便移动这个页面的目录,而不用担心无法找到对应的css文件。

链接
我们可以使用url标签建立一个指向Action的链接,如下:

<li><a href="<s:url action="Register"/>">Register</a></li>

当链接被表示的时候,href会被自动的加上“.action”后缀,因此我们不需要在JSP代码里到处添加“.action”后缀。
如果需要,url标签还会自动的追加java Session ID,以便在不同的Request之间保持同一个会话。

带参数的链接
在地域选择的页面中我们使用了一个新的标签param,使用这个标签可以向url标签中添加参数。例如:

<s:url id="url" action="Welcome">
  <s:param name="request_locale">en</s:param>
</s:url>
<s:a href="%{url}">English</s:a>

param标签会在url标签生成的内容后追加"?request_locale=en" 。可以通过追加多个param标签来在url后边追加多个参数。

通配符
应为Welcome页面只有链接,所以我们没有必要使用一个Action类,但是我们又想使用一个Action形式的url来关联到这个页面,那么怎么做呢?

<action name="Welcome" >
  <result>/tutorial/Welcome.jsp</result>
</action>
我们可以使用上述的代码。

另外为了方便的处理多个JSP页面,我们也可以在struts.xml中这样的声明:

<action name="*" >
  <result>/tutorial/{1}.jsp</result>
</action>

如何工作呢?
如果没有任何的映射匹配,例如请求:http://localhost:8080/tutorial/Welcome.action。那么框架会做如下步骤
首先把Welcome当作*对应的内容
然后在result中使用Welcome替换掉{1}的内容。

相似的如果有一个指向Login.action的请求,那么会定位到/Login.jsp
使用通配符可以建立自己的映射规则,省区逐个配置的困扰。

Form标签
如下Form

代码为:
<%@ taglib prefix="s" uri="/struts-tags" %>
<html>
<head>
  <title>Login</title>
</head>
<body>
<s:form action="Logon">
  <s:textfield label="User Name" name="username"/>
  <s:password label="Password" name="password" />
  <s:submit/>
</s:form>
</body>
</html>

Action类

为上述的Logon页面添加一个Action
package tutorial;

import com.opensymphony.xwork2.ActionSupport;

public class Logon extends ActionSupport {

    public String execute() throws Exception {

        if (isInvalid(getUsername())) return INPUT;
        if (isInvalid(getPassword())) return INPUT;
        return SUCCESS;
    }

    private boolean isInvalid(String value) {
        return (value == null || value.length() == 0);
    }

    private String username;
    public String getUsername() {
        return username;
    }
    public void setUsername(String username) {
        this.username = username;
    }

    private String password;
    public String getPassword() {
        return password;
    }
    public void setPassword(String password) {
        this.password = password;
    }

}

结果类型(Result Type)
Action 处理完成之后,会选择一个结果返回给客户,这个结果可能是简单的HTML页面,JSP页面,FreeMarker模板,Velocity模板,或者是一个 PDF文旦个或者是更复杂的JasperReports。一个Action可能有几个可选的结果类型,为了决定到底使用那个结果类型,Action类的 execute方法必须返回一个标记结果类型的字符串。
struts.xml
<action name="Logon" class="tutorial.Logon">
  <result type="redirect-action">Menu</result>
  <result name="input">/tutorial/Logon.jsp</result>
</action>
如果我们输入了用户名和密码,Logon Action会返回“success”。"success"是默认的返回结果,这个时候会使用Menu action作为结果。
如果我们什么也不输入,Logon Action 会返回"input", Struts 2会使用Logon.jsp 作为结果返回。
校验输入内容

代码

校验通过XML配置或者使用Java 5 的Annotation来标记。xml配置文件的名字是Action名字之后追加"-validation"后缀。例如我们要校验Logon Action那么XML配置文件的名字为:Logon-validation.xml,内容为:


<!DOCTYPE validators PUBLIC
"-//OpenSymphony Group//XWork Validator 1.0.2//EN"
"http://www.opensymphony.com/xwork/xwork-validator-1.0.2.dtd">

<validators>
    <field name="username">
        <field-validator type="requiredstring">
            <message>Username is required</message>
        </field-validator>
    </field>
    <field name="password">
        <field-validator type="requiredstring">
            <message>Password is required</message>
        </field-validator>
    </field>
</validators>

这个文件放在Logon.class相同的目录中。



The first time a page displays, we wouldn't want the validation to fire. We should have a chance to enter the input before being told it's incorrect. One way to bypass validation is to refer to a special "input" method provided by the base ActionSupport class. To do that, we need to edit the Welcome page and the Logon mapping.

To indicate the changes, we'll use  to indicate a line we are removing, and  to indicated a line we are adding.

Welcome.jsp
 <li><a href="<s:url action="Logon"/>">Sign On</a></li>
 <li><a href="<s:url action="Logon_input"/>">Sign On</a></li>

struts.xml
 <action name="Logon" class="tutorial.Logon">
 <action name="Logon_*" method="{1}" class="tutorial.Logon">


如何工作
但提交Logon表单的时候,Struts 2 校验Logon Action类对应的内容。首先找到对应的xml配置文件,这里是Logon-validation.xml,Struts 2 根据xml配置文件创建校验需要的Java类(Validator),最后这些Java类逐个的针对上传的属性执行校验功能。
如果校验错误,会把对应的错误信息放在一个消息队列中,之后Struts2 迁移到对应的input页面,再把错误内容在input页面显示。


国际化 

Struts 2 框架会把Message文件自动关联到Action类。例如要把一个Message文件也Logon Action类关联,我们只需要创建一个叫做Logon.properties的文件,并且把文件放在Logon.class文件的目录中即可。

当然为了方便你也可以将所有的内容放在一个文件中而不是每个Action一个资源文件,这样你只需要做一个package.properties文件放在对应的目录中即可。例如tutorial/package.properties


requiredstring = $/{getText(fieldName)} is required.
password = Password
username = User Name


这个时候需要修改校验配置文件,在其中追加消息定义部分。

Logon-validation.xml
<message>Username is required</message>
<message key="requiredstring"/>

<message>Password is required</message>
<message key="requiredstring"/>


Logon.jsp
 <s:textfield label="User Name" name="username"/>
 <s:textfield label="%{getText('username')}" name="username"/>

 <s:password label="Password" name="password" />
 <s:password label="%{getText('password')}" name="password" />


如何工作呢?
${getText(fieldName)}

这个表达式告诉标签从资源文件中取得内容,例如:
%{getText('password')}


tutorial/package.properties
# ...
HelloWorld.message = Struts is up and running ...
Missing.message = This feature is under construction. Please try again in the next interation.


也可以在代码中使用属性文件获得内容。

HelloWorld.java
package tutorial;

public class HelloWorld extends ExampleSupport {

    public static final String MESSAGE = "HelloWorld.message";

    public String execute() throws Exception {
        setMessage(getText(MESSAGE));
        return SUCCESS;
    }

  // ...
}

 

 

 

 

 

 

 

 

相关文章推荐

Struts 2 概要说明

概要 也 许每一本关于技术的书都应该有一个叫做HelloWorld的示例,应为这非常直观的表现了技术的特性。这本书也不特殊,在这一节中主要涉及一些 Strut 2 的基本特性的说明,包括,如何下载建...

Struts 2中访问Servlet API的几种方法小结

在Struts 2框架中,Action与Servlet API相分离,使得Action无法访问Servlet API,将不能使用session、application等。为了解决这个问题,Struts...

Struts 2中的表达式语言

Struts 2支持以下几种表达式语言: OGNL(Object-Graph Navigation Language),可以方便地操作对象属性的开源表达式语言;JSTL(JSP Standard...

Struts 2最新0day破坏性漏洞(远程任意代码执行)等的重现方法

Struts 2的远程任意代码执行和重定向漏洞,是这两天互联网上最重大的安全事件,据说国内互联网企业中,很多电商纷纷中招,应该已经有大规模的用户隐私泄露。这里我们简单总结下怎样在自己机子上重现这些漏洞...

Struts 2 Spring Hibernate三大框架的执行流程以及原理

转:http://www.cnblogs.com/System-out-println/p/5974113.html Struts2框架 一、简介 Struts2是一个相当强大的Java Web...
  • xjy9266
  • xjy9266
  • 2017年07月19日 14:11
  • 96

使用Struts 2将客户端JSON数据映射为服务器端Java对象

上文(使用 Struts 2将Java对象序列化成JSON)介绍了如何将Java对象序列化成JSON格式并传到客户端。这篇文章就说说如何将客户端的JSON数据映射为服务器端的Java对象。   p...
  • eengel
  • eengel
  • 2013年04月17日 13:23
  • 5703

在 Struts 2 中自定义支持 OGNL 的标签

原文链接http://blog.psjay.com/posts/customize-tags-which-supporting-ognl-in-struts-2/ 最近在用 St...

Struts 2 Quick Guide

Struts2 is popular and mature web application framework based on the MVC design pattern. Struts2 is ...
  • panjone
  • panjone
  • 2012年06月19日 10:33
  • 863

Struts 2 流程

1、客户端初始化一个指向Servlet容器(例如Tomcat)的请求;2、这个请求经过一系列的过滤器(Filter)(这些过滤器中有一个叫做ActionContextCleanUp的可选过滤器,这个过...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:Struts 2 概要说明
举报原因:
原因补充:

(最多只允许输入30个字)