自定义注解@MyTest

本文介绍了一种使用自定义注解实现自动化测试的方法。通过创建自定义注解`MyTest`,并配合核心运行类`CoreRunner`,可以自动识别并执行带有此注解的方法。文章详细展示了自定义注解的定义、应用及如何通过反射调用带注解的方法。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

自定义注解

步骤分析

【步骤一】:创建自定义注解:MyTest
【步骤二】:定义核心运行类.CoreRunner
【步骤三】:在核心运行类中.获得测试类的Class
【步骤四】:获得Class中的所有方法.遍历得到每个方法.

判断方法上有MyTest注解,就执行该方法.

//自定义注解类
@Retention(value=RetentionPolicy.RUNTIME)//元注解①
public @interface MyTest {
}

①元注解:Java中用来修饰其他注释的注释
@Retention(value=RetentionPolicy.RUNTIME)
方法内传入一个枚举分别有三个值
RetentionPolicy.SOURCE:源文件阶段
value=RetentionPolicy.CLASS:字节码阶段
RetentionPolicy.RUNTIME:运行阶段(创建对象阶段)

用与设置注解的存在阶段,默认的自定义注解存在与源码阶段 在生成class文件后以及创建对象阶段就不存在了,所以需要将注解存在阶段延长

补充:类的存在有三种阶段对应的也有三种获取的方式
这里写图片描述

源代码阶段:以.java结尾的文件的形式存在

通过Class.forName(“类名”)方法获得

字节码阶段:将字节码文件编译后以.class结尾的文件存在

通过类名.class方式获取

创建对象阶段:JVM将字节码文件加载进内存的方法区内

通过对象.getClass方法获得

//测试类
public class AnnotationDemo1 {
    @MyTest
    public void demo1(){
        System.out.println("demo1执行了...");
    }
    @MyTest
    public void demo2(){
        System.out.println("demo2执行了...");
    }
    public void demo3(){
        System.out.println("demo3执行了...");
    }
}
//自定义注解核心运行类
    /**
     * 获得测试类的Class.
     * 获得Class中的所有的方法.
     * 遍历每个方法,查看每个方法上是否有MyTest注解.
     * 有MyTest注解,这个方法就执行.
     */
public class CoreRunner {
    public static void main(String[] args) throws IllegalAccessException, IllegalArgumentException, InvocationTargetException, InstantiationException {
        // 1.获得测试类的Class:
        Class clazz = AnnotationDemo1.class;
        // 2.获得Class中的所有的方法: 规定了测试的方法必须是public.
        Method[] methods = clazz.getMethods();
        // 3.遍历每个方法:
        for(Method method:methods){
            boolean flag = method.isAnnotationPresent(MyTest.class);//②
            if(flag){
                // 说明方法上有MyTest注解:
                method.invoke(clazz.newInstance(), null);
            }
        }
    }
}

boolean isAnnotationPresent(Class<? extends Annotation> annotationClass):

判断指定类型的注释是否存在于此元素上 是则返回 true,否则返回 false。

<think>好的,我需要回答用户关于@Documented注解的用法和含义的问题。首先,我得回忆一下Java中的元注解相关知识。用户提到了@Documented,这个注解属于元注解的一种,用于标注其他注解,使其在生成JavaDoc时包含被标注的注解信息。 首先,我应该解释@Documented的基本作用。用户可能想知道这个注解存在的意义,以及它如何影响文档生成。比如,如果不使用@Documented,自定义注解在生成文档时不会被显示出来,而使用后则会被包含在文档中,方便他人查看。 接下来,我需要提供使用方法的步骤。用户可能想知道如何在代码中实际应用这个注解。步骤可能包括定义注解接口时添加@Documented,然后使用该注解标注其他元素,如类或方法。需要确保语法正确,比如使用@interface定义注解,并在前面加上@Documented。 然后,示例代码会很有帮助。用户可能需要看到一个具体的例子来理解如何编写和使用带有@Documented的注解。例如,定义一个注解@B,用@Documented修饰,然后将其应用到一个类上。生成JavaDoc后,查看该类文档时是否包含@B的信息。这可以直观地展示@Documented的效果。 此外,需要指出@Documented只能修饰注解类型,不能用于类或方法等其他元素。这一点容易混淆,应该明确说明。同时,结合其他元注解如@Retention来说明,通常需要指定保留策略为RUNTIME或SOURCE,以确保注解信息在文档中可见。 还要注意用户提供的引用内容。引用3中有一个示例,展示了@Documented的使用方式,可以借鉴这个例子来构建回答。确保示例代码的语法正确,比如使用@interface,并且正确使用@Documented的位置。 用户可能还会有疑问,比如如果没有@Documented会怎样,或者它与其他元注解的关系。虽然用户没有直接问这些,但可以在回答中简要提及,以增强全面性。例如,说明@Documented通常与@Retention一起使用,以确保注解信息在文档生成时可用。 最后,生成相关问题部分需要考虑用户可能的进一步疑问。比如@Documented与其他元注解的区别,或者在不同Java版本中的行为变化。这样可以帮助用户深入理解相关知识点。 总结一下,回答的结构应该是先解释@Documented的作用,再给出使用步骤和示例,接着注意事项,最后相关问题。需要确保内容准确,示例清晰,并正确引用提供的参考资料。</think>### @Documented 注解的用法与含义 #### 作用说明 `@Documented` 是 Java 的元注解(用于修饰其他注解注解),**其核心作用是控制生成的 JavaDoc 是否包含被标注的注解信息**。若自定义注解未添加 `@Documented`,则使用该注解的类或方法在生成 JavaDoc 时,注解信息不会显示;添加后,注解会出现在文档中[^3]。 --- #### 使用方法 1. **定义注解时添加 `@Documented`** 在自定义注解的声明前添加 `@Documented`,语法如下: ```java import java.lang.annotation.Documented; @Documented @interface CustomAnnotation { String value() default "默认"; } ``` 2. **应用自定义注解** 将自定义注解标注在类、方法等元素上: ```java @CustomAnnotation("示例") public class MyClass { // 类内容 } ``` 3. **生成 JavaDoc 验证效果** 使用 `javadoc` 工具生成文档时,`MyClass` 的文档会显示 `@CustomAnnotation` 的注解信息。 --- #### 示例代码解析 参考用户提供的示例[^3]: ```java @Documented @interface B { String value() default "这是一个自定义类"; } @B public class MyTest2 { public static void main(String[] args) throws Exception { Class<?> c = Class.forName("hello3.B"); System.out.println(c); } } ``` - **关键点** - `@B` 被 `@Documented` 修饰,因此生成 `MyTest2` 的 JavaDoc 时会显示 `@B` 注解。 - 若移除 `@Documented`,则 `@B` 不会出现在文档中。 --- #### 注意事项 1. **仅适用于注解类型** `@Documented` 只能修饰其他注解,不可直接用于类或方法。 2. **需结合 `@Retention` 使用** 通常需要配合 `@Retention(RetentionPolicy.RUNTIME)` 或 `@Retention(RetentionPolicy.SOURCE)`,确保注解信息能被保留到文档生成阶段[^3]。 ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值