03-2注解

03-2注解 1注解(Annotation)概述

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

Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用 Annotation, 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。

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

在Java基础中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。在JavaEE/Android中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替JavaEE旧版中所遗留的繁冗代码和XML配置等。

实际项目的开发模式都是基于注解的，JPA是基于注解的，Spring2.5、SpringMVC等框架以上都是基于注解的，注解是一种趋势，一定程度上可以说：框架 = 注解 + 反射 + 设计模式

使用 Annotation 时要在其前面增加 @ 符号, 并把该 Annotation 当成一个修饰符使用。用于修饰它支持的程序元素

2常见的Annotation示例 2.1生成文档相关的注解

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

其中

• @param @return 和 @exception 这三个标记都是只用于方法的。
• @param的格式要求：@param 形参名 形参类型 形参说明
• @return 的格式要求：@return 返回值类型 返回值说明
• @exception的格式要求：@exception 异常类型 异常说明
• @param和@exception可以并列多个

2.2在编译时进行格式检查(JDK内置的三个基本注解)

@Override: 限定重写父类方法, 该注解只能用于方法

  @Override
    public String toString() {
        return "Size{" +
                "abbreviation='" + abbreviation + ''' +
                ", desc='" + desc + ''' +
                '}';
    }

    @Override
    public void show() {
        System.out.println("衣服尺寸枚举类");
    }

@Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择

@SuppressWarnings: 抑制编译器警告

    public static void main(String[] args) {
        @SuppressWarnings("unused")
        int num = 10;
//        System.out.println(num);

        @SuppressWarnings({ "unused", "rawtypes" })
        ArrayList list = new ArrayList();
    }

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

开发项目时，会使用注解代替配置文件，比如spring的@Transactional(),@Service等

@WebServlet("/login")代替了web.xml中的配置文件信息

@WebServlet("/login")
public class SecondServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        System.out.println("login");
        super.doGet(req, resp);
    }
}

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

3自定义Annotation  3.1自定义注解

定义新的 Annotation 类型使用 @interface 关键字

自定义注解自动继承了java.lang.annotation.Annotation接口

Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、以上所有类型的数组。

可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始值可使用 default 关键字

如果只有一个参数成员，建议使用参数名为value

如果定义的注解含有配置参数，那么使用时必须指定参数值，除非它有默认值。格式是“参数名 = 参数值”，如果只有一个参数成员，且名称为value，可以省略“value=”

没有成员定义的 Annotation 称为标记(比如接口Serializable); 包含成员变量的 Annotation 称为元数据 Annotation

注意：自定义注解必须配上注解的信息处理流程才有意义（使用反射）

3.2代码实现

参考jdk中SuppressWarnings

public @interface Annotation1 {
    // String[] value();
    String[] value() default "abc";//default指定默认值
}

 该注解就是最简单的一个注解，调用方式

// @Annotation1("aa") //不指定默认值就会报错
@Annotation1(value = "aa")//当成员变量只有一个时，可以省略
public class Person {
//成员 属性
}

3.3元注解

元注解：用于修饰其他注解的注解

元数据：修饰现有数据的数据
        String age=12;  String和age就是元数据

java中提供了四个元注解

@Retention

@Target

@documented

@Inherited

3.3.1@Retention

Retention：指定所修饰的 Annotation 的生命周期：用于指定该 Annotation 的生命周期, @Rentention 包含一个 RetentionPolicy 类型的成员变量, 使用@Rentention 时必须为该 value 成员变量指定值:

看下@Retention源码

 RetentionPolicy是一个枚举类

 

 总结：

SOURCE在源文件中有效（即源文件保留），编译器直接丢弃这种策略的注释CLASS在class文件中有效（即class保留） ， 当运行 Java 程序时, JVM 不会保留注解。 这是默认值RUNTIME在运行时有效（即运行时保留），当运行 Java 程序时, JVM 会保留注释。程序可以通过反射获取该注释

3.3.2@Target

@Target: 用于指定被修饰的 Annotation 能用于修饰哪些程序元素。 @Target 也包含一个名为 value 的成员变量。

 

TYPE描述类、接口(包括注解类型)或enum声明FIELD描述域METHOD描述方法PARAMETER描述参数CONSTRUCTOR描述构造方法LOCAL_VARIABLE描述局部变量PACKAGE  描述包TYPE_PARAMETER  1.8新增TYPE_USE1.8新增

自定义注解通常都会指明两个元注解：Retention、Target

3.3.3@documented和@Inherited        

@documented:  修饰的 Annotation 类将被javadoc 工具提取成文档。默认情况下，javadoc是不包括注解的

定义为documented的注解必须设置Retention值为RUNTIME。 

比如Date类中的构造器

@Inherited: 被它修饰的 Annotation 将具有继承性。如果某个类使用了被@Inherited 修饰的 Annotation, 则其子类将自动具有该注解。

比如：如果把标有@Inherited注解的自定义的注解标注在类级别上，子类则可以继承父类类级别的注解

一般用的较少

4jdk8注解新特性

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

4.1可重复的注解

jdk8之前编写可重复注解

@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface Annotation1 {
    // String[] value();
    String[] value() default "abc";//default指定默认值
}
public @interface Annotations2 {
    Annotation1[] value();
}

//jdk8之前写法
@Annotations2({@Annotation1(value = "aa"),@Annotation1(value = "bb")})
public class Person {
    //
}

jdk8可重复注解：使用@Repeatable 注解

@Repeatable(Annotation2.class)//需要跟Annotation2的Target和Retention一致
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Annotation1 {
    // String[] value();
    String[] value() default "abc";//default指定默认值
}
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Annotation2 {
    Annotation1[] value();
}

@Annotation1("aa")
@Annotation1("bb")
public class Person {
}

4.2类型注解

JDK1.8之后，关于元注解@Target的参数类型ElementType枚举值多了两个：TYPE_PARAMETER,TYPE_USE。 

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

ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语句中（如：泛型声明）。 

ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中。

@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE,TYPE_PARAMETER,TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Annotation1 {
    // String[] value();
    String[] value() default "abc";//default指定默认值
}

public class Student <@Annotation1 T>{//因为Annotation1声明了TYPE_PARAMETER

    public void study() throws @Annotation1 Exception{//因为Annotation1声明了TYPE_USE
        ArrayList<@Annotation1  String> list = new ArrayList<>();
        int num =(@Annotation1 int)1L;
    }
}