欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

详解Java的Struts框架中注释的用法

程序员文章站 2024-03-07 12:21:57
要开始在你的项目中使用注释,确保webcontent/web-inf/lib文件夹中的jar文件包括以下:  struts2-convention-pl...

要开始在你的项目中使用注释,确保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。这会给出以下画面:

详解Java的Struts框架中注释的用法

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

详解Java的Struts框架中注释的用法

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

详解Java的Struts框架中注释的用法

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;
}