java注释中添加跳转 javaweb注释

转载

huatechinfo 2023-11-09 09:02:47

文章标签 java注释中添加跳转 java System 赋值 文章分类 Java 后端开发

03-day1黑马javaweb笔记-注解

概念

注解：说明程序的。给计算机看的
注释：用文字描述程序的。给程序员看的

百度百科

定义：注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。

概念描述：

JDK1.5之后的新特性
说明程序的
使用注解：@注解名称

作用分类：

编写文档：通过代码里标识的注解生成文档【生成文档doc文档】
代码分析：通过代码里标识的注解对代码进行分析【使用反射】
编译检查：通过代码里标识的注解让编译器能够实现基本的编译检查【Override】

初步使用doc文档生成

/**
 * 注解 javadoc演示
 *
 * @author itcat
 * @version 1.0
 * @since 1.5
 */

public class DocumentGenerationDemo {

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

}

注解说明

@author 作者名
@version 版本号
@since java1.5版本后使用
@param 参数名
@return 返回结果

文档生成命令

javadoc DocumentGenerationDemo.java

java注释中添加跳转 javaweb注释_java注释中添加跳转

找到文档生成后的index.html文件

java注释中添加跳转 javaweb注释_System_02

注解生成后的文档

java注释中添加跳转 javaweb注释_System_03

JDK中预定义的一些注解

@Override ：检测被该注解标注的方法是否是继承自父类(接口)的
@Deprecated：该注解标注的内容，表示已过时
@SuppressWarnings：压制警告一般传递参数all @SuppressWarnings(“all”)

java注释中添加跳转 javaweb注释_java注释中添加跳转_04

package zhushi;

//压住类中的所有警告
@SuppressWarnings("all")
public class PredefinedAnnotationDemo {
    @Override
    public String toString() {
        return super.toString();
    }

    @Deprecated
    public void show1(){
        //过时的方法
    }

    public void test(){
        show1();
    }

}

自定义注解

格式

元注解

public @interface 注解名称{
			属性列表;
		}

利用反编译，可以看到注解本质上就是一个接口，该接口默认继承Annotation接口

javac test.java
javap test.class

java注释中添加跳转 javaweb注释_java_05

属性

接口中的抽象方法

要求：

属性的返回值类型有下列取值

基本数据类型
String
枚举
注解
以上类型的数组

package zhushi;

public @interface Test {
    //基本数据类型
    int show1();

    //String类型
    String show2();

    //枚举类型
    Person per();

    //注解
    ZhuJie zhujie();

    //数组
    String[] arr();
}

定义了属性，在使用时需要给属性赋值

如果定义属性时，使用default关键字给属性默认初始化值，则使用注解时，可以不进行属性的赋值。

//基本数据类型
    int show1() default 10;

    //String类型
    String show2() default "123";

如果只有一个属性需要赋值，并且属性的名称是value，则value可以省略，直接定义值即可。

数组赋值时，值使用{}包裹。如果数组中只有一个值，则{}可以省略

java注释中添加跳转 javaweb注释_java_06

元注解

用于描述注解的注解

@Target：描述注解能够作用的位置

ElementType取值：
				* TYPE：可以作用于类上
				* METHOD：可以作用于方法上
				* FIELD：可以作用于成员变量上

java注释中添加跳转 javaweb注释_System_07

package zhushi;


import java.lang.annotation.ElementType;
import java.lang.annotation.Target;

@Target(value = ElementType.TYPE)//TYPE：可以作用于类上
//@Target(value = ElementType.METHOD)//METHOD：可以作用于方法上
//@Target(value = ElementType.FIELD)//FIELD：可以作用于成员变量上
public @interface Test {

    String value();
    String[] arr();

}

也可以作用于全部领域

package zhushi;


import java.lang.annotation.ElementType;
import java.lang.annotation.Target;

@Target(value = {ElementType.TYPE,ElementType.METHOD,ElementType.FIELD})

public @interface Test {

    String value();
    String[] arr();

}

java注释中添加跳转 javaweb注释_java_08

@Retention：描述注解被保留的阶段

@Retention(RetentionPolicy.RUNTIME)：当前被描述的注解，会保留到class字节码文件中，并被JVM读取到

@Documented：描述注解是否被抽取到api文档中

@Inherited：描述注解是否被子类继承

注解实践

需求：写一个"框架"，不能改变该类的任何代码的前提下，可以帮我们创建任意类的对象，并且执行其中任意方法

在程序使用(解析)注解：获取注解中定义的属性值

获取注解定义的位置的对象（Class，Method,Field）
获取指定的注解
调用注解中的抽象方法获取配置的属性值

ReflectTest.java

package zhushi;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

@Pro(className = "zhushi.Demo1",methodName = "show")
public class ReflectTest {
    public static void main(String[] args) throws ClassNotFoundException, IllegalAccessException, InstantiationException, NoSuchMethodException, InvocationTargetException {
        /*
        前提：不能改变该类任何代码。
        可以创建任意类对象，执行任意方法。
         */

        //1.解析注解
        //1.1获取该类的字节码文件对象
        Class<ReflectTest> reflectTestClass = ReflectTest.class;

        //2 获取上面的注解对象
        Pro annotation = reflectTestClass.getAnnotation(Pro.class);
        //其实就是在内存中去生成了一个该注解接口的子类对象
        /**
         * public class ProImpl implements Pro{
         * 	                public String className(){
         * 	                    return "cn.itcast.annotation.Demo1";
         *                                        }
         * 	                public String methodName(){
         * 	                    return "show";
         *                    }
         * 	            }
         */

        //3.调用注解对象中定义的抽象方法，来获取返回值
        String className = annotation.className();
        String methodName = annotation.methodName();

        System.out.println(className);
        System.out.println(methodName);


        //3.加在该类进内存
        Class cls = Class.forName(className);
        //4.创建对象
        Object o = cls.newInstance();
        //5.获取方法对象
        Method method = cls.getMethod(methodName);
        //6.运行程序
        method.invoke(o);
    }
}

Pro.java

package zhushi;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 描述需要执行的类名，和方法名
 */

@Retention(RetentionPolicy.RUNTIME)
@Target(value = ElementType.TYPE)
public @interface Pro {
    String className();
    String methodName();
}

Demo1.java

package zhushi;

public class Demo1 {
    public void show(){
        System.out.println("demo1...show...");
    }
}

案例（简单的测试框架）

Calculator.java

package cn.itcast.annotation.demo;


/**
 * 小明定义的计算器类
 */
public class Calculator {

    //加法
    @Check
    public void add(){
        String str = null;
        str.toString();
        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...");
    }

}

Check.java

package cn.itcast.annotation.demo;


import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Check {
}

TestCheck.java

package cn.itcast.annotation.demo;


import java.io.BufferedWriter;
import java.io.FileWriter;
import java.io.IOException;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

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


    public static void main(String[] args) throws IOException {
        //1.创建计算器对象
        Calculator c = new Calculator();
        //2.获取字节码文件对象
        Class cls = c.getClass();
        //3.获取所有方法
        Method[] methods = cls.getMethods();

        int number = 0;//出现异常的次数
        BufferedWriter bw = new BufferedWriter(new FileWriter("bug.txt"));


        for (Method method : methods) {
            //4.判断方法上是否有Check注解
            if(method.isAnnotationPresent(Check.class)){
                //5.有，执行
                try {
                    method.invoke(c);
                } catch (Exception e) {
                    //6.捕获异常

                    //记录到文件中
                    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();



    }

}