如何基于IntelliJ自定义插件的自定义错误阻止项目编译？

核心方案：Inspection规则+Gradle前置检查任务 #

Annotator仅负责编辑器层面的高亮，要阻断编译流程，需要把你的逻辑错误检测转为IntelliJ Inspection规则，再让Gradle在编译前强制执行该检查，发现错误即终止编译。

1. 将自定义错误转为Inspection规则 #

放弃单独的Annotator，改用LocalInspectionTool实现错误检测逻辑，这是IntelliJ官方支持的代码检查扩展方式：

public class CustomLogicErrorInspection extends LocalInspectionTool {
    @Override
    public @NotNull PsiElementVisitor buildVisitor(@NotNull ProblemsHolder holder, boolean isOnTheFly) {
        return new JavaElementVisitor() {
            @Override
            public void visitMethod(PsiMethod method) {
                // 替换为你的逻辑错误检测逻辑
                if (hasInvalidLogic(method)) {
                    holder.registerProblem(method, "自定义逻辑错误：不符合业务规则", ProblemHighlightType.GENERIC_ERROR_OR_WARNING);
                }
            }
        };
    }

    private boolean hasInvalidLogic(PsiMethod method) {
        // 实现你的错误判断逻辑，比如检查特定方法调用、变量使用等
        return false;
    }
}

在plugin.xml中注册该Inspection：

<extensions defaultExtensionNs="com.intellij">
    <localInspection language="JAVA"
                     implementationClass="com.yourpackage.CustomLogicErrorInspection"
                     groupPath="Java"
                     groupName="Custom Logic Checks"
                     displayName="Custom Logic Error Check"
                     enabledByDefault="true"
                     level="ERROR"/>
</extensions>

2. 配置Gradle执行检查任务 #

在项目的build.gradle中添加IntelliJ检查任务，并设置为编译前置依赖：

plugins {
    id 'java'
    id 'org.jetbrains.intellij' version '1.17.0' // 适配你的IntelliJ版本
}

intellij {
    version '2023.2' // 对应开发使用的IntelliJ版本
    plugins 'java'
}

// 自定义检查任务，仅运行你的Inspection规则
task runCustomInspections(type: org.jetbrains.intellij.tasks.RunInspectionsTask) {
    // 可通过导出IntelliJ检查配置文件指定规则，或直接用Inspection类名
    includeInspections = ['com.yourpackage.CustomLogicErrorInspection']
    failOnError = true // 发现错误立即终止任务
}

// 让编译任务依赖检查任务，确保先检查再编译
compileJava.dependsOn runCustomInspections

3. 备选方案（适配已有Annotator逻辑） #

如果不想重构为Inspection，可通过临时文件传递错误状态：

• 在Annotator中，检测到错误时将信息写入项目根目录的.custom_errors临时文件
• 自定义Gradle任务读取该文件，存在错误则抛出异常终止编译：

task checkCustomErrors {
    doLast {
        def errorFile = file('.custom_errors')
        if (errorFile.exists() && errorFile.text.trim().length() > 0) {
            throw new GradleException("发现自定义逻辑错误：\n${errorFile.text}")
        }
    }
    // 任务执行前清理旧文件，避免残留错误
    doFirst {
        def errorFile = file('.custom_errors')
        if (errorFile.exists()) errorFile.delete()
    }
}
compileJava.dependsOn checkCustomErrors

注意要在Annotator的清理逻辑中处理临时文件，避免残留影响后续编译。

为什么之前的方案无效？ #

• AnnotationProcessor：仅能处理注解相关的编译期检查，无法识别自定义逻辑模式错误
• ExecutionListener：仅监听事件，无权限中断编译流程
• 自定义CompileTask：未关联错误检测逻辑，无法精准判断是否终止编译

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