Java基础之注解

注解(Annotation)

注解的概括

• 从JDK 5.0开始,Java增加了对元数据(MetaData)的支持,也就是Annotation(注解)
• Annotation其实就是代码里的特殊标记,这些标记可以在编译,类加载,运行时被读取,并执行相应的处理。通过使用Annotation,程序员可以在不改变原有逻辑的情况下,在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。
• Annotation可以像修饰符一样被使用,可用于修饰包,类,构造器,方法,成员变量,参数,局部变量的声明,这些信息被保存在Annotation的“name=value”对中。
• 在JavaSE中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。在JavaEE/Android中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替JavaEE旧版中所遗留的繁冗代码和XML配置等。
• 未来的开发模式都是基于注解的，JPA是基于注解的，Spring2.5以上都是基于注解的，Hibernate3.x以后也是基于注解的，现在的Struts2有一部分也是基于注解的了，注解是一种趋势，一定程度上可以说:框架=注解＋反射＋设计模式。

常见Annotation示例

• 使用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:抑制编译器警告

自定义Annotation

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

注意:自定义注解必须配上注解的信息(使用反射)处理流程才有意义。

JDK中的元注解(元注解：对现有注解进行解释说明的注解)

• JDK的元Annotation用于修饰其他Annotation定义

• JDK5.0提供了4个标准的meta-annotation类型，分别是:

  • Retention:指定所修饰的Annotation的生命周期：SOURCE\CLASS(默认行为)\RUNTIEM(只有声明为RUNTIME生命周期的注解，才能通过反射获取)

  • Target:用于指定被修饰的Annotation能用于修饰哪些程序元素

  • Documented:表示所修饰的注解在被javadoc解析式，保留下来。

  • lnherited:被它修饰的Annotation将具有继承性。

取值(ElementType)		取值(ElementType)
CONSTRUCTOR	用于描述构造器	PACKAGE	用于描述包
FIELD	用于描述域	PARAMETER	用于描述参数
LOCAL_VARIABLE	用于描述局部变量	TYPE	用于描述类、接口(包括注解类型)或enum声明
METHOD	用于描述方法

jdk 8 中注解的新特性：可重复注解、类型注解

1. 可重复注解：① 在MyAnnotation上声明@Repeatable，成员值为MyAnnotations.class

   ​ ② MyAnnotation的Target和Retention等元注解(包含Inherited(如果此元注解不一致，编译时不报错，但运行时会报错))与MyAnnotations相同。

2. 类型注解：ELementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语句中(如:泛型声明)。

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

---

代码体现：

AnnotationTest.java

package Test;
import org.junit.Test;

import java.lang.annotation.Annotation;
import java.util.ArrayList;
import java.util.Date;

/**
 * @创建人 Hexin
 * @创建时间 2022/12/1
 * @描述
 */
public class AnnotationTest {
/**
 *@BelongsProject: JavaSenior
 *@BelongsPackage: Test
 *@Author: hexin
 *@CreateTime: 2022-12-01  09:11
 *@Description:
 *@Version: 1.0
 *
 */
public static void main(String[] args) {
    Person person = new Person();
    person.walk();
    Date date = new Date(2022,9,06);
    System.out.println(date);
    @SuppressWarnings("unused") //编译时，忽视异常
            int num = 10;
    @SuppressWarnings({"unused","rawtypes"})
    ArrayList list = new ArrayList();
}
    @Test
    public void testGetAnnotation(){
        Class clazz = Student.class;
        Annotation[] annotations = clazz.getAnnotations();
        for (int i = 0; i < annotations.length; i++) {
            System.out.println(annotations[i]);
        }
    }

}
//@MyAnnotation(value = "hello")或
@MyAnnotation(value = "hi"/*或"hi"*/)//此时value = "hi"是对value1的重新赋值(其有默认值，为hello)
//jdk8之前的写法
//@MyAnnotations({@MyAnnotation(value = "hi"),@MyAnnotation(value = "hello")})
//jdk8的新特性：可重复注解
@MyAnnotation(value = "hi")
@MyAnnotation(value = "hellow")
class Person{
    private String name;
    private int age;

    public Person(String name, int age) {
        this.name = name;
        this.age = age;
    }
    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 walk(){
        System.out.println("人走路");
    }
    public void sleep(){
        System.out.println("人睡觉");
    }

    public Person() {
    }
}
interface Information{
    void show();
}
class Student extends Person implements Information{
    @Override
    public void walk() {
        System.out.println("学生运动");
    }

    @Override
    public void show() {
        System.out.println("学生表演");
    }
}
//jdk8新特性，类型注解
class Generic<@MyAnnotation T>{
    public void show ()throws @MyAnnotation RuntimeException{
        ArrayList <@MyAnnotation String> list = new ArrayList<>();

        int num = (@MyAnnotation int)10L;
    }
}

Annotation.java(注解)

package Test;

import java.lang.annotation.*;

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

/**
 * @创建人 Hexin
 * @创建时间 2022/12/1
 * @描述
 */
@Inherited
@Documented
@Repeatable(MyAnnotations.class)
@Target({TYPE,METHOD,FIELD,PARAMETER,CONSTRUCTOR,LOCAL_VARIABLE,TYPE_PARAMETER,TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    //String value();
    String value() default"hello";
}

Annotations.java(注解)

package Test;

import java.lang.annotation.*;

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

/**
 * @创建人 Hexin
 * @创建时间 2022/12/1
 * @描述
 */
@Inherited
@Documented
@Target({TYPE,METHOD,FIELD,PARAMETER,CONSTRUCTOR,LOCAL_VARIABLE,TYPE_PARAMETER,TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotations {
    MyAnnotation[] value();
}