Java getter setter 注解

原创

mob64ca12eb7baf 2024-02-01 10:44:01 ©著作权

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

Java Getter Setter 注解实现

作为一名经验丰富的开发者，我将指导你如何实现 Java 中的 Getter Setter 注解。在本文中，我将为你提供一份流程图，详细说明每个步骤需要做什么以及需要使用的代码。

流程图

flowchart TD
    A[定义注解] --> B[创建目标类]
    B --> C[生成 Getter Setter 方法]
    C --> D[使用注解]

步骤说明

1. 定义注解

首先，我们需要定义一个注解，用于标记目标类中需要生成 Getter Setter 方法的属性。注解的定义方法如下：

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.FIELD)
public @interface GenerateGetterSetter {
}

这里使用了 Java 中的内置注解 @Retention 和 @Target，分别用于指定注解的保留策略和作用目标。

2. 创建目标类

接下来，我们需要创建一个目标类，其中包含需要生成 Getter Setter 方法的属性。例如，我们创建一个名为 User 的类：

public class User {
    @GenerateGetterSetter
    private String name;

    @GenerateGetterSetter
    private int age;
}

在上述示例中，我们通过 @GenerateGetterSetter 注解标记了 name 和 age 属性。

3. 生成 Getter Setter 方法

为了实现 Getter Setter 方法的生成，我们需要编写一个自定义的注解处理器。以下是一个实现示例：

import java.lang.reflect.Field;

public class GetterSetterProcessor {
    public static void generateGetterSetter(Object obj) {
        Class<?> clazz = obj.getClass();
        Field[] fields = clazz.getDeclaredFields();

        for (Field field : fields) {
            if (field.isAnnotationPresent(GenerateGetterSetter.class)) {
                generateGetter(clazz, field);
                generateSetter(clazz, field);
            }
        }
    }

    private static void generateGetter(Class<?> clazz, Field field) {
        String fieldName = field.getName();
        String capitalizedFieldName = capitalize(fieldName);
        Class<?> fieldType = field.getType();

        String getterName = "get" + capitalizedFieldName;
        String returnType = fieldType.getSimpleName();

        String getterCode = "public " + returnType + " " + getterName + "() { " +
                "return this." + fieldName + "; }";

        System.out.println(getterCode);
    }

    private static void generateSetter(Class<?> clazz, Field field) {
        String fieldName = field.getName();
        String capitalizedFieldName = capitalize(fieldName);
        Class<?> fieldType = field.getType();

        String setterName = "set" + capitalizedFieldName;
        String parameterType = fieldType.getSimpleName();

        String setterCode = "public void " + setterName + "(" + parameterType + " " + fieldName + ") { " +
                "this." + fieldName + " = " + fieldName + "; }";

        System.out.println(setterCode);
    }

    private static String capitalize(String str) {
        return str.substring(0, 1).toUpperCase() + str.substring(1);
    }
}

在上述代码中，我们使用反射获取目标类的属性，并根据注解生成相应的 Getter Setter 方法。生成的方法代码将打印在控制台上，你可以根据需要进行调整。

4. 使用注解

最后，我们需要在目标类中调用注解处理器来生成 Getter Setter 方法。可以在 main 方法中添加以下代码：

public class Main {
    public static void main(String[] args) {
        User user = new User();
        GetterSetterProcessor.generateGetterSetter(user);
    }
}

上述代码会自动为 User 类中标记了 @GenerateGetterSetter 注解的属性生成相应的 Getter Setter 方法。