首页 > 编程语言 >FutureTask 源码解析

FutureTask 源码解析

时间:2024-12-27 14:55:15浏览次数:7  
标签:解析 UNSAFE private state 源码 static FutureTask null final

一.FutureTask继承接口

       FutureTask是Future的具体实现。FutureTask实现了RunnableFuture接口。RunnableFuture接口又同时继承了Future 和 Runnable 接口。所以FutureTask既可以作为Runnable被线程执行,又可以作为Future得到Callable的返回值。

二.FutureTask 属性

        state 其初始状态为"NEW"(新建)。任务的运行状态仅在三个方法中被转移到终止状态:setsetExceptioncancel。任务的完成过程中,状态可能会临时为"COMPLETING"(正在完成,当结果正在被设置时)或"INTERRUPTING"(仅当为了响应cancel(true)而中断运行者时)。

可能的状态转换如下:

  1. NEW -> COMPLETING -> NORMAL:从新建状态到正在完成状态,再到正常完成状态。
  2. NEW -> COMPLETING -> EXCEPTIONAL:从新建状态到正在完成状态,再到异常完成状态。
  3. NEW -> CANCELLED:从新建状态直接到取消状态。
  4. NEW -> INTERRUPTING -> INTERRUPTED:从新建状态到正在中断状态,再到中断状态。

这个状态设计允许任务在执行过程中根据不同的操作(如正常完成、异常完成、取消或中断)来更新其状态,并且确保了状态转换的效率和正确性。

 public class FutureTask<V> implements RunnableFuture<V> {

    private volatile int state;
    private static final int NEW          = 0;
    private static final int COMPLETING   = 1;
    private static final int NORMAL       = 2;
    private static final int EXCEPTIONAL  = 3;
    private static final int CANCELLED    = 4;
    private static final int INTERRUPTING = 5;
    private static final int INTERRUPTED  = 6;

 
    private Callable<V> callable;
   
    private Object outcome; 
   
    private volatile Thread runner;
 
    private volatile WaitNode waiters;


       static final class WaitNode {
        volatile Thread thread;
        volatile WaitNode next;
        WaitNode() { thread = Thread.currentThread(); }
    }
  1. 定义Unsafe实例和字段偏移量

    • private static final sun.misc.Unsafe UNSAFE;:声明一个Unsafe类型的静态最终变量,用于后续操作。

    • private static final long stateOffset;private static final long runnerOffset;private static final long waitersOffset;:声明三个长整型静态最终变量,用于存储FutureTask类中staterunnerwaiters字段的内存偏移量。

  2. 静态初始化块

    • 在静态初始化块中,首先尝试获取Unsafe实例。由于UnsafegetUnsafe()方法是受限的,通常只能在引导类加载器加载的类中调用,因此这里可能会抛出SecurityException。为了绕过这个限制,实际使用中可能需要通过反射获取Unsafe的私有构造器或私有字段来创建实例(这部分代码未展示)。

    • Class<?> k = FutureTask.class;:获取FutureTask类的Class对象。

    • 通过UNSAFE.objectFieldOffset方法获取FutureTask类中staterunnerwaiters字段的内存偏移量。这些偏移量用于后续直接通过内存地址修改这些字段的值。

 // Unsafe mechanics
    private static final sun.misc.Unsafe UNSAFE;
    private static final long stateOffset;
    private static final long runnerOffset;
    private static final long waitersOffset;
    static {
        try {
            UNSAFE = sun.misc.Unsafe.getUnsafe();
            Class<?> k = FutureTask.class;
            stateOffset = UNSAFE.objectFieldOffset
                (k.getDeclaredField("state"));
            runnerOffset = UNSAFE.objectFieldOffset
                (k.getDeclaredField("runner"));
            waitersOffset = UNSAFE.objectFieldOffset
                (k.getDeclaredField("waiters"));
        } catch (Exception e) {
            throw new Error(e);
        }
    }

三.核心方法

1.run方法

 public void run() {

        //当当前状态不是new,或者cas 操作设置成员变量thread为当前线程失败时直接返回false
        if (state != NEW ||
            !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);
                }
               //正常执行成功时,设置结果及状态
                if (ran)
                    set(result);
            }
        } finally {
            设置成员变量thread为空
            runner = null;
            int s = state;
            if (s >= INTERRUPTING)
                handlePossibleCancellationInterrupt(s);
        }
    }

2.setException()

发生异常时设置异常方法

   (1) 通过cas操作将状态由new->completing

   (2)若设置成功,则将返回结果设置为异常

       同样通过cas操作将状态更新为异常完成状态

       执行唤醒正在等待结果的阻塞线程

protected void setException(Throwable t) {
        if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
            outcome = t;
            UNSAFE.putOrderedInt(this, stateOffset, EXCEPTIONAL); // final state
            finishCompletion();
        }
    }

3.set()

正常设置结果方法

   (1) 通过cas操作将状态由new->completing

   (2)若设置成功,则将返回结果设置为正常返回值

       同样通过cas操作将状态更新为正常完成状态

       执行唤醒正在等待结果的阻塞线程

protected void set(V v) {
        if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
            outcome = v;
            UNSAFE.putOrderedInt(this, stateOffset, NORMAL); // final state
            finishCompletion();
        }
    }

4.finishcompletion()

private void finishCompletion() {
        // assert state > COMPLETING;
        for (WaitNode q; (q = waiters) != null;) {
        //设置等待waiter为空
            if (UNSAFE.compareAndSwapObject(this, waitersOffset, q, null)) {
               //循环遍历将等待线程逐个唤醒 
              for (;;) {
                    
                    Thread t = q.thread;
                    if (t != null) {
                      将每个waiter中的线程都设置为空
                        q.thread = null;
                        LockSupport.unpark(t);
                    }
                    WaitNode next = q.next;
                    if (next == null)
                        break;
                    q.next = null; // unlink to help gc
                    q = next;
                }
                break;
            }
        }

        done();

        callable = null;        // to reduce footprint
    }

5.handlePossibleCancellationInterrupt(int s)

  private void handlePossibleCancellationInterrupt(int s) {
        // It is possible for our interrupter to stall before getting a
        // chance to interrupt us.  Let's spin-wait patiently.
        if (s == INTERRUPTING)
            while (state == INTERRUPTING)
                Thread.yield(); // wait out pending interrupt

        // assert state == INTERRUPTED;

        // We want to clear any interrupt we may have received from
        // cancel(true).  However, it is permissible to use interrupts
        // as an independent mechanism for a task to communicate with
        // its caller, and there is no way to clear only the
        // cancellation interrupt.
        //
        // Thread.interrupted();
    }

6.awaitDone(boolean timed, long nanos)

private int awaitDone(boolean timed, long nanos)
        throws InterruptedException {
          
        final long deadline = timed ? System.nanoTime() + nanos : 0L;
        WaitNode q = null;
        boolean queued = false;
        for (;;) {
           //若当前线程被中断,则移除当前等待节点,抛出异常
            if (Thread.interrupted()) {
                removeWaiter(q);
                throw new InterruptedException();
            }

            int s = state;
            //当状态在完成中状态以后,意味着已经流程结束不需要等待,当waiter 不为空时设置线程为空清除节点,返回状态
            if (s > COMPLETING) {
                if (q != null)
                    q.thread = null;
                return s;
            }
//当当前状态为完成中,则当前线程让出执行,辅助流程尽快走完
            else if (s == COMPLETING) // cannot time out yet
                 Thread.yield();
      //以上都不是则新建waiter放入等待队列
            else if (q == null)
                q = new WaitNode();
            else if (!queued)
// 如果当前线程还没有被加入到等待队列,则尝试使用CAS(Compare-And-Swap)操作将当前节点加入到等
//待队列的头部
                queued = UNSAFE.compareAndSwapObject(this, waitersOffset,
                                                     q.next = waiters, q);
            else if (timed) {
//如果等待有超时时间,则计算剩余等待时间,如果超时则移除当前节点并返回状态。如果没有超时,则调用
//LockSupport.parkNanos(this, nanos)等待指定的纳秒数。
                nanos = deadline - System.nanoTime();
                if (nanos <= 0L) {
                    removeWaiter(q);
                    return state;
                }
                LockSupport.parkNanos(this, nanos);
            }
            else
//如果没有超时时间,则调用LockSupport.park(this)无限期等待,直到被唤醒。
                LockSupport.park(this);
        }
    }

7.removeWaiter(WaitNode node)

    private void removeWaiter(WaitNode node) {
        if (node != null) {
            node.thread = null;
            retry:
            for (;;) {          // restart on removeWaiter race
                for (WaitNode pred = null, q = waiters, s; q != null; q = s) {
                    s = q.next;
                    if (q.thread != null)
                        pred = q;
                    else if (pred != null) {
                        pred.next = s;
                        if (pred.thread == null) // check for race
                            continue retry;
                    }
                    else if (!UNSAFE.compareAndSwapObject(this, waitersOffset,
                                                          q, s))
                        continue retry;
                }
                break;
            }
        }
    }

8.其他简单方法

    @SuppressWarnings("unchecked")
    private V report(int s) throws ExecutionException {
        Object x = outcome;
         //如果状态为正常完成则返回结果值
        if (s == NORMAL)
            return (V)x;
       //如果非正常,则抛出异常
        if (s >= CANCELLED)
            throw new CancellationException();
        throw new ExecutionException((Throwable)x);
    }


    public FutureTask(Callable<V> callable) {
        if (callable == null)
            throw new NullPointerException();
        this.callable = callable;
        this.state = NEW;       // ensure visibility of callable
    }


    public FutureTask(Runnable runnable, V result) {
        this.callable = Executors.callable(runnable, result);
        this.state = NEW;       // ensure visibility of callable
    }

    public boolean isCancelled() {
        return state >= CANCELLED;
    }

    public boolean isDone() {
        return state != NEW;
    }

    public boolean cancel(boolean mayInterruptIfRunning) {
//当当前状态为new 根据传入值设置状态,失败直接返回false
        if (!(state == NEW &&
              UNSAFE.compareAndSwapInt(this, stateOffset, NEW,
                  mayInterruptIfRunning ? INTERRUPTING : CANCELLED)))
            return false;
        try {  
                  
            if (mayInterruptIfRunning) {
                try {
                  //设置线程中断,更新状态

                    Thread t = runner;
                    if (t != null)
                        t.interrupt();
                } finally { // final state
                    UNSAFE.putOrderedInt(this, stateOffset, INTERRUPTED);
                }
            }
        } finally {
//唤醒各个等待线程
            finishCompletion();
        }
        return true;
    }

 
    public V get() throws InterruptedException, ExecutionException {
        int s = state;
       //如果当前状态为新建,将当前线程加入等待
        if (s <= COMPLETING)
            s = awaitDone(false, 0L);
        return report(s);
    }

    public V get(long timeout, TimeUnit unit)
        throws InterruptedException, ExecutionException, TimeoutException {
        if (unit == null)
            throw new NullPointerException();
        int s = state;
      //如果当前状态为新建,将当前线程加入等待,获取状态值不是各种完成状态则抛异常
        if (s <= COMPLETING &&
            (s = awaitDone(true, unit.toNanos(timeout))) <= COMPLETING)
            throw new TimeoutException();
        return report(s);
    }

标签:解析,UNSAFE,private,state,源码,static,FutureTask,null,final
From: https://blog.csdn.net/weixin_45922312/article/details/144750877

相关文章

  • 完成这个函数,解析带符号或不带符号的整形
    fninteger64(input:&str)->IResult<&str,Token>{//map(digit1,|s:&str|Token::Number(s.parse().unwrap()))(input)}完成这个函数,解析带符号或不带符号的整形UUUUUUUUUUUUUUUUUUUUUUU为了完成integer64函数并解析带符号或不带符号的64位整数,我们需要使用......
  • 免费送源码(计算机毕业设计原创定制):Java+CSS+springboot Springboot高校医务室管理系统
    摘 要科技进步的飞速发展引起人们日常生活的巨大变化,电子信息技术的飞速发展使得电子信息技术的各个领域的应用水平得到普及和应用。信息时代的到来已成为不可阻挡的时尚潮流,人类发展的历史正进入一个新时代。在现实运用中,应用软件的工作规则和开发步骤,采用java技术建设高校......
  • 免费送源码:Java+springboot+MySQL 房屋租赁系统小程序的设计与实现 计算机毕业设计原
    目 录摘要11绪论11.1选题意义11.2开发现状11.3springboot框架介绍11.4论文结构与章节安排12 房屋租赁系统小程序系统分析32.1可行性分析32.1.1技术可行性分析32.1.2经济可行性分析32.1.3法律可行性分析32.2系统功能分析32.2.1功能性分析......
  • BitBake 执行流程深度解析:从理论到实践
    BitBake是嵌入式Linux系统开发中一个不可或缺的任务执行引擎,尤其在Yocto项目中担任核心角色。它通过解析元数据、管理任务依赖以及调度构建任务,为开发者提供了一套高度模块化、灵活且高效的工具链支持。然而,BitBake的执行流程不仅仅局限于菜谱工作流,而是构建了一个通......
  • Java 编程中 Bean、PO、POJO、VO、Entity、Model、DTO 术语全面解析对比
    术语描述特点用途BeanJava语言中可重用的组件,通常具有属性和对应的getter、setter方法等遵循JavaBean规范,具有一定的封装性和可访问性用于构建Java应用程序的各种组件,如在框架中作为配置信息的载体等PO持久化对象,通常与数据库中的表结构相对应与数据库表结构紧......
  • 新手必看——ctf六大题型介绍及六大题型解析&举例解题
    CTF(CaptureTheFlag)介绍与六大题型解析一、什么是CTF?CTF(CaptureTheFlag),意为“夺旗赛”,是一种信息安全竞赛形式,广泛应用于网络安全领域。CTF竞赛通过模拟现实中的网络安全攻防战,让参赛者以攻防对抗的形式,利用各种信息安全技术进行解决一系列安全问题,最终获得“旗......
  • springboot健身房预约管理系统-计算机设计毕业源码75535
    目录1绪论1.1选题背景与意义1.2国内外研究现状1.3论文结构与章节安排2系统分析2.1可行性分析2.1.1经济可行性2.1.2技术可行性2.1.3操作可行性2.2系统流程分析2.2.1系统开发流程2.2.2用户登录流程2.2.3系统操作流程2.2.4添加信息流程2.2.......
  • GaussDB SQL查询语句执行过程解析
    ​前沿SQL于关系型数据库而言,重要性不言而喻。就像一个乐团的指挥,指导着作品的正确演绎和节奏的和谐统一。华为云GaussDB作为新一代关系型分布式数据库,具备卓越的技术性能和行业竞争力。很多人对GaussDB的关键技术很好奇:GaussDBSQL语句到底是如何执行的?GaussDBSQL引擎原理是......
  • 2023年12月GESPC++四级真题解析
    一、单选题(每题2分,共30分)题目123456789101112131415答案ABDCCCABAADACBB1.下面有关函数参数的说法,正确的是()。A.函数参数传递时,主函数当中采用值传递方式将参数传递给子函数时,若子函数将参数值改变,主函数当中的参数值不变。B.函数参数传......
  • 源码编译基于python3的cv_bridge
    源码位于工作空间visual下的ros_cv_bridgeubuntu20.04原生python版本就是python3,故直接用下列命令编译即可:catkin_make-DPYTHON_EXECUTABLE=$(whichpython)若编译过程中出现boost报错,把CMake文件中的boost改成python3即可find_package(PythonLibs)if(PYTHONLIBS_VERS......