Struts 2 - 注解

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

要在您的项目中开始使用注解，请确保您已将以下 jar 文件包含在您的WebContent/WEB-INF/lib文件夹中：

struts2-convention-plugin-x.y.z.jar
asm-x.y.jar
antlr-x.y.z.jar
commons-fileupload-x.y.z.jar
commons-io-x.y.z.jar
commons-lang-x.y.jar
commons-logging-x.y.z.jar
commons-logging-api-x.y.jar
freemarker-x.y.z.jar
javassist-.xy.z.GA
ognl-x.y.z.jar
struts2-core-x.y.z.jar
xwork-core.x.y.z.jar

现在，让我们看看如何摆脱struts.xml文件中可用的配置，并用注解替换它。

为了解释 Struts2 中注解的概念，我们将不得不重新考虑我们在Struts2 验证章节中解释的验证示例。

在这里，我们将以一个员工为例，其姓名和年龄将通过一个简单的页面捕获，我们将进行两次验证，以确保用户始终输入姓名，并且年龄应在 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，该文件将在定义的 action 返回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>

创建 Action

这是使用注解的地方。让我们使用注解重新定义 action 类Employee，然后添加一个名为validate()的方法，如下所示，在Employee.java文件中。请确保您的 action 类扩展了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;
   }
}

在这个例子中，我们使用了一些注解。让我逐一介绍它们：

首先，我们包含了Results注解。Results 注解是结果的集合。
在 results 注解下，我们有两个 result 注解。result 注解具有与 execute 方法的结果相对应的name。它们还包含一个位置，指示应提供与 execute() 返回值相对应的哪个视图。
下一个注解是Action注解。它用于装饰 execute() 方法。Action 方法还接收一个值，该值是调用 action 的 URL。
最后，我使用了两个validation注解。我在name字段上配置了 required field validator，在age字段上配置了 integer range validator。我还为验证指定了自定义消息。

配置文件

我们确实不需要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 服务器，并尝试访问 URLhttps://:8080/HelloWorldStruts2/index.jsp。这将生成以下屏幕：

现在不要输入任何必需的信息，只需单击提交按钮。您将看到以下结果：

输入所需信息，但输入错误的 From 字段，例如将 name 设为“test”，将 age 设为 30，最后单击提交按钮。您将看到以下结果：

Struts 2 注解类型

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

Struts 2 注解类型.

打印页面