DelayQueue 底层原理

一、DelayQueue 底层原理

DelayQueue是一种本地延迟队列,比如希望我们的任务在5秒后执行,就可以使用DelayQueue实现。常见的使用场景有:

  • 订单10分钟内未支付,就取消。

  • 缓存过期后,就删除。

  • 消息的延迟发送等。


但是DelayQueue是怎么使用的?底层原理是什么样的?如果有多个任务是怎么排队的? 看完这篇文章,可以轻松解答这些问题。


由于DelayQueue实现了BlockingQueue接口,而BlockingQueue接口中定义了几组放数据和取数据的方法,来满足不同的场景。


二、DelayQueue类结构

先看一下DelayQueue类里面有哪些属性:

public class DelayQueue
extends AbstractQueue
implements BlockingQueue {

/**
* 排它锁,用于保证线程安全
*/
private final transient ReentrantLock lock = new ReentrantLock();

/**
* 底层是基于PriorityQueue实现
*/
private final PriorityQueue q = new PriorityQueue();

/**
* 当前线程
*/
private Thread leader = null;

/**
* 条件队列
*/
private final Condition available = lock.newCondition();

}

DelayQueue实现了BlockingQueue接口,是一个阻塞队列。并且DelayQueue里面的元素需要实现Delayed接口。使用了ReentrantLock保证线程安全,

使用了Condition作条件队列,当队列中没有过期元素的时候,取数据的线程需要在条件队列中等待。

public interface Delayed extends Comparable {

/**
* 返回剩余过期时间
*/
long getDelay(TimeUnit unit);
}


三、初始化

DelayQueue常用的初始化方法有两个,无参构造方法和指定元素集合的有参构造方法。

/**
* 无参构造方法
*/
public DelayQueue() {
}

/**
* 指定元素集合
*/
public DelayQueue(Collection<? extends E> c) {
this.addAll(c);
}


四、使用示例

先定义一个延迟任务,需要实现Delayed接口,并重写getDelay()和compareTo()方法。

public class DelayedTask implements Delayed {

/**
* 任务到期时间
*/
private long expirationTime;

/**
* 任务
*/
private Runnable task;

public void execute() {
task.run();
}

public DelayedTask(long delay, Runnable task) {
// 到期时间 = 当前时间 + 延迟时间
this.expirationTime = System.currentTimeMillis() + delay;
this.task = task;
}

/**
* 返回延迟时间
*/
@Override
public long getDelay(@NotNull TimeUnit unit) {
return unit.convert(expirationTime - System.currentTimeMillis(), TimeUnit.MILLISECONDS);
}

/**
* 任务列表按照到期时间排序
*/
@Override
public int compareTo(@NotNull Delayed o) {
return Long.compare(this.expirationTime, ((DelayedTask) o).expirationTime);
}
}


测试运行延迟任务

@Slf4j
public class DelayQueueTest {

public static void main(String[] args) throws InterruptedException {
// 初始化延迟队列
DelayQueue delayQueue = new DelayQueue<>();

// 添加3个任务,延迟时间分别是3秒、1秒、5秒
delayQueue.add(new DelayedTask(3000, () -> log.info("任务2开始运行")));
delayQueue.add(new DelayedTask(1000, () -> log.info("任务1开始运行")));
delayQueue.add(new DelayedTask(5000, () -> log.info("任务3开始运行")));

// 运行任务
log.info("开始运行任务");
while (!delayQueue.isEmpty()) {
//阻塞获取最先到期的任务
DelayedTask task = delayQueue.take();
task.execute();
}
}
}


输出结果:

可以看出,运行任务的时候,会按照任务的到期时间进行排序,先到期的任务先运行。如果没有到期的任务,调用take()方法的时候,会一直阻塞。


五、存放数据源码

存放数据的方法有四个:


1、add方法源码

add()方法底层基于offer()实现

/**
* add方法入口
*
* @param e 元素
* @return 是否添加成功
*/
public boolean add(E e) {
return offer(e);
}


2、offer方法源码

offer()方法在队列满的时候,会直接返回false,表示插入失败。

/**
* offer方法入口
*
* @param e 元素
* @return 是否插入成功
*/
public boolean offer(E e) {
// 1. 获取锁
final ReentrantLock lock = this.lock;
lock.lock();
try {
// 2. 直接调用PriorityQueue的offer方法
q.offer(e);
// 3. 如果是第一次放数据,需要唤醒调用take方法阻塞的线程
if (q.peek() == e) {
leader = null;
available.signal();
}
return true;
} finally {
// 4. 释放锁
lock.unlock();
}
}

DelayQueue的offer()方法底层是基于PriorityQueue的offer()方法实现的,而PriorityQueue内部实现了排序任务的功能,

由于PriorityQueue的offer()方法实现了队列自动扩容,所以正常情况都会添加数据成功。


3、put方法源码

put()方法底层也是基于offer()实现

/**
* put方法入口
*
* @param e 元素
*/
public void put(E e) {
offer(e);
}


六、取出数据源码

取出数据(取出数据并删除)的方法有四个:


1、remove方法源码

remove()方法源码,如果队列为空,remove()会抛出异常

/**
* remove方法入口
*/
public E remove() {
// 1. 直接调用poll方法
E x = poll();
// 2. 如果取到数据,直接返回,否则抛出异常
if (x != null) {
return x;
} else {
throw new NoSuchElementException();
}
}


2、poll方法源码

poll()方法源码,是从链表头部弹出元素。 poll()方法在弹出元素的时候,如果队列为空,直接返回 null,表示弹出失败

/**
* poll方法入口
*/
public E poll() {
// 1. 获取锁
final ReentrantLock lock = this.lock;
lock.lock();
try {
// 2. 获取队头元素
E first = q.peek();
// 3. 如果队头元素为空,或者还没有过期,则返回null
if (first == null || first.getDelay(NANOSECONDS) > 0) {
return null;
} else {
// 5. 否则返回队头元素
return q.poll();
}
} finally {
// 4. 释放锁
lock.unlock();
}
}


3、take方法源码

take()方法源码,如果队列为空,take()方法就一直阻塞,直到被唤醒

/**
* take方法入口
*/
public E take() throws InterruptedException {
// 1. 加锁,加可中断的锁
final ReentrantLock lock = this.lock;
lock.lockInterruptibly();
try {
for (;😉 {
// 2. 获取队头元素
E first = q.peek();
// 3. 如果队头元素为null,则阻塞等待
if (first == null) {
available.await();
} else {
// 4. 如果队头元素不为null,则获取队头元素延迟时间
long delay = first.getDelay(NANOSECONDS);
// 5. 如果延迟时间小于等于0,表示已到期,则返回队头元素
if (delay <= 0) {
return q.poll();
}
first = null;
// 6. 如果队头元素未到期,则阻塞等待
if (leader != null) {
available.await();
} else {
Thread thisThread = Thread.currentThread();
leader = thisThread;
try {
available.awaitNanos(delay);
} finally {
if (leader == thisThread)
leader = null;
}
}
}
}
} finally {
if (leader == null && q.peek() != null) {
available.signal();
}
// 7. 释放锁
lock.unlock();
}
}

当队列为空的时候,take()方法会一直阻塞,所以需要加可中断的锁。take()方法逻辑也很简单,就是判断队头元素,

如果队头元素存在并且已到期,直接返回,否则就阻塞等待


七、查看数据源码

查看数据,并不删除数据


1、element方法源码

element()方法源码,如果队列为空,则抛出异常,底层直接使用的peek()方法

/**
* element方法入口
*/
public E element() {
// 1. 调用peek方法查询数据
E x = peek();
// 2. 如果查到数据,直接返回
if (x != null) {
return x;
} else {
// 3. 如果没找到,则抛出异常
throw new NoSuchElementException();
}
}


2、peek方法源码

peek()方法源码,如果数组为空,直接返回 null,底层基于PriorityQueue的peek()方法实现

/**
* peek方法入口
*/
public E peek() {
final ReentrantLock lock = this.lock;
lock.lock();
try {
return q.peek();
} finally {
lock.unlock();
}
}


八、总结

DelayQueue队列具有以下特点:

  • DelayQueue实现了BlockingQueue接口,提供了四组放数据和读数据的方法,来满足不同的场景

  • DelayQueue底层采用组合的方式,复用PriorityQueue的按照延迟时间排序任务的功能,实现了延迟队列

  • DelayQueue是线程安全的,内部使用ReentrantLock加锁

posted @ 2025-02-20 21:04  jock_javaEE  阅读(198)  评论(0)    收藏  举报