java怎样使用注解进行代码检查 java注解代码检查的基础入门技巧​

@NonNull

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

@Retention(RetentionPolicy.SOURCE) // 注解只在源码中保留，编译后丢弃
@Target({ElementType.FIELD, ElementType.PARAMETER}) // 适用于字段和参数
public @interface NonNull {
    String message() default "This field cannot be null."; // 可选的错误消息
}

@Retention

SOURCE

@Target

message()

import javax.annotation.processing.*;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.Element;
import javax.lang.model.element.TypeElement;
import javax.tools.Diagnostic;
import java.util.Set;

@SupportedAnnotationTypes("NonNull") // 声明支持的注解类型
@SupportedSourceVersion(SourceVersion.RELEASE_8) // 声明支持的Java版本
public class NonNullProcessor extends AbstractProcessor {

    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        for (Element element : roundEnv.getElementsAnnotatedWith(NonNull.class)) {
            // 检查被注解的元素
            if (element.getKind().isField()) {
                // 检查字段是否被初始化
                // 这里可以添加更复杂的逻辑，例如检查是否有默认值，或者在构造函数中被赋值
                if (element.getSimpleName().toString().startsWith("uninitialized")) { // 假设未初始化的字段名以 "uninitialized" 开头
                    processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR,
                            "Field " + element.getSimpleName() + " is annotated with @NonNull but is not initialized.",
                            element);
                }
            } else if (element.getKind().isParameter()) {
                // 检查方法参数是否为 null
                // 通常需要在运行时进行检查，但这里可以添加编译时的警告
                processingEnv.getMessager().printMessage(Diagnostic.Kind.WARNING,
                        "Parameter " + element.getSimpleName() + " is annotated with @NonNull, consider adding runtime null check.",
                        element);
            }
        }
        return true; // 表示注解已被处理
    }
}

@NonNull

import java.lang.reflect.Method;
import java.lang.reflect.Parameter;

public class RuntimeValidator {

    public static void validate(Object obj, Method method, Object[] args) {
        Parameter[] parameters = method.getParameters();
        for (int i = 0; i < parameters.length; i++) {
            Parameter parameter = parameters[i];
            if (parameter.isAnnotationPresent(NonNull.class)) {
                if (args[i] == null) {
                    NonNull nonNull = parameter.getAnnotation(NonNull.class);
                    String message = nonNull.message(); // 获取自定义的错误消息
                    throw new IllegalArgumentException(message);
                }
            }
        }
    }

    public static void main(String[] args) throws NoSuchMethodException {
        MyClass myObject = new MyClass();
        Method myMethod = MyClass.class.getMethod("myMethod", String.class);

        try {
            validate(myObject, myMethod, new Object[]{null}); // 模拟传入 null 参数
        } catch (IllegalArgumentException e) {
            System.err.println("Validation failed: " + e.getMessage());
        }

        try {
            validate(myObject, myMethod, new Object[]{"not null"}); // 模拟传入非 null 参数
        } catch (IllegalArgumentException e) {
            System.err.println("Validation failed: " + e.getMessage());
        }
    }
}

class MyClass {
    public void myMethod(@NonNull String arg) {
        System.out.println("Method called with arg: " + arg);
    }
}

@NonNull