java学习笔记（六十二）—— 注解

概述

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

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

使用：@注解名称

JDK中内置的注解

@Override，作用是对覆盖超类中方法的方法进行标记，如果被标记的方法并没有实际覆盖超类中的方法，则编译器会发出错误警告。
@Deprecated，作用是对不应该再使用的方法添加注解，当编程人员使用这些方法时，将会在编译时显示提示信息，它与javadoc里的@deprecated标记有相同的功能，准确的说，它还不如javadoc @deprecated，因为它不支持参数，

@SuppressWarnings，作用式用来压制警告

其参数有：
deprecation，使用了过时的类或方法时的警告
unchecked，执行了未检查的转换时的警告
fallthrough，当 switch 程序块直接通往下一种情况而没有 break 时的警告
path，在类路径、源文件路径等中有不存在的路径时的警告
serial，当在可序列化的类上缺少serialVersionUID 定义时的警告
finally ，任何 finally 子句不能正常完成时的警告
all，关于以上所有情况的警告

自定义注解

格式：
- 元注解：public @interface 注解名称{}
```
public @interface MyAnno {
}
```
本质：就是一个接口，默认继承java.lang.annotation.Annotation
```
public interface MyAma extends java.lang.annotation.Annotation {
}
```
属性：接口里面定义的抽象方法
- 属性的返回值类型：基本数据类型，String，枚举、注解，前几种类型的数组
- 定义了属性，在使用时需要给属性赋值。如果定义属性时，使用default关键字给属性初始化值，使用注解时可以不进行赋值。如果只有一个属性需要赋值，并且属性的名称是value，那么value可以省略，直接写值即可。如果数组赋值，值使用{}包裹。如果数组中只有一个值，则{}可以省略

元注解：用于描述注解的注解

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

/*
	ElementType取值
		1、TYPE：可以作用于类上
		2、METHOD：可以作用于方法上
		3、FIELD：可以作用于成员变量上
*/
	@Target(value={ElementType.TYPE}) // 表示该注解只能作用于类上
	public @interface MyAnno {
	}

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

/*
	RetentionPolicy取值：
		1、SOURCE：表示该注解码不会保留到class字节码文件中
		2、CLASS：表示该注解码会保留到class字节码文件中。不会被JVM读取到
		3、表示该注解被保留到class字节码文件中，会被JVM读取到
*/
@Retention(value = RetentionPolicy.RUNTIME) // 表示该注解被保留到class字节码文件中，会被JVM读取到
public @interface MyAnno {
}

@Documented：描述注解是否被抽取到api文档中
@Inherited：描述注解是否被子类继承

解析注解

获取注解中定义的属性值，称注解解析

1、获取注解定义的位置的对象
2、获取指定的注解获取指定的注解，getAnnotation(properties.class)
3、调用注解中的抽象方法来获取配置属性值

// 注解文件
@Target(value = {ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface properties {
    String  className();
    String methodName();
}

// 类文件
public class Demo1 {
    public void show(){
        System.out.println("demo1..show....");
    }
}

// 测试文件
@properties(className = "cn.annotation.Demo1",methodName = "show")
public class ReflectTest {
    public static void main(String[] args) throws Exception{
           /*
               需求：写一个"框架"，可以帮我们创建任意类的对象，并且执行其中任意方法
           */
        // 1.解析注解
        // 1.1 获取改类的字节码文件
        Class<ReflectTest> reflectTestClass = ReflectTest.class;
        // 1.2 获取上边的字节码文件对象
        // 在内存中生成了一个该注解接口的子类实现对象
        properties annotation = reflectTestClass.getAnnotation(properties.class);
        // 1.3 调用注解对象中定义的抽象方法，获取返回值
        String className = annotation.className();
        String methodName = annotation.methodName();
        // 3.加载该类进内存，
        Class cls=Class.forName(className);
        // 4.创建对象
        Constructor constructor = cls.getConstructor();
        Object obj = constructor.newInstance();
        // 5.获取方法对象
        Method method = cls.getMethod(methodName);
        // 6.执行方法
        method.invoke(obj);
    }
}

练习

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

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...");
    }
}

/*
 简单的测试框架
    当主方法执行后，会自动执行被检查的所有方法（加了Check注解的方法），判断方法是否有异常，记录到文件中
*/
public class TestCheck {
    public static void main(String[] args) throws IOException {
        // 1.创建计算器对象
        Calculator c=new Calculator();
        // 2.获取字节码文件对象
        Class  cls= c.getClass();
        // 3.获取所有的方法
        Method[] methods = cls.getMethods();
        int num=0; //出现异常的次数
        BufferedWriter bufferedWriter = new BufferedWriter(new FileWriter("day17\\src\\cn\\calculator\\bug.txt"));
        for (Method method : methods) {
            // 4.判断方法上是否有Check注解
            if(method.isAnnotationPresent(Check.class)){
                try {
                    // 5.执行有Check注解的方法
                    method.invoke(c);
                } catch (Exception e) {
                    // 6.捕获异常

                    // 记记录到bug文件中
                    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.newLine();
        bufferedWriter.flush();
        bufferedWriter.close();
        
    }
}

/*
大多数时候我们不会定义注解，只是使用注解
注解给编译器用，给解析程序用
注解不是程序的有一部分，可以将注解理解为一个标签
*/

miles-zh

发布了113 篇原创文章 · 获赞 1 · 访问量 945

私信关注

java学习笔记（六十二）—— 注解

概述

JDK中内置的注解

自定义注解

解析注解

练习

猜你喜欢