JavaSE——注解

注解

一、注解概述

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

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

3. 注解的定义

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

   ​ }

4. 注解的使用

   （1）注解使用时的语法格式是：
   @注解类型名

   （2）注解可以出现在类上、属性上、方法上、变量上等…注解还可以出现在注解类型上。

5. JDK内置的注解

   java.lang包下的注释类型：

   ​ 掌握：
   ​ Deprecated 用 @Deprecated 注释的程序元素，不鼓励程序员使用这样的元素，通常是因为它很危险或存在更好的选择。

   ​ 掌握：
   ​ Override 表示一个方法声明打算重写超类中的另一个方法声明。 编译器会对被注解的进行检查，若未对父类重写或者重写错 误则会报错。源代码为：

   public @interface Override {//这个注解只是在编译阶段起作用，和运行期无关！
   }
   

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

6. 元注解

   （1）元注解的定义

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

   （2）常见的元注解有哪些？
   ①Target

   ​ 关于Target注解：
   ​ 这是一个元注解，用来标注“注解类型”的“注解”，这个Target注解用来标注“被标注的注解”可以出现在：

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

   ​ ②Retention

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

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

   7. 注解中定义属性

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

      package Annotation;
      
      public @interface MyAnnotation {
      
          String name();
      
          /*
          颜色属性
           */
          String color();
      
          /*
          年龄属性
           */
          int age() default 25; //属性指定默认值
      }
      

      （2）属性是value时可以省略

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

      @MyAnnotation("hehe")
          public void doSome(){
      
          }
      

      （3）注解当中的属性类型

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

   8. 反射注解

      package Annotation2;
      
      public class ReflectAnnotationTest {
          public static void main(String[] args) throws Exception{
      
              // 获取这个类
              Class c = Class.forName("Annotation2.MyAnnotationTest");
              if(c.isAnnotationPresent(MyAnnotation.class)){
                  // 获取该注解对象
                  MyAnnotation myAnnotation = (MyAnnotation)c.getAnnotation(MyAnnotation.class);
                  // 获取注解对象的属性和调接口没区别。
                  String value = myAnnotation.value();
                  System.out.println(value);
              }
          }
      }
      

   9. 通过反射获取注解对象的值

      package annotation2;
      
      import java.lang.reflect.Method;
      
      public class MyAnnotationTest {
      
          @MyAnnotation(username = "admin", password = "456456")
          public void doSome(){
      
          }
      
          public static void main(String[] args) throws Exception{
              // 获取MyAnnotationTest的doSome()方法上面的注解信息。
              Class c = Class.forName("com.cooler.java.annotation6.MyAnnotationTest");
              // 获取doSome()方法
              Method doSomeMethod = c.getDeclaredMethod("doSome");
              // 判断该方法上是否存在这个注解
              if(doSomeMethod.isAnnotationPresent(MyAnnotation.class)) {
                  MyAnnotation myAnnotation = doSomeMethod.getAnnotation(MyAnnotation.class);
                  System.out.println(myAnnotation.username());
                  System.out.println(myAnnotation.password());
              }
          }
      
      }
      

7. 注解在开发中的作用

   需求：
   假设有这样一个注解，叫做：@Id
   这个注解只能出现在类上面，当这个类上有这个注解的时候，要求这个类中必须有一个int类型的id属性。如果没有这个属性
   就报异常。如果有这个属性则正常执行！

package annotation3;

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

package annotation3;

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

// 表示这个注解只能出现在类上面
@Target(ElementType.TYPE)
// 该注解可以被反射机制读取到
@Retention(RetentionPolicy.RUNTIME)
public @interface MustHasIdPropertyAnnotation {

}

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

package annotation3;

/*
自定义异常
 */
public class HasNotIdPropertyException extends RuntimeException {
    public HasNotIdPropertyException(){

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

package annotation3;

import java.lang.reflect.Field;

public class Test {
    public static void main(String[] args) throws Exception{
        // 获取类
        Class userClass = Class.forName("com.cooler.java.annotation7.User");
        // 判断类上是否存在Id注解
        if(userClass.isAnnotationPresent(MustHasIdPropertyAnnotation.class)){
            // 当一个类上面有@MustHasIdPropertyAnnotation注解的时候，要求类中必须存在int类型的id属性
            // 如果没有int类型的id属性则报异常。
            // 获取类的属性
            Field[] fields = userClass.getDeclaredFields();
            boolean isOk = false; // 给一个默认的标记
            for(Field field : fields){
                if("id".equals(field.getName()) && "int".equals(field.getType().getSimpleName())){
                    // 表示这个类是合法的类。有@Id注解，则这个类中必须有int类型的id
                    isOk = true; // 表示合法
                    break;
                }
            }

            // 判断是否合法
            if(!isOk){
                throw new HasNotIdPropertyException("被@MustHasIdPropertyAnnotation注解标注的类中必须要有一个int类型的id属性！");
            }

        }
    }
}