注解(Annotation)

注解(Annotation)

怎么自定义注解呢？语法格式？

	 [修饰符列表] @interface 注解类型名{

	 }

注解怎么使用，用在什么地方？

	第一：注解使用时的语法格式是：
		@注解类型名
	
	第二：注解可以出现在接口上丶类上、属性上、方法上、局部变量上等....
	     注解还可以出现在注解类型上。

代码示例：

//自定义一个注解
public @interface  MyAnnotation{

}


//演示注解可以出现的位置
@MyAnnotation  //在类上
public class AnnotationTest01 {

    @MyAnnotation //实例变量上
    private int no;

    @MyAnnotation  //构造方法上
    public AnnotationTest01(){}
 
    @MyAnnotation //实例方法上
    public static void m1(){
        @MyAnnotation
        int i = 100;
    }

    @MyAnnotation  
    public void m2(@MyAnnotation   //修饰形参
                   String name,
                   @MyAnnotation
                   int k){

    }
}

@MyAnnotation   //接口上
interface MyInterface {

}

@MyAnnotation   //枚举上
enum Season {
    SPRING,SUMMER,AUTUMN,WINTER
}

JDK内置了哪些注解？

java.lang包下的注释类型：

Deprecated ：这个注解标注的元素已经过时，主要是向其他程序员传达一个信息，有更好的解决方案存在
Override ：用来标注一个方法,被标注的方法必须是重写父类的方法
SuppressWarnings 指示应该在注释元素（以及包含在该注释元素中的所有程序元素）中取消显示指定的编译器警告。 

元注解

元注解：用来标注“注解类型”的“注解”，称为元注解。

常见的元注解有：@Documented @Target @Retention

@Documented ：标记当前注解参与 Javadoc 操作，可以生成对应的【JavaDOC 文档】
@Target ：  用来标注“被标注的注解”可以用于哪些 Java 元素
@Retention：决定当前注解参与哪一个步骤（代码执行有三个步骤：1. 编译 2. 生成 .class 字节码文件 3. 运行）
	

@Documented

标记当前注解参与 Javadoc 操作，可以生成对应的【JavaDOC 文档】

@Target：用来标注“被标注的注解”可以出现在哪些位置上。

eg： @Target(ElementType.METHOD)：表示“被标注的注解”只能出现在方法上。

ElementType	功能概述
ElementType.TYPE	表示当前注解可以用于类和接口，以及枚举
ElementType.FIELD	表示当前注解可以用于成员变量
ElementType.METHOD	表示当前注解可以用于成员方法
ElementType.PARAMETER	表示当前注解可以用于成员方法参数 @NotNull
ElementType.CONSTRUCTOR	表示当前注解可以用于构造方法
ElementType.ANNOTATION_TYPE	表示当前注解可以用于注解
ElementType.LOCAL_VARIABLE	表示当前注解可以用于局部变量
ElementType.PACKAGE	表示当前注解可以用于包

Retention注解：用来标注“被标注的注解”最终保存在哪里

@Retention(RetentionPolicy.SOURCE)： 仅参与编译过程，进行语法约束等其他任务，不会在 .class 字节码文件中存在
@Retention(RetentionPolicy.CLASS)：表示该注解被保存在class文件中，参与编译和生成 .class 字节码文件过程，但是不参与运行过程
@Retention(RetentionPolicy.RUNTIME)：当前注解参与代码运行，一般用于提供数据内容，并且可以被反射机制所读取。      

注解中定义属性

如果一个注解当中有属性，那么必须给属性赋值。（除非该属性使用default指定了默认值）

public @interface MyAnnotation {
    /**
     * 我们通常在注解当中可以定义属性，以下这个是MyAnnotation的name属性。
     * 看着像1个方法，但实际上我们称之为属性name。
     * @return
     */
    String name();
    String color();
    int age() default 25; //属性指定默认值
}

public class MyAnnotationTest {

    // 报错的原因：如果一个注解当中有属性，那么必须给属性赋值。（除非该属性使用default指定了默认值。）
    /*@MyAnnotation
    public void doSome(){

    }*/

    //@MyAnnotation(属性名=属性值,属性名=属性值,属性名=属性值)
    @MyAnnotation(name = "张三", color = "红色")
    public void doSome(){

    }

}

如果一个注解的属性的名字是value，并且只有一个属性的话，在使用的时候，该属性名可以省略。

public @interface MyAnnotation {

    /*
    指定一个value属性。
     */
    String value();
}

/*
如果一个注解的属性的名字是value，并且只有一个属性的话，在使用的时候，该属性名可以省略。
 */
public class MyAnnotationTest {

 
    @MyAnnotation("haha")
    public void doOther(){

    }

数组中只有1个元素：大括号可以省略。

//自定义一个注解
public @interface OtherAnnotation {
    /*
    年龄属性
     */
    int age();

    /*
    邮箱地址属性，支持多个
     */
    String[] email();
}


public class OtherAnnotationTest {

    // 数组是大括号
    @OtherAnnotation(age = 25, email = {"zhangsan@123.com", "zhangsan@sohu.com"})
    public void doSome(){

    }

    // 如果数组中只有1个元素：大括号可以省略。
    @OtherAnnotation(age = 25, email = "zhangsan@123.com")
    public void doOther(){

    }

}

注解中的属性可以是哪一种类型

注解当中的属性可以是哪一种类型？
属性的类型可以是：
byte short int long float double boolean char String Class 枚举类型
以及以上每一种的数组形式。

反射注解

案例：通过反射获取标注在类上的注解的属性

代码示例：

//自定义一个注解
//只允许该注解可以标注类、方法
@Target({ElementType.TYPE, ElementType.METHOD})
// 希望这个注解可以被反射
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {

    /*
    value属性。
     */
    String value() default "熊大";
}

@MyAnnotation
public class MyAnnotationTest {

}

public class ReflectAnnotationTest {
    public static void main(String[] args) throws Exception{
        // 获取这个类
        Class c = Class.forName("com.mjl.Test.MyAnnotationTest");
        // 判断类上面是否有@MyAnnotation
        if(c.isAnnotationPresent(MyAnnotation.class)){
            // 获取该注解对象
       MyAnnotation myAnnotation = (MyAnnotation)c.getAnnotation(MyAnnotation.class);
          //获取该注解的value属性
            String value = myAnnotation.value();
            System.out.println(value);//熊大
        }
    }
}