如何使javax.annotation.concurrent.ThreadSafe和GuardedBy注解生效？找不到其注解处理器源码

别担心，这些并发注解的处理器并不是单独的“源码包”，而是整合在成熟的静态分析工具里的。下面是一步步帮你搞定的方案：

1. 先确认注解定义依赖是否到位 #

首先得保证项目里能找到@ThreadSafe和@GuardedBy的注解类。如果是Maven项目，把这段依赖加到pom.xml里：

<dependency>
    <groupId>javax.annotation</groupId>
    <artifactId>javax.annotation-api</artifactId>
    <version>1.3.2</version>
    <scope>provided</scope>
</dependency>

Gradle项目的话就加这个：

compileOnly 'javax.annotation:javax.annotation-api:1.3.2'

这个依赖只提供注解的定义，接下来要引入真正做检查的处理器。

2. 选择合适的注解处理器并配置 #

选项一：Checker Framework（推荐，编译时实时检查） #

Checker Framework专门针对类型安全、并发安全这类场景设计，对@ThreadSafe和@GuardedBy的支持非常完善，能在编译阶段就找出违反规则的代码。

Maven配置方式：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.8.1</version>
            <configuration>
                <annotationProcessorPaths>
                    <path>
                        <groupId>org.checkerframework</groupId>
                        <artifactId>checker-qual</artifactId>
                        <version>3.34.0</version>
                    </path>
                    <path>
                        <groupId>org.checkerframework</groupId>
                        <artifactId>checker</artifactId>
                        <version>3.34.0</version>
                    </path>
                </annotationProcessorPaths>
                <compilerArgs>
                    <arg>-processor</arg>
                    <arg>org.checkerframework.checker.concurrent.ConcurrentChecker</arg>
                </compilerArgs>
            </configuration>
        </plugin>
    </plugins>
</build>

Gradle配置方式：

annotationProcessor 'org.checkerframework:checker:3.34.0'
compileOnly 'org.checkerframework:checker-qual:3.34.0'

tasks.withType(JavaCompile) {
    options.compilerArgs += ['-processor', 'org.checkerframework.checker.concurrent.ConcurrentChecker']
}

选项二：SpotBugs（原FindBugs，静态代码扫描） #

如果你更倾向于用代码扫描工具，SpotBugs也能识别这些并发注解，它会在构建后生成报告指出问题。

Maven配置SpotBugs插件：

<plugin>
    <groupId>com.github.spotbugs</groupId>
    <artifactId>spotbugs-maven-plugin</artifactId>
    <version>4.7.3.6</version>
    <dependencies>
        <dependency>
            <groupId>com.github.spotbugs</groupId>
            <artifactId>spotbugs</artifactId>
            <version>4.7.3</version>
        </dependency>
    </dependencies>
    <executions>
        <execution>
            <goals>
                <goal>check</goal>
            </goals>
        </execution>
    </executions>
</plugin>

运行mvn spotbugs:check就能触发扫描，查看违反注解约束的代码。

3. 验证注解是否生效 #

你可以写一段故意违规的代码测试：

@ThreadSafe
public class TestConcurrentClass {
    private int unguardedCount; // 没有@GuardedBy注解，违反ThreadSafe要求

    public void incrementCount() {
        unguardedCount++;
    }
}

如果用Checker Framework，编译时会直接报错；如果用SpotBugs，扫描后会在报告里标记这个问题。

补充小提示 #

• 要是你确实想看处理器的源码，Checker Framework的ConcurrentChecker和SpotBugs的相关检测器源码都在各自的官方代码仓库里，但实际使用完全不用单独下载源码，依赖已经包含了所有必要的执行文件。
• 使用@GuardedBy时要注意参数格式，比如@GuardedBy("this")或者@GuardedBy("lockObject")，这样处理器才能正确识别保护的锁对象。

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