概念、定义、作用
- 概念:说明程序的。给计算机看的(注释:用文字描述程序的。给程序员看的)
- 定义:注解(Annotation),也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引人的一个特性,与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面,用来对这些元素进行说明,注释。
- 概念描述:
- JDK1.5之后的新特性
- 说明程序的
- 使用注解:@注解名称
- 作用分类:
@编写文档:通过代码里标识的注解生成文档【生成文档doc文档】
@代码分析:通过代码里标识的注解对代码进行分析【使用反射】
@编译检查:通过代码里标识的注解让编译器能够实现基本的编译检查【override】
- JDK中预定义的一些注解
- @override:检测被该注解标注的方法是否是继承自父类(接口)的
- @Deprecated:该注解标注的内容,表示已过时
自定义注解
- 格式:
元注解
public @interface 注解名称{
属性列表;
}
- 本质:注解本质上就是一个接口,该接口默认继承Annotation接口
- public interface MyAnno extends java.lang.annotation.Annotation{}
- 属性:接口中的可以定义的成员方法(接口中的抽象方法)
- 要求:
- 属性的返回值类型有下列取值
- 基本数据类型
- String
- 枚举
- 注解
- 以上类型的数组
- 定义了属性,在使用时需要给属性赋值
- 如果定义属性时,使用default关键字给属性默认初始化值,则使用注解时,可以不进行属性的赋值。
- 如果只有一个属性需要赋值,并且属性的名称是value,则value可以省略,直接定义值即可。
- 数组赋值时,值使用{}包裹。如果数组中只有一个值,则{}可以省略
- 元注解:用于描述注解的注解
- @Target:描述注解能够作用的位置
- ElementType取值:
- TYPE:可以作用于类上
- METHOD:可以作用于方法上
- FIELD:可以作用于成员变量上
- @Retention:描述注解被保留的阶段
- @Retention(RetentionPolicy.RUNTIME):当前被描述的注解,会保留到class字节码文件中,并被JVM读取到
- @Documented:描述注解是否被抽取到api文档中
- @Inherited:描述注解是否被子类继承
在程序中使用(解析)注解:获取注解中定义的属性值
- 获取注解定义的位置的对象
- 获取指定的注解
- 调用注解中的抽象方法获取配置的属性值
解析注解案例
- AnnotationTest
package com.study.annotation;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
@Pro(className = "com.study.annotation.Food", methodName = "show")
public class AnnotationTest {
public static void main(String[] args) throws ClassNotFoundException, InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException {
Class cls = AnnotationTest.class;
Pro pro = (Pro) cls.getAnnotation(Pro.class);
String className = pro.className();
String methodName = pro.methodName();
Class c = Class.forName(className);
Object obj = c.newInstance();
Method method = c.getMethod(methodName);
method.invoke(obj);
}
}
- Pro.java
package com.study.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Pro {
String className();
String methodName();
}
- Food.java
package com.study.annotation;
public class Food {
public void show(){
System.out.println("show...");
}
}
注解+反射实现一个“测试框架”
- Calculator.java
package com.study.frame;
public class Calculator {
@Check
public void add() {
System.out.println("1 + 0 = " + (1 + 0));
}
@Check
public void subtract(){
System.out.println("1 - 0 = " + (1 - 0));
}
@Check
public void multiply(){
System.out.println("1 * 0 = " + (1 * 0));
}
@Check
public void divide(){
System.out.println("1 / 0 = " + (1 / 0));
}
}
- Check.java
package com.study.frame;
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 {
}
- CalculatorTest.java
package com.study.frame;
import java.io.BufferedWriter;
import java.io.FileWriter;
import java.io.IOException;
import java.lang.reflect.Method;
public class CalculatorTest {
public static void main(String[] args) throws IOException {
Calculator calculator = new Calculator();
Class cls = calculator.getClass();
Method[] methods = cls.getMethods();
BufferedWriter bufferedWriter = new BufferedWriter(new FileWriter("check.txt"));
int exceptionNum = 0;
for (Method method : methods){
if (method.isAnnotationPresent(Check.class)){
try{
method.invoke(calculator);
} catch (Exception e){
exceptionNum ++;
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("本次测试共出现" + exceptionNum + "次异常");
bufferedWriter.newLine();
bufferedWriter.flush();
bufferedWriter.close();
}
}
- 结果输出到:check.txt
出错的方法:divide
具体异常名称:ArithmeticException
异常原因:/ by zero
-------------------------------------
本次测试共出现1次异常
注解小结
- 注解给谁用
- 注解不是程序的一部分,可以理解为注解就是一个标签
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】凌霞软件回馈社区,博客园 & 1Panel & Halo 联合会员上线
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】博客园社区专享云产品让利特惠,阿里云新客6.5折上折
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 在鹅厂做java开发是什么体验
· 百万级群聊的设计实践
· WPF到Web的无缝过渡:英雄联盟客户端的OpenSilver迁移实战
· 永远不要相信用户的输入:从 SQL 注入攻防看输入验证的重要性
· 浏览器原生「磁吸」效果!Anchor Positioning 锚点定位神器解析