Java CompletableFuture如何实现超时功能

 更新时间:2025年01月28日 09:04:46   作者:桦说编程  
这篇文章主要为大家介绍了实现超时功能的基本思路以及CompletableFuture(之后简称CF)是如何通过代码实现超时功能的,需要的小伙伴可以了解下

由于网络波动或者连接节点下线等种种问题,对于大多数网络异步任务的执行通常会进行超时限制,在异步编程中是一个常见的问题。本文主要讨论实现超时功能的基本思路以及CompletableFuture(之后简称CF)是如何通过代码实现超时功能的。

基本思路

  • 两个任务,两个线程:原有任务,超时任务
  • 原有的任务正常执行,写入正常结果,原有任务执行成功取消超时任务
  • 超时时取消原有任务,写入结果为超时异常或者默认值
  • 竞态条件下保证结果写入的原子性和只写一次

CompletableFuture 的实现

1. 基本实现流程

// JDK9新增的超时方法
public CompletableFuture<T> orTimeout(long timeout, TimeUnit unit) {
    if (unit == null)
        throw new NullPointerException();
    if (result == null)
        whenComplete(new Canceller(Delayer.delay(new Timeout(this),
                                                 timeout, unit)));
    return this;
}

// CF的内部类
    static final class Timeout implements Runnable {
        final CompletableFuture<?> f;
        Timeout(CompletableFuture<?> f) { this.f = f; }
        public void run() {
            if (f != null && !f.isDone())
                f.completeExceptionally(new TimeoutException());
        }
    }

分析代码得知,whenComplete方法添加了正常结束的回调,取消超时任务。

超时任务通过Delayer.delay创建,超时时执行Timeout::run方法,即写入结果为TimeoutException。

下面来看下Dalayer的具体实现:

/**
 * Singleton delay scheduler, used only for starting and
 * cancelling tasks.
 */
static final class Delayer {
    static ScheduledFuture<?> delay(Runnable command, long delay,
                                    TimeUnit unit) {
        return delayer.schedule(command, delay, unit);
    }

    static final class DaemonThreadFactory implements ThreadFactory {
        public Thread newThread(Runnable r) {
            Thread t = new Thread(r);
            // 守护线程,当主线程关闭时,自身也关闭
            t.setDaemon(true);
            t.setName("CompletableFutureDelayScheduler");
            return t;
        }
    }

    static final ScheduledThreadPoolExecutor delayer;
    static {
        (delayer = new ScheduledThreadPoolExecutor(
            1, new DaemonThreadFactory())).
            setRemoveOnCancelPolicy(true);
    }
}

Delayer是一个单例对象,专门用于执行延迟任务,减少了内存占用。ScheduledThreadPoolExecutor 的配置为单线程,设置了removeOnCancelPolicy,表示取消延迟任务时,任务从延迟队列删除。这里的延迟队列为默认的执行器实现:

public ScheduledThreadPoolExecutor(int corePoolSize,
                                   ThreadFactory threadFactory) {
    super(corePoolSize, Integer.MAX_VALUE,
          DEFAULT_KEEPALIVE_MILLIS, MILLISECONDS,
          new DelayedWorkQueue(), threadFactory);
}

ScheduledThreadPoolExecutor 底层使用延迟队列DelayedWorkQueue,延迟队列底层依赖于索引优先队列,删除操作的时间复杂度为o(logn)。

下面来看下Canceller的具体实现:

static final class Canceller implements BiConsumer<Object, Throwable> {
    final Future<?> f;
    Canceller(Future<?> f) { this.f = f; }
    public void accept(Object ignore, Throwable ex) {
        if (f != null && !f.isDone())
            f.cancel(false);
    }
}

canceller实际上是一个回调函数,原有任务完成后触发,会取消相关超时任务。

2. 静态条件分析

下面是写入CF的实现代码片段:

				// 超时结束        
        if (f != null && !f.isDone())
            f.completeExceptionally(new TimeoutException());
        // 取消任务
        if (f != null && !f.isDone())
            f.cancel(false);
				// CF 原有任务的写入不由orTimeout方法控制,以下为一个示例
						Thread.sleep(1000);
						f.complete(u);

对于CF的检查实际上不能保证原子性,因为这种检查-再计算的模式需要同步块的保护,而CF底层并没有这种实现。所以,if语句检查任务未完成,之后执行代码时,任务可能已经完成了。不过这种检查也有一定的好处,因为CF保证了结果写入后,isDone方法必然为true,从而避免执行不必要的代码。

completeExceptionally 方法和 complete 方法可能同时执行,CF 通过CAS操作保证了结果写入的原子性。

// 异常结果实现
final boolean internalComplete(Object r) { // CAS from null to r
    return RESULT.compareAndSet(this, null, r);
}
// 正常结果实现
final boolean completeValue(T t) {
    return RESULT.compareAndSet(this, null, (t == null) ? NIL : t);
}

public boolean isDone() {
    return result != null;
}

3. 内存泄露 bug

在 JDK21之前的CF实现中,存在内存泄露的bug,具体描述详见 https://bugs.openjdk.org/browse/JDK-8303742 ,目前笔者仅在JDK21 中发现代码已修复(不考虑非LTS版本)。作为bug,后续发布的 JDK 子版本可能会修复这个问题。

这个bug在如下代码中:

// 取消任务,JDK21之前的实现会检查异常结果
if (ex == null && f != null && !f.isDone())
    f.cancel(false);

当正常任务异常结束时,不会取消延迟队列中的任务,最终会导致内存泄露。若项目中存在多个长时间超时CF任务,内存泄露的情况会更明显。

public class LeakDemo {
    public static void main(String[] args) {
        while (true) {
            new CompletableFuture<>().orTimeout(1, TimeUnit.HOURS).completeExceptionally(new Exception());
        }
    }
}

执行以上代码会报OOM错误,你可以在自己的编程环境中进行测试。

4. JDK8如何实现超时任务

JDK8中CompletableFuture并不支持超时任务,笔者推荐使用CFFU类库,其是CF的增强类库,支持在JDK8环境中使用高版本的功能。另一种方案使用 Guava 提供的 ListenableFuture。当然你也可以参照JDK21中的代码自己实现。

到此这篇关于Java CompletableFuture如何实现超时功能的文章就介绍到这了,更多相关Java CompletableFuture超时内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • IDEA中的yml文件与properties互相转换

    IDEA中的yml文件与properties互相转换

    这篇文章主要介绍了IDEA中的yml文件与properties互相转换方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-10-10
  • springBoot系列常用注解(小结)

    springBoot系列常用注解(小结)

    这篇文章主要介绍了springBoot系列常用注解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-04-04
  • IDEA中Javaweb项目图片加载不出来解决方案

    IDEA中Javaweb项目图片加载不出来解决方案

    在IDEA中能够正常的预览到图片,但是在生成项目的war包时,项目的目录结构却会发生变化,所以无法访问图片,本文主要介绍了IDEA中Javaweb项目图片加载不出来解决方案,感兴趣的可以了解一下
    2023-10-10
  • java调用百度的接口获取起-止位置的距离

    java调用百度的接口获取起-止位置的距离

    本文主要介绍了java调用百度的接口获取起-止位置的距离,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-04-04
  • Spring中任务调度之解读@Scheduled和@Schedules注解的使用

    Spring中任务调度之解读@Scheduled和@Schedules注解的使用

    这篇文章主要介绍了Spring中任务调度之解读@Scheduled和@Schedules注解的使用,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2025-04-04
  • 教你在JNA中将本地方法映射到JAVA代码中的示例

    教你在JNA中将本地方法映射到JAVA代码中的示例

    对于JNI来说,我们可以使用native关键字来定义本地方法。那么在JNA中有那些在JAVA代码中定义本地方法的方式呢?对JNA本地方法映射JAVA代码的相关知识感兴趣的朋友一起看看吧
    2022-04-04
  • SpringBoot中的application.properties无法加载问题定位技巧

    SpringBoot中的application.properties无法加载问题定位技巧

    这篇文章主要介绍了SpringBoot中的application.properties无法加载问题定位技巧,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-05-05
  • Netty搭建WebSocket服务器实战教程

    Netty搭建WebSocket服务器实战教程

    这篇文章主要介绍了Netty搭建WebSocket服务器实战,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧
    2024-03-03
  • Java经典面试题汇总:网络编程

    Java经典面试题汇总:网络编程

    本篇总结的是Java 网络编程相关的面试题,后续会持续更新,希望我的分享可以帮助到正在备战面试的实习生或者已经工作的同行,如果发现错误还望大家多多包涵,不吝赐教,谢谢
    2021-07-07
  • JSON 与对象、集合之间的转换的示例

    JSON 与对象、集合之间的转换的示例

    在开发过程中,经常需要和别的系统交换数据,数据交换的格式有XML、JSON等,JSON作为一个轻量级的数据格式比xml效率要高,本篇文章主要介绍了JSON 与 对象 、集合 之间的转换,有兴趣的可以了解一下。
    2017-01-01

最新评论