自定义注解开发

最新推荐文章于 2024-09-11 21:57:46 发布

haogexiaole

最新推荐文章于 2024-09-11 21:57:46 发布

阅读量719

点赞数

自定义注解的语法要求：

@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Description {
    String desc();
    String author();
    int age() default 18;
}

首先我们要明确这不是一个接口，它是使用@interface关键字定义的一个注解。
然后我们看下面的几个方法，String desc();虽然它很类似于接口里面的方法，其实它在注解里面只是一个成员变量（成员以无参无异常的方式声明），int age() default 18;（成员变量可以用default指定一个默认值的）。
最后我们要知道：
①.成员类型是受限制的，合法的类型包括基本的数据类型以及String，Class，Annotation,Enumeration等。
②.如果注解只有一个成员，则成员名必须取名为value()，在使用时可以忽略成员名和赋值号（=）。
③.注解类可以没有成员，没有成员的注解称为标识注解。

元注解：

有没有发现上面那段代码有一个没有说呢？没错，它们就是我们所说的元注解：

@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented

我们先看第一行：@Target是这个注解的作用域，ElementType.METHOD是这个注解的作用域的列表，METHOD是方法声明，除此之外，还有：
CONSTRUCTOR（构造方法声明）,FIELD（字段声明）,LOCAL VARIABLE（局部变量声明）,METHOD（方法声明）,PACKAGE（包声明）,PARAMETER（参数声明）,TYPE（类接口）

第二行：@Retention是它的生命周期，前面不是说注解按照运行机制有一个分类嘛，RUNTIME就是在运行时存在，可以通过反射读取。除此之外，还有:
SOURCE（只在源码显示，编译时丢弃）,CLASS（编译时记录到class中，运行时忽略）,RUNTIME（运行时存在，可以通过反射读取）

第三行：@Inherited是一个标识性的元注解，它允许子注解继承它。

第四行：@Documented，生成javadoc时会包含注解。

使用自定义注解：
使用注解的语法：
@<注解名>(<成员名1>=<成员值1>,<成员名1>=<成员值1>,…)
案例：

@Description(desc="i am Color",author="boy",age=18)
public String Color() {
    return "red";
}

这里的Description是我们刚才在自定义注解语法要求里面定义的注解噢，然后我们可以给它的每一个成员变量赋值，注意数据类型。值得注意的是，因为我们前面定义的作用域是在方法和类接口上，所以这个注解在Color()方法上使用是没问题的。

解析注解
概念：
通过反射获取类、函数或成员上的运行时注解信息，从而实现动态控制程序运行的逻辑。

准备工作：

Description类.png

Child类.png

接下来，我们就开始测试了：

public class ParseAnn {
    public static void main(String[] args) {
        try {
            // 使用类加载器加载类
            Class c = Class.forName("com.test.Child");
            // 找到类上面的注解
            boolean isExist = c.isAnnotationPresent(Description.class);
            // 上面的这个方法是用这个类来判断这个类是否存在Description这样的一个注解
            if (isExist) {
                // 拿到注解实例，解析类上面的注解
                Description d = (Description) c.getAnnotation(Description.class);
                System.out.println(d.value());
            }
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        }
    }
}

输出的结果：
i am class annotation
可以看到，我们成功的解析了Child类上面的注解。

接下来，我们继续解析方法上的注解：

//获取所有的方法
Method[] ms = c.getMethods();
// 遍历所有的方法
for (Method m : ms) {
    boolean isExist1 = m.isAnnotationPresent(Description.class);
    if (isExist1) {
        Description d1=m.getAnnotation(Description.class);
        System.out.println(d1.value());
    }
}

输出的结果：
i am class annotation
i am method annotation
可以看到，我们成功的解析了方法上面的注解。

//另一种解析方法
for (Method m : ms) {
    //拿到方法上的所有的注解
    Annotation[] as=m.getAnnotations();
    for (Annotation a : as) {
        //用二元操作符判断a是否是Description的实例
        if (a instanceof Description) {
            Description d=(Description) a;
            System.out.println(d.value());
        }
    }
}

原文：http://www.importnew.com/23564.html