Java注解

简介

从 JDK 5.0 开始，Java 增加了对元数据(MetaData) 的支持，也就是 Annotation（注解）

Annotation 其实就是代码里的特殊标记，这些标记可以在编译，类加载，运行时被读取，并执行相应的处理。

通过使用 Annotation，程序员可以在不改变原有逻辑的情况下，在源文件中嵌入一些补充信息。

Annotation 可以像修饰符一样被使用，可用于修饰包、类、构造器、方法、成员变量、参数、局部变量的声明，这些信息被保存在 Annotation 的 “name=value” 对中。

未来的开发模式都是基于注解的，注解是一种趋势，一定程度上可以说：框架 = 注解 + 反射 + 设计模式。

常见的注解实例

一、生成文档相关的注解：

@author 标明开发该类模块的作者，多个作者之间使用,分割
@version 标明该类模块的版本
@see 参考转向，也就是相关主题
@since 从哪个版本开始增加的
@param 对方法中某参数的说明，如果没有参数就不能写
@return 对方法返回值的说明，如果方法的返回值类型是void就不能写
@exception 对方法可能抛出的异常进行说明，如果方法没有用throws显式抛出的异常就不能写其中

二、在编译时进行格式检查（JDK内置的三个基本注解）：

@Override 限定重写父类方法，该注解只能用于方法
@Deprecated 用于表示所修饰的元素(类，方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择
@SuppressWarnings 抑制编译器警告

三、跟踪代码依赖性，实现替代配置文件功能：

Servlet3.0提供了注解(annotation)，使得不再需要在web.xml文件中进行Servlet的部署。

@WebServlet("/login")
public class LoginServlet extends HttpServlet {
	private static final long serialVersionUID = 1L;
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws
    ServletException, IOException { 
    }
    protected void doPost(HttpServletRequest request, HttpServletResponse response) 		throws ServletException, IOException {
        doGet(request, response);
        } 
}

之前通过xml配置处理请求的类：

<servlet>
    <servlet-name>LoginServlet</servlet-name>
    <servlet-class>com.servlet.LoginServlet</servlet-class>
</servlet>
<servlet-mapping>
    <servlet-name>LoginServlet</servlet-name>
    <url-pattern>/login</url-pattern>
</servlet-mapping>

自定义注解

自定义注解使用：参照@SuppressWarnings定义

定义新的 Annotation 类型使用 @interface 关键字
自定义注解自动继承了java.lang.annotation.Annotation接口
Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明
- 其方法名和返回值定义了该成员的名字和类型，我们称为配置参数。
- 类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、以上所有类型的数组。
可使用default关键字为成员变量指定默认值
如果只有一个参数成员，建议使用参数名为value
如果定义的注解含有配置参数，那么使用时必须指定参数值，除非它有默认值。
- 格式是：参数名 = 参数值
- 如果只有一个参数成员，且名称为value，可以省略
没有成员定义的 Annotation 称为标记，包含成员变量称为元数据

注意：自定义注解必须配上注解的信息处理流程才有意义。

package com.hncj;
//声明注解
public @interface MyAnnotation {
    //定义成员变量，可以使用default定义默认值
    String value() default "hello";
}
//使用自定义注解，设置参数
@MyAnnotation(value = "hi")
class Person{
    String name;
    String age;
    ////使用自定义注解,默认值
    @MyAnnotation
    public Person(String name, String age) {
        this.name = name;
        this.age = age;
    }
}

元注解

JDK 的元注解用于修饰其他 Annotation 定义。

java四种元注解：

@Retention：只能用于修饰一个 Annotation 定义，用于指定该 Annotation 的生命周期，@Rentention 包含一个 RetentionPolicy 类型的成员变量，使用时需指定值：
- RetentionPolicy.SOURCE：在源文件中有效，编译器直接丢弃。
- RetentionPolicy.CLASS：在class文件中有效，当运行 Java 程序时， JVM 不会保留注解，这是默认值。
- RetentionPolicy.RUNTIME：在运行时有效，当运行 Java 程序时，JVM 会保留注释。程序可以通过反射获取该注释。
@Target：用于修饰 Annotation 定义, 指定被修饰的 Annotation 能用于修饰哪些程序元素。@Target 也包含一个名为 value 的成员变量。
- TYPE：描述类、注解、接口、枚举类
- FIELD：描述域
- METHOD：描述方法
- PARAMETER：描述参数
- CONSTRUCTOR：描述构造器
- LOCAL_VARIABLE：描述局部变量
- PACKAGE：描述包
@Documented：用于指定被该元 Annotation 修饰的 Annotation 类将被 javadoc 工具提取成文档。默认情况下，javadoc是不包括注解的。
@Inherited：被它修饰的 Annotation 将具有继承性。父类使用了@Inherited修饰的注解，其子类将自动继承该注解。

package com.hncj;

import java.lang.annotation.*;

import static java.lang.annotation.ElementType.*;
//定义注解可以被继承
@Inherited
//定义注解可以提取成javadoc文档
@Documented
//定义注解的使用范围
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
//定义注解的声明周期
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    String value() default "hello";
}
@MyAnnotation(value = "hello")
class Person{
    String name;
    String age;
    @MyAnnotation
    public Person(String name, String age) {
        this.name = name;
        this.age = age;
    }
}

JDK8注解新特性

Java 8对注解处理提供了两点改进：可重复的注解及可用于类型的注解。此外，反射也得到了加强，在Java8中能够得到方法参数的名称。这会简化标注在方法参数上的注解。

@Repeatable：jdk8新特性，只能用于修饰一个 Annotation 定义，用于指定该 Annotation 可重复使用。
- 在@MyAnnotation上声明@Repeatable，成员值为MyAnnotations.class
- @MyAnnotations的@Target、@Retention等元注解需和@MyAnnotation一致

package com.hncj;

import java.lang.annotation.*;
import static java.lang.annotation.ElementType.*;

//jdk8新特性：声明该注解可重复使用
@Repeatable(MyAnnotations.class)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    String value() default "hello";
}
//@Target、@Retention等元注解需和MyAnnotation一致
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotations {
    MyAnnotation[] value();
}

//jdk8之前使用重复注解方式
//@MyAnnotations({@MyAnnotation("hi"), @MyAnnotation("ha")})
@MyAnnotation("hi")
@MyAnnotation("ha")
class Person{
    String name;
    String age;
    public Person(String name, String age) {
        this.name = name;
        this.age = age;
    }
}

在Java 8之前，注解只能是在声明的地方所使用，Java8开始，注解可以应用在任何地方。

JDK1.8之后，关于元注解@Target的参数类型ElementType枚举值多了两个：
- TYPE_PARAMETER：表示该注解能写在类型变量的声明语句中（如：泛型声明）。
- TYPE_USE：表示该注解能写在使用类型的任何语句中。

package com.hncj;

import java.lang.annotation.*;
import java.util.ArrayList;
import static java.lang.annotation.ElementType.*;

@Target({TYPE_PARAMETER, TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    String value() default "hello";
}

//泛型、异常、类型等都能使用注解
class Generic <@MyAnnotation  T>{
    public void show() throws @MyAnnotation RuntimeException{
        ArrayList<@MyAnnotation String> list = new ArrayList<String>();
        int num = (@MyAnnotation int) 10L;
    }
}