java加上注解就执行一段代码

原创

mob64ca12e95b2b 2024-08-05 06:15:28 ©著作权

©著作权归作者所有：来自51CTO博客作者mob64ca12e95b2b的原创作品，请联系作者获取转载授权，否则将追究法律责任

Java 注解与执行代码的实践

在 Java 开发中，使用注解（Annotation）是一种非常有力的工具，可以用于指令代码的执行。本文将以简单明了的方式教你如何实现“Java加上注解就执行一段代码”的功能，确保你能轻松地跟上每一步。

流程概述

实现这个功能的流程主要包括以下几个步骤：

步骤	描述
1	定义自定义注解
2	创建一个注解处理器
3	应用注解到目标类或方法
4	运行程序并触发注解处理

步骤详解

1. 定义自定义注解

首先，我们需要定义一个自定义注解，以便我们能够在代码中使用它。注解的基本结构如下：

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 MyAnnotation {
    String value() default "默认值"; // 注解的属性
}

以上代码定义了一个名为 MyAnnotation 的注解，可以应用于方法，并在运行时使用。

2. 创建一个注解处理器

接下来，我们需要创建一个注解处理器，它将在程序运行时检查这些注解，并执行相应的代码。

import java.lang.reflect.Method;

public class AnnotationProcessor {
    public static void processAnnotations(Object obj) {
        // 获取对象的类
        Class<?> clazz = obj.getClass();
        
        // 获取所有的方法
        for (Method method : clazz.getDeclaredMethods()) {
            // 检查方法是否有 MyAnnotation 注解
            if (method.isAnnotationPresent(MyAnnotation.class)) {
                try {
                    // 获取注解的值
                    MyAnnotation annotation = method.getAnnotation(MyAnnotation.class);
                    System.out.println("执行方法: " + method.getName() + ", 注解值: " + annotation.value());
                    
                    // 调用注解标记的方法
                    method.invoke(obj); // 反射调用方法
                } catch (Exception e) {
                    e.printStackTrace(); // 捕获并打印异常
                }
            }
        }
    }
}

在这个注解处理器中，我们通过反射机制查找被 MyAnnotation 注解标记的方法，并在找到时调用它。

3. 应用注解到目标类或方法

现在，我们可以创建一个类并应用这个自定义注解来测试我们的实现。

public class MyClass {
    @MyAnnotation(value = "Hello, World!") // 应用自定义注解
    public void myMethod() {
        System.out.println("方法 myMethod 被调用!"); // 注解调用时执行的代码
    }
}

4. 运行程序并触发注解处理

最后，我们需要编写一个主类来运行程序。

public class Main {
    public static void main(String[] args) {
        MyClass myClass = new MyClass(); // 创建目标对象
        AnnotationProcessor.processAnnotations(myClass); // 处理注解
    }
}

运行上述代码时，myMethod 方法会被执行，且在控制台输出如下信息：

执行方法: myMethod, 注解值: Hello, World!
方法 myMethod 被调用!

序列图

以下是这一过程的序列图，展示了对象的创建和注解处理的步骤：

sequenceDiagram
    participant Main
    participant AnnotationProcessor
    participant MyClass
    
    Main->>MyClass: 创建对象
    Main->>AnnotationProcessor: 调用 processAnnotations(myClass)
    AnnotationProcessor->>MyClass: 查找带注解的方法
    Note right of AnnotationProcessor: 找到 myMethod
    AnnotationProcessor->>Main: 输出执行方法信息
    AnnotationProcessor->>MyClass: 调用 myMethod
    MyClass->>AnnotationProcessor: 输出方法调用信息