Java concurrency之共享锁和ReentrantReadWriteLock_动力节点Java学院整理

// 返回用于读取操作的锁。
Lock readLock()
// 返回用于写入操作的锁。
Lock writeLock()

// 创建一个新的 ReentrantReadWriteLock，默认是采用“非公平策略”。
ReentrantReadWriteLock()
// 创建一个新的 ReentrantReadWriteLock，fair是“公平策略”。fair为true，意味着公平策略；否则，意味着非公平策略。
ReentrantReadWriteLock(boolean fair)

// 返回当前拥有写入锁的线程，如果没有这样的线程，则返回 null。
protected Thread getOwner()
// 返回一个 collection，它包含可能正在等待获取读取锁的线程。
protected Collection<Thread> getQueuedReaderThreads()
// 返回一个 collection，它包含可能正在等待获取读取或写入锁的线程。
protected Collection<Thread> getQueuedThreads()
// 返回一个 collection，它包含可能正在等待获取写入锁的线程。
protected Collection<Thread> getQueuedWriterThreads()
// 返回等待获取读取或写入锁的线程估计数目。
int getQueueLength()
// 查询当前线程在此锁上保持的重入读取锁数量。
int getReadHoldCount()
// 查询为此锁保持的读取锁数量。
int getReadLockCount()
// 返回一个 collection，它包含可能正在等待与写入锁相关的给定条件的那些线程。
protected Collection<Thread> getWaitingThreads(Condition condition)
// 返回正等待与写入锁相关的给定条件的线程估计数目。
int getWaitQueueLength(Condition condition)
// 查询当前线程在此锁上保持的重入写入锁数量。
int getWriteHoldCount()
// 查询是否给定线程正在等待获取读取或写入锁。
boolean hasQueuedThread(Thread thread)
// 查询是否所有的线程正在等待获取读取或写入锁。
boolean hasQueuedThreads()
// 查询是否有些线程正在等待与写入锁有关的给定条件。
boolean hasWaiters(Condition condition)
// 如果此锁将公平性设置为 ture，则返回 true。
boolean isFair()
// 查询是否某个线程保持了写入锁。
boolean isWriteLocked()
// 查询当前线程是否保持了写入锁。
boolean isWriteLockedByCurrentThread()
// 返回用于读取操作的锁。
ReentrantReadWriteLock.ReadLock readLock()
// 返回用于写入操作的锁。
ReentrantReadWriteLock.WriteLock writeLock()

public static class ReadLock implements Lock, java.io.Serializable {
  private static final long serialVersionUID = -5992448646407690164L;
  // ReentrantReadWriteLock的AQS对象
  private final Sync sync;

  protected ReadLock(ReentrantReadWriteLock lock) {
    sync = lock.sync;
  }

  // 获取“共享锁”
  public void lock() {
    sync.acquireShared(1);
  }

  // 如果线程是中断状态，则抛出一场，否则尝试获取共享锁。
  public void lockInterruptibly() throws InterruptedException {
    sync.acquireSharedInterruptibly(1);
  }

  // 尝试获取“共享锁”
  public boolean tryLock() {
    return sync.tryReadLock();
  }

  // 在指定时间内，尝试获取“共享锁”
  public boolean tryLock(long timeout, TimeUnit unit)
      throws InterruptedException {
    return sync.tryAcquireSharedNanos(1, unit.toNanos(timeout));
  }

  // 释放“共享锁”
  public void unlock() {
    sync.releaseShared(1);
  }

  // 新建条件
  public Condition newCondition() {
    throw new UnsupportedOperationException();
  }

  public String toString() {
    int r = sync.getReadLockCount();
    return super.toString() +
      "[Read locks = " + r + "]";
  }
}

final Sync sync;

public void lock() {
  sync.acquireShared(1);
}

public final void acquireShared(int arg) {
  if (tryAcquireShared(arg) < 0)
    doAcquireShared(arg);
}

protected final int tryAcquireShared(int unused) {
  Thread current = Thread.currentThread();
  // 获取“锁”的状态
  int c = getState();
  // 如果“锁”是“互斥锁”，并且获取锁的线程不是current线程；则返回-1。
  if (exclusiveCount(c) != 0 &&
    getExclusiveOwnerThread() != current)
    return -1;
  // 获取“读取锁”的共享计数
  int r = sharedCount(c);
  // 如果“不需要阻塞等待”，并且“读取锁”的共享计数小于MAX_COUNT；
  // 则通过CAS函数更新“锁的状态”，将“读取锁”的共享计数+1。
  if (!readerShouldBlock() &&
    r < MAX_COUNT &&
    compareAndSetState(c, c + SHARED_UNIT)) {
    // 第1次获取“读取锁”。
    if (r == 0) { 
      firstReader = current;
      firstReaderHoldCount = 1;
    // 如果想要获取锁的线程(current)是第1个获取锁(firstReader)的线程
    } else if (firstReader == current) { 
      firstReaderHoldCount++;
    } else {
      // HoldCounter是用来统计该线程获取“读取锁”的次数。
      HoldCounter rh = cachedHoldCounter;
      if (rh == null || rh.tid != current.getId())
        cachedHoldCounter = rh = readHolds.get();
      else if (rh.count == 0)
        readHolds.set(rh);
      // 将该线程获取“读取锁”的次数+1。
      rh.count++;
    }
    return 1;
  }
  return fullTryAcquireShared(current);
}

final int fullTryAcquireShared(Thread current) {
  HoldCounter rh = null;
  for (;;) {
    // 获取“锁”的状态
    int c = getState();
    // 如果“锁”是“互斥锁”，并且获取锁的线程不是current线程；则返回-1。
    if (exclusiveCount(c) != 0) {
      if (getExclusiveOwnerThread() != current)
        return -1;
    // 如果“需要阻塞等待”。
    // (01) 当“需要阻塞等待”的线程是第1个获取锁的线程的话，则继续往下执行。
    // (02) 当“需要阻塞等待”的线程获取锁的次数=0时，则返回-1。
    } else if (readerShouldBlock()) {
      // 如果想要获取锁的线程(current)是第1个获取锁(firstReader)的线程
      if (firstReader == current) {
      } else {
        if (rh == null) {
          rh = cachedHoldCounter;
          if (rh == null || rh.tid != current.getId()) {
            rh = readHolds.get();
            if (rh.count == 0)
              readHolds.remove();
          }
        }
        // 如果当前线程获取锁的计数=0,则返回-1。
        if (rh.count == 0)
          return -1;
      }
    }
    // 如果“不需要阻塞等待”，则获取“读取锁”的共享统计数；
    // 如果共享统计数超过MAX_COUNT，则抛出异常。
    if (sharedCount(c) == MAX_COUNT)
      throw new Error("Maximum lock count exceeded");
    // 将线程获取“读取锁”的次数+1。
    if (compareAndSetState(c, c + SHARED_UNIT)) {
      // 如果是第1次获取“读取锁”，则更新firstReader和firstReaderHoldCount。
      if (sharedCount(c) == 0) {
        firstReader = current;
        firstReaderHoldCount = 1;
      // 如果想要获取锁的线程(current)是第1个获取锁(firstReader)的线程，
      // 则将firstReaderHoldCount+1。
      } else if (firstReader == current) {
        firstReaderHoldCount++;
      } else {
        if (rh == null)
          rh = cachedHoldCounter;
        if (rh == null || rh.tid != current.getId())
          rh = readHolds.get();
        else if (rh.count == 0)
          readHolds.set(rh);
        // 更新线程的获取“读取锁”的共享计数
        rh.count++;
        cachedHoldCounter = rh; // cache for release
      }
      return 1;
    }
  }
}

private void doAcquireShared(int arg) {
  // addWaiter(Node.SHARED)的作用是，创建“当前线程”对应的节点，并将该线程添加到CLH队列中。
  final Node node = addWaiter(Node.SHARED);
  boolean failed = true;
  try {
    boolean interrupted = false;
    for (;;) {
      // 获取“node”的前一节点
      final Node p = node.predecessor();
      // 如果“当前线程”是CLH队列的表头，则尝试获取共享锁。
      if (p == head) {
        int r = tryAcquireShared(arg);
        if (r >= 0) {
          setHeadAndPropagate(node, r);
          p.next = null; // help GC
          if (interrupted)
            selfInterrupt();
          failed = false;
          return;
        }
      }
      // 如果“当前线程”不是CLH队列的表头，则通过shouldParkAfterFailedAcquire()判断是否需要等待，
      // 需要的话，则通过parkAndCheckInterrupt()进行阻塞等待。若阻塞等待过程中，线程被中断过，则设置interrupted为true。
      if (shouldParkAfterFailedAcquire(p, node) &&
        parkAndCheckInterrupt())
        interrupted = true;
    }
  } finally {
    if (failed)
      cancelAcquire(node);
  }
}

public void unlock() {
  sync.releaseShared(1);
}

public final boolean releaseShared(int arg) {
  if (tryReleaseShared(arg)) {
    doReleaseShared();
    return true;
  }
  return false;
}

protected final boolean tryReleaseShared(int unused) {
  // 获取当前线程，即释放共享锁的线程。
  Thread current = Thread.currentThread();
  // 如果想要释放锁的线程(current)是第1个获取锁(firstReader)的线程，
  // 并且“第1个获取锁的线程获取锁的次数”=1，则设置firstReader为null；
  // 否则，将“第1个获取锁的线程的获取次数”-1。
  if (firstReader == current) {
    // assert firstReaderHoldCount > 0;
    if (firstReaderHoldCount == 1)
      firstReader = null;
    else
      firstReaderHoldCount--;
  // 获取rh对象，并更新“当前线程获取锁的信息”。
  } else {
 
    HoldCounter rh = cachedHoldCounter;
    if (rh == null || rh.tid != current.getId())
      rh = readHolds.get();
    int count = rh.count;
    if (count <= 1) {
      readHolds.remove();
      if (count <= 0)
        throw unmatchedUnlockException();
    }
    --rh.count;
  }
  for (;;) {
    // 获取锁的状态
    int c = getState();
    // 将锁的获取次数-1。
    int nextc = c - SHARED_UNIT;
    // 通过CAS更新锁的状态。
    if (compareAndSetState(c, nextc))
      return nextc == 0;
  }
}

private void doReleaseShared() {
  for (;;) {
    // 获取CLH队列的头节点
    Node h = head;
    // 如果头节点不为null，并且头节点不等于tail节点。
    if (h != null && h != tail) {
      // 获取头节点对应的线程的状态
      int ws = h.waitStatus;
      // 如果头节点对应的线程是SIGNAL状态，则意味着“头节点的下一个节点所对应的线程”需要被unpark唤醒。
      if (ws == Node.SIGNAL) {
        // 设置“头节点对应的线程状态”为空状态。失败的话，则继续循环。
        if (!compareAndSetWaitStatus(h, Node.SIGNAL, 0))
          continue;
        // 唤醒“头节点的下一个节点所对应的线程”。
        unparkSuccessor(h);
      }
      // 如果头节点对应的线程是空状态，则设置“文件点对应的线程所拥有的共享锁”为其它线程获取锁的空状态。
      else if (ws == 0 &&
           !compareAndSetWaitStatus(h, 0, Node.PROPAGATE))
        continue;        // loop on failed CAS
    }
    // 如果头节点发生变化，则继续循环。否则，退出循环。
    if (h == head)          // loop if head changed
      break;
  }
}

final boolean readerShouldBlock() {
  return hasQueuedPredecessors();
}

final boolean readerShouldBlock() {
  return apparentlyFirstQueuedIsExclusive();
}

 import java.util.concurrent.locks.ReadWriteLock; 
 import java.util.concurrent.locks.ReentrantReadWriteLock; 
 
 public class ReadWriteLockTest1 { 
 
   public static void main(String[] args) { 
     // 创建账户
     MyCount myCount = new MyCount("4238920615242830", 10000); 
     // 创建用户，并指定账户
     User user = new User("Tommy", myCount); 
 
     // 分别启动3个“读取账户金钱”的线程 和 3个“设置账户金钱”的线程
     for (int i=0; i<3; i++) {
       user.getCash();
       user.setCash((i+1)*1000);
     }
   } 
 } 
 
 class User {
   private String name;      //用户名 
   private MyCount myCount;    //所要操作的账户 
   private ReadWriteLock myLock;  //执行操作所需的锁对象 
 
   User(String name, MyCount myCount) {
     this.name = name; 
     this.myCount = myCount; 
     this.myLock = new ReentrantReadWriteLock();
   }
 
   public void getCash() {
     new Thread() {
       public void run() {
         myLock.readLock().lock(); 
         try {
           System.out.println(Thread.currentThread().getName() +" getCash start"); 
           myCount.getCash();
           Thread.sleep(1);
           System.out.println(Thread.currentThread().getName() +" getCash end"); 
         } catch (InterruptedException e) {
         } finally {
           myLock.readLock().unlock(); 
         }
       }
     }.start();
   }
 
   public void setCash(final int cash) {
     new Thread() {
       public void run() {
         myLock.writeLock().lock(); 
         try {
           System.out.println(Thread.currentThread().getName() +" setCash start"); 
           myCount.setCash(cash);
           Thread.sleep(1);
           System.out.println(Thread.currentThread().getName() +" setCash end"); 
         } catch (InterruptedException e) {
         } finally {
           myLock.writeLock().unlock(); 
         }
       }
     }.start();
   }
 }
 
 class MyCount {
   private String id;     //账号 
   private int  cash;    //账户余额 
 
   MyCount(String id, int cash) { 
     this.id = id; 
     this.cash = cash; 
   } 
 
   public String getId() { 
     return id; 
   } 
 
   public void setId(String id) { 
     this.id = id; 
   } 
 
   public int getCash() { 
     System.out.println(Thread.currentThread().getName() +" getCash cash="+ cash); 
     return cash; 
   } 
 
   public void setCash(int cash) { 
     System.out.println(Thread.currentThread().getName() +" setCash cash="+ cash); 
     this.cash = cash; 
   } 
 }

Thread-0 getCash start
Thread-2 getCash start
Thread-0 getCash cash=10000
Thread-2 getCash cash=10000
Thread-0 getCash end
Thread-2 getCash end
Thread-1 setCash start
Thread-1 setCash cash=1000
Thread-1 setCash end
Thread-3 setCash start
Thread-3 setCash cash=2000
Thread-3 setCash end
Thread-4 getCash start
Thread-4 getCash cash=2000
Thread-4 getCash end
Thread-5 setCash start
Thread-5 setCash cash=3000
Thread-5 setCash end