一,例子
新建一个名为Test的注解
package com.t.test;
import java.lang.annotation.Documented;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import java.lang.annotation.ElementType;
import java.lang.annotation.RetentionPolicy;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface Test {
public int id();
public String description() default "no description";
}
再建一个TestAnnotation的测试类
package com.t.test;
import java.lang.reflect.Method;
public class TestAnnotation {
@Test(id = 1, description = "hello method_1")
public void method_1() {
}
@Test(id = 2)
public void method_2() {
}
@Test(id = 3, description = "last method")
public void method_3() {
}
public static void main(String[] args) {
// TODO Auto-generated method stub
Method[] methods = TestAnnotation.class.getDeclaredMethods();
for (Method method : methods) {
boolean hasAnnocation = method.isAnnotationPresent(Test.class);
if (hasAnnocation) {
Test Annocation = method.getAnnotation(Test.class);
System.out.println("Test( method = " + method.getName() + " , id = " + Annocation.id() + " , description = " + Annocation.description() + " )");
}
}
}
}
执行结果如图:
二、注解
三大标准注解:(@deprecated 、@Override 、@SupperWarnings)
@deprecated 标记不过期,不赞成使用的类和方法,在以后的版本中可以会被删除,应使用其它替代;
@Override 覆盖父类的方法,也许会因为参数等没有覆盖,而实现了重载,那在使用时可能以使用成父类的方法,使用它可以得到更好的提示
@SupperWarnings 抑制编译器发出来的警告,有许多不同类型的警告,传参即可。
四大元注解:(@Target 、@Retention 、@Documented 、@Inherited )
*
* @Target 表示该注解用于什么地方,可能的 ElemenetType 参数包括:
* ElemenetType.CONSTRUCTOR 构造器声明
* ElemenetType.FIELD 域声明(包括 enum 实例)
* ElemenetType.LOCAL_VARIABLE 局部变量声明
* ElemenetType.METHOD 方法声明
* ElemenetType.PACKAGE 包声明
* ElemenetType.PARAMETER 参数声明
* ElemenetType.TYPE 类,接口(包括注解类型)或enum声明
*
* @Retention 表示在什么级别保存该注解信息。可选的 RetentionPolicy 参数包括:
* RetentionPolicy.SOURCE 注解将被编译器丢弃
* RetentionPolicy.CLASS 注解在class文件中可用,但会被VM丢弃
* RetentionPolicy.RUNTIME VM将在运行期也保留注释,因此可以通过反射机制读取注解的信息。
*
* @Documented 将此注解包含在 javadoc 中
*
* @Inherited 允许子类继承父类中的注解
三,获取注解
Java反射API包含了许多方法来在运行时从类,方法或者其它元素获取注解。接口AnnotatedElement包含了大部分重要的方法,如下:
getAnnotations(): 返回该元素的所有注解,包括没有显式定义该元素上的注解。
isAnnotationPresent(annotation): 检查传入的注解是否存在于当前元素。
getAnnotation(class): 按照传入的参数获取指定类型的注解。返回null说明当前元素不带有此注解。
class 通过java.lang.Class被实现,java.lang.reflect.Method 和 java.lang.reflect.Field,所以可以基本上被和任何Java元素使用。