【Java】guava(二) ListenableFuture 使用及原理

2024-05-24 21:08

本文主要是介绍【Java】guava(二) ListenableFuture 使用及原理,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

使用异步编程接口获取返回值的方式有两种:

1.同步方式,也就是调用方主动获取,但是这时可能还没有返回结果,可能需要轮询;

2.回调方式,调用者在提交任务时,注册一个回调函数,任务执行完以后,自动触发回调函数通知调用者;这种实现方式需要在执行框架里植入一个扩展点,用于触发回调。

Java原生api里的Future属于第一种,Java8提供的CompletableFuture属于第二种;在Java8出来之前,guava也提供了基于回调的编程接口,也就是本次要说的ListenableFuture(其实看guava代码,里面有大量这玩意儿,不搞懂不行。。。)。

先看下ListenableFuture接口定义:

public interface ListenableFuture<V> extends Future<V> {void addListener(Runnable listener, Executor executor);
}

可以看到,这个接口在Future接口的基础上增加了addListener方法,允许我们注册回调函数。当然,我们在编程时可能不会直接使用这个接口,因为这个接口只能传Runnable实例。Futures类提供了另一个方法:addCallback方法。下面我们看一个实例:

@Test
public void test55() throws InterruptedException {ListenableFuture<String> s = MoreExecutors.listeningDecorator(Executors.newFixedThreadPool(1)).submit(() -> {Thread.sleep(2000L);return "async result";});Futures.addCallback(s, new FutureCallback<String>() {@Overridepublic void onSuccess(@Nullable String result) {System.out.println("succeed, result: {}" + result);}@Overridepublic void onFailure(Throwable t) {System.out.println("failed, t: " + t);}}, Executors.newSingleThreadExecutor());Thread.sleep(100000);
}

首先看下addCallback方法干了啥?

public static <V> void addCallback(final ListenableFuture<V> future,final FutureCallback<? super V> callback,Executor executor) {
Preconditions.checkNotNull(callback);
future.addListener(new CallbackListener<V>(future, callback), executor);
}

这里调用了ListenableFuture接口的addListener方法,传入了一个CallbackListener实例。而这个实例由需要传入future和一个Callback实例,所以这个回调是可以拿到返回值的。本质上是guava帮我们基于Runnable封了一个回调接口。看下这个CallbackListener接口:

private static final class CallbackListener<V> implements Runnable {final Future<V> future;final FutureCallback<? super V> callback;CallbackListener(Future<V> future, FutureCallback<? super V> callback) {this.future = future;this.callback = callback;}@Overridepublic void run() {if (future instanceof InternalFutureFailureAccess) {Throwable failure =InternalFutures.tryInternalFastPathGetFailure((InternalFutureFailureAccess) future);if (failure != null) {callback.onFailure(failure);return;}}final V value;try {value = getDone(future);} catch (ExecutionException e) {callback.onFailure(e.getCause());return;} catch (RuntimeException | Error e) {callback.onFailure(e);return;}callback.onSuccess(value);}
}

这个类内部有一个future和一个FutureCallback实例,其run方法就是回调时的逻辑,先调用getDone方法获取future的返回值。然后再将返回值调用FutureCallback实例的onSuccess方法执行注册的回调逻辑。当然,如果发生了异常,则会调用onFailure方法通知异常。

好的,至此我们已经了解了用户注册的回调函数是怎么执行的了,那么还有一个重要问题,这个回调是怎么触发的?

在开始的时候大致提了一下,回调的实现一般都是在执行框架层植入一个扩展点,触发回调逻辑,这里也不意外。我们从执行的执行框架入手,开始的时候我们调用MoreExecutors构造了一个线程池:

@GwtIncompatible // TODO
public static ListeningExecutorService listeningDecorator(ExecutorService delegate) {
return (delegate instanceof ListeningExecutorService)? (ListeningExecutorService) delegate: (delegate instanceof ScheduledExecutorService)? new ScheduledListeningDecorator((ScheduledExecutorService) delegate): new ListeningDecorator(delegate);
}

对于我们之前的例子,会返回一个ListeningDecorator类型的线程池,从方法命名也可以看出,这个本质上就是对于Java原生线程池的一个封装,用于返回ListenableFuture类型的Future:

  private static class ListeningDecorator extends AbstractListeningExecutorService {private final ExecutorService delegate;ListeningDecorator(ExecutorService delegate) {this.delegate = checkNotNull(delegate);}@Overridepublic final boolean awaitTermination(long timeout, TimeUnit unit) throws InterruptedException {return delegate.awaitTermination(timeout, unit);}@Overridepublic final boolean isShutdown() {return delegate.isShutdown();}@Overridepublic final boolean isTerminated() {return delegate.isTerminated();}@Overridepublic final void shutdown() {delegate.shutdown();}@Overridepublic final List<Runnable> shutdownNow() {return delegate.shutdownNow();}@Overridepublic final void execute(Runnable command) {delegate.execute(command);}}
}

这个家伙儿啥也没干,就是将执行逻辑委托给了delegate。当然,线程池执行不仅仅是这些方法,比如最开始的submit方法,其实是在其父类AbstractListeningExecutorService中的:

  @Overridepublic <T> ListenableFuture<T> submit(Callable<T> task) {return (ListenableFuture<T>) super.submit(task);}

然后又调用了AbstractListeningExecutorService的父类即Java中原生的AbstractExecutorService的submit方法,进入了原生Java的逻辑。之后会调用newTask创建任务:

public <T> Future<T> submit(Callable<T> task) {if (task == null) {throw new NullPointerException();} else {RunnableFuture<T> ftask = this.newTaskFor(task);this.execute(ftask);return ftask;}
}

guava的AbstractListeningExecutorService覆盖了newTaskFor方法,这样才能返回ListenableFuture呀:

  @Overrideprotected final <T> RunnableFuture<T> newTaskFor(Callable<T> callable) {return TrustedListenableFutureTask.create(callable);}

所以,guava里的ListenableFuture的一个实现类是这里的TrustedListenableFutureTask,这个我们不做深入,直接看其run方法吧,也是在父类里定义的,这个方法很长,截取一段关键逻辑:

try {if (run) {result = runInterruptibly();}
} catch (Throwable t) {error = t;
} finally {}if (run) {afterRanInterruptibly(result, error);}
}

先调用runInterruptibly方法执行任务内容,然后如果执行成功就调用afterxxx方法执行一个后置的逻辑,这个其实就是我们所说的“植入点”,主动调用回调的入口就是这个方法:

@Override
void afterRanInterruptibly(V result, Throwable error) {if (error == null) {TrustedListenableFutureTask.this.set(result);} else {setException(error);}
}

如果有异常,设置Exception,否则设置返回值。我们只看无异常的case:

@CanIgnoreReturnValue
protected boolean set(@Nullable V value) {
Object valueToSet = value == null ? NULL : value;
if (ATOMIC_HELPER.casValue(this, null, valueToSet)) {complete(this);return true;
}
return false;
}

这里在任务里设置完返回值后,就调用了complete方法,只截取关键逻辑:

/** Unblocks all threads and runs all listeners. */
private static void complete(AbstractFuture<?> future) {
Listener next = null;
outer:
while (true) {future.afterDone();next = future.clearListeners(next);future = null;while (next != null) {Listener curr = next;next = next.next;Runnable task = curr.task;if (task instanceof SetFuture) {} else {executeListener(task, curr.executor);}}break;
}

这里的Listener就是最开始添加到Future里的回调函数,是一个链表结构。这个方法会遍历回调链表,逐一调用executeListener方法触发回调逻辑。

至此ListenableFuture的回调逻辑基本清楚了。

 

小结:

1.优先使用Futures工具类添加回调;

2.回调的实现,在执行框架内植入触发逻辑;

这篇关于【Java】guava(二) ListenableFuture 使用及原理的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/999535

相关文章

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时,有没有考虑过 JVM 是如何把静态的字节码(byte code)转化为运行时对象的呢,这个问题看似简单,但清楚的同学相信也不会太多,这篇文章首先介绍 JVM 类初始化的机制,然后给出几个易出错的实例来分析,帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段,分别是:loading 、Linking、initialization

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权,允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true (Spring security默认会带有ROLE_前缀),去

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程,特意画了如下的类图,包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口,接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类,它们之间的依赖,构建起了整个框架。想要理解整个架构,最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文(security context)的信息。当前操作的用户是谁,该用户是否已经被认证,他拥有哪些角色权限…这些都被保

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明(认真看哦) AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证,则会调用 #attemptAuthentica

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门(一):登录与退出》 《Spring-Security-入门(二):基于数据库验证》 《Spring-Security-入门(三):密码加密》 《Spring-Security-入门(四):自定义-Filter》 《Spring-Security-入门(五):在 Sprin

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物

中文分词jieba库的使用与实景应用(一)

知识星球:https://articles.zsxq.com/id_fxvgc803qmr2.html 目录 一.定义: 精确模式(默认模式): 全模式: 搜索引擎模式: paddle 模式(基于深度学习的分词模式): 二 自定义词典 三.文本解析   调整词出现的频率 四. 关键词提取 A. 基于TF-IDF算法的关键词提取 B. 基于TextRank算法的关键词提取

使用SecondaryNameNode恢复NameNode的数据

1)需求: NameNode进程挂了并且存储的数据也丢失了,如何恢复NameNode 此种方式恢复的数据可能存在小部分数据的丢失。 2)故障模拟 (1)kill -9 NameNode进程 [lytfly@hadoop102 current]$ kill -9 19886 (2)删除NameNode存储的数据(/opt/module/hadoop-3.1.4/data/tmp/dfs/na

Hadoop数据压缩使用介绍

一、压缩原则 (1)运算密集型的Job,少用压缩 (2)IO密集型的Job,多用压缩 二、压缩算法比较 三、压缩位置选择 四、压缩参数配置 1)为了支持多种压缩/解压缩算法,Hadoop引入了编码/解码器 2)要在Hadoop中启用压缩,可以配置如下参数