注解

mac2024-01-31  82

目录

注解

概念描述

作用分类

JDK中预定义的一些注解

自定义注解

格式:

本质:

属性:(接口中的抽象方法)

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

在程序使用(解析)注解:获取注解中定义的属性值

案例


注解

概念描述

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

作用分类

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

JDK中预定义的一些注解

@Override :检测被该注解标注的方法是否是继承自父类(接口)的@Deprecated:该注解标注的内容,表示已过时@SuppressWarnings:压制警告 一般传递参数all @SuppressWarnings("all")

自定义注解

格式:

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

本质:

注解本质上就是一个接口,该接口默认继承Annotation接口public interface MyAnno extends java.lang.annotation.Annotation {}

属性:(接口中的抽象方法)

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

基本数据类型String枚举注解以上类型的数组

定义了属性,在使用时需要给属性赋值

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

 枚举类

public enum Person { p1,p2; }

属性的返回值类型 举例

public @interface MyAnno { int value() default 1; // 默认值 1 Person person(); // 枚举类型 MyAnno2 anno2(); // 注解类型 String[] strs(); // 数组类型 }

给属性赋值 举例

@MyAnno(value = 12,person = Person.p1,anno2 = @MyAnno2,strs = {"abc","abb"}) public class Demo { }

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

@Target:描述注解能够作用的位置 ElementType取值: TYPE:可以作用于类上METHOD:可以作用于方法上FIELD:可以作用于成员变量上@Retention:描述注解被保留的阶段 @Retention(RetentionPolicy.RUNTIME):当前被描述的注解,会保留到class字节码文件中,并被JVM读取到@Documented:描述注解是否被抽取到api文档中@Inherited:描述注解是否被子类继承 import java.lang.annotation.*; @Target({ElementType.TYPE,ElementType.METHOD,ElementType.FIELD})// 可作用于类上,方法上,成员变量上 @Retention(RetentionPolicy.RUNTIME) //会保留到class字节码文件中,并被JVM读取到 @Documented // 描述注解是否被抽取到api文档中 @Inherited // 描述注解是否被子类继承 public @interface MyAnno2 { }

在程序使用(解析)注解:获取注解中定义的属性值

获取注解定义的位置的对象 (Class,Method,Field)

获取指定的注解对象

public <A extends Annotation> A getAnnotation(Class<A> annotationClass) //其实就是在内存中生成了一个该注解接口的子类实现

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

/** * 描述需要执行的类名和方法 */ @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @interface Pro { String className(); String methodName(); } import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; @Pro(className = "com.long123.Ana.Demo1",methodName = "show") public class ReflectTest { public static void main(String[] args) throws ClassNotFoundException, IllegalAccessException, InstantiationException, NoSuchMethodException, InvocationTargetException { /* 前提:不能改变该类的任何代码。可以创建任意类的对象,可以执行任意方法 */ //1.解析注解 //1.1获取该类的字节码文件对象 Class<ReflectTest> reflectTestClass= ReflectTest.class; //2.获取上面的注解对象 /* public class ProImpl implements Pro{ public String className(){ return "com.long123.Ana.Demo1"; } public String methodName(){ return "show"; } } */ //其实就是在内存中生成了一个该注解接口的子类实现对象 Pro an = reflectTestClass.getAnnotation(Pro.class); // 3.调用注解对象中定义的抽象方法,获取返回值 String className = an.className(); String methodName = an.methodName(); // 4. 加载类进内存 Class<?> cls = Class.forName(className); // 5. 创建对象 Object obj = cls.newInstance(); // 6. 获取方法对象 final Method method = cls.getMethod(methodName); // 7. 执行方法 method.invoke(obj); } }

案例

简单的测试框架,当主方法执行后,会自动自行被检测的所有方法(加了Check注解的方法),判断方法是否有异常,记录到文件中 

import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; @Target(ElementType.METHOD) @Retention(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)); } public void show(){ System.out.println("永无bug..."); } }

 

import java.io.BufferedWriter; import java.io.FileWriter; import java.io.IOException; import java.lang.reflect.Method; /** * 简单的测试框架 * * 当主方法执行后,会自动自行被检测的所有方法(加了Check注解的方法),判断方法是否有异常,记录到文件中 */ public class TestCheck { public static void main(String[] args) throws IOException { // 1. 创建计算机对象 Calculator c = new Calculator(); // 2. 获取字节码文件对象 Class<? extends Calculator> cls = c.getClass(); // 3. 获取所有的方法 Method[] methods = cls.getMethods(); BufferedWriter bw = new BufferedWriter(new FileWriter("except.txt")); int num = 0; // 记录异常出现的次数 for (Method method : methods) { // 4 .判断方法上是否有Check注解 if (method.isAnnotationPresent(Check.class)){ // 5. 执行方法 try { method.invoke(c); }catch (Exception e) { // 6, 捕获异常 num++; bw.write(method.getName()+"方法出异常了"); bw.newLine(); bw.write("异常的名称:" + e.getCause().getClass().getSimpleName()); bw.newLine(); bw.write("异常的原因:"+e.getMessage()); bw.newLine(); bw.write("-------------------------------"); bw.newLine(); } } } bw.write("总共出现了 "+num+" 次异常"); bw.flush(); bw.close(); } }

 

最新回复(0)