注解

概念：

说明程序的。给计算机看的

注释：用文字描述程序的。给程序员看的

定义：

注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。

概念描述：

  • JDK1.5之后的新特性
  • 说明程序的
  • 使用注解：@注解名称

作用分类：

① 编写文档：通过代码里标识的注解生成文档【生成文档doc文档】
​② 代码分析：通过代码里标识的注解对代码进行分析【使用反射】
​③ 编译检查：通过代码里标识的注解让编译器能够实现基本的编译检查【Override】

  1. javadoc生成doc文档

    示例*：

    新建AnnoDemo1类

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    package com.uestc.annotation;

    /**
     * 注解javadoc演示
     * @author lf_Tech
     * @since 1.5
     * @version 1.0
     *
     */
    public class AnnoDemo1 {
        /**
         * 计算两数和
         * @param a
         * @param b
         * @return
         */
        public int add(int a, int b){
            return a+b;
        }
    }

JDK中预定义的一些注解

  1. @Override ：检测被该注解标注的方法是否是继承自父类(接口)的

  2. @Deprecated：该注解标注的内容，表示已过时

  3. @SuppressWarnings：压制警告

    一般传递参数all @SuppressWarnings("all")

示例：

自定义注解

格式：

1
2
3
4
元注解
public @interface 注解名称{
	属性列表;
}

本质：

注解本质上就是一个接口，该接口默认继承Annotation接口

1
public interface MyAnno extends java.lang.annotation.Annotation {}

属性：

接口中的抽象方法

注解的属性也叫做成员变量，注解只有成员变量，没有方法。注解的成员变量在注解的定义中以“无形参的方法”形式来声明，其方法名定义了该成员变量的名字，其返回值定义了该成员变量的类型

要求：

  1. 属性的返回值类型有下列取值

    • 基本数据类型

    • String

    • 枚举

    • 注解

    • 以上类型的数组

    • 示例：*

      1
      2
      3
      4
      5
      6
      7
      8
      package com.uestc.annotation;
      public @interface MyAnno {
           int show1();//基本数据类型
           String show2();//String类型
           Person per();//枚举类型
           MyAnno2 anno2();//注解类型
           String [] str();//数组类型
      }

  2. 定义了属性，在使用时需要给属性赋值

    1. 如果定义属性时，使用default关键字给属性默认初始化值，则使用注解时，可以不进行属性的赋值。
    2. 如果只有一个属性需要赋值，并且属性的名称是value，则value可以省略，直接定义值即可。
    3. 数组赋值时，值使用{}包裹。如果数组中只有一个值，则{}可以省略

    示例：

    1. 新建MyAnno

      1
      2
      3
      4
      5
      6
      7
      8
      9
      package com.uestc.annotation;
      public @interface MyAnno {
           int show1();//基本数据类型
           String value();
           String show2() default "刘飞";//String类型
           Person per()  ;//枚举类型
           MyAnno2 anno2();//注解类型
           String [] str();//数组类型
      }

    2. 使用注解

      1
      2
      3
      4
      package com.uestc.annotation;
      @MyAnno(show1 = 1, value = "hh", per=Person.p1,anno2 = @MyAnno2(), str={"aa","bb"})
      public class Worker {
      }

元注解：

用于描述注解的注解

  1. @Target：描述注解能够作用的位置

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.ANNOTATION_TYPE)
    public @interface Target {
        /**
         * Returns an array of the kinds of elements an annotation type
         * can be applied to.
         * @return an array of the kinds of elements an annotation type
         * can be applied to
         */
        ElementType[] value();
    }

    ElementType取值：

    • TYPE：可以作用于类上
    • METHOD：可以作用于方法上
    • FIELD：可以作用于成员变量上

    示例：

    1
    2
    3
    4
    5
    6
    package com.uestc.annotation;
    import java.lang.annotation.ElementType;
    import java.lang.annotation.Target;
    @Target(value={ElementType.TYPE, ElementType.METHOD,ElementType.FIELD})//表示该MyAnno3只能作用在类上,方法上，成员变量上
    public @interface MyAnno3 {
    }

  2. @Retention：描述注解被保留的阶段

    1
    @Retention(RetentionPolicy.RUNTIME)：//当前被描述的注解，会保留到class字节码文件中，并被JVM读取到

  3. @Documented：描述注解是否被抽取到api文档中

  4. @Inherited：描述注解是否被子类继承

在程序使用(解析)注解：

获取注解中定义的属性值

  1. 获取注解定义的位置的对象 （Class，Method, Field）

  2. 获取指定的注解: getAnnotation(Class)

    其实就是在内存中生成了一个该注解接口的子类实现对象

    1
    2
    3
    4
    5
    6
    7
    8
    public class ProImpl implements Pro{
        public String className(){
            return "cn.itcast.annotation.Demo1";
        }
        public String methodName(){
            return "show";
        }
    }

  3. 调用注解中的抽象方法获取配置的属性值

使用注解替换配置文件

  1. 新建MyAnno自定义注解

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    package com.uestc.annotation;
    import java.lang.annotation.ElementType;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    @Target(value = ElementType.TYPE)
    @Retention(value = RetentionPolicy.RUNTIME)
    public @interface MyAnno {
        String className();
        String methodName();
    }

  2. 创建ReflectTest

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    package com.uestc.annotation;
    import java.io.InputStream;
    import java.lang.reflect.Method;
    import java.util.Properties;
    /**
     * 框架类
     */
    @MyAnno(className = "com.uestc.domain.Person", methodName ="eat" )
    public class ReflectTest {
        public static void main(String[] args) throws Exception{
            //可以创建任意类的对象，可以执行任意方法
            /**
             * 前提：不能改变该类的任何代码，可以创建任意类的对象，可以执行任意方法
             */
            //1.解析注解
            //1.1 获取该类的字节码文件对象
           Class<ReflectTest> reflet= ReflectTest.class;
            //2.获取上边的注解对象
            MyAnno myAnno= reflet.getAnnotation(MyAnno.class);
            //其实就是在内存中生成了一个该注解接口的子类实现对象
            //3.调用注解对象中定义的抽象方法，获取返回值
            String className=myAnno.className();
            String methodName=myAnno.methodName();
             //4.加载该类进内存
            Class cls=Class.forName(className);
            //5.创建对象
            Object obj=cls.newInstance();
            //6.获取对象的方法
            Method method=cls.getMethod(methodName);
            //7.执行方法
            method.invoke(obj);
        }
    }

    案例：简单的测试框架

    1. 创建Caculator计算器类

      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      15
      16
      17
      18
      19
      20
      21
      22
      23
      24
      package com.uestc.annotation;
      public class Caculator {
          @Check()
          public void add(){
              String str=null;
              str.toString();
              System.out.println("1+0="+(1+0));
          }
          @Check()
          public void sub(){
              System.out.println("1-0="+(1-0));
          }
          @Check()
          public void mul(){
              System.out.println("1*0="+(1*0));
          }
          @Check()
          public void div(){
              System.out.println("1/0="+(1/0));
          }
          @Check()
          public void show(){
          }
      }

    2. 创建自定义注解Check

      1
      2
      3
      4
      5
      6
      7
      8
      9
      package com.uestc.annotation;
      import java.lang.annotation.ElementType;
      import java.lang.annotation.Retention;
      import java.lang.annotation.RetentionPolicy;
      import java.lang.annotation.Target;
      @Target(value = ElementType.METHOD)
      @Retention(value = RetentionPolicy.RUNTIME)
      public @interface Check {
      }

    3. 创建CheckTest

      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      15
      16
      17
      18
      19
      20
      21
      22
      23
      24
      25
      26
      27
      28
      29
      30
      31
      32
      33
      34
      35
      36
      37
      38
      39
      40
      41
      42
      43
      44
      package com.uestc.annotation;
      import java.io.BufferedReader;
      import java.io.BufferedWriter;
      import java.io.FileWriter;
      import java.io.IOException;
      import java.lang.reflect.InvocationTargetException;
      import java.lang.reflect.Method;

      public class CheckTest {
          public static void main (String[] args) throws IOException {
              //创建计算机对象
              Caculator c=new Caculator();
              //1.获取Caculator的字节码文件
              Class caculator=c.getClass();
              //2.获取Caculator的所有方法
              Method [] methods= caculator.getMethods();
              BufferedWriter bw=new BufferedWriter(new FileWriter("E:\\javaWebLearning\\Reflect\\bug.txt"));
              int count=0;//记录bug的次数
              //3.遍历所有的方法
              for(Method method:methods){
                  //判断是否有check注解
                  if(method.isAnnotationPresent(Check.class)){
                      //如果有check注解则执行
                      try {
                          method.invoke(c);
                      } catch (Exception e) {
                          count++;
                          bw.write(method.getName()+"出现异常了");
                          bw.newLine();
                          bw.write("异常的名称"+e.getCause().getClass().getSimpleName());
                          bw.newLine();
                          bw.write("异常的原因"+e.getCause().getMessage());
                          bw.newLine();
                          bw.write("------------------");
                          bw.newLine();
                      }
                  }
              }

              bw.write("本次测试一共出现"+count+"个bug");
              bw.flush();
              bw.close();
          }
      }

      效果展示：

    小结：

    1. 以后大多数时候，我们会使用注解，而不是自定义注解
    2. 注解给谁用？
      1. 编译器
      2. 给解析程序用
    3. 注解不是程序的一部分，可以理解为注解就是一个标签