注解

基本概念

• 概念：说明程序的。给计算机看的
• 注释：用文字描述程序的。给程序员看的
• 定义：注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个新特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用力啊对这些元素进行说明，注释。
• 概念描述：
  • JDK1.5之后的新特性
  • 说明程序的
  • 使用注解：@注解名称

作用分类

• 1. 编写文档：通过代码里标识的注解生成文档【生成doc文档】

  使用javadoc命令

• 2. 代码分析：通过代码里标识的注解对代码进行分析【使用反射】
• 3. 编译检查：通过代码里表示的注解让编译器能够实现基本的编译检查【Override】

JDK中预定义的一些注解

• @Override：检测被标注的方法是否继承自父类（接口）
• @Deprecated：标识标注的内容已过时
• @SuppressWarnings：压制警告
  • 一般传递参数all @SuppressWarnings("all")

自定义注解

格式

元注解

public @interface 注解名称{
	属性列表；
}

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

​ ```public interface myAnno extends java.lang.annotation.Annotation{}

属性：接口中的抽象方法

• 要求；

• 1. 属性的返回值类型仅限下列取值
     • 基本数据类型
     • String
     • 枚举
     • 注解
     • 以上类型的数组
  2. 定义了属性，在使用时需要给属性赋值
     • 如果定义属性时，使用default关键字给属性默认初始化值，使用注解时，可以不进行赋值
     • 如果只有一个属性需要赋值，且属性名为value，则属性名value可以省略，直接定义值即可
     • 数组赋值时，值使用{}包裹。如果数组中只有一个值，则{}可以省略
  3. 元注解：用于描述注解的注解
     • @Target： 描述注解能够作用的位置
       • TYPE:可以作用于类上
       • METHOD:可以作用于方法上
       • FIELD:可以作用于成员变量上
     • @Retention：描述注解被保留的阶段
       • @Retention(RetentionPolicy.RUNTIME)：当前被描述的注解，会保留到class字节码文件中，并被JVM读取到
     • @Documented：描述的注解是否被抽取到api文档中
     • @Inherited：描述的注解是否被子类继承

在程序中使用注解：获取注解中定义的属性值

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

2. 获取指定的注解

   • getAnnotation(Class)

     //其实就是在内存中生成了一个该注解接口的子类实现对象
     public class ProImpl implements Pro{
       public String className(){
       	return "com.digger.practice.Cat";
       }
       public String methodName(){
         return "sleep";
       }
     }
     

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

案例：简单的测试框架

• 自定义check注解

package com.digger.practice;

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

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Check {
}

• 需要测试的方法

package com.digger.practice;

public class Calculator {

    @Check
    public void add(){
        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));
    }

    public void show(){
        System.out.println("只会写bug");
    }
}

• 测试代码

package com.digger.practice;

import java.io.BufferedWriter;
import java.io.FileWriter;
import java.io.IOException;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

public class TestCheck {

    public static void main(String[] args) throws IOException {
        //创建Calculator对象
        Calculator calculator = new Calculator();
        //获取字节码文件对象
        Class cls = calculator.getClass();
        //获取所有方法
        Method[] methods = cls.getMethods();

        int num = 0;//统计出现异常的次数
        BufferedWriter bufferedWriter = new BufferedWriter(new FileWriter("bug.txt"));

        for(Method method: methods){
            //判断方法上是否有check注解
            if(method.isAnnotationPresent(Check.class)){
                //执行方法
                try {
                    method.invoke(calculator);
                } catch (Exception e) {
                    //捕获异常
                    num++;
                    bufferedWriter.write(method.getName() + "方法出现异常了");
                    bufferedWriter.newLine();
                    bufferedWriter.write("异常的名称：" + e.getCause().getClass().getSimpleName());
                    bufferedWriter.newLine();
                    bufferedWriter.write("异常的原因：" + e.getCause().getMessage());
                    bufferedWriter.newLine();
                    bufferedWriter.write("---------------------------");
                    bufferedWriter.newLine();
                }
            }
        }
        bufferedWriter.write("本次测试共出现了"+ num + "次异常");
        bufferedWriter.flush();
        bufferedWriter.close();
    }


}

• 运行结果

小结：

• 大多数情况下我们使用注解，很少自定义注解
• 注解给谁用？
  • 1.编译器
  • 2.解析程序
• 注解不是程序的一部分，可以理解为注解就是一个标签

标签：java,bufferedWriter,import,注解,public,属性
来源： https://www.cnblogs.com/digger72/p/15531057.html