Struts 2验证框架


在本章中,我们将深入研究Struts验证框架。在Struts核心中,我们有一个验证框架,它协助应用程序在执行操作方法之前运行规则来执行验证。

客户端验证通常使用Javascript实现。但是,不应该仅仅依靠客户端验证。最佳实践表明验证应该在您的应用程序框架的各个层次上引入。现在让我们看看两种向我们的Struts项目添加验证的方法。

在这里,我们将举一个 雇员 的例子,他的姓名和年龄应该用一个简单的页面来捕捉,我们将把这两个验证放在一起,以确保用户总是输入一个名字和年龄,该年龄应该在28到28之间65。

让我们从示例的主JSP页面开始。

创建主页面

让我们编写主页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打印提交按钮。我们为每个标签使用了标签属性,为每个标签创建标签。

创建视图

我们将使用JSP文件success.jsp,在定义的操作返回SUCCESS的情况下将调用该文件。

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

创建行动

因此,让我们定义一个小的操作类 Employee ,然后添加一个名为 validate() 的方法,如 Employee.java 文件中所示。确保你的动作类扩展了 ActionSupport 类,否则你的validate方法将不会被执行。

package com.CodingDict.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");
      }
   }
}

如上例所示,验证方法检查'姓名'字段是否有值。如果没有提供任何值,我们会为“名称”字段添加一个字段错误并附带自定义错误消息。其次,我们检查'年龄'字段的输入值是否在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 = "com.CodingDict.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>

现在,右键单击项目名称,然后单击 导出 > WAR文件创建一个 WAR 文件。然后将这个WAR部署到Tomcat的webapps目录中。最后,启动Tomcat服务器并尝试访问URL http:// localhost:8080 / HelloWorldStruts2 / index.jsp 。这将产生以下屏幕 -

Email用户输入

现在不要输入任何所需的信息,只需点击 提交 按钮。你会看到下面的结果 -

错误

输入所需的信息,但输入错误的From字段,让我们说,名称为“测试”,年龄为30,最后点击 提交 按钮。你会看到下面的结果 -

成功

验证如何工作?

当用户按下提交按钮时,Struts 2将自动执行验证方法,如果方法中列出的任何 “if” 语句为真,则Struts 2将调用其addFieldError方法。如果添加了任何错误,那么Struts 2将不会继续调用execute方法。相反,Struts 2框架将作为调用操作的结果返回 输入

因此,当验证失败并且Struts 2返回 输入时 ,Struts 2框架将重新显示index.jsp文件。因为我们使用了Struts 2表单标签,所以Struts 2会自动在表单提交之上添加错误信息。

这些错误消息是我们在addFieldError方法调用中指定的错误消息。addFieldError方法有两个参数。第一个是错误适用的 表单 字段名称,第二个是显示在该表单字段上方的错误消息。

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

为了处理 输入 的返回值,我们需要在 struts.xml 中将下面的结果添加到我们的动作节点中。

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

基于XML的验证

做验证的第二种方法是在动作类旁边放置一个xml文件。Struts2基于XML的验证提供了更多的验证选项,如电子邮件验证,整数范围验证,表单验证字段,表达式验证,正则表达式验证,所需验证,必需字符串验证,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中。让我们让我们的Employee操作类如下所示,而无需 验证() 方法 -

package com.CodingDict.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默认会有更多的验证器。常见的验证器包括日期验证器,正则表达式验证器和字符串长度验证器。