Struts 2 - 注解

更新于 2025/4/2 11:22:17

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

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

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-l ogging-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 验证一章中解释的验证示例。

在这里，我们将以一个员工为例，他的姓名、年龄将使用一个简单的页面捕获，我们将进行两次验证，以确保 Ü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;
   }
}

我们在这个例子中使用了几个注解。让我一一介绍一下 −

首先，我们包含了 Results 注解。Results 注解是结果的集合。
在结果注解下，我们有两个结果注解。结果注解具有与执行方法的结果相对应的 name。它们还包含一个位置，即应该提供哪个视图，对应于来自 execute() 的返回值
下一个注解是 Action 注解。这用于修饰 execute() 方法。Action 方法还接受一个值，该值是调用操作的 URL。
最后，我使用了两个 validation 注解。我已经在 name 字段上配置了必填字段验证器，并在 age 字段上配置了整数范围验证器。我还为验证指定了自定义消息。

配置文件

我们确实不需要 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。这将产生以下屏幕 −