以下内容摘自郭霖《第一行代码》第三版
使用AsyncTask
AsyncTask是一个抽象类,所以如果我们想使用它,就必须创建一个子类去继承它。在继承时我们可以为AsyncTask类指定3个泛型参数:
-
Params。在执行AsyncTask时需要传入的参数,可用于在后台任务中使用。
-
Progress。在后台任务执行时,如果需要在界面上显示当前的进度,则使用这里指定的泛型作为进度单位。
-
Result。当任务执行完毕后,如果需要对结果进行返回,则使用这里指定的泛型作为返回值类型。
重写AsyncTask中的几个方法才能完成对任务的定制:
-
onPreExecute()
这个方法会在后台任务开始执行之前调用,用于进行一些界面上的初始化操作,比如显示一个进度条对话框等。
-
doInBackground(Params…)
这个方法中的所有代码都会在子线程中运行,我们应该在这里去处理所有的耗时任务。任务一旦完成,就可以通过return语句将任务的执行结果返回,如果AsyncTask的第三个泛型参数指定的是Unit,就可以不返回任务执行结果。注意,在这个方法中是不可以进行UI操作的,如果需要更新UI元素,比如说反馈当前任务的执行进度,可以调用publishProgress (Progress…)方法来完成。
-
onProgressUpdate(Progress…)
当在后台任务中调用了publishProgress(Progress…)方法后,onProgressUpdate (Progress…)方法就会很快被调用,该方法中携带的参数就是在后台任务中传递过来的。在这个方法中可以对UI进行操作,利用参数中的数值就可以对界面元素进行相应的更新。
-
onPostExecute(Result)
当后台任务执行完毕并通过return语句进行返回时,这个方法就很快会被调用。返回的数据会作为参数传递到此方法中,可以利用返回的数据进行一些UI操作,比如说提醒任务执行的结果,以及关闭进度条对话框等。
完整的自定义AsyncTask:
class DownloadTask: AsyncTask<Unit, Int, Boolean>() {
// 在后台任务开始执行之前调用,用于进行一些界面上的初始化操作
override fun onPreExecute() {
progressDialog.show() // 显示进度对话框
}
// 在子线程中运行,我们应该在这里去处理所有的耗时任务
override fun doInBackground(vararg p0: Unit?) = try {
while (true){
val downloadPercent = doDownload() // 这是一个虚构方法
publishProgress(downloadPercent)
if(downloadPercent >= 100){
break
}
}
true
}catch (e: Exception){
false
}
// 当在后台任务中调用了publishProgress(Progress...)方法后,onProgressUpdate (Progress...)方法就会很快被调用,
// 该方法中携带的参数就是在后台任务中传递过来的。
override fun onProgressUpdate(vararg values: Int?) {
// 这里更新下载进度
progressDialog.setMessage("Download ${values[0]}%")
}
// 当后台任务执行完毕并通过return语句进行返回时,这个方法就很快会被调用
override fun onPostExecute(result: Boolean?) {
progressDialog.dismiss() // 关闭进度对话框
// 这里显示下载结果
if(result){
Toast.makeText(context, "Download succeeded", Toast.LENGTH_SHORT).show()
}else{
Toast.makeText(context, "Download failed", Toast.LENGTH_SHORT).show()
}
}
}
在这个DownloadTask中,我们在doInBackground()方法里执行具体的下载任务。这个方法里的代码都是在子线程中运行的,因而不会影响主线程的运行。注意,这里虚构了一个doDownload()方法,用于计算当前的下载进度并返回,我们假设这个方法已经存在了。在得到了当前的下载进度后,下面就该考虑如何把它显示到界面上了,由于doInBackground()方法是在子线程中运行的,在这里肯定不能进行UI操作,所以我们可以调用publishProgress()方法并传入当前的下载进度,这样onProgressUpdate()方法就会很快被调用,在这里就可以进行UI操作了。
当下载完成后,doInBackground()方法会返回一个布尔型变量,这样onPostExecute()方法就会很快被调用,这个方法也是在主线程中运行的。然后,在这里我们会根据下载的结果弹出相应的Toast提示,从而完成整个DownloadTask任务。
简单来说,使用AsyncTask的诀窍就是,在doInBackground()方法中执行具体的耗时任务,在onProgressUpdate()方法中进行UI操作,在onPostExecute()方法中执行一些任务的收尾工作。
如果想要启动这个任务,只需编写以下代码即可:
DownloadTask().execute()
当然,你也可以给execute()方法传入任意数量的参数,这些参数将会传递到DownloadTask的doInBackground()方法当中。
只需要调用一下publishProgress()方法,就可以轻松地从子线程切换到UI线程了。