【Spring注解】java注解浅析

我们IDE编程时经常会自动给我们添加Override、Deprecated等以及三方框架注解，这些注解是怎么定义以及工作的，我们该怎么自定义注解，这些可能是一个入门程序猿所不了解的，本篇文章将对注解进行简单的介绍，希望能给一些对注解有困惑的开发一点帮助。

何为注解

Annotation（注解）就是Java提供了一种元程序中的元素关联任何信息和着任何元数据（metadata）的途径和方法，Annotion是一个接口，程序可以通过反射来获取指定程序元素的Annotion对象，然后通过Annotion对象来获取注解里面的元数据。

Annotation(注解)是JDK5.0及以后版本引入的。它可以用于创建文档，跟踪代码中的依赖性，甚至执行基本编译时检查。从某些方面看，annotation就像修饰符一样被使用，并应用于包、类 型、构造方法、方法、成员变量、参数、本地变量的声明中。这些信息被存储在Annotation的“name=value”结构对中。
　　
　　Annotation的成员在Annotation类型中以无参数的方法的形式被声明。其方法名和返回值定义了该成员的名字和类型。在此有一个特定的默认语法：允许声明任何Annotation成员的默认值：一个Annotation可以将name=value对作为没有定义默认值的Annotation成员的值，当然也可以使用name=value对来覆盖其它成员默认值。这一点有些近似类的继承特性，父类的构造函数可以作为子类的默认构造函数，但是也可以被子类覆盖。
　　
　　Annotation能被用来为某个程序元素（类、方法、成员变量等）关联任何的信息。需要注意的是，这里存在着一个基本的规则：Annotation不能影响程序代码的执行，无论增加、删除 Annotation，代码都始终如一的执行。

首先看下我们最长用到的JDK内置注解

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

Override注解又使用了注解？没错，@Target和@Retention是元注解（用于给其注解其他注解，一般自定义注解都要使用）.

注解作用

注解的作用基本有三个：
1、生成文档。这是最常见的，也是java 最早提供的注解。常用的有 @see @param @return 等
2、跟踪代码依赖性，实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。作用就是减少配置。现在的框架基本都使用了这种配置来减少配置文件的数量。也是
3、在编译时进行格式检查。如@override 放在方法前，如果你这个方法并不是覆盖了超类方法，则编译时就能检查出。

注解分类

根据注解使用方法和用途，我们可以将annotation分三类：

1、系统注解：

JDK提供了三个系统注解Override（标记此方法是覆盖了父类的方法）、Deprecated（用于标记方法等过时，一般都会有新的API提供）、SuppressWarnnings（用于通知java编译器禁止特定的编译警告）

2、元注解：

Java5.0定义了4个标准的meta-annotation类型
① @Target：用于说明Annotation所修饰的范围，系统代码如下

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE})
public @interface Target {
    ElementType[] value();
}

ElementType是个枚举类型，取值有：

1. CONSTRUCTOR:用于描述构造器
2. FIELD:用于描述域
3. LOCAL_VARIABLE:用于描述局部变量
4. METHOD:用于描述方法
5. PACKAGE:用于描述包
6. PARAMETER:用于描述参数
7. TYPE:用于描述类、接口(包括注解类型) 或enum声明

② @Retention：定义Annotation被保留的时间长短即注解生命周期限制

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE})
public @interface Retention {
    RetentionPolicy value();
}

RetentionPolicy也是个枚举类型，取值有：

1. SOURCE:在源文件中有效（即源文件保留，被编译器丢弃）
2. CLASS:在class文件中有效（即class保留，被编译但虚拟机忽略）
3. RUNTIME:在运行时有效（即运行时保留，class装载的时候读取）

③ @Documented：用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化

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

④ @Inherited：用于标记注解是被继承的，如果一个使用了@Inherited修饰的annotation类型被用于一个class，则这个annotation将被用于该class的子类

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE})
public @interface Inherited {
}

3、自定义注解

自定义注解一般包含编译注解和运行时注解，根据系统提供API以及相关机制在编译或者运行时获取想要的数据，自定义注解形式和系统注解以及元注解一样，下文会有自定义注解的Demo。

从上面的元注解来看，注解又分为：
1、标记注解，比如@Override、@Inherited、@Documented。这类注解是没有元素的，用于标记元素特性比如过时、覆盖父类方法等
2、单值注解，只有一个元素的注解，比如@Target、@Retention等
3、完整注解 ，除了①和②的所有注解

注解元素定义形式如：

public @interface 注解名 {定义体}//public 可以省略
public String name() default "fieldName";//元素定义样式</pre>

使用形式：

@注解名（name1= value1,name2 = value2）

单值注解定义和使用还有简写方式：

元素定义：

String value() default “value”

使用形式：

@注解名（value）

注解处理器

定义注解和使用注解都很容易，关键还是要处理注解，如果没有处理注解的方法那么注解就仅仅相当于注释了。所以创建注解处理器是很重要的，获取注解之前我们肯定要先获取注解作用的Target，比如：
Class：类定义
Constructor：构造器定义
Field：类的成员变量
Method：类中的方法
Package：类的包定义
这几个都是AnnotatedElement接口实现类，运行时注解可以通过java.lang.reflect包下的反射API运行时获取，含的获取注解的方法如下：

方法1： T getAnnotation(Class annotationClass): 返回改程序元素上存在的、指定类型的注解，如果该类型注解不存在，则返回null。

方法2：Annotation[] getAnnotations():返回该程序元素上存在的所有注解。

方法3：boolean is AnnotationPresent(Class<?extends Annotation> annotationClass):判断该程序元素上是否包含指定类型的注解，存在则返回true，否则返回false。

方法4：Annotation[] getDeclaredAnnotations()：返回直接存在于此元素上的所有注释。与此接口中的其他方法不同，该方法将忽略继承的注释。（如果没有注释直接存在于此元素上，则返回长度为零的一个数组。）该方法的调用者可以随意修改返回的数组；这不会对其他调用者返回的数组产生任何影响。

注解体系思维导图

作者：YYOmomo
链接：https://www.jianshu.com/p/2972782a4ee0
来源：简书
简书著作权归作者所有，任何形式的转载都请联系作者获得授权并注明出处。