注解
-
概念:说明程序的,给计算机看的
-
注释:用文字描述程序的,给程序员看的
-
定义: 注解(Annotation),也叫元数据。一种代码级别的说明。它是JDK1.5以以后版本引入的一个特性,与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面,用来对这些元素进行说明,注释。
-
概念描述:
- JKD1.5 之后的新特性
- 说明程序的
- 使用注解:@注解名称
-
作用分类:
1.编写文档:通过代码里标识的元数据生成文档【生成文档doc文档】
2.代码分析:通过代码里标识的元数据对代码进行分析【s会用反射】
3.编译检查:通过代码里标识的元数据让编译器能够实现基本的编译检查【Override】 -
JDK中预定义的一些注解
- @Override : 检测被该注解标注的方法是否是继承自父类(接口)的
- @Deprecated:将该注解标注的内容,已过时
- @SuppressWarnings: 压制警告
- 一般传递参数 all @SuppressWarnings(“all”)
-
自定义注解
- 格式:
元注解
public @interface 注解名称{} - 本质:注解本质就是一个接口,该接口默认继承Annotation接口
- public interface interface_name extends java.lang.annotation.Annotation{}
- 属性:接口中的抽象方法
-
要求:
1.属性的返回值类型- 基本数据类型
- String
- 枚举
- 注解
- 以上类型的数组
@Myanno(value = 12, per = Person.P1, anno = @Myanno2, strs = {"abc","aaa"}
2.定义了属性,在使用时需要给属性赋值
- 如果定义属性时,使用default关键字给属性默认初始化值,则使用注解时,可以不进行属性的赋值。
- 如果只有一个属性需要赋值,并且属性的名称是value,则value可以省略,直接赋值即可。
- 数组赋值时,值使用{}包裹,如果只有一个值可以不写{}。
-
元注解: 用于描述注解的注解
- @Target:描述注解能够作用的位置
- ElementType取值:
- TYPE:可以作用在类上
- METHOD:可以作用在方法上
- FIELD:可以作用在成员变量上
@Target(value = {ElementType.TYPE,ElementType.METHOD,ElementType.FIELD}
- ElementType取值:
- @Retention: 描述注解被保留的阶段
- @Retention(RetentionPolicy.RUNTIME):当前被描述的注解,会保留到class字节码文件中,并被JVM读取到
- @Document: 描述注解是否被抽取到的api文档中
- @Inherited:描述注解是否被子类继承
- @Target:描述注解能够作用的位置
-
- 格式:
-
在程序中使用(解析)注解: 获取注解中定义的属性值
- 获取注解定义的位置的对象(Class,Method,Field)
- 获取指定的注解
/**
* getAnnotation(Class)
* 其实就是在内存中生成了一个该注解接口的子类实现对象
* public class ProImpl implements Pro{
* public String className(){
* return “com.Yves.annotation.Demo1”;
* }
* public String methodName(){
* return “show”;
* }
* }
*/
3.调用注解中的抽象方法获取配置的属性值
小结
1.以后大多数时候,我们会使用注解,而不是自定义注解
2.注解给谁用?
- 编译器
- 解析程序
3.注解不是程序的一部分,可以理解注解就是一个标签
案列
使用注解进行测试
check
package com.Yves.demo;
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 {
}
Calculator
package com.Yves.demo;
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("no bug ... ");
}
}
TestCheck
package com.Yves.demo;
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 Exception {
Calculator c = new Calculator();
Class cls = c.getClass();
Method[] methods = cls.getMethods();
int number = 0;
BufferedWriter bw = new BufferedWriter(new FileWriter("bug.txt"));
for (Method method : methods) {
if(method.isAnnotationPresent(Check.class)){
try {
method.invoke(c);
} catch (Exception e) {
number++;
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.write("本次测试一共出现" + number + "次异常");
bw.flush();
bw.close();
}
}