Fork/Join框架（六）取消任务

取消任务

当你在一个ForkJoinPool类中执行ForkJoinTask对象，在它们开始执行之前，你可以取消执行它们。ForkJoinTask类提供cancel()方法用于这个目的。当你想要取消一个任务时，有一些点你必须考虑一下，这些点如下：

• ForkJoinPool类并没有提供任何方法来取消正在池中运行或等待的所有任务。
• 当你取消一个任务时，你不能取消一个已经执行的任务。

在这个指南中，你将实现取消ForkJoinTask对象的例子。你将查找数在数组中的位置。第一个找到这个数的任务将取消剩下的任务（未找到这个数的任务）。由于Fork/Join框架并没有提供这种功能，所以，你将实现一个辅助类来做这个取消功能。

准备工作…

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

如何做…

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

1.创建ArrayGenerator类。这个类将产生一组随机的、指定大小的整数数字。实现generateArray()方法。它将产生一组数字，它接收数组大小作为参数。

1 public class ArrayGenerator {
2 public int[] generateArray(int size) {
3 int array[]=new int[size];
4 Random random=new Random();
5 for (int i=0; i
6 array[i]=random.nextInt(10);
7 }
8 return array;
9 }

2.创建一个TaskManager类。我们将使用这个类来存储在ForkJoinPool中执行的所有任务。由于ForkJoinPool和ForkJoinTask类的局限性，你将使用这个类来取消ForkJoinPool类的所有任务。

1 public class TaskManager {

3.声明一个对象参数化为ForkJoinTask类型的数列，其中ForkJoinTask类参数化为Integer类型。

1 private List> tasks;

4.实现这个类的构造器，它初始化任务数列。

1 public TaskManager(){
2 tasks=new ArrayList<>();
3 }

5.实现addTask()方法。它添加ForkJoinTask对象到任务数列。

1 public void addTask(ForkJoinTask task){
2 tasks.add(task);
3 }

6.实现cancelTasks()方法。它将使用cancel()方法取消在数列中的所有ForkJoinTask对象。它接收一个想要取消剩余任务的ForkJoinTask对象作为参数。这个方法取消所有任务。

1 public void cancelTasks(ForkJoinTask cancelTask){
2 for (ForkJoinTask task :tasks) {
3 if (task!=cancelTask) {
4 task.cancel(true);
5 ((SearchNumberTask)task).writeCancelMessage();
6 }
7 }
8 }

7.实现SearchNumberTask类，指定它继承参数化为Integer类型的RecursiveTask类。这个类将查找在整数数组的元素块中的数。

1 public class SearchNumberTask extends RecursiveTask {

8.声明一个私有的、int类型的数字数组。

1 private int numbers[];

9.声明两个私有的、int类型的属性start和end。这些属性将决定任务要处理的数组的元素。

1 private int start, end;

10.声明一个私有的、int类型的属性number，它将存储你将要查找的数。

1 private int number;

11.声明一个私有的、TaskManager类型的属性manager。你将使用这个对象来取消所有任务。

1 private TaskManager manager;

12.声明一个私有的、int类型的常量并初始化它为值-1。当任务没有找到这个数时，它将作为任务的返回值。

1 private final static int NOT_FOUND=-1;

13.实现这个类的构造器来初始化它的属性。

1 public Task(int numbers[], int start, int end, int number,
2 TaskManager manager){
3 this.numbers=numbers;
4 this.start=start;
5 this.end=end;
6 this.number=number;
7 this.manager=manager;
8 }

14.实现compute()方法。写入一条信息（start和end属性值）到控制台表明这个方法的开始。

1 @Override
2 protected Integer compute() {
3 System.out.println("Task: "+start+":"+end);

15.如果start和end之差大于10（这个任务将处理超过10个元素的数组），调用launchTasks()方法，将这个任务的工作拆分成两个任务。

1 int ret;
2 if (end-start>10) {
3 ret=launchTasks();

16.否则，这个任务调用lookForNumber()方法来查找在数组块中的数。

1 } else {
2 ret=lookForNumber();
3 }

17.返回任务的结果。

1 return ret;

18.实现lookForNumber()方法。

1 private int lookForNumber() {

19.对于任务要处理的元素块中的所有元素，将你想要查找的数与存储在元素中的值进行比较。如果他们相等，写入一条信息到控制台表明这种情形，使用TaskManager对象的cancelTasks()方法来取消所有任务，并返回你已经找到的这个数对应元素的位置。

1 for (int i=start; i
2 if (array[i]==number) {
3 System.out.printf("Task: Number %d found in position
4 %d\n",number,i);
5 manager.cancelTasks(this);
6 return i;
7 }

20.在循环的内部，令任务睡眠1秒。

1 try {
2 TimeUnit.SECONDS.sleep(1);
3 } catch (InterruptedException e) {
4 e.printStackTrace();
5 }
6 }

21.最后，返回值-1。

1 return NOT_FOUND;
2 }

22.实现launchTasks()方法。首先，将这个任务要处理的数块分成两个部分，然后，创建两个Task对象来处理它们。

1 private int launchTasks() {
2 int mid=(start+end)/2;
3 Task task1=new Task(array,start,mid,number,manager);
4 Task task2=new Task(array,mid,end,number,manager);

23.添加这个任务到TaskManager对象中。

1 manager.addTask(task1);
2 manager.addTask(task2);

24.使用fork()方法异步执行这两个任务。

1 task1.fork();
2 task2.fork();

25.等待这个任务的结束，返回第一个任务的结果（如果它不等于1），或第二个任务的结果。

1 int returnValue;
2 returnValue=task1.join();
3 if (returnValue!=-1) {
4 return returnValue;
5 }
6 returnValue=task2.join();
7 return returnValue;

26.实现writeCancelMessage()方法，当任务取消时，写一条信息到控制台。

1 public void writeCancelMessage(){
2 System.out.printf("Task: Canceled task from %d to
3 %d",start,end);
4 }

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

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

28.使用ArrayGenerator类，创建一个有1000个数字的数组。

1 ArrayGenerator generator=new ArrayGenerator();
2 int array[]=generator.generateArray(1000);

29.创建一个TaskManager对象。

1 TaskManager manager=new TaskManager();

30.使用默认的构造器创建一个ForkJoinPool对象。

1 ForkJoinPool pool=new ForkJoinPool();

31.创建一个Task对象来处理前面生成的数组。

1 Task task=new Task(array,0,1000,5,manager);

32.使用execute()方法，在池中异步执行任务。

1 pool.execute(task);

33.使用shutdown()方法关闭这个池。

1 pool.shutdown();

34.使用ForkJoinPool类的awaitTermination()方法，等待任务的结束。

1 try {
2 pool.awaitTermination(1, TimeUnit.DAYS);
3 } catch (InterruptedException e) {
4 e.printStackTrace();
5 }

35.写入一条信息到控制台，表明程序的结束。

1 System.out.printf("Main: The program has finished\n");

它是如何工作的…

ForkJoinTask提供cancel()方法，允许你取消一个还未执行的任务。这是一个非常重要的点。如果任务已经开始它的执行，那么调用cancel()方法对它没有影响。这个方法接收一个Boolean值，名为mayInterruptIfRunning的参数。这个名字可能让你觉得，如果你传入一个true值给这个方法，这个任务将被取消，即使它正在运行。

Java API文档指出，在ForkJoinTask类的默认实现中，这个属性不起作用。任务只能在它们还未开始执行时被取消。一个任务的取消不会影响到已经提到到池的（其他）任务。它们继续它们的执行。 Fork/Join框架的一个局限性是，它不允许取消在ForkJoinPool中的所有任务。为了克服这个限制，你实现了TaskManager类。它存储被提到池中的所有任务。它有一个方法取消它存储的所有任务。如果一个任务由于它正在运行或已经完成而不能被取消，cancel()方法返回false值，所以，你可以尝试取消所有任务，而不用担心可能有间接的影响。 在这个例子中，你已经实现一个任务，用来在一个数字数组中查找一个数。如Fork/Join框架所推荐的，你将问题分解成更小的子问题。你只关心这个数的出现，所以当你找到它，你取消了其他任务。 以下截图显示这个例子执行的一部分： 参见

• 在第5章，Fork/Join框架中的创建一个Fork/Join池指南