Java的注解浅析
阅读原文时间:2023年07月11日阅读:1

人的一生就像一篇文章,只有经过多次精心修改,才能不断完善

Java注解概念理解:

  Java注解又称为Java标注,是JDK5引入的一中注释机制,Java中大家熟悉的五种注解分别是:@Override,@Deprecated,@SuppressWarnings,@SafeVarargs,@FunctionalInterface,看到这些注解大家应该都不陌生,这是Java中基本的五个注解。

  Java注解可以通俗理解为打标签,我可以给一个年轻人打一个标签为年轻,活力,激情,理想主义等,这些就可以看作是年轻人的注解。可以理解标签是事物某些方面的特点和解释。

如何定义注解:

定义注解通过@interface关键字来实现    

public @interface Fruit {
}

  如上代码,即创建了Fruit注解,可以理解一个名字为Fruit的标签。

  使用注解:使用注解的方法很简单,可以将注解放在类上或者方法上,看你需要这个注解实现什么作用了,例如将注解注释类

@Fruit
public class Annotest {
}

  这样就将@Fruit标签打到了Annotest这个类上。

  看到这,你可能就明白了,注解就是将标签打到某个方法,类,包上,标识这个类,使这个方法,类具有这个注解所具有的标识呗,是的,没错

  使用自定义注解仅仅做到这样是不够的,还需要用到Java中的元注解

元注解:

  元注解是一种基本的注解,可以运用到注解上边(可以理解为元注解也是一种标签,只不过他是特殊的标签,可以打在注解身上的一种注解)

  Java中的注解有以下五种,@Retention,@Documented,@Target,@Inherited,@Repeatable

  @Retention:保留,维持,保留的意思,该注解提供了注解的生命周期

       取值有如下几种:

       RetentionPolicy.SOURCE: 标识该注解只保留源码阶段,编译器即忽视丢弃 

       RetentionPolicy.CLASS:  高注解保留到编译阶段,不回加载到jvm

      RetentionPolicy.RUNTIME: 注解保留到运行时候

  @Documented:标识该注解属于文档类型,他的作用是将注解中的元素包含到javac中去
  @Target:标识该注解运用的地方,限制注解的使用场景,target的取值如下: 
      ElementType.ANNOTATION_TYPE:可以给一个注解类进行注解
      ElementType.CONSTRUCTOR:给一个构造方法进行注解
      ElementType.FIELD:给属性方法进行注解
      ElementType.LOCAL_VARIABLE:给局部方法进行注解
      ElementType.METHOD:给方法进行注解
      ElementType.PACKAGE:给包进行注解
      ElementType.PARAMETER:给一个方法内的参数进行注解
      ElementType.TYPE:给一个类型进行注解,类型包括:类,接口,枚举类
  @Inherited:继承注解,如果一个超类使用该注解,其子类没有被任何注解标注的话,那么这个子类就继承了该超类的注解
  @Repeatable:jdk1.8加进来的一个注解,意思是可重复的意思,使用该注解意味着注解的值可以取多个(这个注解我用到的很少,需要深入了解请百度)

  注解属性:
  注解只有成员变量,没有方法,成员变量就是属性,例如:

@Retention(RetentionPolicy.RUNTIME)
@Documented
@Target(ElementType.TYPE)
public @interface Fruit {
int id();
String msg();
}

  该注解定义了两个成员:id和msg,在使用的时候,我们应该给它进行赋值

@Fruit(id = 1, msg = "anno")
public class TestAno {
}

  在注解中定义的成员类型时候必须是8中基本数据类型+类,接口,注解,以及注解数组

  注解中的成员属性还可以指定默认值

@Retention(RetentionPolicy.RUNTIME)
@Documented
@Target(ElementType.TYPE)
public @interface Fruit {
int id() default 0;
String msg() default "apple";
}

获取注解:

  我们使用注解的初衷就是对代码中的类,方法等打标签,那它的作用是什么,当然是在获取类或者方法的时候,判断这个类或者方法是不是该注解类型,进行特殊的操作和处理,那么如何检查和提取注解呢,相信你们已经想到,那就是使用Java中的反射机制

  反射获取注解:Class类中的方法判断类中isAnnotationPresent()方法判断是否运用注解,getAnnotation()方法获取注解对象,getAnnotations()获取所有的注解

public boolean isAnnotationPresent(Class annotationClass) {
return GenericDeclaration.super.isAnnotationPresent(annotationClass);
}

public A getAnnotation(Class annotationClass) {
Objects.requireNonNull(annotationClass);

return (A) annotationData().annotations.get(annotationClass);  

}

  public Annotation[] getAnnotations() {} 

  如下利用反射获取注解的例子:

@Fruit
public class Test {

public static void main(String\[\] args) {  
    boolean isAnno = Test.class.isAnnotationPresent(Fruit.class);  
    if(isAnno) {  
        Fruit annotation = Test.class.getAnnotation(Fruit.class);  
        System.out.println(annotation.id());  
        System.out.println(annotation.msg());  
    }  
}  

}

  运行的结果当然是:0 apple

  接下来看注解在方法的注解如何提取

  1. 先定义一个属性注解:MyParamAnno

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface MyParamAnno {

String value();  

}

  2. 定义一个方法类型注解:MyMethodAnno

@Retention(RetentionPolicy.RUNTIME)
@Documented
@Target(ElementType.METHOD)
public @interface MyMethodAnno {
}

  3. 解析方法属性上注解示例:

@Fruit(msg = "skyline")
public class MethodAnnoTest {

@MyParamAnno("hello")  
String param;

@MyMethodAnno  
public void method(){}

public static void main(String\[\] args) {  
    boolean isAnno = MethodAnnoTest.class.isAnnotationPresent(Fruit.class);  
    if (isAnno) {  
        Fruit annotation = MethodAnnoTest.class.getAnnotation(Fruit.class);  
        System.out.println(annotation.msg());  
    }  
    //解析属性方法注解  
    try {  
        Field param = MethodAnnoTest.class.getDeclaredField("param");  
        param.setAccessible(true);  
        //获取该变量的注解  
        MyParamAnno paramAnno = param.getAnnotation(MyParamAnno.class);  
        if(paramAnno != null) {  
            System.out.println("成员属性的注解值为:" + paramAnno.value());  
        }

        //获取方法的注解  
        Method method = MethodAnnoTest.class.getDeclaredMethod("method");  
        if (method != null) {  
            MyMethodAnno methodAnno = method.getAnnotation(MyMethodAnno.class);  
            System.out.println("方法注解:" + methodAnno.annotationType().getSimpleName());  
        }

    } catch (NoSuchFieldException e) {  
        e.printStackTrace();  
    } catch (NoSuchMethodException e) {  
        e.printStackTrace();  
    }

}  

}

 输出的结果值为:

skyline
成员属性的注解值为:hello
方法注解:MyMethodAnno

总结:

  注释是为了标注和解释代码,但是由于用到反射机制,所以会对性能方面有所影响,所以不要滥用。