注解
注解
注解（Annotation），也叫元数据，一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。注解的存在可以部分的替代配置文件。
作用
- 编写文档：通过代码里标识的注解生成文档【生成文档doc文档】
package com.sgp.annotation; /** * @author shenguopin * @version 1.0 * @since 2021.7.16 */ public class JavaDocDemo { /** * * @param a * @param b * @return 两数之和 */ public int add(int a, int b){ return a+b; } } - 代码分析：通过代码里标识的注解对代码进行分析【使用反射】
- 编译检查：通过代码里标识的注解让编译器能够实现基本的编译检查【Override】
jdk预定义的注解
JDK中预定义的一些注解
- @Override：检测被该注解标注的方法是否是继承自父类(接口)的
- @Deprecated：该注解标注的内容已过时
- @SuppressWarnings：压制警告
- 一般传递参数all @SuppressWarnings("all")
package com.sgp.annotation;
@SuppressWarnings("all")
public class AnnotationDemo01 {
@Override
public String toString(){
return null//没加分好会报错
}
@Deprecated
public void show1(){
}
//show2替代了show1
public void show2(){
}
}
自定义注解
-
格式：
元注解 public @interface 注解名称{ 属性列表; } -
本质：注解本质上就是一个接口，该接口默认继承Annotation接口
public interface MyAnno extends java.lang.annotation.Annotation {} -
属性：注解中的抽象方法也称为属性，因为他用起来和普通属性一样
-
要求：
- 属性的返回值类型只能是下列取值
- 基本数据类型
- String
- 枚举
- 注解
- 以上类型的数组
- 定义了属性，在使用时需要给属性赋值
- 如果定义属性时，使用default关键字给属性默认初始化值，则使用注解时，可以不进行属性的赋值。
- 如果只有一个属性需要赋值，可以省略属性名，直接定义值即可。
- 数组赋值时，值使用{}包裹。如果数组中只有一个值，则{}可以省略
//自定义注解
public @interface MyAnno01 {
public abstract int a();
String show();
double d() default 3.14;
}
//测试注解
@MyAnno01(a=1,show="hello")//方法名=值，和属性的赋值方式一样，所以也把注解的抽象方法叫做属性
public class MyAnno01Test {
}
-
元注解：用于描述注解的注解
-
@Target：描述注解能够作用的位置，参数是枚举ElementType
- ElementType取值：
- TYPE：可以作用于类上
- METHOD：可以作用于方法上
- FIELD：可以作用于成员变量
- ElementType取值：
-
@Retention：描述注解被保留的阶段
- @Retention(RetentionPolicy.RUNTIME)：当前被描述的注解，会保留到class字节码文件中，并被JVM读取
-
@Documented：描述注解是否被抽取到api文档中
-
@Inherited：描述注解是否被子类继承
-
package com.sgp.annotation;
import java.lang.annotation.*;
/*
元注解：用于描述注解的注解
* @Target：描述注解能够作用的位置
* @Retention：描述注解被保留的阶段
* @Documented：描述注解是否被抽取到api文档中
* @Inherited：描述注解是否被子类继承
*/
@Target({ElementType.FIELD,ElementType.METHOD,ElementType.TYPE})
@Retention(value = RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface MyAnno01 {
public abstract int a();
String show();
double d() default 3.14;
}
注解的使用
可以用注解实现反射的框架。
//自定义一个注解，把想要操作的类名和方法名作为抽象方法
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Pro {
String className();//代表了一套规范
String methodName();
}
package cn.itcast.annotation;
import java.io.InputStream;
import java.lang.reflect.Method;
import java.util.Properties;
/**
* 框架类
要求在不改变该类的代码的情况下，可以创建任意类的对象，可以执行任意方法
*/
@Pro(className = "cn.itcast.annotation.Demo1",methodName = "show")//为注解的属性赋值，值就是想要操作的类名和方法名
public class ReflectTest {
public static void main(String[] args) throws Exception {
//1.解析注解
//1.1获取该类的字节码文件对象
Class<ReflectTest> reflectTestClass = ReflectTest.class;
//2.获取上边的注解对象
//其实就是在内存中生成了一个该注解接口的子类实现对象
/*
public class ProImpl implements Pro{
public String className(){
return "cn.itcast.annotation.Demo1";
}
public String methodName(){
return "show";
}
}
*/
Pro an = reflectTestClass.getAnnotation(Pro.class);
//3.调用注解对象中定义的抽象方法，获取返回值
String className = an.className();
String methodName = an.methodName();
System.out.println(className);
System.out.println(methodName);
//3.加载该类进内存
Class cls = Class.forName(className);
//4.创建对象
Object obj = cls.newInstance();
//5.获取方法对象
Method method = cls.getMethod(methodName);
//6.执行方法
method.invoke(obj);
}
}
注解实现测试框架
自定义Check注解
@Target(ElementType.METHOD)//用于方法
@Retention(value = RetentionPolicy.RUNTIME)
public @interface Check {
}
需要测试的类
//定义了一个计算器类，要对此类进行测试
public class Calculator {
//加法
@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));//这里有by/zero异常
}
public void show(){
System.out.println("永无bug...");
}
}
测试框架
/**
* 简单的测试框架
* 当主方法执行后，会自动检测所有加了Check注解的方法，如果出现异常就记录到文件中
*/
public class checkTest {
public static void main(String[] args) throws IOException {
//1.创建计算器对象
Calculator calc = new Calculator();
//2.获取字节码文件对象
Class cls = calc.getClass();
//3.获取所有方法
Method[] methods = cls.getMethods();
int count = 0;//出现异常的次数
PrintStream ps = new PrintStream(new FileOutputStream("bug.txt"));
for (Method method : methods) {//methods.iter快速遍历
//4.判断方法上是否有Check注解
if(method.isAnnotationPresent(Check.class)){
//5.有，执行
try {
method.invoke(calc);
} catch (Exception e) {
//捕获异常，记录到文件中
ps.println(method.getName()+"方法出现异常了");
ps.println("异常的名称："+e.getCause().getClass().getSimpleName());
ps.println("异常的原因："+e.getCause().getMessage());
count++;
}
}
}
ps.println("本次测试一共出现"+count+"次异常");
//释放资源
ps.close();
}
}
bug.txt文件
add方法出现异常了
异常的名称：NullPointerException
异常的原因：Cannot invoke "String.toString()" because "str" is null
div方法出现异常了
异常的名称：ArithmeticException
异常的原因：/ by zero
本次测试一共出现2次异常
