注解的使用

目录

1. 注解的理解

2. 注解的使用示例 

3. 如何自定义注解：参照@SuppressWarnings定义

4. 元注解 ：对现有的注解进行解释说明的注解 

5. 如何获取注解信息:通过发射来进行获取、调用 

 6.JDK8中注解的新特性：可重复注解、类型注解

6.1 可重复注解

6.2 类型注解

1. 注解的理解

• ① jdk 5.0 新增的功能
• ② Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用 Annotation,程序员可以在不改变原逻辑的情况下, 在源文件中嵌入一些补充信息。
• ③在JavaSE中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。JavaEE/Android
• 中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替JavaEE旧版中所遗留的繁冗代码和XML配置等。

 框架 = 注解 + 反射机制 + 设计模式

2. 注解的使用示例 

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

示例二：在编译时进行格式检查(JDK内置的个基本注解)
    @Override: 限定重写父类方法, 该注解只能用于方法
    @Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的择
    @SuppressWarnings: 抑制编译器警告

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

3. 如何自定义注解：参照@SuppressWarnings定义

① 注解声明为：@interface
② 内部定义成员，通常使用value表示
③ 可以指定成员的默认值，使用default定义
④ 如果自定义注解没成员，表明是一个标识作用。 

说明： 

• 如果注解有成员，在使用注解时，需要指明成员的值。
• 自定义注解必须配上注解的信息处理流程(使用反射)才意义。
• 自定义注解都会通过指明两个元注解：Retention、Target

代码举例： 

@Inherited
@Repeatable(MyAnnotations.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE,TYPE_PARAMETER,TYPE_USE})
public @interface MyAnnotation {

    String value() default "hello";
}


@MyAnnotation("hello")
public class Student{
}

4. 元注解 ：对现有的注解进行解释说明的注解 

jdk 提供的4种元注解：
Retention：指定所修饰的 Annotation 的生命周期：SOURCE\CLASS（默认行为)\RUNTIME
                   只有声明为RUNTIME生命周期的注解，才能通过反射获取。
Target:用于指定被修饰的 Annotation 能用于修饰哪些程序元素
*******以下注解出现的频率较低*******
Documented:表示所修饰的注解在被javadoc解析时，保留下来。
Inherited:被它修饰的 Annotation 将具继承性。

类比：元数据的概念：String name = "Tom";

5. 如何获取注解信息:通过发射来进行获取、调用 

前提：要求此注解的元注解Retention中声明的生命周期状态为：RUNTIME 

@Test
public void test21(){
    Class studentClass = Student.class;
    Annotation[] annotations = studentClass.getAnnotations();
    for (Annotation annotation : annotations) {
        System.out.println(annotation);//@exception.MyAnnotation(value=[hello])
    }
}

 6.JDK8中注解的新特性：可重复注解、类型注解

 jdk8之前的写法：

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

@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE,TYPE_PARAMETER,TYPE_USE})
public @interface MyAnnotation {
    String[] value();
}

//jdk8之前的写法：
@MyAnnotaions({@MyAnnotation("hello"),@MyAnnotation("hi")})
public class Student{
}

    @Test
    public void test21(){
        Class studentClass = Student.class;
        Annotation[] annotations = studentClass.getAnnotations();
        for (Annotation annotation : annotations) {
            System.out.println(annotation);//@exception.MyAnnotaions(value=[@exception.MyAnnotation(value=[hello]), @exception.MyAnnotation(value=[hi])])
        }
    }

6.1 可重复注解

① 在MyAnnotation上声明@Repeatable，成员值为MyAnnotations.class
② MyAnnotation的Target和Retention等元注解与MyAnnotations相同;Inherited注解在                MyAnnotation和MyAnnotations要么同时有，要么都不用。 

@Inherited
@Repeatable(MyAnnotaions.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE,TYPE_PARAMETER,TYPE_USE})
public @interface MyAnnotation {
    String[] value();
}

@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE,TYPE_PARAMETER,TYPE_USE})
public @interface MyAnnotaions {
    MyAnnotation[] value();
}

@MyAnnotation("hello")
@MyAnnotation("hi")
public class Student{
}

6.2 类型注解

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

@Inherited
@Repeatable(MyAnnotaions.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE,TYPE_PARAMETER,TYPE_USE})
//TYPE_USE表示该注解能写在使用类型的任何语句中
public @interface MyAnnotation {
    String[] value() default "hello";
}

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