java并发编程-Callable与Future

在前面的文章中我们讲述了创建线程的2种方式,一种是直接继承Thread,另外一种就是实现Runnable接口。这2种方式都有一个缺陷就是:在执行完任务之后无法获取执行结果。如果需要获取执行结果,就必须通过共享变量或者使用线程通信的方式来达到效果,这样使用起来就比较麻烦。

而自从Java 1.5开始,就提供了Callable和Future,通过它们可以在任务执行完毕之后得到任务执行结果。

今天我们就来讨论一下Callable、Future和FutureTask三个类的使用方法。以下是本文的目录大纲:

 一.Callable与Runnable

 二.Future

 三.FutureTask

  四.使用示例

  唔、CompletionService


一.Callable与Runnable

   先说一下java.lang.Runnable吧,它是一个接口,在它里面只声明了一个run()方法:

public interface Runnable {
     public abstract void run();
}

   由于run()方法返回值为void类型,所以在执行完任务之后无法返回任何结果。

   Callable位于java.util.concurrent包下,它也是一个接口,在它里面也只声明了一个方法,只不过这个方法叫做call():

public  interface  Callable<V> {
    /**
     * Computes a result, or throws an exception if unable to do so.
     *
     * @return computed result
     * @throws Exception if unable to compute a result
     */
    V call() throws Exception;
}

 可以看到,这是一个泛型接口,call()函数返回的类型就是传递进来的V类型。

  可以看到,这是一个泛型接口,call()函数返回的类型就是传递进来的V类型。

  那么怎么使用Callable呢?一般情况下是配合ExecutorService来使用的,在ExecutorService接口中声明了若干个submit方法的重载版本:

 

 <T> Future<T> submit(Callable<T> task);
  <T> Future<T> submit(Runnable task, T result);
  Future<?> submit(Runnable task);

     第一个submit方法里面的参数类型就是Callable。

  暂时只需要知道Callable一般是和ExecutorService配合来使用的,具体的使用方法讲在后面讲述。

  一般情况下我们使用第一个submit方法和第三个submit方法,第二个submit方法很少使用。

二.Future

    Future就是对于具体的Runnable或者Callable任务的执行结果进行取消、查询是否完成、获取结果。必要时可以通过get方法获取执行结果,该方法会阻塞直到任务返回结果。

  Future类位于java.util.concurrent包下,它是一个接口: 

public  interface  Future<V> {
    boolean cancel(boolean  mayInterruptIfRunning);
    boolean isCancelled();
    boolean isDone();
    V get() throws InterruptedException, ExecutionException;
    V get(long timeout, TimeUnit unit)
        throws InterruptedException, ExecutionException, TimeoutException;
}

在Future接口中声明了5个方法,下面依次解释每个方法的作用:

   cancel方法用来取消任务:

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

  • 如果这个任务已经完成或之前的已被取消或由于其他原因不能被取消,那么这个方法将会返回false并且这个任务不会被取消。

  • 如果这个任务正在等待执行者获取执行它的线程,那么这个任务将被取消而且不会开始它的执行。如果这个任务已经正在运行,则视方法的参数情况而定。 cancel()方法接收一个Boolean值参数(mayInterruptIfRunning)。如果参数为true并且任务正在运行,那么这个任务将被取消。如果参数为false并且任务正在运行,那么这个任务将不会被取消。 

   isCancelled方法表示任务是否被取消成功,如果在任务正常完成前被取消成功,则返回 true。

   isDone方法表示任务是否已经完成,若任务完成,则返回true;

    get()方法用来获取执行结果,这个方法会产生阻塞,会一直等到任务执行完毕才返回;

    get(long timeout, TimeUnit unit)用来获取执行结果,如果在指定时间内,还没获取到结果,就直接返回null。

  也就是说Future提供了三种功能:

     1)判断任务是否完成;

     2)能够中断任务;

     3)能够获取任务执行结果。

  因为Future只是一个接口,所以是无法直接用来创建对象使用的,因此就有了下面的FutureTask。

  cancel方法测试代码:

    测试1:测试一个在进行中的任务,通过cancel(true)来取消任务。

public static void main(String[] args) {

		ExecutorService executor = Executors.newCachedThreadPool();
		Task task = new FtureCancel().new Task();
		System.out.printf("Main: Executing the Task\n");
		Future<String> result = executor.submit(task);

		try {
			Thread.sleep(2000);
		} catch (InterruptedException e) {
			e.printStackTrace();
		}

		System.out.printf("Main: Canceling the Task\n");
		result.cancel(true);
		System.out.printf("Main: Canceled: %s\n", result.isCancelled());
		System.out.printf("Main: Done: %s\n", result.isDone());

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

	class Task implements Callable<String> {

		@Override
		public String call() throws Exception {
			while (true) {
				System.out.println("Test");
				Thread.sleep(1000);
			}
		}

	}

输出结果:

  blob.png

  测试2: 将上述代码改成cancel(false),但是任务代码还是不断在后台执行任务:

    blob.png

三.FutureTask

      集Runnable、Callable、Future于一身,它首先实现了Runnable与Future接口,然后在构造函数中还要注入Callable对象(或者变形的Callable对象:Runnable + Result),所以FutureTask类既可以使用new Thread(Runnable r)放到一个新线程中跑,也可以使用ExecutorService.submit(Runnable r)放到线程池中跑,而且两种方式都可以获取返回结果,但实质是一样的,即如果要有返回结果那么构造函数一定要注入一个Callable对象,或者注入一个Runnable对象加一个预先给定的结果  

 FutureTask类实现了RunnableFuture接口,我们看一下RunnableFuture接口的实现:   

public interface RunnableFuture<V> extends Runnable, Future<V> {
    void run();
}

  可以看出RunnableFuture继承了Runnable接口和Future接口,而FutureTask实现了RunnableFuture接口。所以它既可以作为Runnable被线程执行,又可以作为Future得到Callable的返回值。

 FutureTask提供了2个构造器:

public FutureTask(Callable<V> callable) {
   }
   public FutureTask(Runnable runnable, V result) {
   }

   事实上,FutureTask只是Future接口的实现类。

四.使用示例

 1.使用Callable+Future获取执行结果

public class Test {
    public static void main(String[] args) {
        ExecutorService executor = Executors.newCachedThreadPool();
        Task task = new Task();
        Future<Integer> result = executor.submit(task);
        executor.shutdown();
         
        try {
            Thread.sleep(1000);
        } catch (InterruptedException e1) {
            e1.printStackTrace();
        }
         
        System.out.println("主线程在执行任务");
         
        try {
            System.out.println("task运行结果"+result.get());
        } catch (InterruptedException e) {
            e.printStackTrace();
        } catch (ExecutionException e) {
            e.printStackTrace();
        }
         
        System.out.println("所有任务执行完毕");
    }
}
class Task implements Callable<Integer>{
    @Override
    public Integer call() throws Exception {
        System.out.println("子线程在进行计算");
        Thread.sleep(3000);
        int sum = 0;
        for(int i=0;i<100;i++)
            sum += i;
        return sum;
    }
}
执行结果:
子线程在进行计算
主线程在执行任务
task运行结果4950
所有任务执行完毕

2.使用Callable+FutureTask获取执行结果

   V get() 如有必要,等待计算完成,然后检索其结果。

   V get(long timeout, TimeUnit unit)

    如有必要,最多等待为使计算完成所给定的时间之后,检索其结果(如果结果可用)。

  Executor框架利用FutureTask来完成异步任务,并可以用来进行任何潜在的耗时的计算。一般FutureTask多用于耗时的计算,主线程可以在完成自己的任务后,再去获取结果。

public class TestThreadPool {
	public static void main(String[] args) {
		// 创建线程池
		ThreadPoolExecutor pool = new ThreadPoolExecutor(3, 3, 2,
				TimeUnit.SECONDS, new ArrayBlockingQueue<Runnable>(10),
				new ThreadPoolExecutor.AbortPolicy());
		List<FutureTask<String>> tasks = new ArrayList<FutureTask<String>>();
		for (int i = 0; i < 10; i++) {
			FutureTask<String> futureTask = new FutureTask<String>(
					new ThreadPoolTask(i));
			pool.submit(futureTask);
			tasks.add(futureTask);
		}	
		for (FutureTask<String> futureTask : tasks) {
			try {
				// 阻塞一直等待执行完成拿到结果
				System.out.println("future result:" + futureTask.get());
				// 阻塞一直等待执行完成拿到结果,如果在超时时间内,没有拿到则抛出异常
				// System.out.println("future result:"+futureTask.get(1,TimeUnit.SECONDS));
			} catch (InterruptedException e) {
				e.printStackTrace();
			} catch (ExecutionException e) {
				e.printStackTrace();
			} // 捕获超时异常
			// catch (TimeoutException e) {
			// e.printStackTrace();
			// }
		}		
		System.out.println("--------------------------");
	}

	/**
	 * 执行业务计算
	 */
	public static class ThreadPoolTask implements Callable<String> {
		private int value;
		public ThreadPoolTask(int value) {
			this.value = value;
		}
		@Override
		public String call() throws Exception {
			// 计算
			System.out.println("value-----" + value++);
			Thread.sleep(2000);
			return String.valueOf(value);
		}
	}
}

实例2:

public class FutureTest2 {

	public static void main(String[] args) {	
		ExecutorService executorService=Executors.newCachedThreadPool();
		Task2 task2=new Task2();
		FutureTask<Integer> futureTask=new FutureTask<Integer>(task2);
		executorService.submit(futureTask);
		executorService.shutdown();	
           System.out.println("主线程在执行任务");  
        try {
            System.out.println("task运行结果"+futureTask.get());
        } catch (InterruptedException e) {
            e.printStackTrace();
        } catch (ExecutionException e) {
            e.printStackTrace();
        }  
        System.out.println("所有任务执行完毕");	
	}
}
class Task2 implements Callable<Integer>{
    @Override
    public Integer call() throws Exception {
        System.out.println("子线程在进行计算");
        Thread.sleep(3000);
        int sum = 0;
        for(int i=0;i<100;i++)
            sum += i;
        return sum;
    }
}

CompletionService:

     如果你向Executor提交了一个批处理任务,并且希望在它们完成后获得结果。为此你可以保存与每个任务相关联的Future,然后不断地调用timeout为零的get,来检验Future是否完成。这样做固然可以,但却相当乏味。直接通过CompletionService类来实现批处理任务功能,

   CompletionService整合了Executor和BlockingQueue的功能。你可以将Callable任务提交给它去执行,然后使用类似于队列中的take和poll方法,在结果完整可用时获得这个结果,像一个打包的Future。ExecutorCompletionService是实现CompletionService接口的一个类,并将计算任务委托给一个Executor。  

    ExecutorCompletionService的实现相当直观。它在构造函数中创建一个BlockingQueue,用它去保持完成的结果。计算完成时会调用FutureTask中的done方法。当提交一个任务后,首先把这个任务包装为一个QueueingFuture,它是  FutureTask的一个子类,然后覆写done方法,将结果置入BlockingQueue中,take和poll方法委托给了BlockingQueue,它会在结果不可用时阻塞。

  CompletionService整合了Executor和BlockingQueue的功能:

1.public ExecutorCompletionService(Executor executor) {  
2.        if (executor == null)  
3.            throw new NullPointerException();  
4.        this.executor = executor;  
5.        this.aes = (executor instanceof AbstractExecutorService) ?  
6.            (AbstractExecutorService) executor : null;  
7.        this.completionQueue = new LinkedBlockingQueue<Future<V>>();  
8. }

  任务的提交和执行都是委托给Executor来完成。当提交某个任务时,该任务首先将被包装为一个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; 
}

QueueingFuture是FutureTask的一个子类,通过改写该子类的done方法,可以实现当任务完成时,将结果放入到BlockingQueue中。

1.private class QueueingFuture extends FutureTask<Void> {  
2.        QueueingFuture(RunnableFuture<V> task) {  
3.            super(task, null);  
4.            this.task = task;  
5.        }  
6.        protected void done() { completionQueue.add(task); }  
7.        private final Future<V> task;  
8.    }

   而通过使用BlockingQueue的take或poll方法,则可以得到结果。在BlockingQueue不存在元素时,这两个操作会阻塞,一旦有结果加入,则立即返回。

1.public Future<V> take() throws InterruptedException {  
2.    return completionQueue.take();  
3.}  
4.public Future<V> poll() {  
5.    return completionQueue.poll();  
6.}

代码案例:

public class Test17 {
	public static void main(String[] args) throws Exception {
		Test17 t = new Test17();
		t.count1();
		t.count2();
	}
     //使用阻塞容器保存每次Executor处理的结果,在后面进行统一处理
	public void count1() throws Exception{
		ExecutorService exec = Executors.newCachedThreadPool();
		BlockingQueue<Future<Integer>> queue = new LinkedBlockingQueue<Future<Integer>>();
		for(int i=0; i<10; i++){
			Future<Integer> future =exec.submit(getTask());
			queue.add(future);
		}
		int sum = 0;
		int queueSize = queue.size();
		for(int i=0; i<queueSize; i++){
			sum += queue.take().get();
		}
		System.out.println("总数为:"+sum);
		exec.shutdown();
	}
     //使用CompletionService(完成服务)保持Executor处理的结果
	public void count2() throws InterruptedException, ExecutionException{
		ExecutorService exec = Executors.newCachedThreadPool();
		CompletionService<Integer> execcomp = new ExecutorCompletionService<Integer>(exec);
		for(int i=0; i<10; i++){
			execcomp.submit(getTask());
		}
		int sum = 0;
		for(int i=0; i<10; i++){
              //检索并移除表示下一个已完成任务的 Future,如果目前不存在这样的任务,则等待。
			Future<Integer> future = execcomp.take();
			sum += future.get();
		}
		System.out.println("总数为:"+sum);
		exec.shutdown();
	}
	//得到一个任务
	public Callable<Integer> getTask(){
		final Random rand = new Random();
		Callable<Integer> task = new Callable<Integer>(){
			@Override
			public Integer call() throws Exception {
				int i = rand.nextInt(10);
				int j = rand.nextInt(10);
				int sum = i*j;
				System.out.print(sum+"\t");
				return sum;
			}
		};
		return task;
	}
	/**
	 * 执行结果:
		6	6	14	40	40	0	4	7	0	0	总数为:106
		12	6	12	54	81	18	14	35	45	35	总数为:312
	 */
}

 take 方获取并移除表示下一个已完成任务的 Future,如果目前不存在这样的任务,则等待。<如果需要用到返回值建议用take>

  poll 获取并移除表示下一个已完成任务的 Future,如果不存在这样的任务,则返回null。

发表评论