详解Java的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-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的验证 一章中。

在这里,我们将采取一个例子,雇员Employee 将被捕获的姓名和年龄使用一个简单的页面,我们将会把两个验证,以确保使用总是进入一个名字和年龄应该是在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类的注释,然后添加一个方法称为validate() ,如下所示在Employee.java文件。请确保操作类扩展ActionSupport类,否则validate方法将不会被执行。

package com.yiibai.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;
  }
}

在这个例子中,我们已经使用了一些注解。让我逐个说明:

首先,我们已经Result注解。结果注解的结果是一个集合。结果注解下,我们有两个结果注释。结果注释的名称对应的执行方法的结果。它们还含有一个视图应担任相应的execute() 返回值的位置。

下一个注解是行动注解。这是用来修饰 execute()方法。操作方法也需要一个值,该URL上调用操作。

最后,使用两个验证的注解。已经配置了所需的字段验证的年龄字段"name“字段和整数范围验证。也指定了自定义验证消息。

配置文件:
我们不需要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>

现在,右键点击项目名称,并单击 Export > WAR File创建一个WAR文件。然后部署此WAR在Tomcat的webapps目录下。最后,启动Tomcat服务器和尝试访问URL http://localhost:8080/HelloWorldStruts2/index.jsp。这会给出以下画面:

现在不输入任何所需信息,只需点击“Submit ”按钮。将看到以下结果:

输入所需的信息,但输入了错误的“From ”字段,让我们说“test”和年龄为30名,最后点击“Submit ”按钮。将看到以下结果:

Struts 2的注释类型
Struts 2 应用程序可以使用Java5注释作为替代XML和Java属性配置。可以检查最重要的注解涉及不同类别的列表:
Struts 2 应用程序可以使用Java5注释作为替代XML和Java属性配置。这里是清单的不同的类别有关的最重要的注解:

命名空间注释(动作注释):
@ Namespace注释允许在Action类中,而不是基于零配置的约定动作的命名空间的定义。

@Namespace("/content")
public class Employee extends ActionSupport{
 ...
}

结果注释 - (动作译注):
@ Result注解允许在Action类中,而不是一个XML文件中定义的动作结果。

@Result(name="success", value="/success.jsp")
public class Employee extends ActionSupport{
 ...
}

结果注释 - (动作译注):
@ Results注解定义了一套动作的结果。

@Results({
  @Result(name="success", value="/success.jsp"),
  @Result(name="error", value="/error.jsp")
})
public class Employee extends ActionSupport{
 ...
}

注释后(拦截注释):
@After注解标志着一个需要调用后的主要操作方法和执行结果的操作方法。返回值将被忽略。

public class Employee extends ActionSupport{
  @After
  public void isValid() throws ValidationException {
   // validate model object, throw exception if failed
  }
  public String execute() {
   // perform secure action
   return SUCCESS;
  }
}

注释之前(拦截注释):
@ Before注释标记需要一个操作方法的主要操作方法之前被调用执行结果。返回值将被忽略。

public class Employee extends ActionSupport{
  @Before
  public void isAuthorized() throws AuthenticationException {
   // authorize request, throw exception if failed
  }
  public String execute() {
   // perform secure action
   return SUCCESS;
  }
}

BeforeResult注释 - (拦截注释):
@ BeforeResult注解标志着一个结果之前需要执行的操作方法。返回值将被忽略。

public class Employee extends ActionSupport{
  @BeforeResult
  public void isValid() throws ValidationException {
  // validate model object, throw exception if failed
  }

  public String execute() {
   // perform action
   return SUCCESS;
  }
}

ConversionErrorFieldValidator注释 - (验证译注):
此验证注解如果有任何转换错误进行了实地检查,并适用于他们,如果他们存在。

public class Employee extends ActionSupport{
  @ConversionErrorFieldValidator(message = "Default message",
            key = "i18n.key", shortCircuit = true)
  public String getName() {
    return name;
  }
}

DateRangeFieldValidator注释 - (验证译注):
这验证注解检查日期字段的值在指定范围内。

public class Employee extends ActionSupport{
  @DateRangeFieldValidator(message = "Default message",
  key = "i18n.key", shortCircuit = true,
  min = "2005/01/01", max = "2005/12/31")
  public String getDOB() {
    return dob;
  }
}

DoubleRangeFieldValidator注释 - (验证译注):
此验证注解检查双字段有一个值,该值在指定范围内。如果既不最小或最大,什么都不会做的。

public class Employee extends ActionSupport{

  @DoubleRangeFieldValidator(message = "Default message",
  key = "i18n.key", shortCircuit = true,
  minInclusive = "0.123", maxInclusive = "99.987")
  public String getIncome() {
    return income;
  }
}

EmailValidator注释 - (验证译注):
这验证注解检查一个字段是一个有效的E-mail地址,如果它包含一个非空的字符串。

public class Employee extends ActionSupport{

  @EmailValidator(message = "Default message",
  key = "i18n.key", shortCircuit = true)
  public String getEmail() {
    return email;
  }
}

ExpressionValidator注释 - (验证译注):
这种非字段级验证验证所提供的正则表达式。

@ExpressionValidator(message = "Default message", key = "i18n.key",
shortCircuit = true, expression = "an OGNL expression" )
IntRangeFieldValidator注释 - (验证译注):
这验证注解检查一个数字字段的值在指定的范围内。如果既不最小或最大,什么都不会做的。

public class Employee extends ActionSupport{

  @IntRangeFieldValidator(message = "Default message",
  key = "i18n.key", shortCircuit = true,
  min = "0", max = "42")
  public String getAge() {
    return age;
  }
}

RegexFieldValidator 注释 - (验证译注):
这个注解验证一个字符串字段,使用正则表达式。

@RegexFieldValidator( key = "regex.field", expression = "yourregexp")
RequiredFieldValidator 注释 - (验证译注):
这验证注解检查一个字段不为空。标注必须被应用在方法层面。

public class Employee extends ActionSupport{

  @RequiredFieldValidator(message = "Default message",
  key = "i18n.key", shortCircuit = true)
  public String getAge() {
    return age;
  }
}

RequiredStringValidator注释 - (验证译注):
这验证注解检查一个字符串字段不为空(即非空,长度> 0)。

public class Employee extends ActionSupport{

  @RequiredStringValidator(message = "Default message",
  key = "i18n.key", shortCircuit = true, trim = true)
  public String getName() {
    return name;
  }
}

StringLengthFieldValidator注释 - (验证译注):
这个验证检查字符串字段是合适的长度。假定该字段是一个字符串。如果设置既不是minLength 也不是最大长度,什么都不会做。

public class Employee extends ActionSupport{

  @StringLengthFieldValidator(message = "Default message",
  key = "i18n.key", shortCircuit = true,
  trim = true, minLength = "5", maxLength = "12")
  public String getName() {
    return name;
  }
}

UrlValidator注释 - (验证译注):
这个验证检查一个字段是一个有效的URL。

public class Employee extends ActionSupport{

  @UrlValidator(message = "Default message",
  key = "i18n.key", shortCircuit = true)
  public String getURL() {
    return url;
  }
}

验证注释 - (验证译注):
如果想使用多个相同类型的注释,这些注释必须嵌套在@Validations() 注释。

public class Employee extends ActionSupport{

 @Validations(
  requiredFields =
   {@RequiredFieldValidator(type = ValidatorType.SIMPLE,
   fieldName = "customfield",
   message = "You must enter a value for field.")},
  requiredStrings =
   {@RequiredStringValidator(type = ValidatorType.SIMPLE,
   fieldName = "stringisrequired",
   message = "You must enter a value for string.")}
  )
  public String getName() {
    return name;
  }
}

CustomValidator注释 - (验证译注):
这个注解可以用于自定义验证。使用ValidationParameter的注释,以提供额外的 params.

@CustomValidator(type ="customValidatorName", fieldName = "myField")

转换注释 - (类型转换注释):
这是一个标记注释类型转换类型级别。转换注释必须应用在类型级别。

@Conversion()
  public class ConversionAction implements Action {
}

CreateIfNull注释 - (类型转换注释):
这个注解设置类型转换CreateIfNull。必须应用在域或方法级CreateIfNull注解。

@CreateIfNull( value = true )
private List<User> users;

元素注释 - (类型转换注释):
这个注解设置元素进行类型转换。必须应用在字段域或方法级元素的注解。

@Element( value = com.acme.User )
private List<User> userList;

关键注释 - (类型转换注释):
这个注解设置进行类型转换的关键。必须应用在域或方法级的关键注解。

@Key( value = java.lang.Long.class )
private Map<Long, User> userMap;

KeyProperty注释 - (类型转换注释):
这个注解设置类型转换KeyProperty。必须应用在域或方法级KeyProperty注解。

@KeyProperty( value = "userName" )
protected List<User> users = null;

TypeConversion注释 - (类型转换注释):
这个注解的注解是用于类和应用程序的转换规则。注解可以应用于TypeConversion在属性和方法的级别。

@TypeConversion(rule = ConversionRule.COLLECTION,
converter = "java.util.String")
public void setUsers( List users ) {
  this.users = users;
}
(0)

相关推荐

  • Java中三种简单注解介绍和代码实例

    简单Java注解 JDK5提供的简单注解类型只有3个. 这三个都是用来预防错误或者进行提醒的,分别是: 1.Override 2.Deprecated 3.Suppresswarnings 需要注意,JDK5(另一个说法,Tiger)实际上并没有许多内置注解;相反,它允许核心Java支持注解特性的能力. JSR-175中严格规定它用来定义元数据功能. 需要由程序员编写自定义的注解类型,其他JSR标准也编写了一系列标准注解类型. 下面将用实例来深入讲解这三个简单注解. Override 注解 Ov

  • Java 批量删除html中注释内容的方法

    其实删除html文本中的注释有很多方法,这里就自己随便写了一个处理方法,权当笔记,有需要的同学可以参考. html文本的注释有几个特点: 1. 成对出现,有开始就一定有结束. 2. 注释标签没有嵌套,注释开始标签(以下称为 <!--)下一个一定是其对应的结束标签(以下称为 -->). 3. 一行中可能有多个注释标签对儿. 4. 注释也可以换行. 大致有以下几种情况: 复制代码 代码如下: <html>  <!--This is a head-->  <head&g

  • 从HelloWorld和文档注释开始入门Java编程

    HelloWorld public class HelloWorld { public static void main(String args[]) { System.out.println("Hello World!"); //向控制台输出一条语句,同时必须以;结尾 } } 运行上面程序如图所示 我们通过上面的程序开始分析并学习Java语言的基础知识: 1.注释: Java的注释分为三种:单行注释//  多行注释/*-*/  文档注释 像上面的HelloWorld程序分别用到了多行

  • Java注解之Retention、Documented、Inherited介绍

    Retention注解 Retention(保留)注解说明,这种类型的注解会被保留到那个阶段. 有三个值: 1.RetentionPolicy.SOURCE -- 这种类型的Annotations只在源代码级别保留,编译时就会被忽略 2.RetentionPolicy.CLASS -- 这种类型的Annotations编译时被保留,在class文件中存在,但JVM将会忽略 3.RetentionPolicy.RUNTIME -- 这种类型的Annotations将被JVM保留,所以他们能在运行时

  • Java Annotation(Java 注解)的实现代码

    如果你想知道java annotation是什么?你可以先看看:"http://www.infoq.com/articles/Annotation-Hammer" 下面是我做的一个demo: 项目结构: 运行效果: ==================================================== 代码部分: 注:很多人会考虑这个问题,"这样做的目的是什么?我们可以做一个配置文件(xml,properties等),不是比这个跟方便...或者说 直接把我们

  • java自定义注解接口实现方案

    java注解是附加在代码中的一些元信息,用于一些工具在编译.运行时进行解析和使用,起到说明.配置的功能. 注解不会也不能影响代码的实际逻辑,仅仅起到辅助性的作用.包含在 java.lang.annotation 包中. 1.元注解 元注解是指注解的注解.包括 @Retention @Target @Document @Inherited四种. 1.1.@Retention: 定义注解的保留策略 Java代码 复制代码 代码如下: @Retention(RetentionPolicy.SOURCE

  • Java代码注释规范详解

    代码附有注释对程序开发者来说非常重要,随着技术的发展,在项目开发过程中,必须要求程序员写好代码注释,这样有利于代码后续的编写和使用. 基本的要求: 1.注释形式统一 在整个应用程序中,使用具有一致的标点和结构的样式来构造注释.如果在其它项目中发现它们的注释规范与这份文档不同,按照这份规范写代码,不要试图在既成的规范系统中引入新的规范. 2.注释内容准确简洁 内容要简单.明了.含义准确,防止注释的多义性,错误的注释不但无益反而有害. 3.基本注释(必须加) (a) 类(接口)的注释 (b) 构造函

  • Java经验点滴:类注释文档编写方法

    文章来源:csdn 作者:chensheng913 对于Java语言,最体贴的一项设计就是它并没有打算让人们为了写程序而写程序--人们也需要考虑程序的文档化问题.对于程序的文档化,最大的问题莫过于对文档的维护.若文档与代码分离,那么每次改变代码后都要改变文档,这无疑会变成相当麻烦的一件事情. 解决的方法看起来似乎很简单:将代码同文档"链接"起来.为达到这个目的,最简单的方法是将所有内容都置于同一个文件.然而,为使一切都整齐划一,还必须使用一种特殊的注释语法,以便标记出特殊的文档:另外还

  • 基于Java注解(Annotation)的自定义注解入门介绍

    要深入学习注解,我们就必须能定义自己的注解,并使用注解,在定义自己的注解之前,我们就必须要了解Java为我们提供的元注解和相关定义注解的语法. -------------------------------------------------------------------------------- 元注解: 元注解的作用就是负责注解其他注解.Java5.0定义了4个标准的meta-annotation类型,它们被用来提供对其它 annotation类型作说明.Java5.0定义的元注解:

  • java教程之java注解annotation使用方法

    1.概述 注解可以定义到方法上,类上,一个注解相当与一个类,就相当于实例了一个对象,加上了注解,就相当于加了一个标志. 常用的注解:@Override:表示重新父类的方法,这个也可以判断是否覆盖的父类方法,在方法前面加上此语句,如果提示的错误,那么你不是覆盖的父类的方法,要是提示的没有错误,那么就是覆盖的父类的方法.@SuppressWarnings("deprecation"):取消编译器的警告(例如你使用的方法过时了)@Deprecated:在方法的最上边也上此语句,表示此方法过时

  • 全面解析Java中的注解与注释

    注解 一.什么是 Annotation? (注解 or 注释) Annotation, 准确的翻译应该是 -- 注解. 和注释的作用完全不一样. Annotation 是JDK5.0及以后版本引入的一个特性. 与类.接口.枚举是在同一个层次,可以成为java 的一个类型. 语法是以@ 开头 简单来说, 注释是程序员对源代码的类,方法,属性等做的一些记忆或提示性描述(比如这个方法是做什么用的),是给人来看的. 注解则是Java 编译器可以理解的部分,是给编译器看的. 举个简单的例子来看一下注解的使

随机推荐