Struts2 验证框架

OStack程序员社区-中国程序员成长平台 › 门户 › 编程› 开发框架›Struts2 教程

原作者: [db:作者] 来自: [db:来源] 收藏邀请

这章我们将研究Struts的验证框架。Struts的核心中的验证框架，可在执行action方法之前，帮助应用程序运行规则执行验证。
客户端验证通常使用Javascript实现，但是不能仅仅依赖于客户端验证。实践表明，应该在应用程序框架的所有级别引入验证。接下来让我们看一下给Struts项目添加验证的两种方法。
我们举一个Employee的例子，employee的名字和年龄将使用一个简单的页面捕获，我们会进行两次验证，以确保用户始终输入一个名称，并且年龄是在28和65之间。那么让我们先从示例的JSP主页面开始。

创建主页

我们接下来编写用于收集employee的相关信息的JSP文件index.jsp。

<%@ page language="java" contentType="text/html; charset=ISO-8859-1"
   pageEncoding="ISO-8859-1"%>
<%@ taglib prefix="s" uri="/struts-tags"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" 
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Employee Form</title>
</head>

<body>
   <s:form action="empinfo" method="post">
      <s:textfield name="name" label="Name" size="20" />
      <s:textfield name="age" label="Age" size="20" />
      <s:submit name="submit" label="Submit" align="center" />
   </s:form>
</body>
</html>

index.jsp使用Struts标签，目前我们还没有学习到，不过会在标签相关的章节中学习它们。现在，假设s:textfield标签印出一个输入框，并且s:submit印出一个提交按钮。我们为每个标签使用了label属性，即为每个标签创建label。

创建视图

我们将使用在action返回SUCCESS的情况下调用的JSP文件success.jsp。

<%@ page language="java" contentType="text/html; charset=ISO-8859-1"
	pageEncoding="ISO-8859-1"%>
<%@ taglib prefix="s" uri="/struts-tags"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" 
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Success</title>
</head>
<body>
   Employee Information is captured successfully.
</body>
</html>

创建Action

那么，让我们定义一个小的action类：Employee，然后添加一个名为validate()的方法，如下Employee.java文件所示。确保action类扩展了ActionSupport类，否则将不会执行validate方法。

package cn.ogeek.struts2;

import com.opensymphony.xwork2.ActionSupport;

public class Employee extends ActionSupport{
   private String name;
   private int age;
   
   public String execute() 
   {
       return SUCCESS;
   }
   public String getName() {
       return name;
   }
   public void setName(String name) {
       this.name = name;
   }
   public int getAge() {
       return age;
   }
   public void setAge(int age) {
       this.age = age;
   }

   public void validate()
   {
      if (name == null || name.trim().equals(""))
      {
         addFieldError("name","The name is required");
      }
      if (age < 28 || age > 65)
      {
         addFieldError("age","Age must be in between 28 and 65");
      }
   }
}

如上例所示，验证方法首先检查“Name”字段是否具有值。如果没有任何值，则会为“Name”字段添加一个字段“错误”，并显示自定义的错误消息。其次，检查“年龄”字段的输入值是否在28和65之间，如果不符合这个条件，我们在验证字段之上添加一个错误。

配置文件

最后，让我们使用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="helloworld" extends="struts-default">

      <action name="empinfo" 
         class="cn.ogeek.struts2.Employee"
         method="execute">
         <result name="input">/index.jsp</result>
         <result name="success">/success.jsp</result>
      </action>

   </package>

</struts>

以下是web.xml文件的内容：

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://java.sun.com/xml/ns/javaee"
   xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
   xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
   http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
   id="WebApp_ID" version="3.0">

   <display-name>Struts 2</display-name>
   <welcome-file-list>
      <welcome-file>index.jsp</welcome-file>
   </welcome-file-list>

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

现在，右键单击项目名称，然后单击“Export”> “WAR File”以创建WAR文件。然后在Tomcat的webapps目录中部署WAR文件。最后，启动Tomcat服务器并尝试访问URL http://localhost:8080/HelloWorldStruts2/index.jsp，将显示以下界面：

现在不输入任何信息，只点击Submit按钮，将看到以下结果：

输入所要求的信息而非错误类的字段，如名称为“text”，年龄为30，然后点击Submit按钮，可以看到以下界面：

这个验证是如何进行的？

当用户按下提交按钮时，Struts2 将自动执行validate方法，如果方法中列出的任何if语句为真，Struts2 将调用addFieldError方法。如果添加了任何错误信息，Struts2 将不会调用execute方法。否则，Struts2 框架将返回input作为调用操作的结果。
因此，当验证失败并且Struts2 返回input时，Struts2 框架将重新显示index.jsp文件。由于我们使用Struts2 的form标签，Struts2 会自动在form字段上方添加错误信息。
这些错误信息是我们在addFieldError方法调用中指定的信息。addFieldError方法接受两个参数，第一个是出错时应用的form字段名称，第二个是在form字段上方显示的错误信息。

addFieldError("name","The name is required");

要处理input的返回值，我们需要将以下结果添加到struts.xml中的action节点。

<result name="input">/index.jsp</result>

XML验证

第二种进行验证的方法是在action类旁边放置一个xml文件。Struts2 基于XML的验证提供了更多的验证方式，如email验证、integer range验证、form验证、expression验证、regex验证、required验证、requiredstring验证、stringlength验证等。
xml文件需要命名为'[action-class]'-validation.xml。因此，在我们的示例中，创建了一个名为Employee-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="name">
      <field-validator type="required">
         <message>
            The name is required.
         </message>
      </field-validator>
   </field>

   <field name="age">
     <field-validator type="int">
         <param name="min">29</param>
         <param name="max">64</param>
         <message>
            Age must be in between 28 and 65
         </message>
      </field-validator>
   </field>
</validators>

上面的XML文件将保存在CLASSPATH中，理想情况下是与类文件一起保存。以下是没有validate()方法的Employee action类：

package cn.ogeek.struts2;

import com.opensymphony.xwork2.ActionSupport;

public class Employee extends ActionSupport{
   private String name;
   private int age;
   
   public String execute() 
   {
       return SUCCESS;
   }
   public String getName() {
       return name;
   }
   public void setName(String name) {
       this.name = name;
   }
   public int getAge() {
       return age;
   }
   public void setAge(int age) {
       this.age = age;
   }
}

其余的设置将保持，如同前面的例子一样。现在如果你运行应用程序，它将产生与我们前面例子相同的结果。

使用xml文件来存储配置的优点是允许验证与应用程序代码分离。你可以让开发人员编写代码，让测试人员来创建xml验证文件。另一个需要注意的是默认情况下可用的验证器。Struts有许多默认的验证器，常见的包括：Date验证器，Regex验证器和String Length验证器。点击以下链接可以了解更多“Struts2-XML验证器”的详细信息。