知识点之Java 注解 Annotation

什么是注解？

注解（Annotation）是JDK5.0开始引入的技术，是对某一事物进行添加注释说明，会存放一些信息，这些信息可能对以后某个时段来说是很有用处的。
Java注解又叫java标注，java提供了一套机制，使得我们可以对方法、类、参数、包、域以及变量等添加标准(即附上某些信息)。且在以后某个时段通过反射将标注的信息提取出来以供使用。

注解有什么作用？

1. 编译检查
   Annotation具有“让编译器进行编译检查的作用”。
   例如：@SuppressWarnings, @Deprecated和@Override都具有编译检查作用。

2. 在反射中使用Annotation
   在反射的Class, Method, Field等函数中，有许多于Annotation相关的接口。
   这也意味着，我们可以在反射中解析并使用Annotation。

3. 根据Annotation生成帮助文档
   通过给Annotation注解加上@Documented标签，能使该Annotation标签出现在javadoc中。
   能够帮忙查看查看代码

4. 自定义注解实现想要的功能
   通过@Override, @Deprecated等，我们能很方便的了解程序的大致结构。
   另外，我们也可以通过自定义Annotation来实现一些功能。

5. 注解处理器
   如果没有用来读取注解的方法和工作，那么注解也就不会比注释更有用处了。使用注解的过程中，很重要的一部分就是创建于使用注解处理器。Java SE5扩展了反射机制的API，以帮助程序员快速的构造自定义注解处理器。

6. 在框架中的作用
   在开发Java程序，尤其是Java EE应用的时候，总是免不了与各种配置文件打交道。以Java EE中典型的S(pring)S(truts)H(ibernate)架构来说，Spring、Struts和Hibernate这三个框架都有自己的XML格式的配置文件。这些配置文件需要与Java源代码保存同步，否则的话就可能出现错误。而且这些错误有可能到了运行时刻才被发现。把同一份信息保存在两个地方，总是个坏的主意。理想的情况是在一个地方维护这些信息就好了。其它部分所需的信息则通过自动的方式来生成。JDK 5中引入了源代码中的注解（annotation）这一机制。注解使得Java源代码中不但可以包含功能性的实现代码，还可以添加元数据。注解的功能类似于代码中的注释，所不同的是注解不是提供代码功能的说明，而是实现程序功能的重要组成部分。Java注解已经在很多框架中得到了广泛的使用，用来简化程序中的配置。

   因为注解大多都有自己的配置参数，而配置参数以名值对的方式出现，所以从某种角度来说，可以把注解看成是一个XML元素，该元素可以有不同的预定义的属性。而属性的值是可以在声明该元素的时候自行指定的。在代码中使用注解，就相当于把一部分元数据从XML文件移到了代码本身之中，在一个地方管理和维护。
   上面两段话其实已经阐述了java注解的主要作用之一，就是跟踪代码依赖性，实现替代配置文件功能。比较常见的是Spring等框架中的基于注解配置。现在的框架很多都使用了这种方式来减少配置文件的数量。基本上秉持着这么一个原则，与具体场景相关的配置应该使用注解的方式与数据关联，与具体场景无关的配置放于配置文件中。在另一方面我们还可以在通过设置注解的@Retention 级别在运行时使用反射对不同的注解进行处理。

注解怎么玩？

内置注解

1. @Override，定义在java.lang.Override中，此注解只适用于修辞方法，表示一个方法声明打算重写父类中的另一个方法声明。
2. @Deprecated，定义在java.lang.Deprecated中，此注解可以用于修饰方法，属性，类，表示不鼓励程序员使用被修饰的元素，通常是因为这样的元素已过时，用它存在危险或者有更好的元素替代它。
3. @SuppressWarnings，定义在java.lang.SuppressWarnings中，用来抑制编译时的警告信息。

它与前两个注解有所不同，它需要添加一个参数才能正确使用，这些参数都是已经定义好了的，我们选择性使用就好了，有：
@SuppressWarnings("all")
@SuppressWarnings("unchecked")
@SuppressWarnings(value={"unchecked","deprecation"})
等等......

元注解

元注解，就是定义注解的注解，也就是说这些元注解是的作用就是专门用来约束其它注解的注解。请区别上面那三个内置注解，他们也是通过元注解定义而来的。

元注解有：@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允许我们自定义注解来使用。
自定义步骤大致分为两步：

1. 通过@interface关键字(注意，不是interface，是@interface)声明注解名称，以及注解的成员属性或者叫做注解的参数。
2. 使用java内置的四个元注解对这个自定义标注的功能和范围进行一些限制，限制范围请看上 元注解。

创建规范：注解的参数 = 参数类型 + 参数名();
只有一个参数时，参数名最好用value();

自定义注解示例：

import java.lang.annotation.*;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@interface MyAnnotation {
    String[] value() default {"PGL自定义注解"};
}

自定义注解怎么用？

当注解的参数都有默认值且不需要重新定义时，可以不给定参数；但参数没有默认值时，必须在用时给定参数值。