如何实现Java编译期检查方法参数列表的@Retention(SOURCE)自定义注解

好问题！要实现这个编译期的方法参数检查，你需要借助Java的APT（Annotation Processing Tool）机制写一个自定义注解处理器——这是处理SOURCE级注解的标准玩法，下面一步步给你拆解：

1. 核心思路梳理 #

你的@HasParameterList注解被标记为RetentionPolicy.SOURCE，意味着它只会存在于源码阶段，编译后会被完全丢弃。要在编译时触发参数检查逻辑，必须通过注解处理器扫描源码中带该注解的方法，实时验证并抛出编译错误。

2. 准备依赖（以Maven为例） #

推荐使用Google的AutoService来自动注册注解处理器，省去手动配置META-INF文件的麻烦。在pom.xml中添加以下依赖：

<dependencies>
    <!-- 注解处理核心API -->
    <dependency>
        <groupId>javax.annotation</groupId>
        <artifactId>javax.annotation-api</artifactId>
        <version>1.3.2</version>
        <scope>provided</scope>
    </dependency>
    <!-- AutoService自动注册处理器 -->
    <dependency>
        <groupId>com.google.auto.service</groupId>
        <artifactId>auto-service</artifactId>
        <version>1.0.1</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

3. 编写自定义注解处理器 #

创建一个继承AbstractProcessor的类，实现核心检查逻辑：

import com.google.auto.service.AutoService;
import javax.annotation.processing.*;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.Element;
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.element.TypeElement;
import java.util.Set;

@AutoService(Processor.class) // AutoService自动帮我们完成处理器注册
public class HasParameterListProcessor extends AbstractProcessor {

    @Override
    public Set<String> getSupportedAnnotationTypes() {
        // 指定当前处理器要处理的注解全类名
        return Set.of(HasParameterList.class.getCanonicalName());
    }

    @Override
    public SourceVersion getSupportedSourceVersion() {
        // 声明支持的最高Java版本
        return SourceVersion.latestSupported();
    }

    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        // 遍历所有被@HasParameterList注解的元素
        for (Element element : roundEnv.getElementsAnnotatedWith(HasParameterList.class)) {
            // 先校验注解是否用在了方法上
            if (!(element instanceof ExecutableElement)) {
                processingEnv.getMessager().printError(
                    "@HasParameterList只能标注在方法上",
                    element
                );
                continue;
            }

            ExecutableElement method = (ExecutableElement) element;
            // 检查方法是否有参数列表
            if (method.getParameters().isEmpty()) {
                // 抛出编译错误，Messager会在IDE/编译日志中显示提示
                processingEnv.getMessager().printError(
                    "方法 [" + method.getSimpleName() + "] 被@HasParameterList注解，但未定义参数列表",
                    element
                );
            }
        }
        return true; // 标记该注解已被处理，无需其他处理器介入
    }
}

4. 测试验证效果 #

写几个测试类来验证处理器的工作逻辑：

public class TestProcessor {

    // 编译报错：无参数但被@HasParameterList注解
    @HasParameterList
    public void emptyParamMethod() {}

    // 正常通过：存在参数列表
    @HasParameterList
    public void validMethod(String arg1, int arg2) {}

    // 编译报错：注解用在了字段上
    @HasParameterList
    private String testField;
}

当你执行mvn compile或者在IDE中编译时，处理器会自动触发，抛出对应的编译错误，直接阻止不符合要求的代码通过编译。

补充说明 #

• 如果不想使用AutoService，你可以手动在src/main/resources/META-INF/services/javax.annotation.processing.Processor文件中添加处理器的全类名（比如com.yourpackage.HasParameterListProcessor）
• 处理器抛出的错误提示和Java原生编译错误完全一致，会直接显示在IDE的问题面板中，开发者体验友好
• 整个检查逻辑完全在编译阶段完成，不会对运行时性能产生任何影响

内容的提问来源于stack exchange，提问作者Zero