线程执行者(九)执行者取消一个任务

执行者取消一个任务

当你使用执行者工作时,你不得不管理线程。你只实现Runnable或 Callable任务和把它们提交给执行者。执行者负责创建线程,在线程池中管理它们,当它们不需要时,结束它们。有时候,你想要取消已经提交给执行者 的任务。在这种情况下,你可以使用Future的cancel()方法,它允许你做取消操作。在这个指南中,你将学习如何使用这个方法来取消已经提交给执行者的任务。

准备工作…

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

如何做…

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

1.创建Task类,指定实现Callable接口,并参数化为String类型。实现call()方法,写入一条信息到控制台,并使这个线程在循环中睡眠100毫秒。


1 public class Task implements Callable<String> {
2 @Override
3 public String call() throws Exception {
4 while (true){
5 System.out.printf("Task: Test\n");
6 Thread.sleep(100);
7 }
8 }

2.实现示例的主类,创建Main类,实现main()方法。


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

3. 使用Executors类的newCachedThreadPool()方法创建ThreadPoolExecutor对象。


1 ThreadPoolExecutor executor=(ThreadPoolExecutor)Executors.newCachedThreadPool();

4.创建Task对象。


1 Task task=new Task();

5.使用submit()方法提交任务给执行者。


1 System.out.printf("Main: Executing the Task\n");
2 Future<String> result=executor.submit(task);

6.使主任务睡眠2秒。


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

7.使用通过submit()方法返回的Future对象result的cancel()方法,取消任务的执行。传入true值作为cancel()方法的参数。


1 System.out.printf("Main: Canceling the Task\n");
2 result.cancel(true);

8.将isCancelled()方法和isDone()的调用结果写入控制台,验证任务已取消,因此,已完成。


1 System.out.printf("Main: Canceled: %s\n",result.isCanceled());
2 System.out.printf("Main: Done: %s\n",result.isDone());

9.使用shutdown()方法结束执行者,写入信息(到控制台)表明程序结束。


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

它是如何工作的…

当你想要取消你已提交给执行者的任务,使用Future接口的cancel()方法。根据cancel()方法参数和任务的状态不同,这个方法的行为将不同:

  • 如果这个任务已经完成或之前的已被取消或由于其他原因不能被取消,那么这个方法将会返回false并且这个任务不会被取消。
  • 如果这个任务正在等待执行者获取执行它的线程,那么这个任务将被取消而且不会开始它的执行。如果这个任务已经正在运行,则视方法的参数情况而定。 cancel()方法接收一个Boolean值参数。如果参数为true并且任务正在运行,那么这个任务将被取消。如果参数为false并且任务正在运行,那么这个任务将不会被取消。

以下截图显示该示例的执行输出:

线程执行者(九)执行者取消一个任务

不止这些…

如果你使用Future对象的get()方法来控制一个已被取消的任务,这个get()方法将抛出CancellationException异常。

参见

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