如何实现同时使用两个自定义注解时触发Lint警告/错误

当然可以！通过自定义Android Lint规则，你完全能实现这个需求——当代码里同时标注了@A和@B注解时，自动触发警告或错误提示，引导用户只使用其中一个。下面是具体的实现步骤：

步骤1：搭建Lint规则模块 #

首先，在你的Android项目中创建一个独立的Java模块（Lint API对Java的支持更成熟）。然后在该模块的build.gradle中添加Lint相关依赖：

plugins {
    id 'java-library'
}

dependencies {
    // 依赖Lint核心API和内置检查库，版本尽量和你的AGP版本匹配
    implementation 'com.android.tools.lint:lint-api:30.1.2'
    implementation 'com.android.tools.lint:lint-checks:30.1.2'
}

jar {
    manifest {
        // 指定Lint规则的注册表类，后续会创建这个类
        attributes("Lint-Registry-v2": "com.yourpackage.CustomLintRegistry")
    }
}

步骤2：编写冲突注解检测的Detector #

创建一个ConflictingAnnotationsDetector类，负责扫描代码中的注解，检查是否存在@A和@B同时使用的情况：

import com.android.tools.lint.detector.api.*;
import org.jetbrains.uast.UAnnotation;
import org.jetbrains.uast.UElement;

import java.util.List;

public class ConflictingAnnotationsDetector extends Detector implements Detector.UastScanner {

    // 定义Lint问题的核心信息：ID、描述、详细说明、分类、优先级、严重程度
    public static final Issue ISSUE = Issue.create(
            "ConflictingAnnotations",
            "不能同时使用@A和@B注解",
            "@A和@B注解互斥，请只选择其中一个使用",
            Category.CORRECTNESS,
            6, // 优先级1-10，越高越容易被用户关注
            Severity.ERROR, // 可选WARNING或ERROR，根据你的需求调整
            new Implementation(ConflictingAnnotationsDetector.class, Scope.JAVA_FILE_SCOPE)
    );

    @Override
    public List<String> getApplicableAnnotations() {
        // 指定需要监听的两个注解的全类名，替换成你实际的包路径
        return List.of("com.yourpackage.A", "com.yourpackage.B");
    }

    @Override
    public void visitAnnotation(@NotNull JavaContext context, @NotNull UAnnotation annotation) {
        // 获取当前注解所属的元素（方法或参数，因为你的注解Target是这两个）
        UElement annotatedElement = annotation.getUastParent();
        if (annotatedElement == null) return;

        // 检查该元素是否同时拥有@A和@B注解
        boolean hasAnnotationA = annotatedElement.findAnnotation("com.yourpackage.A") != null;
        boolean hasAnnotationB = annotatedElement.findAnnotation("com.yourpackage.B") != null;

        if (hasAnnotationA && hasAnnotationB) {
            // 当两个注解同时存在时，报告问题
            context.report(
                    ISSUE,
                    annotatedElement,
                    context.getLocation(annotatedElement),
                    "当前元素同时使用了@A和@B注解，请仅保留其中一个"
            );
        }
    }
}

步骤3：注册自定义Lint规则 #

创建一个IssueRegistry子类，用来注册你的自定义Detector：

import com.android.tools.lint.detector.api.Issue;
import com.android.tools.lint.detector.api.IssueRegistry;

import java.util.List;

public class CustomLintRegistry extends IssueRegistry {
    @Override
    public List<Issue> getIssues() {
        // 将刚才定义的ISSUE加入注册表
        return List.of(ConflictingAnnotationsDetector.ISSUE);
    }
}

步骤4：在项目中集成并测试 #

1. 先将Lint模块打包成Jar包：执行该模块的jar任务（Gradle面板里找到该模块 > Tasks > other > jar），生成的Jar会在build/libs目录下。
2. 在你的主App模块的build.gradle中添加对这个Jar的依赖：

dependencies {
    lintChecks files('libs/your-lint-module.jar') // 替换成你的Jar路径
}

3. 现在打开Android Studio，运行Lint检查：点击顶部菜单栏的Analyze > Inspect Code...，选择要检查的范围，确认后就能看到——当代码中同时使用@A和@B时，会触发你定义的错误/警告提示。

额外注意点 #

• 确保注解的全类名和你项目中的实际路径一致，否则Detector无法正确识别。
• Lint API的版本尽量和你的Android Gradle插件（AGP）版本匹配，避免出现兼容性问题。
• 你可以根据需求调整Severity：如果是强制要求不能同时使用，设为ERROR；如果只是提醒，设为WARNING。

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