Java注解

1、注解，或者叫做注释，英文单词是：Annotation

2、注解Annotation是一种引用数据类型。编译之后也是生成xxx.class文件。

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

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

}

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

        第一：注解使用时的语法格式是：
            @注解类型名

        第二：注解可以出现在类上、属性上、方法上、变量上等.....
            注解还可以出现在注解类型上。

5、JDK内置了哪些注解呢？

        java.lang包下的注释类型：
            【掌握】：Deprecated 用 @Deprecated 注释的程序元素，不鼓励程序员使用这样的元素，通常是因为它很危险或存在更好的选择。

            【掌握】：Override 表示一个方法声明打算重写超类中的另一个方法的声明。

        源码：

public @interface Override {
}

标识性注解，给编译器作参考的。@Override这个注解只能注解方法。
编译器看到方法上这个注解的时候，编译器会自动检查该方法是否重写了父类的方法。如果没有重写，报错。这个注解只是编译阶段起作用，和运行期无关！

            不用掌握：SuppressWarnings 指示应该在注释元素（以及包含在该注释元素中的所有程序元素）中取消显示指定的编译器警告。

6、注解中带有属性

自定义一个注解

public @interface MyAnnotation {
   
    String name();

    //颜色属性
    String color();

    //年龄属性
    int age() default 25; // 属性指定默认值
}

解析：在注解当中可以定义属性，以下这个是MyAnnotation的name属性。看着像一个方法，但实际上我们称之为属性name。

        还可以对属性指定默认值。

测试

@MyAnnotation
public void doSome(){
}

上面代码报错：报错的原因：如果一个注解当中有属性，那么必须给属性赋值。（除非该属性使用是default指定了默认值。）

@MyAnnotation(属性名=属性值, 属性名=属性值, 属性名=属性值)

@MyAnnotation(name="zhansan", color = "红色")
public void doSome(){
}

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

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

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

7、元注解
        什么是元注解？
            用来标注“注解类型”的“注解”，称为元注解。

        常见的元注解有哪些？
            Target，Retention

        关于Target注解：
            这是一个元注解，用来标记“注解类型”的“注解”，这个Target注解用来标记“被标记的注解”可以出现在哪些位置上。

            @Target(ElementType.METHOD)：表示“被标注的注解”只能出现在方法上。
            @Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
                表示该注解可以出现在：
                    构造方法上，字段上，局部变量上，方法上 ...  ，类上..

        关于Retention注解：
            这是一个元注解，用来标注“注解类型”的“注解”，这个Retention注解用来标注“被标注的注解”最终保存在哪里。

        @Retention(RetentionPolicy.SOURCE)：表示该注解只被保留在java源文件中。
        @Retention(RetentionPolicy.CLASS)：表示该注解被保存在class文件中。
        @Retention(RetentionPolicy.RUNTIME)：表示该注解被保存在class文件中。，并且可以被反射机制所读取。

定义一个注解

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

// 只允许该注解可以标注类，方法
@Target({ElementType.TYPE, ElementType.METHOD})
// 希望这个注解可以被反射
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    String value() default "北京大兴区";
}

在一个类上注释这个注解

@MyAnnotation("上海浦东区")
public class MyAnnotationTest {
}

判断类上面是否有@MyAnnotation，使用isAnnotationPresent()方法

try {
    Class c = Class.forName("test.MyAnnotationTest");
    // 判断类上面是否有@MyAnnotation        
    if (c.isAnnotationPresent(MyAnnotation.class)){
        // 获取该注解对象
        MyAnnotation myAnnotation = (MyAnnotation) c.getAnnotation(MyAnnotation.class);
        System.out.println("类上面的注解对象" + myAnnotation); // @test.MyAnnotation()
        // 获取注解对象的属性
        String value = myAnnotation.value();
        System.out.println(value);
    }
    // 判断String类上面是否存在这个注解
    Class stringClass = Class.forName("java.lang.String");
    System.out.println(stringClass.isAnnotationPresent(MyAnnotation.class)); // false
} catch (ClassNotFoundException e) {
    e.printStackTrace();
}

也可以使用反射机制获取类中的方法，方法对象也存在isAnnotationPresent()方法。

8、注解在开发中有什么用呢？
            自定义一个注解，叫做：@Id
            这个注解只能出现在类上面，当这个类上有这个注解的时候，要求这个类中必须有一个int类型的id属性。如果没有这个属性就报异常。如果有这个属性则正常执行！

自定义注解

@Target(ElementType.TYPE)
// 该注解可以被反射机制读取到
@Retention(RetentionPolicy.RUNTIME)
public @interface Id {
}

这个注解@Id用来标注类，被标注的类中必须有一个int类型的id属性，没有就报异常。

定义User类并使用注解@Id来标注

@Id
public class User {
    int id;
    String name;
    String password;
}

自定义一个异常类

public class HasNotIdPropertyException extends RuntimeException{
    public HasNotIdPropertyException() {
    }

    public HasNotIdPropertyException(String message) {
        super(message);
    }
}

测试

try {
    Class userClass = Class.forName("test.User");
    // 判断类上是否存在@Id注解
    boolean isOK = false;  // 给一个默认的标记
    if (userClass.isAnnotationPresent(Id.class)) {
        // 获取类的属性
        Field[] fields = userClass.getDeclaredFields();
        for (Field field : fields) {
            if ("id".equals(field.getName()) && "int".equals(field.getType().getName())) {
                // 表示这个类是合法的类，有@Id注解，则这个类中必须有int类型的id
                isOK = true; // 表示合法
                break;
            }
        }
        // 判断是否合法
        if (!isOK) {
            throw new HasNotIdPropertyException("被@Id注解的类上必须有一个int类型的id属性！");
        }
    }
} catch (ClassNotFoundException e) {
    e.printStackTrace();
}