一、注解介绍
注解概念：注解是说明程序的，给计算机看的。
注释概念：用文字描述程序的，给程序员看的。
注解定义：注解（Annotation），也叫元数据。一种代码级别的说明。它是 JDK1.5 及以后版本引入的一个特效，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等前面，用来对这些元素进行说明，注释。
概念描述：
-
- JDk 1.5之后的新特性
- 说明程序的
- 使用注解：@注解名称
- JDk 1.5之后的新特性
注解作用分类：
-
- 编写文档：通过代码里标识的注解生成文档【生成文档 doc 文档】
- 编写文档：通过代码里标识的注解生成文档【生成文档 doc 文档】
Demo：编写一个类，然后通过 javadoc 文件名.java 来生成 doc文档
1 /**
2 * 注解javadoc演示
3 *
4 * @author ks
5 * @version 1.0
6 * @since 1.5
7 */
8 public class AnnoDemo1 {
9
10 /**
11 * 计算两数的和
12 * @param a 整数
13 * @param b 整数
14 * @return 两数的和
15 */
16 public int add(int a, int b ){
17 return a + b;
18 }
19 }
-
- 代码分析：通过代码里标识的注解对代码进行分析【使用反射】
- 编译检查：通过代码里标识的注解让编译器能够实现基本的编译检查【Override】
二、JDK 中预定义注解
JDk 中预定义的一些注解：
-
- @Override：检测被该注解标注的方法是否是继承自父类（接口）的
- @Deprecated：该注解标注的内容，表示已过时
- @SuppressWarnings：压制警告，一般传递参数 all,压制所有的警告（@SuppressWarnings("all")）
- @Override：检测被该注解标注的方法是否是继承自父类（接口）的
Demo :
1 /**
2 * 内置注解
3 */
4 @SuppressWarnings("all") // 表示压制所有的警告，可以作用与类与方法
5 public class AnnoDemo {
6
7 @Override // 表示方法重写
8 public String toString() {
9 return super.toString();
10 }
11
12 @Deprecated // 表示方法已经过时了，但是不能删除，为了向下兼容
13 public void show1() {
14 // 有缺陷
15 }
16
17 public void show2() {
18 // 替代 show1方法
19 }
20
21 public void demo() {
22 show1();
23 }
24 }
三、自定义注解
1、自定义注解格式
元注解
public @interface 注解名称{
属性列表;
}
首先创建一个 MyAnno 类，然后在 cmd 窗口通过 javac 文件名.java 编译文件，接着再使用 javap 文件名.class 进行反编译。
public @interface MyAnno {}
通过反编译，我们得到一个信息：
public interface MyAnno extends java.lang.annotation.Annotation {}
总结：注解本质上就是一个接口，该接口默认继承Annotation接口
2、属性
注解既然是一个接口，那么就可以在接口中声明方法。
属性：接口中的抽象方法。
属性的返回值类型有下列取值：
① 基本数据类型
② String 类型
③ 枚举 Enum 类型
④ 注解类型
⑤ 以上类型的数组
属性的赋值：
在注解中定义了属性，在使用时需要给属性赋值：
① 如果定义属性时，使用default关键字给属性默认初始化值，则使用注解时，可以不进行属性的赋值。
② 如果只有一个属性需要赋值，并且属性的名称是value，则value可以省略，直接定义值即可。
③ 数组赋值时，值使用{}包裹。如果数组中只有一个值，则{}可以省略
3、元注解
元注解：用于描述注解的注解
常用的元注解：
（1） @Target：描述注解能够作用的位置
Target 里面是一个 ElementType[] value() 枚举数组，有如下取值：
-
-
-
-
- TYPE：可以作用于类上
- METHOD：可以作用于方法上
- FIELD：可以作用于成员变量上
-
-
-
（2） @Retention：描述注解被保留的阶段
Retention 里面是 RetentionPolicy value()，取值有：
-
-
-
-
- RetentionPolicy.SOURCE：当前被描述的注解，不会存在 class 字节码文件中（不常用）
- RetentionPolicy.CLASS：当前被描述的注解，会保留到class字节码文件中，但是不会被JVM读取。（不常用）
- RetentionPolicy.RUNTIME：当前被描述的注解，会保留到class字节码文件中，并被JVM读取到（自定义常用）
-
-
-
（3） @Documented：描述注解是否被抽取到api文档中
如果在被描述的注解A上添加了该元注解，那么当一个类B使用注解A时，注解A会被抽取到 api 文档中。
（4） @Inherited：描述注解是否被子类继承
如果在被描述的注解A上添加了该元注解，那么当一个类B使用注解A时，这个类B的子类C也会使用注解A。
四、在程序使用（解析）注解
需求：不能改变该类的任何代码。可以创建任意类的对象，可以执行任意方法
创建一个类：
1 public class Demo1 {
2 public void show() {
3 System.out.println("hello world");
4 }
5 }
自定义一个注解：
1 import java.lang.annotation.ElementType;
2 import java.lang.annotation.Retention;
3 import java.lang.annotation.RetentionPolicy;
4 import java.lang.annotation.Target;
5
6 /**
7 * 描述需要执行的类名和方法名
8 */
9 @Target({ElementType.TYPE})
10 @Retention(RetentionPolicy.RUNTIME)
11 public @interface Pro {
12
13 String className();
14 String methodName();
15 }
测试类：
1 import java.io.InputStream;
2 import java.lang.reflect.Method;
3 import java.util.Properties;
4
5 @Pro(className = "cn.ks.annotation.Demo1",methodName = "show") //给类添加注解，并给属性赋值
6 public class ReflectTest {
7 public static void main(String[] args) throws Exception {
8 /*
9 前提：不能改变该类的任何代码。可以创建任意类的对象，可以执行任意方法
10 */
11
12 //1、解析注解
13 //1.1 获取该类的字节码文件
14 Class<ReflectTest2> re = ReflectTest2.class;
15 //2 获取上面注解对象
16 // 其实就是在内存中生成了一个该注解接口的子类实现对象
17 Pro an = re.getAnnotation(Pro.class);
18
19 /*
20 public class ProImpl implements Pro {
21 public String className() {
22 return
23 }
24
25 public String methodName() {
26 return
27 }
28 }
29 */
30
31 //3 调用注解对象定义的抽象方法，获取返回值
32 String className = an.className();
33 String methodName = an.methodName();
34 System.out.println(className);
35 System.out.println(methodName);
36
37 //4.加载该类进内存
38 Class cls = Class.forName(className);
39 //5.创建对象
40 Object obj = cls.newInstance();
41 //6.获取方法对象
42 Method method = cls.getMethod(methodName);
43 //7.执行方法
44 method.invoke(obj);
45 }
46 }
五、案例
需求：给一个 Calculator 类，测试类中的方法是否都正常。
自定义一个注解：
1 import java.lang.annotation.ElementType;
2 import java.lang.annotation.Retention;
3 import java.lang.annotation.RetentionPolicy;
4 import java.lang.annotation.Target;
5
6 @Retention(RetentionPolicy.RUNTIME)
7 @Target(ElementType.METHOD)
8 public @interface Check {
9 }
给 Calculator 类中的每一个方法添加 @check 注解
1 public class Calculator {
2
3 //加法
4 @Check
5 public void add(){
6 String str = null;
7 str.toString();
8 System.out.println("1 + 0 =" + (1 + 0));
9 }
10 //减法
11 @Check
12 public void sub(){
13 System.out.println("1 - 0 =" + (1 - 0));
14 }
15 //乘法
16 @Check
17 public void mul(){
18 System.out.println("1 * 0 =" + (1 * 0));
19 }
20 //除法
21 @Check
22 public void div(){
23 System.out.println("1 / 0 =" + (1 / 0));
24 }
25
26
27 public void show(){
28 System.out.println("永无bug...");
29 }
30
31 }
测试类：
1 import java.io.BufferedWriter;
2 import java.io.FileWriter;
3 import java.io.IOException;
4 import java.lang.reflect.Method;
5
6 /**
7 *
8 * 当主方法执行后，会自动自行被检测的所有方法(加了Check注解的方法)，判断方法是否有异常，记录到文件中
9 */
10 public class TestCheck {
11
12
13 public static void main(String[] args) throws IOException {
14 //1.创建计算器对象
15 Calculator c = new Calculator();
16 //2.获取字节码文件对象
17 Class cls = c.getClass();
18 //3.获取所有方法
19 Method[] methods = cls.getMethods();
20
21 int number = 0;//出现异常的次数
22 BufferedWriter bw = new BufferedWriter(new FileWriter("bug.txt"));
23
24
25 for (Method method : methods) {
26 //4.判断方法上是否有Check注解
27 if(method.isAnnotationPresent(Check.class)){
28 //5.有，执行
29 try {
30 method.invoke(c);
31 } catch (Exception e) {
32 //6.捕获异常
33
34 //记录到文件中
35 number ++;
36
37 bw.write(method.getName()+ " 方法出异常了");
38 bw.newLine();
39 bw.write("异常的名称:" + e.getCause().getClass().getSimpleName());
40 bw.newLine();
41 bw.write("异常的原因:"+e.getCause().getMessage());
42 bw.newLine();
43 bw.write("--------------------------");
44 bw.newLine();
45
46 }
47 }
48 }
49
50 bw.write("本次测试一共出现 "+number+" 次异常");
51
52 bw.flush();
53 bw.close();
54
55
56
57 }
58
59 }
总结：注解是给编译器，解析程序使用的；注解不是程序的一部分。
4763
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
