线程执行者（十一）执行者分离任务的启动和结果的处理

声明：本文是《 Java 7 Concurrency Cookbook 》的第四章，作者： Javier Fernández González     译者：许巧辉     校对：方腾飞，叶磊

执行者分离任务的启动和结果的处理

通常，当你使用执行者执行并发任务时，你将会提交 Runnable或Callable任务给这个执行者，并获取Future对象控制这个方法。你可以发现这种情况，你需要提交任务给执行者在一个对象中，而处理结果在另一个对象中。基于这种情况，Java并发API提供CompletionService类。

CompletionService 类有一个方法来提交任务给执行者和另一个方法来获取已完成执行的下个任务的Future对象。在内部实现中，它使用Executor对象执行任务。这种行为的优点是共享一个CompletionService对象，并提交任务给执行者，这样其他（对象）可以处理结果。其局限性是，第二个对象只能获取那些已经完成它们的执行的任务的Future对象，所以，这些Future对象只能获取任务的结果。

在这个指南中，你将学习如何使用CompletionService类把执行者启动任务和处理它们的结果分开。

准备工作…

这个指南的例子使用Eclipse IDE实现。如果你使用Eclipse或其他IDE，如NetBeans，打开它并创建一个新的Java项目。

如何做…

按以下步骤来实现的这个例子:

1.创建ReportGenerator类，并指定其实现Callable接口，参数化为String类型。

public class ReportGenerator implements Callable<String> {

2.声明两个私有的、String类型的属性，sender和title，用来表示报告的数据。

private String sender;
private String title;

3.实现这个类的构造器，初始化这两个属性。

public ReportGenerator(String sender, String title){
this.sender=sender;
this.title=title;
}

4.实现call()方法。首先，让线程睡眠一段随机时间。

@Override
public String call() throws Exception {
try {
Long duration=(long)(Math.random()*10);
System.out.printf("%s_%s: ReportGenerator: Generating a report during %d seconds/n",this.sender,this.title,duration);
TimeUnit.SECONDS.sleep(duration);
} catch (InterruptedException e) {
e.printStackTrace();
}

5.然后，生成一个有sender和title属性的字符串的报告，返回这个字符串。

String ret=sender+": "+title;
return ret;
}

6.创建ReportRequest类，实现Runnable接口。这个类将模拟一些报告请求。

public class ReportRequest implements Runnable {

7.声明私有的、String类型的属性name，用来存储ReportRequest的名称。

private String name;

8.声明私有的、CompletionService类型的属性service。CompletionService接口是个参数化接口，使用String类型参数化它。

private CompletionService<String> service;

9.实现这个类的构造器，初始化这两个属性。

public ReportRequest(String name, CompletionService<String> service){
this.name=name;
this.service=service;
}

10.实现run()方法。创建1个ReportGenerator对象，并使用submit()方法把它提交给CompletionService对象。

@Override
public void run() {
ReportGenerator reportGenerator=new ReportGenerator(name,"Report");
service.submit(reportGenerator);
}

11.创建ReportProcessor类。这个类将获取ReportGenerator任务的结果，指定它实现Runnable接口。

public class ReportProcessor implements Runnable {

12.声明一个私有的、CompletionService类型的属性service。由于CompletionService接口是个参数化接口，使用String类作为这个CompletionService接口的参数。

private CompletionService<String> service;

13.声明一个私有的、boolean类型的属性end。

private boolean end;

14.实现这个类的构造器，初始化这两个属性。

public ReportProcessor (CompletionService<String> service){
this.service=service;
end=false;
}

15.实现run()方法。当属性end值为false，调用CompletionService接口的poll()方法，获取CompletionService执行的下个已完成任务的Future对象。

@Override
public void run() {
while (!end){
try {
Future<String> result=service.poll(20, TimeUnit.SECONDS);

16.然后，使用Future对象的get()方法获取任务的结果，并且将这些结果写入到控制台。

if (result!=null) {
String report=result.get();
System.out.printf("ReportReceiver: Report Received:%s/n",report);
}
} catch (InterruptedException | ExecutionException e) {
e.printStackTrace();
}
}
System.out.printf("ReportSender: End/n");
}

17.实现setEnd()方法，用来修改属性end的值。

public void setEnd(boolean end) {
this.end = end;
}

18.实现这个示例的主类，通过创建Main类，并实现main()方法。

public class Main {
public static void main(String[] args) {

19.使用Executors类的newCachedThreadPool()方法创建ThreadPoolExecutor。

ExecutorService executor=(ExecutorService)Executors.newCachedThreadPool();

20.创建CompletionService，使用前面创建的执行者作为构造器的参数。

CompletionService<String> service=new ExecutorCompletionService<>(executor);

21.创建两个ReportRequest对象，并用线程执行它们。

ReportRequest faceRequest=new ReportRequest("Face", service);
ReportRequest onlineRequest=new ReportRequest("Online";,service);
Thread faceThread=new Thread(faceRequest);
Thread onlineThread=new Thread(onlineRequest);

22.创建一个ReportProcessor对象，并用线程执行它。

ReportProcessor processor=new ReportProcessor(service);
Thread senderThread=new Thread(processor);

23.启动这3个线程。

System.out.printf("Main: Starting the Threads/n");
faceThread.start();
onlineThread.start();
senderThread.start();

24.等待ReportRequest线程的结束。

try {
System.out.printf("Main: Waiting for the report
generators./n");
faceThread.join();
onlineThread.join();
} catch (InterruptedException e) {
e.printStackTrace();
}

25.使用shutdown()方法关闭执行者，使用awaitTermination()方法等待任务的结果。

System.out.printf("Main: Shutting down the executor./n");
executor.shutdown();
try {
executor.awaitTermination(1, TimeUnit.DAYS);
} catch (InterruptedException e) {
e.printStackTrace();
}

26.设置ReportSender对象的end属性值为true，结束它的执行。

processor.setEnd(true);
System.out.println("Main: Ends");

这是如何工作的…

在示例的主类中，你使用Executors类的newCachedThreadPool()方法创建ThreadPoolExecutor。然后，使用这个对象初始化一个CompletionService对象，因为CompletionService需要使用一个执行者来执行任务。利用CompletionService执行一个任务，你需要使用submit()方法，如在ReportRequest类中。

当其中一个任务被执行，CompletionService完成这个任务的执行时，这个CompletionService在一个队列中存储Future对象来控制它的执行。poll()方法用来查看这个列队，如果有任何任务执行完成，那么返回列队的第一个元素，它是一个已完成任务的Future对象。当poll()方法返回一个Future对象时，它将这个Future对象从队列中删除。这种情况下，你可以传两个属性给那个方法，表明你想要等任务结果的时间，以防队列中的已完成任务的结果是空的。

一旦CompletionService对象被创建，你创建2个ReportRequest对象，用来执行3个ReportGenerator任务，每个都在CompletionService中，和一个ReportSender任务，它将会处理已提交给2个ReportRequest对象的任务所产生的结果。

不止这些…

CompletionService类可以执行Callable和Runnable任务。在这个示例中，你已经使用Callable，但你同样可以提交Runnable对象。由于Runnable对象不会产生结果，CompletionService类的理念不适用于这些情况。

这个类同样提供其他两个方法，用来获取已完成任务的Future对象。这两个方法如下：

• poll()：不带参数版本的poll()方法，检查是否有任何Future对象在队列中。如果列队是空的，它立即返回null。否则，它返回第一个元素，并从列队中删除它。
• take()：这个方法，不带参数。检查是否有任何Future对象在队列中。如果队列是空的，它阻塞线程直到队列有一个元素。当队列有元素，它返回第一元素，并从列队中删除它。

参见

• 在第4章，线程执行者中的执行者执行返回结果的任务指南