Java多线程研究06-带返回值的线程定义接口Callable以及Future，FutureTask的使用

Posted 2022-12-06 zczpeng

带返回值的Callable

JAVA线程相关的Runnable接口中的run()方法没有提供返回值，如下：

......
public void run() 
    ......

......

如果需要在线程A执行完成，得到返回值后，再继续执行某个业务。那么推荐使用JDK1.5中提供的带有“执行返回值”的线程定义接口：Callable。

如果还需要为多个线程的执行调度加入更复杂的控制逻辑，那么需要我们之前讨论过的同步机制和JDK1.5中java.util.concurrent.locks包中的工具配合使用，才能达到效果，下篇文章介绍。
JDK1.5的java.util.concurrent包中提供了一个Callable接口和一组相关机制，能够帮助程序员安全、快速、简洁的完成以上的功能（线程执行完成后，返回一个执行结果）。Callable接口中需要实现的接口方法为call()，这个方法有一个泛化的返回值 V，可以帮助返回定义的任何一种对象结果。接口源代码如下：

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;

下面我们通过一段简单的代码，看一下Callable接口是如何完成执行结果的返回和激活等待线程的：

package com.carsmart.test;

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;

public class CallableThreadTest 

    public static void main(String[] args) 

        MyCallableThread callableThread = new MyCallableThread(new Person("张老三", 99));
        // Callable需要在线程池中执行，还有一种方法，见下文。
        ExecutorService executor = Executors.newSingleThreadExecutor();
        Future<Person> result = executor.submit(callableThread);
        try 
            // main线程会在这里等待，直到callableThread任务执行完成
            String name = result.get().getName();
            System.out.println(name);
            // 停止线程池。
            executor.shutdown();
         catch (InterruptedException | ExecutionException e) 
            e.printStackTrace();
        
    



// 此处Callable<T>，可以放入自定义类
class MyCallableThread implements Callable<Person> 

    private Person p;

    public MyCallableThread(Person person) 
        this.p = person;
    

    @Override
    public Person call() throws Exception 
        return this.p;
    



class Person 
    public String name;
    public int age;

    public Person(String name, int age) 
        super();
        this.name = name;
        this.age = age;
    

    public String getName() 
        return name;
    

    public void setName(String name) 
        this.name = name;
    

    public int getAge() 
        return age;
    

    public void setAge(int age) 
        this.age = age;
    

    @Override
    public String toString() 
        return "\\"name\\":" + name + ", \\"age\\":" + age + "\\"";
    

运行结果：
张老三

从以上给出的使用代码，包括以下几个实际动作：
目前Callable定义的线程任务，只能放入线程池中，由线程池中的任务进行执行。没有类似于Runnable接口那样，new Thread(new MyDefindRunnable())并且start()的线程运行方式。

Future

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

Future类位于java.util.concurrent包下，它是一个接口：
　　
public interface Future
boolean cancel(boolean mayInterruptIfRunning);
boolean isCancelled();
boolean isDone();
V get() throws InterruptedException, ExecutionException;
V get(long timeout, TimeUnit unit)
throws InterruptedException, ExecutionException, TimeoutException;

解释这5个方法的作用：

1，cancel方法用来取消任务，如果取消任务成功则返回true，如果取消任务失败则返回false。参数mayInterruptIfRunning表示是否允许取消正在执行却没有执行完毕的任务，如果设置true，则表示可以取消正在执行过程中的任务。如果任务已经完成，则无论mayInterruptIfRunning为true还是false，此方法肯定返回false，即如果取消已经完成的任务会返回false；如果任务正在执行，若mayInterruptIfRunning设置为true，则返回true，若mayInterruptIfRunning设置为false，则返回false；如果任务还没有执行，则无论mayInterruptIfRunning为true还是false，肯定返回true。

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

3，isDone方法表示任务是否已经完成，若任务完成，则返回true；

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

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

　　也就是说Future提供了三种功能：
　　1）判断任务是否完成；
　　2）能够中断任务；
　　3）能够获取任务执行结果。

执行多个带返回值的任务，并取得多个返回值的代码如下：

public static void main(String[] args) 

        ExecutorService cachedThreadPool = Executors.newCachedThreadPool();
        List<Future> futureList = new ArrayList<Future>();
        for (int i = 0; i < 5; i++) 
            MyCallableThread callableThread = new MyCallableThread(new Person("留" + i + "手", 100));
            Future<Person> future = cachedThreadPool.submit(callableThread);
            futureList.add(future);
        
        //
        try 
            for (Future future : futureList) 
                System.out.println(future.get().toString());
            
         catch (InterruptedException e) 
            e.printStackTrace();
         catch (ExecutionException e) 
            e.printStackTrace();
        
    

运行结果：

FutureTask

如果你不想使用线程池管理任务的执行，又不能直接将Callable接口的任务放入Thread，那么你只能借助一个工具类：FutureTask。使用方式如下：

FutureTask<Person> futureTask = new FutureTask<Person>(callableThread);
new Thread(futureTask).start();

FutureTask既可以作为Runnable被线程执行，又可以作为Future得到Callable的返回值。

    //第一种方式
        ExecutorService executor = Executors.newCachedThreadPool();
        MyCallableThread callableThread = new MyCallableThread(new Person("留" + i + "手", 100));
        FutureTask<Person> futureTask = new FutureTask<Integer>(callableThread );
        executor.submit(futureTask);
        executor.shutdown();

   //第二种方式，注意这种方式和第一种方式效果是类似的，只不过一个使用的是ExecutorService，一个使用的是Thread
        MyCallableThread callableThread = new MyCallableThread(new Person("留" + i + "手", 100));
        FutureTask<Person> futureTask = new FutureTask<Person>(callableThread );
        Thread thread = new Thread(futureTask);
        thread.start();