使用单机缓存之王Caffeine实现一个延迟队列

延迟队列:顾名思义就是支持将消息按照一定的要求延迟投递的消息队列。生活中需要使用延迟队列最普遍的场景就是订单支付,订单只有在规定的时间内完成支付,交易才算真正的完成,没有在规定时间内完成支付的订单将会被取消。

Caffeine:一款高性能、接近最优的缓存库。

Caffeine和延迟队列又有什么联系呢?延迟队列的核心特征就是将消息延迟投递,Caffeine的老化机制刚好可以满足延迟队列的基本要求。Caffeine可以按照时间对存储的值进行老化,不同值的老化时间可以不同,并且Caffeine支持将值的老化信息发送到监听器,利用这一特性就可以实现简单的延迟队列。

当前已经有很多优秀的延迟队列实现,如果需要延迟队列功能请使用经过考验的软件哦。

Delay Queue架构

delay queue.png

基于Java自带的Blocking Queue和Caffeine实现Delay Queue。Delay Queue只提供两个简单的接口用于读写数据,

write: 客户端向Delay Queue添加数据时,添加的数据会直接写入Caffeine并根据参数设置老化时间。

read: 客户端从Delay Queue获取数据,如果有可被获取的数据Delay Queue直接返回位于队列头部的数据,否则将会阻塞客户端直到有可用数据为止。

event: Caffeine将值的过期事件处理后写入 Blocking Queue。

接口说明

write:

public void write(E element, long delay, TimeUnit unit);

写入element到队列,并设置经过delay的延迟后element才能被read。

read:

public E read(long timeout, TimeUnit unit) throws InterruptedException;

尝试从queue读取数据,最多等待timeout时间

3 代码实现

3.1 数据封装

引入写入到queue中的每个数据需要被延迟处理的时间不同,因此再将值写入到Caffeine之前需要简单的封装,封装后的数据包括原始数据和延迟时间等信息。

private static final class DataWrapper<E> {
    private final E data;
    private final long delay;
    private final TimeUnit unit;

    public DataWrapper(E data, long delay, TimeUnit unit) {
        this.data = data;
        this.delay = delay;
        this.unit = unit;
    }
}

3.2 event处理

我们需要监听Caffeine对过期数据的处理,并把数据写入到Blocking Queue中。

private static final class Listener<E> implements RemovalListener<String, DataWrapper<E>> {
    private final BlockingQueue<E> blockingQueue;

    public Listener(BlockingQueue<E> blockingQueue) {
        this.blockingQueue = blockingQueue;
    }

    @Override
    public void onRemoval(@Nullable String s, @Nullable DataWrapper<E> dataWrapper, @NonNull RemovalCause removalCause) {
        try {
            if (Objects.nonNull(dataWrapper)) {
                blockingQueue.put(dataWrapper.data);
            }
        } catch (InterruptedException e) {
            e.printStackTrace(); // 仅用于测试
        }
    }
}

3.3 过期策略设置

对写入到Caffeine中的每一个数据设置一个过期时间,这可以通过Caffeine中的Expiry接口实现

private Expiry<String, DataWrapper<E>> expiry = new Expiry<>() {
    @Override
    public long expireAfterCreate(@NonNull String key, @NonNull DataWrapper<E> dataWrapper, long currentTime) {
        return dataWrapper.unit.toNanos(dataWrapper.delay);
    }

    @Override
    public long expireAfterUpdate(@NonNull String key, @NonNull DataWrapper<E> dataWrapper, long currentTime, @NonNegative long currentDuration) {
        return dataWrapper.unit.toNanos(dataWrapper.delay);
    }

    @Override
    public long expireAfterRead(@NonNull String key, @NonNull DataWrapper<E> dataWrapper, long currentTime, @NonNegative long currentDuration) {
        return dataWrapper.unit.toNanos(dataWrapper.delay);
    }
};

3.4 CaffeineDelayQueue

在完成3.1-3.3章节的代码编写后,实现一个基于Caffeine的延迟队列就变得十分简单,关键代码如下:

public class CaffeineDelayQueue<E> {
    private final BlockingQueue<E> blockingQueue;
    private final Cache<String, DataWrapper<E>> scheduler;

    public CaffeineDelayQueue(int size) {
        this.blockingQueue = new ArrayBlockingQueue<>(size);
        this.scheduler = Caffeine.newBuilder()
            .expireAfter(expiry)
            .evictionListener(new Listener<>(blockingQueue))
            .scheduler(Scheduler.systemScheduler())
            .build();
    }
}

4 使用样例

CaffeineDelayQueue<Integer> queue = new CaffeineDelayQueue<>(1024);
queue.write(1, 1, TimeUnit.SECONDS);
queue.write(2, 3, TimeUnit.SECONDS);
queue.write(3, 2, TimeUnit.SECONDS);

for (; ; ) {
    Integer data = queue.read(200, TimeUnit.MILLISECONDS);
    if (Objects.nonNull(data)) {
        System.out.println(data);
    }
}

上面样例程序的输出如下:

1
3
2
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,236评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,867评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,715评论 0 340
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,899评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,895评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,733评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,085评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,722评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,025评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,696评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,816评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,447评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,057评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,009评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,254评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,204评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,561评论 2 343

推荐阅读更多精彩内容