java多线程获取结果CompletionService

java多线程异步获取结果CompletionService   

一、前言：

        在异步任务程序中，一种常见的场景是，主线程提交多个异步任务，然后希望有任务完成就处理结果，并且按任务完成顺序逐个处理，对于这种场景，Java并发包提供的CompletionService 方法可以帮我们解决。

 

二、定义：

       下面我们来看一下这个CompletionService 有哪些内容：

public interface CompletionService<V> {
    Future<V> submit(Callable<V> task);
    Future<V> submit(Runnable task, V result);
    Future<V> take() throws InterruptedException;
    Future<V> poll();
    Future<V> poll(long timeout, TimeUnit unit) throws InterruptedException;
}

submit():     用于提交一个需要返回果的任务。该方法返回一个Future对象，通过调用这个对象的get()方法，我们就能获得返回结 果。get()方法会一直阻塞，直到返回结果返回   (与ExecutorService 方法一样)

 take():      获取下一个完成任务的结果，take()会阻塞等待，直到结果返回

 poll():      获取下一个结果，是立刻返回结果，不论是否任务已经完成，如果没有已完成的任务，返回null，带时间参数的poll方法会最多等待限定的时间

 

三、实现原理：

    CompletionService的主要实现类是ExecutorCompletionService，它依赖于一个Executor完成实际的任务提交，而自己主要负责结果的排队和处理，它的构造方法有两个：

public ExecutorCompletionService(Executor executor)
public ExecutorCompletionService(Executor executor, BlockingQueue<Future<V>> completionQueue)

至少需要一个Executor参数，可以提供一个BlockingQueue参数，用作完成任务的队列，没有提供的话，ExecutorCompletionService内部会创建一个LinkedBlockingQueue

这个BlockingQueue或者LinkedBlockingQueue 就是用来对结果进行排队和排序的

 举一个简单的例子

演示了并发下载并分析URL的标题，一有任务完成就输出其结果，如果没有完成的就阻塞等待

package com.test;

import org.jsoup.Jsoup;
import org.jsoup.nodes.Document;
import org.jsoup.select.Elements;

import java.util.Arrays;
import java.util.List;
import java.util.concurrent.*;

/**
 * 异步获取批量结果
 */
public class CompletionServiceDemo {
    //封装任务
    static class UrlTitleParser implements Callable<String> {
        private String url;

        public UrlTitleParser(String url) {
            this.url = url;
        }

        @Override
        public String call() throws Exception {
            //使用jsoup第三方解析网页
            //获取网页的dom结构数据
            Document doc = Jsoup.connect(url)
                    .header("accept-charset","utf-8")
                    .get();
            //获取title的元素
            Elements elements = doc.select("title");
            if (elements.size() > 0) {
                return url + ": " + elements.get(0).text();
            }
            return null;
        }
    }

    public static void parse(List<String> urls) throws InterruptedException {
        //创建线程池  最大10个线程
        ExecutorService executor = Executors.newFixedThreadPool(10);
        try {
            //创建接受任务的Completion
            CompletionService<String> completionService = new ExecutorCompletionService<>(
                    executor);
            //依次提交任务
            for (String url : urls) {
                completionService.submit(new UrlTitleParser(url));
            }
            //依次获取任务结果  注意take函数是阻塞函数   是按完成任务先后排序的 并不是按提交任务先后
            for (int i = 0; i < urls.size(); i++) {
                Future<String> result = completionService.take();
                try {
                    System.out.println(result.get());
                } catch (ExecutionException e) {
                    e.printStackTrace();
                }
            }
        } finally {
            //关闭线程池
            executor.shutdown();
        }
    }

    public static void main(String[] args) throws InterruptedException {
        List<String> urls = Arrays.asList(new String[] {
                "https://blog.youkuaiyun.com/FireAny2010/article/details/102837272",
                "https://blog.youkuaiyun.com/FireAny2010/article/details/102798925",
                "https://blog.youkuaiyun.com/FireAny2010/article/details/102605309",
                "https://blog.youkuaiyun.com/FireAny2010/article/details/102718862" });
        parse(urls);
    }
}

 

四、具体分析

 1、ExecutorCompletionService是怎么让结果有序处理的呢？

        答：如前所述，它有一个额外的队列，每个任务完成之后，都会将代表结果的Future入队。

 2、任务完成后，怎么知道入队呢？

        答：我们要知道FutureTask，任务完成后，不管是正常完成、异常结束、还是被取消，都会调用finishCompletion方法，而该方法会调用一个done方法，该方法代码为：

protected void done() { }

可以看出 它的实现为空，但它是一个protected方法，子类可以重写该方法

在ExecutorCompletionService中，提交的任务类型不是一般的FutureTask，而是一个子类QueueingFuture，我们可以看一下源码：

public Future<V> submit(Callable<V> task) {
    if (task == null) throw new NullPointerException();
    RunnableFuture<V> f = newTaskFor(task);
    executor.execute(new QueueingFuture(f));
    return f;
}

该子类重写了done方法，在任务完成时将结果加入到完成队列中，其代码为：

private class QueueingFuture extends FutureTask<Void> {
    QueueingFuture(RunnableFuture<V> task) {
        super(task, null);
        this.task = task;
    }
    protected void done() { completionQueue.add(task); }
    private final Future<V> task;
}

ExecutorCompletionService的take/poll方法就是从该队列获取结果，如下所示：

public Future<V> take() throws InterruptedException {
    return completionQueue.take();
}

五、实现invokeAny

AbstractExecutorService的invokeAny的实现，就利用了ExecutorCompletionService，它的基本思路是，提交任务后，通过take方法获取结果，获取到第一个有效结果后，取消所有其他任务，不过，它的具体实现有一些优化，比较复杂。我们看一个模拟的示例，从多个搜索引擎查询一个关键词，但只要任意一个的结果就可以，模拟代码如下：

public class InvokeAnyDemo {
    static class SearchTask implements Callable<String> {
        private String engine;
        private String keyword;

        public SearchTask(String engine, String keyword) {
            this.engine = engine;
            this.keyword = keyword;
        }

        @Override
        public String call() throws Exception {
            // 模拟从给定引擎搜索结果
            Thread.sleep(engine.hashCode() % 1000);
            return "<result for> " + keyword;
        }
    }

    public static String search(List<String> engines, String keyword)
            throws InterruptedException {
        ExecutorService executor = Executors.newFixedThreadPool(10);
        CompletionService<String> cs = new ExecutorCompletionService<>(executor);
        List<Future<String>> futures = new ArrayList<Future<String>>(
                engines.size());
        String result = null;
        try {
            for (String engine : engines) {
                futures.add(cs.submit(new SearchTask(engine, keyword)));
            }
            for (int i = 0; i < engines.size(); i++) {
                try {
                    result = cs.take().get();
                    if (result != null) {
                        break;
                    }
                } catch (ExecutionException ignore) {
                    // 出现异常，结果无效，继续
                }
            }
        } finally {
            // 取消所有任务，对于已完成的任务，取消没有什么效果
            for (Future<String> f : futures)
                f.cancel(true);
            executor.shutdown();
        }
        return result;
    }

    public static void main(String[] args) throws InterruptedException {
        List<String> engines = Arrays.asList(new String[] { "www.baidu.com",
                "www.sogou.com", "www.so.com", "www.google.com" });
        System.out.println(search(engines, "老马说编程"));
    }
}

SearchTask模拟从指定搜索引擎查询结果，search利用CompletionService/ExecutorService执行并发查询，在得到第一个有效结果后，取消其他任务