带有 java.util.concurrent.locks.ReadWriteLock 的 @GuardedBy 注释

Question

注释受ReadWriteLock 保护的字段以便像 FindBugs 这样的工具可以利用注释的正确/首选方法是什么？ ReadWriteLock 的名称是否应该简单地写在@GuardedBy 注释中。有没有理由在@GuardedBy 注释中只写读锁或写锁的名称？ FindBugs 或其他工具是否甚至支持@GuardedBy 中的ReadWriteLock？

Answer 1

Find bugs 支持以下注解：

net.jcip.annotations.GuardedBy
net.jcip.annotations.Immutable
net.jcip.annotations.NotThreadSafe
net.jcip.annotations.ThreadSafe

这些GuardedBy注解的用法应该如下：

@ThreadSafe  
public class Queue<E> implements java.util.Queue<E>  
{  
    private ConcurrentLinkedQueue readWriteLock;  

    @GuardedBy( value="readWriteLock" )  
    public boolean offer(E o)  
    {  
        return queue.offer( o ); 
    }  

}  

Answer 2

在撰写本文时，@GuardedByisn't fully implemented by Findbugs，主要用于文档。 （它是部分实现的。）

我总是使用@GuardedBy("readwritelock") 或我使用的对象synchronize。

以后者为例：

class Example {
    private Object lock = new Object();

    @GuardedBy("lock")
    private Stuff innards = ...;

    public void work() {
        synchronized(lock) {
            workWith(innards.goop());
        }
    }        
}