java 注解重写set方法

原创

mob64ca12d9e536 2024-09-15 05:22:21 ©著作权

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

如何实现 Java 注解重写 set 方法

在 Java 中，我们可以通过注解（Annotation）来增强我们的程序功能，特别是在属性的 setter 方法中使用注解，可以实现一些自定义的处理逻辑。接下来，我将向你展示如何通过注解重写 set 方法的步骤和关键代码。

流程概述

下面是整个实现流程的步骤。你可以根据这个表格进行学习和实践：

步骤	描述
1	定义自定义注解
2	创建一个类，在该类中使用自定义注解
3	使用反射来解析注解并重写 `set` 方法
4	测试实现效果

接下来，我们将详细解释每一步的操作。

步骤详解

第一步：定义自定义注解

我们首先需要定义一个自定义注解，通常我们将其命名为 @MyCustomSetter。

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

// 定义注解，设置作用目标为字段
@Target(ElementType.FIELD) 
// 定义注解在运行时可用
@Retention(RetentionPolicy.RUNTIME) 
public @interface MyCustomSetter {
    String value() default ""; // 可选的注解属性
}

这段代码中，@Target 指定了该注解可以应用于字段，而 @Retention 则表示注解在运行时仍然有效。

第二步：创建一个类使用自定义注解

接下来我们创建一个类，给某个字段的 setter 方法加上我们的注解。

public class User {
    private String name;

    @MyCustomSetter("custom-Name") // 使用自定义注解
    public void setName(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }
}

在这里，我们给 setName 方法添加了 @MyCustomSetter 注解，后面可以在反射中用到。

第三步：使用反射来解析注解并重写 `set` 方法

在这一步，我们将使用 Java 的反射机制来查找并使用 MyCustomSetter 注解。

import java.lang.reflect.Field;
import java.lang.reflect.Method;

public class AnnotationProcessor {
    
    public static void processAnnotations(Object obj) {
        Class<?> objClass = obj.getClass(); // 获取对象的类
        Field[] fields = objClass.getDeclaredFields(); // 获取所有字段

        for (Field field : fields) {
            if (field.isAnnotationPresent(MyCustomSetter.class)) { // 检查是否有自定义注解
                MyCustomSetter annotation = field.getAnnotation(MyCustomSetter.class);
                System.out.println("Setting field: " + field.getName() + " with value: " + annotation.value());
                try {
                    // 获取对应的 setter 方法并调用
                    Method setter = objClass.getMethod("set" + capitalize(field.getName()), String.class);
                    setter.invoke(obj, annotation.value()); // 调用 setter 方法
                } catch (Exception e) {
                    e.printStackTrace(); // 输出异常信息
                }
            }
        }
    }

    // 辅助方法：将字符串首字母大写
    private static String capitalize(String str) {
        if (str == null || str.isEmpty()) return str;
        return str.substring(0, 1).toUpperCase() + str.substring(1);
    }
}

上面的代码首先获取了对象的所有字段，然后检查字段上是否有 MyCustomSetter 注解。如果有，就获取与该字段对应的 setter 方法并传入注解中的值。

第四步：测试实现效果

最后，我们可以编写一个测试代码来验证实现是否有效。

public class Main {
    public static void main(String[] args) {
        User user = new User(); // 创建 User 对象
        AnnotationProcessor.processAnnotations(user); // 处理注解
        System.out.println("User name set to: " + user.getName()); // 输出设置后的姓名
    }
}

通过运行这段代码，我们可以看到 setName 方法被注解中的值 "custom-Name" 重写。