教程 > Struts 教程 > Struts 基础 阅读：18

Struts 2 注解

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

要开始在项目中使用注解，请确保我们已在 Web/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-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 页面 index.jsp 开始。用于收集上面提到的 Employee 相关信息。

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%@ taglib prefix = "s" uri = "/struts-tags"%>
<html>
  <head>
    <title>Hello 迹忆客(jiyik.com)</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>

创建 Action

这是使用注解的地方。 让我们用注解重新定义动作类 Employee，然后在 Employee.java 文件中添加一个名为 validate() 的方法，如下所示。 确保我们的操作类继承了 ActionSupport 类，否则我们验证方法将不会被执行。

package com.jiyik.struts2.action;

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

@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")
    @Override
    public String execute() {
        return SUCCESS;
    }

    public String getName() {
        return name;
    }

    public int getAge() {
        return age;
    }

    @RequiredStringValidator(message = "姓名不能为空")
    public void setName(String name) {
        this.name = name;
    }

    @IntRangeFieldValidator(message = "年龄必须在 28 至 65 岁之间" , min = "28", max = "65")
    public void setAge(int age) {
        this.age = age;
    }
}

在此示例中，我们使用了很少的注解。 让我们一一介绍

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

配置文件

我们确实不需要 struts.xml 配置文件，所以让我们删除这个文件，让我们检查 web.xml 文件的内容

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.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.filter.StrutsPrepareAndExecuteFilter</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>

我们是用 IDEA 启动项目。项目启动成功后，我们访问 http://localhost:8080 显示界面如下所示

struts 注解表单页面

现在不要输入任何信息，只需单击 Submit 按钮。 我们将看到以下结果

Struts 注解字段验证

输入所需的信息， name 为“test”，age 为 30，最后点击 Submit 按钮。 我们将看到以下结果

Struts 注解验证成功界面

Struts 2 注释类型

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

Struts 2 注解类型

查看笔记

扫码一下
查看教程更方便