Java注解详解

注解

注解概述

• 从JDK5.0开始，Java增加了对元数据(MetaData)的支持,也就是Annotation(注解)

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

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

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

• 未来的开发模式都是基于注解的，JPA是基于注解的，Spring2.5以上都是基于注解的，Hibernate3.x以后也是基于注解的，现在的Struts2有一部分也是基于注解的了，注解是一种趋势，一定程度上可以说:框架=注解+反射+设计模式。

常见注解示例

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

示例一:生成文档相关的注解

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

示例二:在编译时进行格式检查JDK内置的三个基本注解)

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

示例三:跟踪代码依赖性，实现替代配置文件功能

JDK注解代码示例

@Override：重写父类方法

class Person {
    private String name;
    private int age;

    public Person(String name, int age) {
        this.name = name;
        this.age = age;
    }

    public Person() {
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public void eat(){
        System.out.println("人吃饭");
    }

    public void walk(){
        System.out.println("人走路");
    }

}

interface Info{
    void show();
}

class Student extends Person implements  Info{
    @Override
    public void show() {
        
    }

    @Override
    public void eat() {
        super.eat();
    }

    @Override
    public void walk() {
        super.walk();
    }
}

编译器会为我们检查该方法是否是实现接口方法或者是重写父类的方法，如果我们故意写一个方法不是重写方法而加上注解，会给出一个提示警告

@SuppressWarnings:抑制编译器警告

@SuppressWarnings("unused")
int num=10;

自定义注解

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

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

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

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

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

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

• 没有成员定义的Annotation称为标记;包含成员变量的Annotation 称为元数据Annotation注意:自定义注解必须配上注解的信息处理流程才有意义。

IDEA中的定义操作

1. IDEA中new ->选择注解类型

2. 生成如下的模板

package com.dreamcold.annotions;

public @interface MyAnnotation {
}

定义示例

标注：

• 注解声明为: @interface
• 内部定义成员，通常使用value表示
• 可以指定成员的默认值，使用default定义
• 如果自定义注解没有成员，表明是一个标识作用。
• 如果注解有成员，在使用注解时，需要指明成员的值
• 自定义注解必须配上注解的信息处理流程(使用反射)才有意义。

MyAnnotation.java

package com.dreamcold.annotions;

public @interface MyAnnotation {
    String value();
}

Person.java

@MyAnnotation(value = "hello")
class Person {
    private String name;
    private int age;

    public Person(String name, int age) {
        this.name = name;
        this.age = age;
    }

    public Person() {
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public void eat(){
        System.out.println("人吃饭");
    }

    public void walk(){
        System.out.println("人走路");
    }

}

这种情况下一定要给注解传一个值，否则就会报错

这种情况下我们可以给对应属性一个默认值,使用default关键字：

package com.dreamcold.annotions;

public @interface MyAnnotation {
    String value() default "hello";
}

jdk提供的4种元注解

• JDK的元Annotation用于修饰其他Annotation定义
• JDK5.0提供了4个标准的meta annotation类型， 分别是:
  • Retention
  • Target
  • Documented
  • Inherited
• 元数据的理解:
  • String name = "dreamcold";

Retention

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

• RetentionPolicy.SOURCE:在源文件中有效(即源文件保留),编译器直接丢 弃这种策略的注释.
• RetentionPolicy.CLASS:在class文件中有效(即class保留)，当运行Java程序时，JVM不会保留注解。这是默认值，不指定的话默认是它
• RetentionPolicy.RUNTIME:在运行时有效(即运行时保留) , 当运行Java程序时, JVM会保留注释。程序可以通过反射获取该注释。只有声明为RUNTIME生命周期的注解，才能通过反射获取。

比如以@SuppressWarnings:抑制编译器警告为例：

我们再次点进去SOURCE:我们发现实际上是一个枚举类：

注释告诉我们注解将在被编译器丢弃，也就是在javac命令将.java文件编译成为.class后，.class文件中不会保留该注解，其他值类型效果如上。

Target

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

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

比如以@SuppressWarnings:抑制编译器警告为例：

@Target中的类型是一个枚举类，这些枚举类如下：其枚举类一些该注解可以写在的位置比如属性、构造器、变量等等

public enum ElementType {
    /** Class, interface (including annotation type), or enum declaration */
    TYPE,

    /** Field declaration (includes enum constants) */
    FIELD,

    /** Method declaration */
    METHOD,

    /** Formal parameter declaration */
    PARAMETER,

    /** Constructor declaration */
    CONSTRUCTOR,

    /** Local variable declaration */
    LOCAL_VARIABLE,

    /** Annotation type declaration */
    ANNOTATION_TYPE,

    /** Package declaration */
    PACKAGE,

    /**
     * Type parameter declaration
     *
     * @since 1.8
     */
    TYPE_PARAMETER,

    /**
     * Use of a type
     *
     * @since 1.8
     */
    TYPE_USE
}

我们之前自己定义的注解什么都没有加，所以其可以在任何地方标注，我们可以给其加上一些限制：

package com.dreamcold.annotions;

import java.lang.annotation.ElementType;
import java.lang.annotation.Target;

//我们的注解可以修饰方法
@Target({ElementType.METHOD})
public @interface MyAnnotation {
    String value() default "hello";
}

这时候我们用我们的注解修饰一个变量，就会报错：会提示我们的注解不能修饰变量！

两种不常用的元注解

• @Documented:用于指定被该元Annotation修饰的Annotation类将被
  javadoc工具提取成文档。默认情况下，javadpc是不包括注解的。
  • 定义为Documented的注解必须设置Retention值为RUNTIME.
  • 表示所修饰的注解在被javadoc解析时， 保留下来。
• @Inherited:被它修饰的Annotation将具有继承性。如果某个类使用了被
  • @Inherited修饰的Annotation,则其子类将自动具有该注解。
  • 比如:如果把标有@Inherited注解的自定义的注解标注在类级别上，子类则可以
    继承父类类级别的注解
  • 实际应用中，使用较少

JDK8中的注解新特性

可重复注解

什么是可重复注解呢？

我们想给一个类Person类加上两个重复的注解，比如两个重复的@MyAnnotation,但是这时候IDEA会报错：

也就是注解重复了，我们要想实现这样的效果，在JDK8之前是按照这样实现的：

MyAnnotation

package com.dreamcold.annotions;

import java.lang.annotation.ElementType;
import java.lang.annotation.Target;

@Target({ElementType.TYPE,ElementType.METHOD})
public @interface MyAnnotation {
    String value() default "hello";
}

MyAnnotations.java

package com.dreamcold.annotions;

public @interface MyAnnotations {
    MyAnnotation[] value();
}

Person.java

@MyAnnotations({@MyAnnotation,@MyAnnotation})
class Person {
    private String name;
    private int age;

    public Person(String name, int age) {
        this.name = name;
        this.age = age;
    }

    public Person() {
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public void eat(){
        System.out.println("人吃饭");
    }

    public void walk(){
        System.out.println("人走路");
    }

}

JDK8之后的写法：

MyAnnotation.java

package com.dreamcold.annotions;

import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Target;

@Repeatable(MyAnnotations.class)
@Target({ElementType.TYPE,ElementType.METHOD})
public @interface MyAnnotation {
    String value() default "hello";
}

MyAnnotations.java

package com.dreamcold.annotions;

import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Target;

@Target({ElementType.TYPE,ElementType.METHOD})
public @interface MyAnnotations {
    MyAnnotation[] value();
}

1. 注意要注意@Repeatable的生命周期不可以小于注解的生命周期
2. 注意MyAnnotation可以标注注解的位置，MyAnnotations可以标注注解的位置一定要包括MyAnnotation可以标注注解的位置

Person.java

@MyAnnotation
@MyAnnotation
class Person {
    private String name;
    private int age;

    public Person(String name, int age) {
        this.name = name;
        this.age = age;
    }

    public Person() {
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public void eat(){
        System.out.println("人吃饭");
    }

    public void walk(){
        System.out.println("人走路");
    }

}

总结

• MyAnnotation.上声明@Repeatable, 成员值为MyAnnotations.class

• MyAnnotation的Target Retent ion和MyAnnotations相同

类型注解

在JDK1.8中ElementType中新增了两种类型：

类型注解:

• JDK1.8之后，关于元注解@ Target的参数类型ElementType枚举值多了两个:TYPE_PARAMETER,TYPEUSE
• 在Java8之前，注解只能是在声明的地方所使用，Java8开始，注解可以应用.在任何地方。
  • ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语句中(如:泛型声明)
  • ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中

示例一

MyAnnotation.java

package com.dreamcold.annotions;

import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Target;

@Repeatable(MyAnnotations.class)
@Target({ElementType.TYPE,ElementType.METHOD,ElementType.TYPE_PARAMETER})
public @interface MyAnnotation {
    String value() default "hello";
}

Generic.java

package com.dreamcold.annotions;

public class Generic <@ MyAnnotation T>{
}

示例二：加上ElementType.TYPE_USE在哪里都可以标注

MyAnnotation.java

package com.dreamcold.annotions;

import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Target;

@Repeatable(MyAnnotations.class)
@Target({ElementType.TYPE,ElementType.METHOD,ElementType.TYPE_PARAMETER,ElementType.TYPE_USE})
public @interface MyAnnotation {
    String value() default "hello";
}

Generic.java

package com.dreamcold.annotions;

import java.util.ArrayList;

public class Generic <@ MyAnnotation T>{
    public void show() throws @MyAnnotation RuntimeException{
        ArrayList<@MyAnnotation String> list=new ArrayList<>();
        int num=(@MyAnnotation int)10L;
    }
}