如何要求方法必须标注@AuthZCheck或@NoAuthZCheck否则触发编译错误？

有成熟的可落地实现方案，按生效优先级从高到低排序如下：

这是JDK原生支持的编译期扫描方案，只要方法未标注指定注解，编译阶段就会直接抛出错误阻断编译，完全满足要求。

实现步骤： #

1. 编写注解处理器逻辑，示例代码如下：

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

// 替换成你实际的两个注解的全类名
@SupportedAnnotationTypes({"com.yourcompany.auth.AuthZCheck", "com.yourcompany.auth.NoAuthZCheck"})
@SupportedSourceVersion(SourceVersion.RELEASE_8)
public class AuthAnnotationMandatoryProcessor extends AbstractProcessor {

    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        // 遍历所有编译单元
        for (Element rootElement : roundEnv.getRootElements()) {
            // 遍历类内所有成员
            for (Element enclosedElement : rootElement.getEnclosedElements()) {
                // 仅校验普通方法，可根据团队规则调整，比如排除构造方法、私有方法等
                if (enclosedElement.getKind() == ElementKind.METHOD) {
                    boolean hasValidAuthAnnotation = 
                        enclosedElement.getAnnotation(AuthZCheck.class) != null
                        || enclosedElement.getAnnotation(NoAuthZCheck.class) != null;
                    
                    if (!hasValidAuthAnnotation) {
                        // 抛出编译错误，定位到具体未加注解的方法
                        processingEnv.getMessager().printMessage(
                            Diagnostic.Kind.ERROR,
                            "方法必须显式标注@AuthZCheck（权限校验）或@NoAuthZCheck（无需校验）注解",
                            enclosedElement
                        );
                    }
                }
            }
        }
        return true;
    }
}

2. 打包处理器为独立Jar包，在Jar包的META-INF/services/javax.annotation.processing.Processor文件中填写上述处理器的全类名完成注册。
3. 所有业务项目引入该Jar包，Maven等构建工具会自动识别注解处理器，编译时未符合规则的代码会直接报错，无法完成编译。

如果团队已经在使用静态代码检查工具，可以直接新增自定义规则实现强制校验：

• Checkstyle：新增自定义检查规则，扫描所有方法的注解列表，不符合规则的标记为阻断级错误
• Alibaba Java Coding Guidelines/SpotBugs：同样支持自定义规则，把该校验逻辑加入全局规则集
• 配置为规则不通过则无法合并代码，也能达到强制要求的效果，仅触发时机晚于编译期处理器。

在IDEA等IDE中自定义Inspection规则：

• 进入Settings -> Editor -> Inspections，新增Java注解检查规则，逻辑为「方法未标注@AuthZCheck或@NoAuthZCheck时标记为错误」
• 将规则导出为团队共享配置，所有成员导入后写代码时IDE会实时标红提示，还可配置快速修复选项一键添加注解。

无论使用上述哪种方案，都可以在CI/CD流程中加入对应的扫描脚本，代码提交后自动校验所有方法的注解，不符合规则直接阻断合并，作为最后一道兜底防线。

落地建议 #

可以将注解处理器、静态检查规则统一配置到团队公用的父pom中，业务项目只需继承父pom即可自动生效，避免有人刻意绕开规则。

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