Java之注解
注解介绍:
- 概念:说明程序的。给计算机看的
- 注释:用文字描述程序的。给程序员看的
定义:注解(Annotation),也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性,与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面,用来对这些元素进行说明,注释【百度百科】。
-
概念描述:
- JDK1.5之后的新特性
- 说明程序的
- 使用注解:@注解名称
作用分类:
①编写文档:通过代码里标识的注解生成文档【生成文档doc文档】
②代码分析:通过代码里标识的注解对代码进行分析【使用反射】
③编译检查:通过代码里标识的注解让编译器能够实现基本的编译检查【Override】
补充一点:可以利用javadoc工具,从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。
生成的index.html打开就是我们所熟悉的jdk开发文档。
JDK中预定义的一些注解与自定义注解
@Override:检测被该注解标注的方法是否是继承自父类(接口)的
@Deprecated:该注解标注的内容,表示已过时
@SuppressWarnings:压制警告
一般传递参数all @SuppressWarnings("all")
明白了一些常用的注解外,我们可以自定义注解,怎么做呢?
* 自定义注解
* 格式:
元注解
public @interface 注解名称{
属性列表;
}
那这个@interface到底是一个什么东西呢,来测试一下
package annotation;
public @interface AnnoDemo02 {
}
将上面这个注解进行编译,然后进行反编译
可以看到它其实只是一个继承与Annotation的一个接口而已,所以注解的本质就是一个接口。
注解定义的属性:
-
属性:接口中的抽象方法
要求:
属性的返回值类型只能为下列取值:
1. 基本数据类型int double float
2. String
3. 枚举
4. 注解
5. 以上类型的数组表示package annotation; public @interface AnnoDemo02 { int add(); String show() default "liuzeyu"; Person p(); AnnoDemo3 anno(); }
-
定义了属性,在使用时需要给属性赋值
特点:- 如果定义属性时,使用default关键字给属性默认初始化值,则使用注解时,可以不进行属性的赋值。
- 如果只有一个属性需要赋值,并且属性的名称是value,则value可以省略,直接定义值即可。
- 数组赋值时,值使用{}包裹。如果数组中只有一个值,则{}可以省略
package annotation; @AnnoDemo02(add = 1, anno = @AnnoDemo3, p = Person.p1, show = "liuzeyu") public class Test { }
元注解
- 元注解:用于描述注解的注解
* @Target:描述注解能够作用的位置
* ElementType取值:
* TYPE:可以作用于类上
* METHOD:可以作用于方法上
* FIELD:可以作用于成员变量上
* @Retention:描述注解被保留的阶段
* @Retention(RetentionPolicy.RUNTIME):当前被描述的注解,会保留到class字节码文件中,并被JVM读取到,Class时期不会被JVM读取到
* @Documented:描述注解是否被抽取到api文档中
* @Inherited:描述注解是否被子类继承
import java.lang.annotation.ElementType;
import java.lang.annotation.RetentionPolicy;
@java.lang.annotation.Target(value = {ElementType.TYPE,ElementType.METHOD,
ElementType.FIELD})
@java.lang.annotation.Retention(RetentionPolicy.RUNTIME)
@java.lang.annotation.Documented()
@java.lang.annotation.Inherited()
public @interface AnnoDemo02 {
}
使用注解:
package annotation;
@AnnoDemo02
public class Test {
@AnnoDemo02
private String name;
public Test() {
}
@AnnoDemo02
void show() {}
}
这里只演示了@Target注解其余用法类似,只是实现的功能不同而已,比较常用的是前面@Target, @Retention注解。
重点:在程序中解析注解
实现:解析字符串===>生成对象Demo1/2===>执行对象相对应的方法show[与反射的效果一样]
1、准备两个类Demo1,Demo2
public class Demo1 {
public void show() {
System.out.println("Demo1...show...");
}
}
public class Demo1 {
public void show() {
System.out.println("Demo1...show...");
}
}
用到的注解:
import java.lang.annotation.ElementType;
import java.lang.annotation.RetentionPolicy;
@java.lang.annotation.Target({ElementType.TYPE})
@java.lang.annotation.Retention(RetentionPolicy.RUNTIME)
public @interface Pro {
String className();
String methodName();
}
2、开始测试,创建测试类ReflectTest
@Pro(className = "annotation.Demo2", methodName = "show")
public class ReflectTest {
public static void main(String[] args) throws IOException, Exception {
//1.解析注解
Class<ReflectTest> cls = ReflectTest.class; 获取这个类的字节码对象
//2.获取上面注解对象
//这一步要注意:其实就是在内存中生成了一个该注解接口的子类实现对象。类似
/**
* public class ProImple implements Pro{
* public String className(){
* return "annotation.Demo2"
* }
public String methodName(){
return "show"
}
* }
*/
Pro an = cls.getAnnotation(Pro.class);
//3.调用注解对象中定义的抽象方法,获取返回值
String clsName = an.className();
String methodName = an.methodName();
System.out.println(clsName +" ====> " + methodName);
//加载进内存
Class clz = Class.forName(clsName);
Object obj = clz.getConstructor().newInstance(); //创建对象
Method method = clz.getMethod(methodName); //获取方法
method.invoke(obj); //执行相对应的方法
}
}
综合小案例【注解在框架上的使用】
存在异常的Calculator 类,我们现在使用注解来测试出现异常的地方,并输出到文件显示
/**
* 小明定义的计算机类
*/
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...");
}
}
注解:
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Check {
}
然后准备测试
public class Test {
public static void main(String[] args) throws Exception {
//1.创建计算器类对象
Calculator cal = new Calculator();
//2.获取字节码文件对象
Class cls = cal.getClass();
//3.获取计算器类所有方法
Method[] methods = cls.getMethods();
//判断方法上是否会有注解
BufferedWriter bw = new BufferedWriter(new FileWriter("bug.txt")); //用于io操作
int num = 0; //记录出现异常的次数
for(Method method:methods) {
if(method.isAnnotationPresent(Check.class)) {
//有的话执行
try {
method.invoke(cal);
//捕获异常
} catch (Exception e) {
num ++;
bw.write(method.getName() + "方法出异常了..");
bw.newLine();
bw.write("异常的名称" + e.getCause().getClass().getSimpleName());
bw.newLine();
bw.write("异常的原因" + e.getCause().getMessage());
bw.newLine();
bw.write("------------------------------------");
bw.newLine();
bw.flush();
}
}
}
}
}
结果就是在输出窗口能看到被正确执行的函数,在bug.txt中描述错误的异常信息。
好久没写博客了,如有错误,欢迎指正,共同进步๑乛◡乛๑