Java高级语法 一：注解

Java高级语法 一：注解

思维导图:

元数据概念：

元数据（Metadata），又称中介数据、中继数据，为描述数据的数据（data about data），或者说是用于提供某种资源的有关信息的结构数据（structured data）。主要是描述数据属性（property）的信息，用来支持如指示存储位置、历史数据、资源查找、文件记录等功能。在Java中，元数据以标签的形式存在与Java代码中。

注解概念

注解是一系列元数据，它提供数据用来解释程序代码，但是注解并非是所解释的代码本身的一部分。注解对于代码的运行效果没有直接影响。

注解作用：

• 提供信息给编译器： 编译器可以利用注解来探测错误和警告信息

• 编译阶段时的处理： 软件工具可以用来利用注解信息来生成代码、Html文档或者做其它相应处理。

• 运行时的处理： 某些注解可以在程序运行的时候接受代码的提取。

  优缺点：

  　Annotation 的优点
  　　１、保存在 class 文件中，降低维护成本。
  　　２、无需工具支持，无需解析。
  　　３、编译期即可验证正确性，查错变得容易。
  　　４、提升开发效率。
  　Annotation 缺点：
  　　１、若要对配置项进行修改，不得不修改 Java 文件，重新编译打包应用。
  　　２、配置项编码在 Java 文件中，可扩展性差。

实现和应用：

定义实现

注解通过 @interface关键字进行定义。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
    
	public int id() default -1;
	public String msg() default "Hi";
    
}

注解中属性可以有默认值，默认值需要用 default 关键值指定

赋值的方式是在注解的括号内以 value="" 形式，多个属性之前用 ，隔开。

@TestAnnotation(id=3,msg="hello annotation")
public class Test {

}

元注解

负责注解其他注解的注解

@Retention、@Documented、@Target、@Inherited、@Repeatable 5 种。

1：@Retention

相当于给一张标签上面盖了一张时间戳，时间戳指明了标签张贴的时间周期。

作用：表示需要在什么级别保存该注释信息，用于描述注解的生命周期（即：被描述的注解在什么范围内有效）

@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
}

取值为三个：

1：RetentionPolicy.SOURCE 注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视。
2：RetentionPolicy.CLASS 注解只被保留到编译进行的时候，它并不会被加载到 JVM 中。
3：RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候，它会被加载进入到 JVM 中，所以在程序运行时可以获取到它们。

2：@Target

Target 是目标的意思，@Target 指定了注解运用的地方。@Target说明了Annotation所修饰的对象范围：Annotation可被用于 packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。

当一个注解被 @Target 注解时，这个注解就被限定了运用的场景。

类比到标签，原本标签是你想张贴到哪个地方就到哪个地方，但是因为 @Target 的存在，它张贴的地方就非常具体了，比如只能张贴到方法上、类上、方法参数上等等。@Target 有下面的取值

ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
ElementType.CONSTRUCTOR 可以给构造方法进行注解
ElementType.FIELD 可以给属性进行注解
ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
ElementType.METHOD 可以给方法进行注解
ElementType.PACKAGE 可以给一个包进行注解
ElementType.PARAMETER 可以给一个方法内的参数进行注解
ElementType.TYPE 可以给一个类型进行注解，比如类、接口、枚举

3：@Inherited

Inherited 是继承的意思，但是它并不是说注解本身可以继承，而是说如果一个超类被 @Inherited 注解过的注解进行注解的话，那么如果它的子类没有被任何注解应用的话，那么这个子类就继承了超类的注解。

类比：老子的儿子长大后，只要没有和老子断绝父子关系，虽然别人没有给他贴标签，但是他自然也是富豪。老子的孙子长大了，自然也是富豪。

4：@Repeatable

Repeatable 自然是可重复的意思。什么样的注解会多次应用呢？通常是注解的值可以同时取多个。

类比：一个人他既是程序员又是产品经理,同时他还是个画家。

@interface Persons {
	Person[]  value();
}


@Repeatable(Persons.class)
@interface Person{
	String role default "";
}

@Person(role="artist")
@Person(role="coder")
@Person(role="PM")
public class SuperMan{
	
}

5：@Documented

顾名思义，这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去。

Java预置注解

1：@Deprecated

用来标记过时的元素

2：@SuppressWarnings

阻止警告的意思。之前说过调用被 @Deprecated 注解的方法后，编译器会警告提醒，而有时候开发者会忽略这种警告，他们可以在调用的地方通过 @SuppressWarnings 达到目的。

3：@Override

提示子类要复写父类中被 @Override 修饰的方法。

4：@SafeVarargs

参数安全类型注解。它的目的是提醒开发者不要用参数做一些不安全的操作,它的存在会阻止编译器产生 unchecked 这样的警告。它是在 Java 1.7 的版本中加入的。

例如：堆污染”警告

什么是堆污染：当把一个不是泛型的集合赋值给一个带泛型的集合的时候，这种情况就很容易发生堆污染，这个注解也是用来抑制编译器警告的注解

5：@FunctionalInterface

函数式接口注解，只能有一个方法的借口，例如：@Runable

注解与反射

注解通过反射获取。

1：首先可以通过 Class 对象的 isAnnotationPresent() 方法判断它是否应用了某个注解。

2：然后通过 getAnnotation() 方法来获取 Annotation 对象。

3：如果获取到的 Annotation 如果不为 null，则就可以调用它们的属性方法。

第一步：首先可以通过 Class 对象的 isAnnotationPresent() 方法判断它是否应用了某个注解。

public static void main(String[] args) {
	
	boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class);
	
	if ( hasAnnotation ) {
		TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class);
		
		System.out.println("id:"+testAnnotation.id());
		System.out.println("msg:"+testAnnotation.msg());
	}

}
}

注解处理器类库：

注解处理器类库(java.lang.reflect.AnnotatedElement)：

　　Java使用Annotation接口来代表程序元素前面的注解，该接口是所有Annotation类型的父接口。除此之外，Java在java.lang.reflect 包下新增了AnnotatedElement接口，该接口代表程序中可以接受注解的程序元素，该接口主要有如下几个实现类：

　　Class：类定义
　　Constructor：构造器定义
　　Field：累的成员变量定义
　　Method：类的方法定义
　　Package：类的包定义

　　java.lang.reflect 包下主要包含一些实现反射功能的工具类，实际上，java.lang.reflect 包所有提供的反射API扩充了读取运行时Annotation信息的能力。当一个Annotation类型被定义为运行时的Annotation后，该注解才能是运行时可见，当class文件被装载时被保存在class文件中的Annotation才会被虚拟机读取。
　　AnnotatedElement 接口是所有程序元素（Class、Method和Constructor）的父接口，所以程序通过反射获取了某个类的AnnotatedElement对象之后，程序就可以调用该对象的如下四个个方法来访问Annotation信息：

　　方法1： T getAnnotation(Class annotationClass): 返回改程序元素上存在的、指定类型的注解，如果该类型注解不存在，则返回null。
　　方法2：Annotation[] getAnnotations():返回该程序元素上存在的所有注解。
　　方法3：boolean is AnnotationPresent(Class annotationClass):判断该程序元素上是否包含指定类型的注解，存在则返回true，否则返回false.
　　方法4：Annotation[] getDeclaredAnnotations()：返回直接存在于此元素上的所有注释。与此接口中的其他方法不同，该方法将忽略继承的注释。（如果没有注释直接存在于此元素上，则返回长度为零的一个数组。）该方法的调用者可以随意修改返回的数组；这不会对其他调用者返回的数组产生任何影响。

参考链接：

注解基础科普https://blog.csdn.net/briblue/article/details/73824058

注解的思维导图https://www.cnblogs.com/ITtangtang/p/3974531.html ：

注解处理器类库：https://www.cnblogs.com/peida/archive/2013/04/26/3038503.html