Struts 2 - 注释


如前所述,Struts 提供两种形式的配置。传统方法是使用struts.xml文件进行所有配置。到目前为止,我们在教程中已经看到了很多这样的例子。配置 Struts 的另一种方法是使用 Java 5 注释功能。使用struts注解,我们可以实现零配置

要开始在项目中使用注释,请确保已在WebContent/WEB-INF/lib文件夹中包含以下 jar 文件 -

  • struts2-约定-插件-xyzjar
  • asm-xyjar
  • antlr-xyzjar
  • 公共文件上传-xyzjar
  • 公共 io-xyzjar
  • commons-lang-xyjar
  • 公共日志记录 xyzjar
  • commons-logging-api-xyjar
  • freemarker-xyzjar
  • javassist-.xy.z.GA
  • 奥格尼-xyzjar
  • struts2-核心-xyzjar
  • xwork-core.xyzjar

现在,让我们看看如何取消struts.xml文件中的可用配置并将其替换为注释。

为了解释 Struts2 中注释的概念,我们必须重新考虑Struts2 验证章节中解释的验证示例。

在这里,我们将以一个员工为例,其姓名、年龄将使用一个简单的页面捕获,我们将进行两次验证以确保 ÜSER 始终输入姓名,年龄应在 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 打印提交按钮。我们为每个标签使用了 label 属性,它为每个标签创建标签。

创建视图

我们将使用 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,然后在Employee.java文件中添加一个名为validate()的方法,如下所示。确保您的操作类扩展了ActionSupport类,否则您的 validate 方法将不会被执行。

package com.tutorialspoint.struts2;

import com.opensymphony.xwork2.ActionSupport;
import org.apache.struts2.convention.annotation.Action;
import org.apache.struts2.convention.annotation.Result;
import org.apache.struts2.convention.annotation.Results;
import com.opensymphony.xwork2.validator.annotations.*;

@Results({
   @Result(name = "success", Location = "/success.jsp"),
   @Result(name = "input", Location = "/index.jsp")
})
public class Employee extends ActionSupport {
   private String name;
   private int age;

   @Action(value = "/empinfo")
   
   public String execute() {
      return SUCCESS;
   }

   @RequiredFieldValidator( message = "The name is required" )
   
   public String getName() {
      return name;
   }
   
   public void setName(String name) {
      this.name = name;
   }

   @IntRangeFieldValidator(message = "Age must be in between 28 and 65", min = "29", max = "65")
   
   public int getAge() {
      return age;
   }
   
   public void setAge(int age) {
      this.age = age;
   }
}

我们在这个例子中使用了一些注释。让我一一介绍一下 -

  • 首先,我们添加了结果注释。结果注释是结果的集合。

  • 在结果注释下,我们有两个结果注释。结果注释的名称执行方法的结果相对应。它们还包含一个位置,该位置应提供与execute()的返回值相对应的视图

  • 下一个注释是Action注释。这用于装饰execute() 方法。Action 方法还接受一个值,该值是调用该操作的 URL。

  • 最后,我使用了两个验证注释。我已经在名称字段上配置了必需的字段验证器,在年龄字段上配置了整数范围验证器。我还为验证指定了一条自定义消息。

配置文件

我们确实不需要struts.xml配置文件,所以让我们删除这个文件并检查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>
      
      <init-param>
         <param-name>struts.devMode</param-name>
         <param-value>true</param-value>
      </init-param>
   </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。这将产生以下屏幕 -

通过电子邮件发送用户输入

现在不要输入任何必需的信息,只需单击“提交”按钮即可。您将看到以下结果 -

错误

输入所需信息,但在“发件人”字段中输入错误,假设姓名为“test”,年龄为 30,最后单击“提交”按钮。您将看到以下结果 -

成功

Struts 2 注释类型

Struts 2 应用程序可以使用 Java 5 注释作为 XML 和 Java 属性配置的替代方案。您可以检查与不同类别相关的最重要注释的列表 -

Struts 2 注释类型