标准的Annotation
JDK1.5提供了若干的标准Annotation来补充语法定义，或者标记Annotation。标准的Annotation有以下几个：
|
Annotation |
使用范围 |
用途 |
|
Deprecated |
所有 |
将目标标记为不推荐使用 |
|
SuppressWarnings |
除了包和Annotation |
禁止标记对象发出被标记的警告信息 |
|
Override |
方法 |
标记这个方法重写了父类的方法 |
|
Target |
Annotation |
标记Annotation的适用范围 |
|
Retention |
Annotation |
标记Annotation最终驻留的地方 |
|
Documented |
Annotation |
该Annotation在JavaDoc文档中出现 |
|
Inherited |
Annotation |
该Annotation默认被使用该Annotation的所有子类继承 |
下面具体讲解标准Annotation的用法。
常用的Annotation包括以下三个：@Deprecated @SuppressWarnings @Override，他们的用途分别如上表所示。
以下说明的Annotation有一个共同的特点就是他们都只能用在Annotation的声明上。
@Target用来标记Annotation适用的范围，@Target有一些预定义的属性，如下表所示：
|
类型 |
适用范围 |
|
ANNOTATION_TYPE |
只能用在Annotation的声明中 |
|
PACKAGE |
用在包上 |
|
TYPE |
类（包括枚举）或者接口（包括Annotation） |
|
METHOD |
方法 |
|
CONSTRUCTOR |
构造方法 |
|
FIELD |
字段（包含枚举内部的常量） |
|
PARAMETER |
方法或者构造方法的参数 |
|
LOCAL_VARIABLE |
本地变量 |
@Retention用来标记Annotation在那些范围（源代码，类文件或者运行时）内是可用的。@Retention与定义了一些属性，如下表所示：
|
驻留策略 |
描述 |
|
SOURCE |
Annotation只存在于源代码中，不包括在编译生成Class文件中 |
|
CLASS |
Annotation存在于源代码中，也存在于编译生成的Class文件中，但是在运行时这些Annotation不被JVM装载。 |
|
RUNTIME |
Annotation存在于源代码中，也存在于编译生成的Class文件中，同时在运行时这些Annotation被装载到JVM内部，可以使用反射的机制在运行时使用。 |
@Documented用来将Annotation显示在生成的JavaDoc中。
@Inherited只能用来标记用在类上的Annotation，用来说明被标记的Annotation会被该类的所有子类自动的继承。
Annotation应用实例
/**
* http://www.onjava.com/pub/a/onjava/2005/01/19/metadata_validation.html
* by Jacob Hookom
*/
使用Annotation的一个例子就是建立一个简单的用户输入验证框架，使用这个框架最终用户可以以如下的方式来定义字段的校验属性：
@ValidateRequired
@ValidateEmail
public void setEmail(String email) {
this.email = email;
}
@ValidateRequired
@ValidateLength(min=6,max=12)
public void setPassword(String password) {
this.password = password;
}
以上的代码说明，email字段是必须的，且必须满足email的校验要求，同时password字段也是必须的，且长度必须在6~12之间。有了这些定义之后我们能够使用如下的代码达到验证的效果：
Validator.validate(loginBean, "email", "yourname@onjava.com"); //pass
Validator.validate(loginBean, "password", ""); // failure
要能够达到上述的要求，我们必须定义一些Annotation，以下代码是ValidateLength和ValidateExpr的声明：
package annotations.validates;
//Example @ValidateLength(min=6,max=8)
public @interface ValidateLength {
int min() default 0;
int max() default Integer.MAX_VALUE;
}
//Example @ValidateExpr("^(\\w){0,2}$");
public @interface ValidateExpr {
String value();
}
具体开发的过程中我们会遇到一些问题，这主要由于两方面的原意产生
第一，Annotation内部不能定义方法，只能定义一些状态。
第二，Annotation不允许使用继承（extends或者implements），这意味着我们不能在反射的过程中使用instance of这样的功能。
为了识别出于我们定义的校验相关的Annotation我们定义了一个如下的Annotation：
package annotations.validates;
import java.lang.annotation.*;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Validate {
//Class<ValidateExprHandler> value();
Class<? extends ValidateHandler> value();
}
正如你所看到的Validate可以驻留在JVM内部，即它可以在运行时通过反射的方式使用。同时它必须用来标记其他的Annotation，同时他有一个Class类型的value元素，这个类型必须从ValidateHandler继承而来，主要用来处理具体的验证逻辑。
在此设计之下看看我们如何声明一个ValidateExpr的Annotation对象：
package annotations.validates;
import java.lang.annotation.*;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Validate(ValidateExprHandler.class)
public @interface ValidateExpr {
String value();
}
推荐信息
- 暂无记录
评论