1.Java 注解

2020-09-10  本文已影响0人  清梦星河哈
注解:说明程序的。给计算机看的
注释:用文字描述程序的。给程序员看的

例子

1.注解生成doc文档
/**
 * 注解JavaDoc演示
 * @author A
 * @version 1.0
 * @since 1.5
 */
public class AnnoDemo {

    /**
     * 计算两数的和
     * @param a 整数
     * @param b 整数
     * @return 两数的和
     */
    public int add(int a, int b){
        return a + b;
    }
}

然后打开命令处理程序 cmd


360截图20200910162801767.png

定位到AnnoDemo.java类文件夹
输入命令javadoc AnnoDemo.java(javadoc + 要生成文档java类名)

360截图20200910163748936.png
注意java类的编码格式不能生成时换成GBK

打开生成的index.html就可以看到像Java官方说明文档

2.自定义注解
/**
 * 属性的返回值类型有下列取值
 *  基本数据类型
 *  String
 *  枚举
 *  注解
 *  以上类型的数组
 */
public @interface MyAnno/*注解名*/ {

    //基本数据类型
    int age();

    //String
    String name() default "张三";

    //返回枚举
    Person per();

    //返回注解
    MyAnno2 anno2();

    //数组
    String[] strs();
}
3.元注解
/**
 * 元注解:用于描述注解的注解
 *   @Target:描述注解能够作用的位置
 *     ElementType取值:
 *       TYPE:可以作用于类上
 *       METHOD:可以作用于方法上
 *       FIELD:可以作用于成员变量上
 *   @Retention:描述注解被保留的阶段
 *     @Retention(RetentionPolicy.RUNTIME):前被描述的注解,会保留到Class字节码文件中,并被JVM读取到
 *   @Documented:描述注解是否被抽取到API文档中
 *   @Inherited:描述注解是否被子类继承
 */
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented //是否被抽取到API文档中
@Inherited //是否被子类继承
public @interface MyAnno3 {

}
4.在程序使用(解析)注解
@Target(ElementType.TYPE)//作用在类上
@Retention(RetentionPolicy.RUNTIME)
public @interface Pro {

    String className();

    String methodName();
}

@Pro(className = "11111", methodName="2222")
public class Reflect {

    public static void main(String[] args) {

        //1.解析注解
        //1.1获取该类的字节码文件对象
        Class<Reflect> reflectClass = Reflect.class;
        //2.获取上边的注解对象
        //其实就是在内存中生成一个该注解接口的子类实现对象
        Pro an = reflectClass.getAnnotation(Pro.class);
        //3.调用注解对象中定义的抽象方法,获取返回值
        String className = an.className();
        String methodName = an.methodName();
        System.out.println(className);
        System.out.println(methodName);
    }
}

打印className和methodName就会获取到11111和2222

用注解检查方法Bug的简单例子

@Target(ElementType.METHOD)//作用在方法上
@Retention(RetentionPolicy.RUNTIME)
public @interface Check {

}

要检查的方法加上@Check

    @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));
    }

简单的测试框架

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

    public static void main(String[] args) throws IOException {
        Calculator calculator = new Calculator();
        Class<? extends Calculator> cls = calculator.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(calculator);
                } 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();
    }
}
上一篇 下一篇

猜你喜欢

热点阅读