锦囊篇|一文摸懂AsyncTask

时间:2022-07-22
本文章向大家介绍锦囊篇|一文摸懂AsyncTask,主要内容包括其使用实例、应用技巧、基本知识点总结和需要注意事项,具有一定的参考价值,需要的朋友可以参考一下。

使用说明

/**
 * AsyncTask存在三个泛型类型
 * 1。Params:输入数据
 * 2。Progress:类似于用于进度更新的返回值
 * 3。Result:输出的数据
 */
public class MyTask extends AsyncTask<String, Integer, String> {

    /**
     * 后台操作
     * @param strings
     * @return
     */
    @Override
    protected String doInBackground(String... strings) {
        return null;
    }

    /**
     * 执行前的预处理
     */
    @Override
    protected void onPreExecute() {
        super.onPreExecute();
    }

    /**
     * 执行完成
     * @param s
     */
    @Override
    protected void onPostExecute(String s) {
        super.onPostExecute(s);
    }

    /**
     * 刷新得到的新更新
     * @param values
     */
    @Override
    protected void onProgressUpdate(Integer... values) {
        super.onProgressUpdate(values);
    }

    /**
     * 任务取消
     * @param s
     */
    @Override
    protected void onCancelled(String s) {
        super.onCancelled(s);
    }

    /**
     * 任务取消
     */
    @Override
    protected void onCancelled() {
        super.onCancelled();
    }
}

而Async的执行流程如下图所示

MyTask task = new MyTask();
task.execute("。。");

一般我们在代码中只用执行excute()的函数,在各个函数流程中给出相对应的操作。

对应的项目写在我的Github仓库[1]

原理分析

步骤一:构造函数

在使用期间我们是需要实例化这个对象的,那么必经的入口就是他的构造函数了。

public AsyncTask(@Nullable Looper callbackLooper) {
        // 如果callbackLooper没有自行设置,会直接使用UI线程的Handler
        mHandler = callbackLooper == null || callbackLooper == Looper.getMainLooper()
            ? getMainHandler()
            : new Handler(callbackLooper);

        mWorker = new WorkerRunnable<Params, Result>() {
            public Result call() throws Exception {
                mTaskInvoked.set(true);
                Result result = null;
                // 。。。
                // 这里出现了我必须要重写的函数!!!
                result = doInBackground(mParams);
                // 。。。
                // 把我们得到的数据传输了出去,发送到哪里呢?
                postResult(result);
                return result;
            }
        };

        mFuture = new FutureTask<Result>(mWorker) {
            @Override
            protected void done() {
                // 。。。
                // 一个一定会执行的函数
                postResultIfNotInvoked(get());
                // 。。。
            }
        };
    }
    
    private void postResultIfNotInvoked(Result result) {
        // 任务标记
        final boolean wasTaskInvoked = mTaskInvoked.get();
        // 任务为执行,则传递结果
        if (!wasTaskInvoked) {
            postResult(result);
        }
    }

在这里我看到的都是一些数据的初始化,其实就是对任务完成的出口发送消息的定义、数据如何进行传递的定义等等。

步骤二:执行 / execute()

public final AsyncTask<Params, Progress, Result> execute(Params... params) {
        return executeOnExecutor(sDefaultExecutor, params);
}

进入执行的第一句话,我们就能够看到这样一个函数,从字面意思我就能够知道了,是将数据放入了一个线程池。 为了验证我们之前所说的执行流程我们先进入executeOnExecutor ()的函数。

    public final AsyncTask<Params, Progress, Result> executeOnExecutor(Executor exec,
            Params... params) {
        // 。。。。
        // 验证了最开始的使用流程,excute执行后,调用的是onPreExecute
        onPreExecute();
        // 开始对任务进行了处理
        mWorker.mParams = params;
        exec.execute(mFuture);

        return this;
    }

回到我们的执行流程中,我们还没有了解我们用的线程池他是怎样的? 通过不断的函数调用,我们能够找到这样的一个线程池内部类。

    private static class SerialExecutor implements Executor {
        final ArrayDeque<Runnable> mTasks = new ArrayDeque<Runnable>();
        Runnable mActive;

        public synchronized void execute(final Runnable r) {
           mTasks.offer(new Runnable() {
                public void run() {
                    try {
                        r.run();
                    } finally {
                        scheduleNext(); // 1
                    }
                }
            });
            if (mActive == null) {
                scheduleNext(); // 1
            }
        }

        protected synchronized void scheduleNext() {
            // 从任务队列中取出一个任务
            if ((mActive = mTasks.poll()) != null) {
                // 出现了另外一个线程池来进行执行????
                THREAD_POOL_EXECUTOR.execute(mActive);
            }
        }
    }

其他我们先并不予以关注,你是否看到了scheduleNext()这个一定会被调用的函数呢?而且里面又出现了一个线程池。原来这个 THREAD_POOL_EXECUTOR变量才是真正的执行动作的线程池,那怎么去看待上面的那个线程池呢?其实mTasks这个变量已经告诉我们答案了,他是一个任务存储的队列,并且execute()是一个同步函数,所以 SerialExecutor确切的说是一个进行按序任务调度的线程池。这样也就证实了在很多博客中会说AsyncTask是一个由两个线程池和一个Handler组成的。

调用顺序的验证

前面讲过了execute()后面调用的函数是onPreExecute()。而接下来的步骤就是doInBackground(),回到先前的execute()的代码中,我们知道会出现下面的代码

exec.execute(mFuture); 

// 上方操作调用的函数
public static void execute(Runnable runnable) {
    sDefaultExecutor.execute(runnable);
}

我们已经讲过了sDefaultExecutor他是一个任务调度的线程池,他会将任务发送给THREAD_POOL_EXECUTOR进行完成,而他完成的mFuture其实也是一个全局变量,我在构造函数中已经提到过了。

mWorker = new WorkerRunnable<Params, Result>() {
            public Result call() throws Exception {
                mTaskInvoked.set(true);
                Result result = null;
                try {
                    Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND);
                    // 由线程池执行完成时,用于回调的借口
                    result = doInBackground(mParams);
                    Binder.flushPendingCommands();
                } catch (Throwable tr) {
                    mCancelled.set(true);
                    throw tr;
                } finally {
                    postResult(result);
                }
                return result;
            }
        };

        mFuture = new FutureTask<Result>(mWorker) {
            @Override
            protected void done() {
                try {
                    postResultIfNotInvoked(get());
                } catch (InterruptedException e) {
                    android.util.Log.w(LOG_TAG, e);
                } catch (ExecutionException e) {
                    throw new RuntimeException("An error occurred while executing doInBackground()",
                            e.getCause());
                } catch (CancellationException e) {
                    postResultIfNotInvoked(null);
                }
            }
        };

这里给读者们看个全貌,作为最后的回调接口中,我们是否已经关注到了一个函数doInBackground()这个函数呢? 目前为止我们已经完成了前三步,就差最后的一步onPostExecute()的执行出现了,其实在上文就已经提到过了postResult(result)这段代码,就是进行一个结果的提交也就对应着我们所说的onPostExecute()。 我们通过深入了解可以知道,就是通过Handler将一个数据传出去,这个时候既然结束了,那就对应的是一个finish()函数。

private static class InternalHandler extends Handler {
        public InternalHandler(Looper looper) {
            super(looper);
        }

        @SuppressWarnings({"unchecked", "RawUseOfParameterizedType"})
        @Override
        public void handleMessage(Message msg) {
            AsyncTaskResult<?> result = (AsyncTaskResult<?>) msg.obj;
            switch (msg.what) {
                case MESSAGE_POST_RESULT:
                    // 任务结束,返回数据。
                    result.mTask.finish(result.mData[0]);
                    break;
                case MESSAGE_POST_PROGRESS:
                    // 得到了publish的操作,来到这里操作数据。
                    result.mTask.onProgressUpdate(result.mData);
                    break;
            }
        }
    }
// 被调用的finish函数
private void finish(Result result) {
        if (isCancelled()) {
            onCancelled(result);
        } else {
            onPostExecute(result);
        }
        mStatus = Status.FINISHED;
    }

到这里,我们完完整整的验证了执行的流程。

总结

Q1:为什么AsyncTask会引发内存泄漏问题?

A1:其实这个问题一个方面和Handler同理,如果采用了UI线程中的Looper作为消息暂存的空间,那Activity被销毁时同样的会因为消息没有没执行而发生内存泄漏。具体的分析见于锦囊篇|一文摸懂Handler[2]

另一个方面就是关于线程池的创建,public static final Executor THREAD_POOL_EXECUTOR;,你能够看到是一个静态的变量,那么即便当Activity被销毁时,还在运行的线程任务是不会被暂停的,这也就是造成了内存泄漏的第二个原因了。

参考资料

[1] Github仓库: https://github.com/ClericYi/MoNiAsyncTask

[2] 锦囊篇|一文摸懂Handler: https://juejin.im/post/5e4fa55f6fb9a07cb427d081