简单说说 FutureTask 源码

72 阅读4分钟

1: FutureTask的继承图

image.png

实现了RunnableFuture接口 RunnableFuture接口同时现实了Future与Runnable接口 继承了任务执行,取消,获取,超时等特性。

2: FutureTask的简单使用

/**
 * 继承 FutureTask<RealData>  
 * RealData为自定义返回对象
 * IFatureData 为本人自定义的获取结果的接口
 **/
public class MyFutureTask extends FutureTask<RealData> implements IFatureData {

   //接受一个Callable(当然也提供接受Runnable的构造函数) 当然 FutureTask也是一个Runnable
   //其本质是在Run中执行Callable的call
   public MyFutureTask(Callable callable) {
      super(callable);
   }

   @Override
   public Object getContent() {
      String content = null;
      try {
         content = get().getContent();
      } catch (InterruptedException e) {
         e.printStackTrace();
      } catch (ExecutionException e) {
         e.printStackTrace();
      }
      return content;
   }
}
public class Host01 {


   public IFatureData request(final int count, final char c) {
      //
      System.out.println("  request (" + count + "," + c + ")" + "begin");
      // new出来
      MyFutureTask myFutureTask = new MyFutureTask(new Callable() {
         @Override
         public RealData call() throws Exception {
            return new RealData(count, c);
         }
      });
      //因为FuturetTask本质是Runnable 每个都可以适配个Thread去执行 当然也可以由单线程串行执行
//    myFutureTask.run();
      new Thread(myFutureTask).start();
      return myFutureTask;
   }
}
public class MainTest2 {

   public static void main(String[] args) throws InterruptedException {

      Host01 host = new Host01();
      //
      IFatureData a = host.request(10, 'A');
      IFatureData b = host.request(20, 'B');
      IFatureData c = host.request(30, 'C');

      Thread.sleep(5000);
      System.out.println(a.getContent());
      System.out.println(b.getContent());
      System.out.println(c.getContent());

   }
}
public class RealData implements IFatureData {

   private final String message;

   public RealData(int count, char c) {
      System.out.println(" making realDate (" + count + "," + ") Begin");
      //
      char[] bufer = new char[count];
      for (int i = 0; i < count; i++) {
         bufer[i] = c ;
         try {
            Thread.sleep(100);
         } catch (InterruptedException e) {
            e.printStackTrace();
         }
      }
      System.out.println(" making realDate (" + count + "," + ") End");
      this.message = new String(bufer);
   }


   @Override
   public String getContent(){
      return message ;
   }
}
public interface IFatureData {

   Object getContent();
}

上述代码为FatureTask具体使用 可以看到 FatureTask本质是个Runnable 在Run中执行Call 并提供了延迟获取与取消(这里的需要也是线程级别的 不是立即生效) 关于FatureTask 取消与超时功能在这里就不提供Dome代码了

2: 浅析FutureTask源码

FutureTask 的内部状态码

image.png

内部状态流转如下 NEW -> COMPLETING -> NORMAL。 正常执行

NEW -> COMPLETING -> EXCEPTIONAL。异常了

NEW -> CANCELLED。 被取消了

NEW -> INTERRUPTING -> INTERRUPTED(使用线程级别的Thread.interrupted()中断)

我们看一个类 先从构造开始看

image.png 构造很简单 接受一个callable/runnable(转换成Callable)并把状态state转换成new

Run方法

public void run() {
    //因为可能会把同一个future封装多个Thread中执行 所以此判断为并发考虑 只会有一个线程有执行权
    if (state != NEW || 如果state状态不是new(大于new 则证明此任务正在执行中或者已取消)
        或者执行线程正在占用状态 则直接Return
        !UNSAFE.compareAndSwapObject(this, runnerOffset,
                                     null, Thread.currentThread()))
        return;
    try {
        Callable<V> c = callable; 
        //状态是初始状态 
        if (c != null && state == NEW) {
            //结果集
            V result;
            //执行状态
            boolean ran;
            try {
                result = c.call();
                ran = true;
            } catch (Throwable ex) {
                result = null;
                ran = false;
                setException(ex);
            }
            //如果执行成功调用set(cas原子更新状态 并唤醒所以挂起的获取结果线程 因为结果已经出来了)
            //下面解析set源码
            if (ran)
                set(result);
        }
    } finally {
        // runner must be non-null until state is settled to
        // prevent concurrent calls to run()
        //执行完只会通知放弃执行权(和锁有点像)
        runner = null;
        // state must be re-read after nulling runner to prevent
        // leaked interrupts
        int s = state;
        //这里不管是否执行c.call state都不可能为new 执行成功会变成NORMAL
        //catch (Throwable ex) 执行失败 外部设置了中断信号  捕捉到了 那么需要做中断处理(Cpu)
        //让出Cpu执行权
        if (s >= INTERRUPTING) 
            handlePossibleCancellationInterrupt(s);
    }
}

Set方法

protected void set(V v) {
    //CAS 更新state状态 由new改为完成中 这里就像原子声明
    if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
        //抢到了预状态 赋值 设置完成状态(最终)
        outcome = v;
        UNSAFE.putOrderedInt(this, stateOffset, NORMAL); // final state
        //因为有可能有多个线程获取同一个futureTask任务的结果 被挂起来了 组成了一个链表
        //唤醒链表中的所有线程
        finishCompletion();
    }
}

finishCompletion方法


/**
 * Removes and signals all waiting threads, invokes done(), and
 * nulls out callable.
 */
private void finishCompletion() {
    // assert state > COMPLETING;
    //遍历整个链表 waiters 为头节点
    for (WaitNode q; (q = waiters) != null;) {
    //Cas置null节点
        if (UNSAFE.compareAndSwapObject(this, waitersOffset, q, null)) {
            for (;;) {
                //拿到挂起的线程
                Thread t = q.thread;
                if (t != null) {
                    q.thread = null;
                    //使用unpark唤醒线程
                    LockSupport.unpark(t);
                }
                //拿到当前节点的next节点
                WaitNode next = q.next;
                //直到处理到最后一个 在当前这个内循环中就处理完了整个链表
                //双层for也是为并发考虑 在处理过程中又有新的thread成为 waiters
                if (next == null)
                    break;
                q.next = null; // unlink to help gc
                q = next;
            }
            break;
         
        }
    }

    done();

    callable = null;        // to reduce footprint
}

get方法 get方法普通版和超时版在代码与逻辑上大致一样 这里以get的普通版为说明

public V get() throws InterruptedException, ExecutionException {
    int s = state;
    if (s <= COMPLETING)
        //awaitDone OL指无限等待
        s = awaitDone(false, 0L);
    return report(s);
}
private int awaitDone(boolean timed, long nanos)
    throws InterruptedException {
    //计算等待时间 纳秒级别
    final long deadline = timed ? System.nanoTime() + nanos : 0L;
    WaitNode q = null;
    //此次get的线程是否为链表挂起线程 默认false
    boolean queued = false;
    for (;;) { //注意这里循环 每次循环state状态都可能会变
        //是否被打上中断标识
        if (Thread.interrupted()) {
            //如果是 那就证明不需要执行了 之前等待的结果的线程(如果有)全部唤醒 remove掉
            removeWaiter(q);
            throw new InterruptedException();
        }

        int s = state; //检查状态
        
        **这里的每个if else if 都是一次循环结果再判断**
        
        
        if (s > COMPLETING) { //这里只有可能正常完成状态/异常状态返回null 两种情况
            if (q != null)
                q.thread = null;
            return s;
        }
        //如果还是在完成中 yield 让出CPU执行权
        else if (s == COMPLETING) // cannot time out yet
            Thread.yield();
        else if (q == null) //q在第一次进入并且没有进入if (s > COMPLETING) 的时候为null 
            //说明 此线程需要挂起了 
            q = new WaitNode();
        else if (!queued)
            //走到这里则开始了CAS入队 此次循环的上一次 绝对是 q==null
            queued = UNSAFE.compareAndSwapObject(this, waitersOffset,
                                                 q.next = waiters, q);
        else if (timed) {
            //已经入队的元素开始做超时判断 //进入到这里else if 则证明已经入队成功了
            nanos = deadline - System.nanoTime();
            //如果超时 remover
            if (nanos <= 0L) {
                removeWaiter(q);
                return state;
            }
            //不然就park指定纳秒
            LockSupport.parkNanos(this, nanos); //挂起
        }
        else
            //到这里就证明 无限挂起
            LockSupport.park(this);
    }
}

FutureTask的整个源码都是围绕者state的状态变化做处理 使用阻塞链表挂起对现场环境下多同一个FutureTask的取用 在Run方法中执行成功 state的状态会由 NEW -> COMPLETING -> NORMAL。 失败会 setException NEW -> COMPLETING -> EXCEPTIONAL