注解

什么是注解

• Annotation 是从JDK5.0版本引入的技术
• Annotation 的作用
  • 不是程序本身，可以对程序做出解释。（这一点和注释（comment）没什么区别）
  • 可以被其他程序（比如：编译器等）读取
• Annotation 的格式
  • 注解是以 "@注解名" 在代码中存在的，还可以添加一些参数值，例如：@SuppressWarnings(value = "unchecked")
• Annotation 在哪里使用
  • 可以附加在package，class，field 等上面，相当于给他们添加了额外的辅助信息，我们可以通过反射机制编程实现对这些元数据的访问

例：

//什么是注解
public class Test01 extends Object{

    //@Override  重写的注解
    @Override
    public String toString() {
        return super.toString();
    }

    //Deprecated    不推荐程序员使用，但是可以使用，或者存在更好的方式
    @Deprecated
    public static void test(){
        System.out.println("Deprecated");
    }

    //作用：用于抑制编译器产生警告信息
    @SuppressWarnings("all")
    public void test02(){
        List list = new ArrayList();
    }


    public static void main(String[] args) {
        test();
    }

}

内置注解

• @Override：定义在java.lang.Override中，此注释只适用于修辞方法，表示一个方法声明打算重写超类中的另一个方法声明
• @Deprecated：定义在java.lang.Deprecated中，此注释可以用于修辞手法，属性，类，表示不鼓励程序员使用这样的元素，通常是因为它很危险或者存在更好的选择 
• @SuppressWarnings：定义在java.lang.SuppressWarnings中，用来抑制编译时的警告信息。

        与前面两个注释有所不同，你需要添加一个参数才能正确使用，这些参数都是已经定义好了的，我们选择性的使用就好了。

1. @SuppressWarnings（"all"）
2. @SuppressWarnings（"unchecked"）
3. @SuppressWarnings（value={"unchecked","deprecation"}）

元注解

• 元注解的作用就是负责注解其他注解，Java定义了4个标准的meta-annotation类型，他们被用来提供对其他annotation类型说明
• 这些类型和它们所支持的类在 java.lang.annotation 包中可以找到

        ① @Target：用于描述注解的使用范围（即：被描述的注解可以用在说明地方）

                1.CONSTRUCTOR:用于描述构造器

                2.FIELD:用于描述域

                3.LOCAL_VARIABLE:用于描述局部变量

                4.METHOD:用于描述方法

                5.PACKAGE:用于描述包

                6.PARAMETER:用于描述参数

                7.TYPE:用于描述类、接口(包括注解类型) 或enum声明

        ② @Retention：表示需要在说明级别保存改注释信息，用于描述注解的的生命周期 (SOURCE < CLASS < RUNTIME)

                1.RetentionPolicy.SOURCE：注解只保留在源文件，当Java文件编译成class文件的时候，注解被遗弃；

                2.RetentionPolicy.CLASS：注解被保留到class文件，但jvm加载class文件时候被遗弃，这是默认的生命周期；

                3.RetentionPolicy.RUNTIME：注解不仅被保存到class文件中，jvm加载class文件之后，仍然存在；

        ③ @Document：说明该注解被包含在javadoc中

        ④ @Inherited：说明子类可以继承父类中的该注解

例：

//测试元注解
public class Test02 {

    @MyAnnotation
    public void test(){

    }
}

//定义一个注解
//Target 表示我们的注解可以用在哪些地方，
@Target(value = {ElementType.METHOD, ElementType.TYPE})

//Retention 表示我们的注解在什么地方还有效
//  runtime > class > sources
@Retention(value = RetentionPolicy.RUNTIME)

//Documented 表示是否将我们的注释生成在JAVAdoc中
@Documented

//Inherited 子类可以继承父类的注解
@Inherited
@interface MyAnnotation{

}

自定义注解

• 使用@interface自定义注解时，自动继承了 java.lang.annotation.Annotation 接口
• 分析：
  • @interface用来声明一个注解，格式： @interface 注解名 { 定义内容 }
  • 其中的每一个方法实际上是声明了一个配置参数
  • 方法的名称就是参数的名称
  • 返回值类型就是参数的类型 （返回值只能是基本类型 Class ，String ，enum）
  • 可以通过 default 来声明参数的默认值
  • 如果只有一个参数成员，一般参数名为 value
  • 注解元素必须要有值，我们定义注解元素时，经常使用空字符串 0 作为默认值

例：

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

//自定义注解
public class Test03 {
    //注解可以显示赋值，如果没有默认值，我们就必须给注解赋值
    @MyAnnotation2()
    public void test(){

    }

    @MyAnnotation3("")
    public void test2(){

    }
}

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2{
    //注解的参数：参数类型 + 参数名()；
    String name() default "";   //default默认值
    int age() default 0;
    int id() default -1;    //默认值为-1，代表不存在

    String[] schools() default{"清华大学","北京大学"};

}

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation3{
    //注解只有一个值，可以使用value命名
    String value();
}