Semaphore 信号量,可用于控制一定时间内,并发执行的线程数,基于 AQS 实现。可应用于网关限流、资源限制 (如 最大可发起连接数)。由于 release() 释放许可时,未对释放许可数做限制,所以可以通过该方法增加总的许可数量。

获取许可 支持公平和非公平模式,默认非公平模式。公平模式无论是否有许可,都会先判断是否有线程在排队,如果有线程排队,则进入排队,否则尝试获取许可;非公平模式无论许可是否充足,直接尝试获取许可。

不多废话,下面直接看源码。

核心内部类 Sync

  1. abstract static class Sync extends AbstractQueuedSynchronizer {
  2. private static final long serialVersionUID = 1192457210091910933L;
  3. /* 赋值state为总许可数 */
  4. Sync(int permits) {
  5. setState(permits);
  6. }
  7. /* 剩余许可数 */
  8. final int getPermits() {
  9. return getState();
  10. }
  11. /* 自旋 + CAS非公平获取 */
  12. final int nonfairTryAcquireShared(int acquires) {
  13. for (;;) {
  14. // 剩余可用许可数
  15. int available = getState();
  16. // 本次获取许可后,剩余许可
  17. int remaining = available - acquires;
  18. // 如果获取后,剩余许可大于0,则CAS更新剩余许可,否则获取失败失败
  19. if (remaining < 0 ||
  20. compareAndSetState(available, remaining))
  21. return remaining;
  22. }
  23. }
  24. /**
  25. * 自旋 + CAS 释放许可
  26. * 由于未对释放许可数做限制,所以可以通过release动态增加许可数量
  27. */
  28. protected final boolean tryReleaseShared(int releases) {
  29. for (;;) {
  30. // 当前剩余许可
  31. int current = getState();
  32. // 许可更新值
  33. int next = current + releases;
  34. // 如果许可更新值为负数,说明许可数量溢出,抛出错误
  35. if (next < current) // overflow
  36. throw new Error("Maximum permit count exceeded");
  37. // CAS更新许可数量
  38. if (compareAndSetState(current, next))
  39. return true;
  40. }
  41. }
  42. /* 自旋 + CAS 减少许可数量 */
  43. final void reducePermits(int reductions) {
  44. for (;;) {
  45. // 当前剩余许可
  46. int current = getState();
  47. // 更新值
  48. int next = current - reductions;
  49. // 较少许可数错误,抛出异常
  50. if (next > current) // underflow
  51. throw new Error("Permit count underflow");
  52. // CAS更新许可数
  53. if (compareAndSetState(current, next))
  54. return;
  55. }
  56. }
  57. /* 丢弃所有许可 */
  58. final int drainPermits() {
  59. for (;;) {
  60. int current = getState();
  61. if (current == 0 || compareAndSetState(current, 0))
  62. return current;
  63. }
  64. }
  65. }
  66. /**
  67. * 非公平模式
  68. */
  69. static final class NonfairSync extends Sync {
  70. private static final long serialVersionUID = -2694183684443567898L;
  71. NonfairSync(int permits) {
  72. super(permits);
  73. }
  74. protected int tryAcquireShared(int acquires) {
  75. return nonfairTryAcquireShared(acquires);
  76. }
  77. }
  78. /**
  79. * 公平模式
  80. */
  81. static final class FairSync extends Sync {
  82. private static final long serialVersionUID = 2014338818796000944L;
  83. FairSync(int permits) {
  84. super(permits);
  85. }
  86. /**
  87. * 公平模式获取许可
  88. * 公平模式不论许可是否充足,都会判断同步队列中是否有线程在等地,如果有,获取失败,排队阻塞
  89. */
  90. protected int tryAcquireShared(int acquires) {
  91. for (;;) {
  92. // 如果有线程在排队,立即返回
  93. if (hasQueuedPredecessors())
  94. return -1;
  95. // 自旋 + cas获取许可
  96. int available = getState();
  97. int remaining = available - acquires;
  98. if (remaining < 0 ||
  99. compareAndSetState(available, remaining))
  100. return remaining;
  101. }
  102. }
  103. }

主要 API

  1. public class Semaphore implements java.io.Serializable {
  2. private static final long serialVersionUID = -3222578661600680210L;
  3. /** All mechanics via AbstractQueuedSynchronizer subclass */
  4. private final Sync sync;
  5. /**
  6. * 根据给定的 总许可数permits,创建 Semaphore
  7. */
  8. public Semaphore(int permits) {
  9. sync = new NonfairSync(permits);
  10. }
  11. /**
  12. * fair为true表示使用公平锁模式,false使用非公平锁
  13. */
  14. public Semaphore(int permits, boolean fair) {
  15. sync = fair ? new FairSync(permits) : new NonfairSync(permits);
  16. }
  17. // --------------------- 获取许可 --------------------
  18. /* 获取指定数量的许可 */
  19. public void acquire(int permits) throws InterruptedException {
  20. if (permits < 0) throw new IllegalArgumentException();
  21. sync.acquireSharedInterruptibly(permits);
  22. }
  23. /* 获取一个许可 */
  24. public void acquire() throws InterruptedException {
  25. sync.acquireSharedInterruptibly(1);
  26. }
  27. public final void acquireSharedInterruptibly(int arg)
  28. throws InterruptedException {
  29. if (Thread.interrupted())
  30. throw new InterruptedException();
  31. if (tryAcquireShared(arg) < 0) // 获取许可,剩余许可>=0,则获取许可成功,<0获取许可失败,进入排队
  32. doAcquireSharedInterruptibly(arg);
  33. }
  34. protected int tryAcquireShared(int acquires) {
  35. return nonfairTryAcquireShared(acquires);
  36. }
  37. /**
  38. * @return 剩余许可数量。非负数,获取许可成功,负数,获取许可失败
  39. */
  40. final int nonfairTryAcquireShared(int acquires) {
  41. for (;;) {
  42. int available = getState();
  43. int remaining = available - acquires;
  44. if (remaining < 0 ||
  45. compareAndSetState(available, remaining))
  46. return remaining;
  47. }
  48. }
  49. /**
  50. * 获取许可失败,当前线程进入同步队列,排队阻塞
  51. */
  52. private void doAcquireSharedInterruptibly(int arg)
  53. throws InterruptedException {
  54. // 创建同步队列节点,并入队
  55. final Node node = addWaiter(Node.SHARED);
  56. boolean failed = true;
  57. try {
  58. for (;;) {
  59. // 如果当前节点是第二个节点,尝试获取锁
  60. final Node p = node.predecessor();
  61. if (p == head) {
  62. int r = tryAcquireShared(arg);
  63. if (r >= 0) {
  64. setHeadAndPropagate(node, r);
  65. p.next = null; // help GC
  66. failed = false;
  67. return;
  68. }
  69. }
  70. // 阻塞当前线程
  71. if (shouldParkAfterFailedAcquire(p, node) &&
  72. parkAndCheckInterrupt())
  73. throw new InterruptedException();
  74. }
  75. } finally {
  76. if (failed)
  77. cancelAcquire(node);
  78. }
  79. }
  80. // --------------------- 释放归还许可 -------------------------
  81. /* 释放指定数量的许可 */
  82. public void release(int permits) {
  83. if (permits < 0) throw new IllegalArgumentException();
  84. sync.releaseShared(permits);
  85. }
  86. /* 释放一个许可 */
  87. public void release() {
  88. sync.releaseShared(1);
  89. }
  90. public final boolean releaseShared(int arg) {
  91. // 归还许可成功
  92. if (tryReleaseShared(arg)) {
  93. doReleaseShared();
  94. return true;
  95. }
  96. return false;
  97. }
  98. /**
  99. * 释放许可
  100. * 由于未对释放许可数做限制,所以可以通过release动态增加许可数量
  101. */
  102. protected final boolean tryReleaseShared(int releases) {
  103. for (;;) {
  104. int current = getState();
  105. int next = current + releases;
  106. if (next < current) // overflow
  107. throw new Error("Maximum permit count exceeded");
  108. if (compareAndSetState(current, next))
  109. return true;
  110. }
  111. }
  112. private void doReleaseShared() {
  113. // 自旋,唤醒等待的第一个线程(其他线程将由第一个线程向后传递唤醒)
  114. for (;;) {
  115. Node h = head;
  116. if (h != null && h != tail) {
  117. int ws = h.waitStatus;
  118. if (ws == Node.SIGNAL) {
  119. if (!compareAndSetWaitStatus(h, Node.SIGNAL, 0))
  120. continue; // loop to recheck cases
  121. // 唤醒第一个等待线程
  122. unparkSuccessor(h);
  123. }
  124. else if (ws == 0 &&
  125. !compareAndSetWaitStatus(h, 0, Node.PROPAGATE))
  126. continue; // loop on failed CAS
  127. }
  128. if (h == head) // loop if head changed
  129. break;
  130. }
  131. }
  132. }