Java注解

Java注解(Annotation)

Java注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置的功能。

注解相关类都包含在java.lang.annotation包中。

Java注解分类

JDK基本注解

@Override
重写
@Deprecated
已过时
@SuppressWarnings(value = "unchecked")
压制编辑器警告

JDK元注解

元注解用于修饰其他的注解(纪委：管干部的干部)

@Retention

定义注解的保留策略

@Retention(RetentionPolicy.SOURCE) :注解仅存在于源码中，在class字节码文件中不包含

@Retention(RetentionPolicy.CLASS):默认的保留策略，注解会在class字节码文件中存在，但运行时无法获得，

@Retention(RetentionPolicy.RUNTIME):注解会在class字节码文件中存在，在运行时可以通过反射获取到

@Target

指定被修饰的Annotation可以放置的位置(被修饰的目标)
@Target(ElementType.TYPE) //接口、类
@Target(ElementType.FIELD) //属性
@Target(ElementType.METHOD) //方法
@Target(ElementType.PARAMETER) //方法参数
@Target(ElementType.CONSTRUCTOR) //构造函数
@Target(ElementType.LOCAL_VARIABLE) //局部变量
@Target(ElementType.ANNOTATION_TYPE) //注解
@Target(ElementType.PACKAGE) //包

  注：可以指定多个位置，例如：

@Target({ElementType.METHOD, ElementType.TYPE})，也就是此注解可以在方法和类上面使用

@Inherited

指定被修饰的Annotation将具有继承性

@Documented

指定被修饰的该Annotation可以被javadoc工具提取成文档.

注解分类

根据Annotation是否包含成员变量,可以把Annotation分为两类:

标记Annotation:

没有成员变量的Annotation; 这种Annotation仅利用自身的存在与否来提供信息

元数据Annotation:

包含成员变量的Annotation; 它们可以接受(和提供)更多的元数据;

自定义注解开发

使用@interface关键字, 其定义过程与定义接口非常类似, 需要注意的是:

Annotation的成员变量在Annotation定义中是以无参的方法形式来	声明的, 其方法名和返回值类型定义了该成员变量的名字和类型, 
而且我们还可以使用default关键字为这个成员变量设定默认值，例	如：

@Inherited

@Retention(RetentionPolicy.RUNTIME)

@Target({ElementType.METHOD, ElementType.TYPE})

public @interface Tag {

 String name() default "该叫啥才好呢?";


 String description() default "这家伙很懒, 啥也没留下...";

 }

注1：只有名字为“value”属性，赋值时可以省略属性名

提取Annotation信息

使用AnnotatedElement接口中的方法提取注解中的数据，像Class/Constructor/Field/Method/Package这些类都实现了AnnotatedElement接口
注：只有当定义Annotation时使用了@Retention(RetentionPolicy.RUNTIME)修饰,
JVM才会在装载class文件时提取保存在class文件中的Annotation,该Annotation才会在运行时可见,这样我们才能够解析

案例一：提供类的注解
案例二：属性上的注解
案例三：方法上的注解

注解处理器

使用Annotation修饰了类/方法/成员变量等之后,这些Annotation不会自己生效,为了让程序中的这些注解起作用,
必须由这些注解的开发者为这些注解提供一个注解处理器(Annotation Processor)。另外，在编译期间，
JVM会自动运行注解处理器（当然，我们需要将其注册）

创建注解处理器

自定义处理器都需要继承于AbstractProcessor
init(ProcessingEnvironment processingEnv)：每一个注解处理器类都必须有一个空的构造函数。init()方法会被注解处理工具调用，并输入ProcessingEnviroment参数。ProcessingEnviroment提供很多有用的工具类Elements, Types和Filer。
process(Set<? extends TypeElement> annotations, RoundEnvironment
env)：这是最重要的一个方法，你在这里写你的扫描、评估和处理注解的代码，以及生成Java文件。输入参数RoundEnviroment，可以让你查询出包含特定注解的被注解元素

  getSupportedAnnotationTypes()：该注解处理器是注册到哪些注解上。它的返回值是一个字符串的集合，包含本处理器想要处理的注解类型的合法全称。    
  getSupportedSourceVersion()：用来指定你使用的Java版本。通常这里返回SourceVersion.latestSupported()。然而，如果你有足够的理由只支持Java 7的话，你也可以返回SourceVersion.RELEASE_7。

  注1：在Java7还可以使用如下两个注解，而不用重写getSupportedAnnotationTypes()和getSupportedSourceVersion()
  @SupportedSourceVersion(SourceVersion.latestSupported())
  @SupportedAnnotationTypes({// 合法注解全名的集合})

  但要考虑代码兼容性的原因，特别是针对Android平台，我建议使用重载getSupportedAnnotationTypes()
  和getSupportedSourceVersion()方法代替@SupportedAnnotationTypes和@SuppozrtedSourceVersion

  注2：init方法参数详解：ProcessingEnvironment
       Elements elementUtils = processingEnv.getElementUtils();//一个用来处理Element的工具类；
       Types typeUtils = processingEnv.getTypeUtils();         //一个用来处理TypeMirror的工具类；
       Filer filer = processingEnv.getFiler();                 //正如这个名字所示，使用Filer你可以创建文件；       
       Messager messager = processingEnv.getMessager();        //一个用来处理消息的工具类，为了输出错误信息。
                                                               //因为在注解处理器里面不可以抛出Exception！
                                                               //为什么了？因为在编译阶段抛出错误后，注解处理器就不会运行完，
                                                               //也就没什么用了。 所以Message就是为了输出错误信息 

       private void error(Element e, String msg, Object... args) {
         messager.printMessage(
            Diagnostic.Kind.ERROR,
            String.format(msg, args),
            e);
       }

       
  注3：Element代表的是源代码，它的子类有这些：
       PackageElement：包名
       TypeElement：类
       VariableElement：变量
       ExecutableElement：方法
       详细见资料“Car.java”
      
  注4：process方法返回true即是退出处理
       return true; // 退出处理

注册注解处理器(静态处理器，非AOP处理)

1 手动
      在当前项目中的resources/META-INF/services目录需要新建一个特殊的文件javax.annotation.processing.Processor
      javax.annotation.processing.Processor文件的内容是注解处理器的合法的全名列表，每一个元素换行分割
      - META-INF 
      - - services 
      - - - javax.annotation.processing.Processor           

2 使用google的auto-service项目
      1. 导入依赖
         <dependency>
           <groupId>com.google.auto.service</groupId>
           <artifactId>auto-service</artifactId>
           <version>1.0-rc4</version>
         </dependency>
      2. 在注解处理器上添加@AutoService(Processor.class)即可

Maven打包(打包涵依赖jar包 )

   MAVEN打AR包，注意还要将依赖打到Jar包中。详情见资料“test1-pom.xml”

动态注解处理器(spring aop方式)

Retention：保留
Policy：策略
RUNTIME：运行时间
Annotation：注释

@Service用于标注业务层组件

@Controller用于标注控制层组件（如struts中的action）

@Repository用于标注数据访问组件，即DAO组件

@Component泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注。

@Aspect切面

@Pointcut定义需要切面的地方，表达式参数（https://blog.csdn.net/elim168/article/details/78150438）

@annotation当执行的方法上拥有指定的注解时生效。

@After

@Before

@Around