Android AsyncTask完全解析 带你从源码的角度彻底理解
我们都知道,android ui是线程不安全的,如果想要在子线程里进行ui操作,就需要借助android的异步消息处理机制。之前我也写过了一篇文章从源码层面分析了android的异步消息处理机制。
不过为了更加方便我们在子线程中更新ui元素,android从1.5版本就引入了一个asynctask类,使用它就可以非常灵活方便地从子线程切换到ui线程,我们本篇文章的主角也就正是它了。
asynctask很早就出现在android的api里了,所以我相信大多数朋友对它的用法都已经非常熟悉。不过今天我还是准备从asynctask的基本用法开始讲起,然后我们再来一起分析下asynctask源码,看看它是如何实现的,最后我会介绍一些关于asynctask你所不知道的秘密。
asynctask的基本用法
首先来看一下asynctask的基本用法,由于asynctask是一个抽象类,所以如果我们想使用它,就必须要创建一个子类去继承它。在继承时我们可以为asynctask类指定三个泛型参数,这三个参数的用途如下:
1. params
在执行asynctask时需要传入的参数,可用于在后台任务中使用。
2. progress
后台任务执行时,如果需要在界面上显示当前的进度,则使用这里指定的泛型作为进度单位。
3. result
当任务执行完毕后,如果需要对结果进行返回,则使用这里指定的泛型作为返回值类型。
因此,一个最简单的自定义asynctask就可以写成如下方式:
class downloadtask extends asynctask<void, integer, boolean> { …… }
这里我们把asynctask的第一个泛型参数指定为void,表示在执行asynctask的时候不需要传入参数给后台任务。第二个泛型参数指定为integer,表示使用整型数据来作为进度显示单位。第三个泛型参数指定为boolean,则表示使用布尔型数据来反馈执行结果。
当然,目前我们自定义的downloadtask还是一个空任务,并不能进行任何实际的操作,我们还需要去重写asynctask中的几个方法才能完成对任务的定制。经常需要去重写的方法有以下四个:
1. onpreexecute()
这个方法会在后台任务开始执行之间调用,用于进行一些界面上的初始化操作,比如显示一个进度条对话框等。
2. doinbackground(params...)
这个方法中的所有代码都会在子线程中运行,我们应该在这里去处理所有的耗时任务。任务一旦完成就可以通过return语句来将任务的执行结果进行返回,如果asynctask的第三个泛型参数指定的是void,就可以不返回任务执行结果。注意,在这个方法中是不可以进行ui操作的,如果需要更新ui元素,比如说反馈当前任务的执行进度,可以调用publishprogress(progress...)方法来完成。
3. onprogressupdate(progress...)
当在后台任务中调用了publishprogress(progress...)方法后,这个方法就很快会被调用,方法中携带的参数就是在后台任务中传递过来的。在这个方法中可以对ui进行操作,利用参数中的数值就可以对界面元素进行相应的更新。
4. onpostexecute(result)
当后台任务执行完毕并通过return语句进行返回时,这个方法就很快会被调用。返回的数据会作为参数传递到此方法中,可以利用返回的数据来进行一些ui操作,比如说提醒任务执行的结果,以及关闭掉进度条对话框等。
因此,一个比较完整的自定义asynctask就可以写成如下方式:
class downloadtask extends asynctask<void, integer, boolean> { @override protected void onpreexecute() { progressdialog.show(); } @override protected boolean doinbackground(void... params) { try { while (true) { int downloadpercent = dodownload(); publishprogress(downloadpercent); if (downloadpercent >= 100) { break; } } } catch (exception e) { return false; } return true; } @override protected void onprogressupdate(integer... values) { progressdialog.setmessage("当前下载进度:" + values[0] + "%"); } @override protected void onpostexecute(boolean result) { progressdialog.dismiss(); if (result) { toast.maketext(context, "下载成功", toast.length_short).show(); } else { toast.maketext(context, "下载失败", toast.length_short).show(); } } }
这里我们模拟了一个下载任务,在doinbackground()方法中去执行具体的下载逻辑,在onprogressupdate()方法中显示当前的下载进度,在onpostexecute()方法中来提示任务的执行结果。如果想要启动这个任务,只需要简单地调用以下代码即可:
new downloadtask().execute();
以上就是asynctask的基本用法,怎么样,是不是感觉在子线程和ui线程之间进行切换变得灵活了很多?我们并不需求去考虑什么异步消息处理机制,也不需要专门使用一个handler来发送和接收消息,只需要调用一下publishprogress()方法就可以轻松地从子线程切换到ui线程了。
分析asynctask的源码
虽然asynctask这么简单好用,但你知道它是怎样实现的吗?那么接下来,我们就来分析一下asynctask的源码,对它的实现原理一探究竟。注意这里我选用的是android 4.0的源码,如果你查看的是其它版本的源码,可能会有一些出入。
从之前downloadtask的代码就可以看出,在启动某一个任务之前,要先new出它的实例,因此,我们就先来看一看asynctask构造函数中的源码,如下所示:
public asynctask() { mworker = new workerrunnable<params, result>() { public result call() throws exception { mtaskinvoked.set(true); process.setthreadpriority(process.thread_priority_background); return postresult(doinbackground(mparams)); } }; mfuture = new futuretask<result>(mworker) { @override protected void done() { try { final result result = get(); postresultifnotinvoked(result); } catch (interruptedexception e) { android.util.log.w(log_tag, e); } catch (executionexception e) { throw new runtimeexception("an error occured while executing doinbackground()", e.getcause()); } catch (cancellationexception e) { postresultifnotinvoked(null); } catch (throwable t) { throw new runtimeexception("an error occured while executing " + "doinbackground()", t); } } }; }
这段代码虽然看起来有点长,但实际上并没有任何具体的逻辑会得到执行,只是初始化了两个变量,mworker和mfuture,并在初始化mfuture的时候将mworker作为参数传入。mworker是一个callable对象,mfuture是一个futuretask对象,这两个变量会暂时保存在内存中,稍后才会用到它们。
接着如果想要启动某一个任务,就需要调用该任务的execute()方法,因此现在我们来看一看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) { if (mstatus != status.pending) { switch (mstatus) { case running: throw new illegalstateexception("cannot execute task:" + " the task is already running."); case finished: throw new illegalstateexception("cannot execute task:" + " the task has already been executed " + "(a task can be executed only once)"); } } mstatus = status.running; onpreexecute(); mworker.mparams = params; exec.execute(mfuture); return this; }
果然,这里的代码看上去才正常点。可以看到,在第15行调用了onpreexecute()方法,因此证明了onpreexecute()方法会第一个得到执行。可是接下来的代码就看不明白了,怎么没见到哪里有调用doinbackground()方法呢?别着急,慢慢找总会找到的,我们看到,在第17行调用了executor的execute()方法,并将前面初始化的mfuture对象传了进去,那么这个executor对象又是什么呢?查看上面的execute()方法,原来是传入了一个sdefaultexecutor变量,接着找一下这个sdefaultexecutor变量是在哪里定义的,源码如下所示:
public static final executor serial_executor = new serialexecutor(); …… private static volatile executor sdefaultexecutor = serial_executor;
可以看到,这里先new出了一个serial_executor常量,然后将sdefaultexecutor的值赋值为这个常量,也就是说明,刚才在executeonexecutor()方法中调用的execute()方法,其实也就是调用的serialexecutor类中的execute()方法。那么我们自然要去看看serialexecutor的源码了,如下所示:
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(); } } }); if (mactive == null) { schedulenext(); } } protected synchronized void schedulenext() { if ((mactive = mtasks.poll()) != null) { thread_pool_executor.execute(mactive); } } }
serialexecutor类中也有一个execute()方法,这个方法里的所有逻辑就是在子线程中执行的了,注意这个方法有一个runnable参数,那么目前这个参数的值是什么呢?当然就是mfuture对象了,也就是说在第9行我们要调用的是futuretask类的run()方法,而在这个方法里又会去调用sync内部类的innerrun()方法,因此我们直接来看innerrun()方法的源码:
void innerrun() { if (!compareandsetstate(ready, running)) return; runner = thread.currentthread(); if (getstate() == running) { // recheck after setting thread v result; try { result = callable.call(); } catch (throwable ex) { setexception(ex); return; } set(result); } else { releaseshared(0); // cancel } }
可以看到,在第8行调用了callable的call()方法,那么这个callable对象是什么呢?其实就是在初始化mfuture对象时传入的mworker对象了,此时调用的call()方法,也就是一开始在asynctask的构造函数中指定的,我们把它单独拿出来看一下,代码如下所示:
public result call() throws exception { mtaskinvoked.set(true); process.setthreadpriority(process.thread_priority_background); return postresult(doinbackground(mparams)); }
在postresult()方法的参数里面,我们终于找到了doinbackground()方法的调用处,虽然经过了很多周转,但目前的代码仍然是运行在子线程当中的,所以这也就是为什么我们可以在doinbackground()方法中去处理耗时的逻辑。接着将doinbackground()方法返回的结果传递给了postresult()方法,这个方法的源码如下所示:
private result postresult(result result) { message message = shandler.obtainmessage(message_post_result, new asynctaskresult<result>(this, result)); message.sendtotarget(); return result; }
如果你已经熟悉了异步消息处理机制,这段代码对你来说一定非常简单吧。这里使用shandler对象发出了一条消息,消息中携带了message_post_result常量和一个表示任务执行结果的asynctaskresult对象。这个shandler对象是internalhandler类的一个实例,那么稍后这条消息肯定会在internalhandler的handlemessage()方法中被处理。internalhandler的源码如下所示:
private static class internalhandler extends handler { @suppresswarnings({"unchecked", "rawuseofparameterizedtype"}) @override public void handlemessage(message msg) { asynctaskresult result = (asynctaskresult) msg.obj; switch (msg.what) { case message_post_result: // there is only one result result.mtask.finish(result.mdata[0]); break; case message_post_progress: result.mtask.onprogressupdate(result.mdata); break; } } }
这里对消息的类型进行了判断,如果这是一条message_post_result消息,就会去执行finish()方法,如果这是一条message_post_progress消息,就会去执行onprogressupdate()方法。那么finish()方法的源码如下所示:
private void finish(result result) { if (iscancelled()) { oncancelled(result); } else { onpostexecute(result); } mstatus = status.finished; }
可以看到,如果当前任务被取消掉了,就会调用oncancelled()方法,如果没有被取消,则调用onpostexecute()方法,这样当前任务的执行就全部结束了。
我们注意到,在刚才internalhandler的handlemessage()方法里,还有一种message_post_progress的消息类型,这种消息是用于当前进度的,调用的正是onprogressupdate()方法,那么什么时候才会发出这样一条消息呢?相信你已经猜到了,查看publishprogress()方法的源码,如下所示:
protected final void publishprogress(progress... values) { if (!iscancelled()) { shandler.obtainmessage(message_post_progress, new asynctaskresult<progress>(this, values)).sendtotarget(); } }
非常清晰了吧!正因如此,在doinbackground()方法中调用publishprogress()方法才可以从子线程切换到ui线程,从而完成对ui元素的更新操作。其实也没有什么神秘的,因为说到底,asynctask也是使用的异步消息处理机制,只是做了非常好的封装而已。
读到这里,相信你对asynctask中的每个回调方法的作用、原理、以及何时会被调用都已经搞明白了吧。
关于asynctask你所不知道的秘密
不得不说,刚才我们在分析serialexecutor的时候,其实并没有分析的很仔细,仅仅只是关注了它会调用mfuture中的run()方法,但是至于什么时候会调用我们并没有进一步地研究。其实serialexecutor也是asynctask在3.0版本以后做了最主要的修改的地方,它在asynctask中是以常量的形式被使用的,因此在整个应用程序中的所有asynctask实例都会共用同一个serialexecutor。下面我们就来对这个类进行更加详细的分析,为了方便阅读,我把它的代码再贴出来一遍:
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(); } } }); if (mactive == null) { schedulenext(); } } protected synchronized void schedulenext() { if ((mactive = mtasks.poll()) != null) { thread_pool_executor.execute(mactive); } } }
可以看到,serialexecutor是使用arraydeque这个队列来管理runnable对象的,如果我们一次性启动了很多个任务,首先在第一次运行execute()方法的时候,会调用arraydeque的offer()方法将传入的runnable对象添加到队列的尾部,然后判断mactive对象是不是等于null,第一次运行当然是等于null了,于是会调用schedulenext()方法。在这个方法中会从队列的头部取值,并赋值给mactive对象,然后调用thread_pool_executor去执行取出的取出的runnable对象。之后如何又有新的任务被执行,同样还会调用offer()方法将传入的runnable添加到队列的尾部,但是再去给mactive对象做非空检查的时候就会发现mactive对象已经不再是null了,于是就不会再调用schedulenext()方法。
那么后面添加的任务岂不是永远得不到处理了?当然不是,看一看offer()方法里传入的runnable匿名类,这里使用了一个try finally代码块,并在finally中调用了schedulenext()方法,保证无论发生什么情况,这个方法都会被调用。也就是说,每次当一个任务执行完毕后,下一个任务才会得到执行,serialexecutor模仿的是单一线程池的效果,如果我们快速地启动了很多任务,同一时刻只会有一个线程正在执行,其余的均处于等待状态。android照片墙应用实现,再多的图片也不怕崩溃 这篇文章中例子的运行结果也证实了这个结论。
不过你可能还不知道,在android 3.0之前是并没有serialexecutor这个类的,那个时候是直接在asynctask中构建了一个sexecutor常量,并对线程池总大小,同一时刻能够运行的线程数做了规定,代码如下所示:
private static final int core_pool_size = 5; private static final int maximum_pool_size = 128; private static final int keep_alive = 10; …… private static final threadpoolexecutor sexecutor = new threadpoolexecutor(core_pool_size,
maximum_pool_size, keep_alive, timeunit.seconds, sworkqueue, sthreadfactory);
可以看到,这里规定同一时刻能够运行的线程数为5个,线程池总大小为128。也就是说当我们启动了10个任务时,只有5个任务能够立刻执行,另外的5个任务则需要等待,当有一个任务执行完毕后,第6个任务才会启动,以此类推。而线程池中最大能存放的线程数是128个,当我们尝试去添加第129个任务时,程序就会崩溃。
因此在3.0版本中asynctask的改动还是挺大的,在3.0之前的asynctask可以同时有5个任务在执行,而3.0之后的asynctask同时只能有1个任务在执行。为什么升级之后可以同时执行的任务数反而变少了呢?这是因为更新后的asynctask已变得更加灵活,如果不想使用默认的线程池,还可以*地进行配置。比如使用如下的代码来启动任务:
executor exec = new threadpoolexecutor(15, 200, 10, timeunit.seconds, new linkedblockingqueue<runnable>()); new downloadtask().executeonexecutor(exec);
这样就可以使用我们自定义的一个executor来执行任务,而不是使用serialexecutor。上述代码的效果允许在同一时刻有15个任务正在执行,并且最多能够存储200个任务。
好了,到这里我们就已经把关于asynctask的所有重要内容深入浅出地理解了一遍,相信在将来使用它的时候能够更加得心应手。
上一篇: ASP.NET拒绝访问临时目录的解决方法