AbstractQueuedSynchronizer(AQS) 源码细致分析 - Semaphore 源码分析

1、简介

  • Semaphore,信号量,它保存了一系列的许可 (permits),每次调用 acquire() 方法都将消耗一个许可,每次调用 release() 方法都将归还一个许可。
  • Semaphore 通常用于限制同一时间对共享资源的访问次数上,也就是说常说的限流。
  • Semaphore 信号量,获取同行证流程图。

HoBNv9.png

2、入门案例

案例1

public class Pool {
    /**
     * 可同时访问资源的最大线程数
     */
    private static final int MAX_AVAILABLE = 100;
    
    /**
     * 信号量 表示:可获取的对象通行证
     */
    private final Semaphore available = new Semaphore(MAX_AVAILABLE, true);
    
    /**
     * 共享资源,可以想象成 items 数组内存储的都是Connection对象 模拟是连接池
     */
    protected Object[] items = new Object[MAX_AVAILABLE];
    
    /**
     * 共享资源占用情况,与items数组一一对应,比如:
     * items[0]对象被外部线程占用,那么 used[0] == true,否则used[0] == false
     */
    protected boolean[] used = new boolean[MAX_AVAILABLE];

    /**
     * 获取一个空闲对象
     * 如果当前池中无空闲对象,则等待..直到有空闲对象为止
     */
    public Object getItem() throws InterruptedException {
        // 每次调用acquire()都将消耗一个许可(permits)
        available.acquire();
        return getNextAvailableItem();
    }

    /**
     * 归还对象到池中
     */
    public void putItem(Object x) {
        if (markAsUnused(x))
            available.release();
    }

    /**
     * 获取池内一个空闲对象,获取成功则返回Object,失败返回Null
     * 成功后将对应的 used[i] = true
     */
    private synchronized Object getNextAvailableItem() {
        for (int i = 0; i < MAX_AVAILABLE; ++i) {
            if (!used[i]) {
                used[i] = true;
                return items[i];
            }
        }
        return null;
    }

    /**
     * 归还对象到池中,归还成功返回true
     * 归还失败:
     * 1.池中不存在该对象引用,返回false
     * 2.池中存在该对象引用,但该对象目前状态为空闲状态,也返回false
     */
    private synchronized boolean markAsUnused(Object item) {
        for (int i = 0; i < MAX_AVAILABLE; ++i) {
            if (item == items[i]) {
                if (used[i]) {
                    used[i] = false;
                    return true;
                } else
                    return false;
            }
        }
        return false;
    }
}

案例2

public class SemaphoreTest02 {
    public static void main(String[] args) throws InterruptedException {
        // 声明信号量,初始的许可(permits)为2
        // 公平模式:fair为true
        final Semaphore semaphore = new Semaphore(2, true);

        Thread tA = new Thread(() ->{
            try {
                // 每次调用acquire()都将消耗一个许可(permits)
                semaphore.acquire();
                System.out.println("线程A获取通行证成功");
                TimeUnit.SECONDS.sleep(10);
            } catch (InterruptedException e) {
            }finally {
                // 每次调用release()都将归还一个许可(permits)
                semaphore.release();
            }
        });
        tA.start();
        // 确保线程A已经执行
        TimeUnit.MILLISECONDS.sleep(200);

        Thread tB = new Thread(() ->{
            try {
                // 调用acquire(2)都将消耗2个许可(permits)
                semaphore.acquire(2);
                System.out.println("线程B获取通行证成功");
            } catch (InterruptedException e) {
            }finally {
                // 调用release(2)都将归还2个许可(permits)
                semaphore.release(2);
            }
        });
        tB.start();
        // 确保线程B已经执行
        TimeUnit.MILLISECONDS.sleep(200);

        Thread tC = new Thread(() ->{
            try {
                // 每次调用acquire()都将消耗一个许可(permits)
                semaphore.acquire();
                System.out.println("线程C获取通行证成功");
            } catch (InterruptedException e) {
            }finally {
                // 每次调用release()都将归还一个许可(permits)
                semaphore.release();
            }
        });
        tC.start();
    }
}

执行结果如下

线程A获取通行证成功
线程B获取通行证成功
线程C获取通行证成功

3、源码分析

3.1、内部类 Sync

  • 通过 Sync 的几个实现方法,我们获取到以下几点信息:
    • 许可证的个数是在构造方法的时候传入的
    • 许可证存放在状态变量 state 中
    • 尝试获取一个许可证的时候,则 state 的值 减1
    • 当 state 的值为 0 的时候,则无法再获取许可
    • 释放一个许可证的时候,则 state 的值加1
    • 许可证的个数可以动态改变
abstract static class Sync extends AbstractQueuedSynchronizer {
    private static final long serialVersionUID = 1192457210091910933L;

    // 构造方法,传入许可次数,放入state中
    Sync(int permits) {
        setState(permits);
    }

    // 获取许可次数
    final int getPermits() {
        return getState();
    }

	// 非公平模式尝试获取许可
    final int nonfairTryAcquireShared(int acquires) {
        for (;;) {
            // 先看看还有几个许可
            int available = getState();
            // 减去这次需要获取的许可还剩下几个许可
            int remaining = available - acquires;
            // 如果剩余许可小于0了则直接返回
            // 如果剩余许可不小于0,则尝试原子更新state的值,成功了返回剩余许可
            if (remaining < 0 ||
                compareAndSetState(available, remaining))
                return remaining;
        }
    }

    // 释放许可
    protected final boolean tryReleaseShared(int releases) {
        for (;;) {
            // 先看看还有几个许可
            int current = getState();
            // 加上这次释放的许可
            int next = current + releases;
            // 检测溢出
            if (next < current) // overflow
                throw new Error("Maximum permit count exceeded");
            // 如果原子更新state的值成功,就说明释放许可成功,则返回true
            if (compareAndSetState(current, next))
                return true;
        }
    }

	// 减少许可
    final void reducePermits(int reductions) {
        for (;;) {
            // 先看看还有几个许可
            int current = getState();
            // 减去将要减少的许可
            int next = current - reductions;
            // 检测溢出
            if (next > current) // underflow
                throw new Error("Permit count underflow");
            // 原子更新state的值,成功了返回true
            if (compareAndSetState(current, next))
                return;
        }
    }
    
	// 销毁许可
    final int drainPermits() {
        for (;;) {
            // 先看看还有几个许可
            int current = getState();
            // 如果为0,直接返回
			// 如果不为0,把state原子更新为0
            if (current == 0 || compareAndSetState(current, 0))
                return current;
        }
    }
}

3.2、内部类 NonfairSync

非公平模式下,直接调用父类的 nonfairTryAcquireShared() 尝试获取许可证

static final class NonfairSync extends Sync {
    private static final long serialVersionUID = -2694183684443567898L;
	
	// 构造方法,调用父类的构造方法
    NonfairSync(int permits) {
        super(permits);
    }
	// 尝试获取许可,调用父类的nonfairTryAcquireShared()方法
    protected int tryAcquireShared(int acquires) {
        return nonfairTryAcquireShared(acquires);
    }
}

3.3、内部类 FairSync

公平模式下,先检测前面是否有排队的,如果有排队的则获取许可失败,进入队列排队,否则尝试原子更新 state 的值

注意为了阅读方便,该内部类中将一些 AQS 中的方法粘贴过来了,再方法头注释加有标注

static final class FairSync extends Sync {
    private static final long serialVersionUID = 2014338818796000944L;

    FairSync(int permits) {
        super(permits);
    }

    //位于AQS中,可以响应中断获取共享锁的方法
    public final void acquireSharedInterruptibly(int arg)
        throws InterruptedException {
        // 条件成立:说明当前线程调用 acquire 方法的线程已经是中断状态了,直接抛出异常...
        if (Thread.interrupted())
            throw new InterruptedException();
        // 尝试获取通行证,通过减少 state的值)获取成功返回 >= 0的值,获取失败,返回 <0 的值
        if (tryAcquireShared(arg) < 0)
            //将获取通行证失败的线程加入到AQS的阻塞队列中
            doAcquireSharedInterruptibly(arg);
    }

    //位于AQS中:采用共享中断的方式
    private void doAcquireSharedInterruptibly(int arg)
        throws InterruptedException {
        //将调用semaphore.acquire()方法的线程包装成node加入到AQS的阻塞队列当中
        final Node node = addWaiter(Node.SHARED);
        boolean failed = true; //是否发生异常
        try {
            for (;;) {
                //获取当前线程节点的前驱节点
                final Node p = node.predecessor();
                //条件成立,说明当前线程对应的节点为head.next节点
                if (p == head) {
                    //head.next节点就有权力获取共享锁了
                    int r = tryAcquireShared(arg);
                    //当队列中所有获取共享锁的线程没有全部释放的时候才会获取成功
                    if (r >= 0) {
                        setHeadAndPropagate(node, r);
                        p.next = null; // help GC
                        failed = false;
                        return;
                    }
                }
                if (shouldParkAfterFailedAcquire(p, node) &&
                    parkAndCheckInterrupt())
                    //响应中断
                    throw new InterruptedException();
            }
        } finally {
            if (failed)
                cancelAcquire(node);
        }
    }

    // 尝试获取通行证(通过减少 state的值)获取成功返回 >= 0的值,获取失败,返回 <0 的值
    protected int tryAcquireShared(int acquires) {
        // 自旋操作
        for (;;) {
            // 判断当前AQS 阻塞队列内是否有等待者线程,如果有直接返回 -1,表示当前 acquire 操作的线程需要进入队列等待
            if (hasQueuedPredecessors())
                return -1;
            // 执行到这里,有哪几种情况?
            // 1.调用 acquire 的时候,AQS 阻塞队列内没有其他等待者
            // 2.当前节点在阻塞队列内是 head.next 节点(重入锁)

            // 获取 state 的值,state 表示通行证
            int available = getState();
            // remaining:表示当前线程获取通行证完成之后,semaphore 还剩余数量
            int remaining = available - acquires;
            // 条件一成立:remaining < 0:表示线程获取通行证失败
            // 条件二:前提条件:remaining >= 0,表示当前线程可以去获取通行证
            // compareAndSetState(available, remaining):成立:说明当前线程获取通行证成功,CAS 失败,则自旋
            if (remaining < 0 ||
                compareAndSetState(available, remaining))
                return remaining;
        }
    }

    //位于AQS中,释放共享锁
    public final boolean releaseShared(int arg) {
        // 条件成立:表示当前线程释放资源成功,释放资源成功后去唤醒获取资源失败的线程
        if (tryReleaseShared(arg)) {
            // 唤醒获取资源失败的线程
            doReleaseShared();
            return true;
        }
        return false;
    }

    // 尝试归还令牌,当前线程释放资源
    protected final boolean tryReleaseShared(int releases) {
        // 自旋
        for (;;) {
            // 获取当前AQS的 state的值
            int current = getState();
            // 获取新的通行证的个数
            int next = current + releases;
            if (next < current) // overflow
                throw new Error("Maximum permit count exceeded");
            // CAS 交换 通行证的个数
            if (compareAndSetState(current, next))
                return true;
        }
    }

    //都有哪几种路径会调用到doReleaseShared方法呢?
    //1.latch.countDown() -> AQS.state==0 -> doReleaseShared()
    //唤醒当前阻塞队列内的head.next对应的线程
    //2.被唤醒的线程 -> doAcquireSharedInterruptibly parkAndCheckInterrupt()唤醒
    //-> setHeadAndPropagate() -> doReleaseShared()
    // Semaphore版本
    // 唤醒获取资源失败的线程
    //唤醒等待的线程
    private void doReleaseShared() {
        for (;;) {
            //获取队列的头结点
            Node h = head;
            //如果队列已经初始化成功并且队列中节点的个数>1
            //条件1:h!=null成立,说明阻塞队列不为空
            //不成立:h==null 什么时候会是这样的呢?
            //latch创建出来以后,没有任何线程调用过await()方法之前,有线程调用latch.countDown()且触发了唤醒阻塞节点的逻辑
            //条件2:h!=tail成立 说明当前阻塞队列内,除了head节点以外,还有其他节点
            //h==tail -> head和tail指向的是同一个node对象,什么时候会有这种情况呢?
            //正常唤醒情况下,依次获取到共享锁,当前线程执行到这里的时候,这个线程就是tail节点
            //第一个调用await()方法的线程与调用countDown()且触发唤醒阻塞节点的线程出现了并发
            //因为await()线程是第一个调用latch.await()的线程,此时队列内什么也没有,它选哟补充创建一个head
            //在await()线程入队完成之前,假设当前队列内只有刚刚补充创建的空元素head
            //同期,外部有一个调用countDown()的线程,将state值从1修改为了0,那么这个线程需要做唤醒阻塞操作
            //注意:调用await()的线程,因为完全入队完成之后,再次回到doAcquireSharedInterruptibly会进入到自旋中
            //获取当前元素的前驱,判断自己是head.next,所以接下来该线程又会将自己设置为head,然后该线程即从await方法返回了
            if (h != null && h != tail) {
                //获取头结点的等待状态
                int ws = h.waitStatus;
                //如果头结点的等待状态为SIGNAL,说明后继节点还没有被唤醒过
                if (ws == Node.SIGNAL) {
                    //唤醒后继节点前,将head节点的状态改为 0
                    //这里为什么使用CAS呢?回头说...
                    //当doReleaseShared方法,存在多个线程唤醒head.next逻辑的时候
                    //CAS可能会失败...
                    //案例:
                    //t3线程在if(h==head)返回false的时候,会继续自旋,参与唤醒下一个head.next的逻辑
                    //t3此时执行到CAS waiStatus(h,node.SIGNAL,0)成功..t4在t3修改成功之前,也进入到了if
                    //但是t4 修改 CAS WaitStatus(h,Node.SIGNAL, 0) 会失败,因为 t3 改过了...
                    if (!compareAndSetWaitStatus(h, Node.SIGNAL, 0))
                        continue;            // loop to recheck cases
                    //唤醒后继节点
                    unparkSuccessor(h);
                }
                //执行到这里,说明当前头结点的等待状态不是SIGNAL
                else if (ws == 0 &&
                    !compareAndSetWaitStatus(h, 0, Node.PROPAGATE))
                    continue;                // loop on failed CAS
            }
            //条件成立:
            //说明刚刚唤醒的后继节点,还没执行到setHeadAndPropagate方法里面的 设置当前唤醒节点为head的逻辑
            //这个时候,当前线程直接跳出去...结束了..
            //此时用不用担心,唤醒逻辑在这里会断掉呢?
            //不需要担心,因为被唤醒的线程早晚都会执行到doReleaseShared方法
            //h==null latch创建出来后,没有任何线程调用过await()方法之前
            //有线程调用latch.countDown()操作,并且触发了唤醒阻塞节点的操作
            //3.h=tail -> head和tail指向的是同一个node对象
            //条件不成立:
            //被唤醒的节点非常积极,直接将自己设置为了新的head,此时,唤醒它的节点(前驱),执行h==head会不成立
            //此时head节点的前驱,不会跳出doReleaseShared方法,会继续唤醒新head节点的后继
            if (h == head)                   // loop if head changed
                break;
        }
    }
}

3.3、构造方法

创建 Semaphore 的时候需要传入许可证的个数。Semaphore 默认也是非公平模式,但是你可以调用第二个构造方法声明其为 公平模式。

// 构造方法,创建时要传入许可次数,默认使用非公平模式
public Semaphore(int permits) {
    sync = new NonfairSync(permits);
}

// 构造方法,需要传入许可次数,及是否公平模式
public Semaphore(int permits, boolean fair) {
    sync = fair ? new FairSync(permits) : new NonfairSync(permits);
}

3.4、acquire() 方法

获取一个许可证,默认使用的是可中断的方式,如果尝试获取许可证失败,会进入 AQS 中的阻塞队列中排队

public void acquire() throws InterruptedException {
    sync.acquireSharedInterruptibly(1);
}

// 获取一个许可,非中断方式,如果尝试获取许可失败,会进入AQS的队列中排队。
public void acquireUninterruptibly() {
     sync.acquireShared(1);
}

3.5、acquire(int permits)方法

一次获取多个许可,可中断方式。

public void acquire(int permits) throws InterruptedException {
    if (permits < 0) throw new IllegalArgumentException();
    sync.acquireSharedInterruptibly(permits);
}

// 一次获取多个许可,非中断方式。
public void acquireUninterruptibly(int permits) {
    if (permits < 0) throw new IllegalArgumentException();
    sync.acquireShared(permits);
}

小节

  • Semaphore,也叫信号量,通常用于空字同一时刻对共享资源的访问上,也就是限流场景;
  • Semaphore 的内部实现是基于 AQS 的共享锁实现的
  • Semaphore 初始化的时候需要指定许可的次数,许可的次数是存储在 state 中
  • 获取一个许可证的时候,则 state 的值 减一
  • 释放一个许可证的时候,则 state 加一并唤醒 AQS 阻塞队列中排队的线程
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值