Android学习之AsyncTask

矫情吗；* 2023-07-03 10:33 23阅读 0赞

# 1. 定义 #

1.  AsyncTask是一个抽象类，查询源码可以得到，其中只有一个抽象方法`doInBackground()`，所以继承AsyncTask需要实现该方法。

public abstract class AsyncTask<Params, Progress, Result> { 
    	protected abstract Result doInBackground(Params... var1);
    }

通过`Android Studio`查看源码，可以发现其提示非常明显：（此处感慨一下，`Android studio`确实十分好用）  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4Mjk1NTEx_size_16_color_FFFFFF_t_70_pic_center]上面只截图了一部分的源码，从图中可以看出，其中必须实现的抽象方法`doInBackground()`前面标识着`WorkerThread`，表示该方法是运行在工作线程中；而其他的一些方法前面标识着`MainThread`，则表示运行在UI线程中，也就意味着这些方法能够控制UI （**敲重点！要考的！**）

1.  我们再来看看`AsyncTask`类

public abstract class AsyncTask<Params, Progress, Result> { 
    }

可以看到，`AsyncTask`有三个参数:

*  `Params`：表示启动任务时需要的参数类型
 *  `Progress`：表示任务运行过程中返回进度值的类型
 *  `Result` ：表示后台执行任务完成后返回结果的类型  
    暂时对这三个参数有这么一个了解即可，下面会结合实例代码进行解释。

1.  优点  
    封装，简化异步操作：  
    封装了使用Thread + Handler进行ui的更新、数据的传递操作等等。

# 2.重点方法介绍 #

先来一张方法调用顺序图：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4Mjk1NTEx_size_16_color_FFFFFF_t_70_pic_center 1]

1.  `execute`  
    在源码中，可以看到`execute`的重载方法：

public final AsyncTask<Params, Progress, Result> execute(Params... params) { 
           throw new RuntimeException("Stub!");
    }
    public static void execute(Runnable runnable) { 
    	   throw new RuntimeException("Stub!");
    }

其中可以看到第一个方法的参数类型为`Params`，结合第一点关于类参数的描述可以知道，当调用`execute`执行耗时任务时，传入的参数即是类定义声明的参数类型；并且`execute`会将参数传入`doInbackground`中。

1.  `onPreExecute`

protected void onPreExecute() { 
        throw new RuntimeException("Stub!");
    }

执行后台耗时操作之前调用，通常用户完成一些初始化操作。

1.  `doInBackground()`

protected abstract Result doInBackground(Params... var1);

`doInBackground`方法，是`AsyncTask`进行任务执行的方法，即是进行耗时操作执行的地方。从源码的截图可以看到，其运行在工作线程中，不会阻塞到主线程。  
其中，该方法的参数列表可以看到是一个数组参数，而且类型是类定义参数中的`Params`，该参数列表即是调用`execute`时传入的参数列表。  
并且，可以发现，该函数的返回值类型为`Result`类型，结合类定义类型参数中的`Result`可以知道，其返回值即是任务执行后需要返回的结果；并且当该函数执行完成后，会将返回结果传递给`onPostExecute`。

1.  `onPostExecute(Result result)`

protected void onPostExecute(Result result) { 
        throw new RuntimeException("Stub!");
    }

可以看到，该函数的参数为`Result`，其接收的内容即是`doInBackground`函数的返回内容。  
一般在这里，我们完成了异步操作，于是进行一些UI的最终结果更新、展示。

1.  `onProgressUpdate(Progress... values)`和`publishProgress(Progress... values)`

protected void onProgressUpdate(Progress... values) { 
    	throw new RuntimeException("Stub!");
    }
    protected final void publishProgress(Progress... values) { 
        throw new RuntimeException("Stub!");
    }

这两个方法是*心心相依滴！*  
![在这里插入图片描述][20200205162015565.png]![在这里插入图片描述][20200205162003918.png]  
这两个 方法主要用于更新进度信息。其中，由上图源码提示可知：`publishProgress`方法是运行在工作线程的，而`onProgressUpdate`方法则是运行在主线程中。  
由上面的流程图可以看到，通过`doInBackground`方法调用`publishProgress`方法，将进度信息传递给`onProgressUpdate`方法，而后在`onProgressUpdate`进行UI的更新。

1.  `cancel`和`isCanceled`

public final boolean cancel(boolean mayInterruptIfRunning) { 
        throw new RuntimeException("Stub!");
    }
    public final boolean isCancelled() { 
        throw new RuntimeException("Stub!");
    }

这里要着重介绍一下`cancel`方法！！！**敲重点！要考的！**  
`cancel`方法从字面上可以理解，就是取消，即是停止了`AsyncTask`的任务了。但是 **!!!**，通过实际的代码编写以及了解了`AsyncTask`的设计机制，得出：

原来，当`AsyncTask`调用`cancel`方法后，并不会直接的去强制停止工作线程的运行，而只是对该`AsyncTask`标记了一个为**cancelled**的状态。  
所以，如果只是简单的调用了`cancel`函数，并不会直接就停止了线程的运行。  
所以，想要通过`cancel`结束任务，需要自行进行编码判断。  
利用`isCancelled`函数，可以随时得到当前`AsyncTask`的状态是否已经被`cancelled`了，然后决定是否继续运行耗时任务。

# 3.实例展示 #

/** * 主要展示进度的显示与UI的更新，以及cancel的操作 */
    public class ProgressBarActivity extends AppCompatActivity { 
        ProgressBar progressBar;
        MyAsyncTask myAsyncTask;
        @Override
        protected void onCreate(Bundle savedInstanceState) { 
            super.onCreate(savedInstanceState);
            setContentView(R.layout.activity_progress_bar);
    
            progressBar = (ProgressBar)findViewById(R.id.progressBar);
            myAsyncTask = new MyAsyncTask();
            myAsyncTask.execute(); //实例化，并调用execute
        }
    
        /** * 退出页面的时候，将其cancel掉 */
        @Override
        protected void onPause() { 
            super.onPause();
            if(myAsyncTask != null){ 
                if(myAsyncTask.getStatus() == AsyncTask.Status.RUNNING){ 
                    myAsyncTask.cancel(true);
                }
            }
        }
    
        private class MyAsyncTask extends AsyncTask<Void, Integer, Void>{ 
    
            @Override
            protected void onProgressUpdate(Integer... values) { 
                super.onProgressUpdate(values);
                if(!isCancelled()){  //通过是否为cancel状态，决定是否进行下一步
                    progressBar.setProgress(values[0]);
                }
            }
    
            @Override
            protected Void doInBackground(Void... voids) { 
                for(int i=0;i<100;i++){ 
                    if(!isCancelled()){  //通过是否为cancel状态，决定是否进行下一步
                        publishProgress(i);
                        try { 
                            Thread.sleep(300);//模拟耗时操作
                        } catch (InterruptedException e) { 
                            e.printStackTrace();
                        }
                    }else{ 
                        break;
                    }
                }
                return null;
            }
        }
    }

相信上面的代码还是比较简单的，可以在我的 [Github][] 上面看一下我学习过程中写的三个小样例。

# 4.注意事项 #

1.  必须在UI线程中创建AsyncTask的实例
2.  必须在UI线程中调用AsyncTask的execute()方法
3.  重写的四个方法是系统自动调用的， 不应手动调用
4.  每一个AsyncTask只能被执行一次，多次调用将会引发异常

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4Mjk1NTEx_size_16_color_FFFFFF_t_70_pic_center]: https://img-blog.csdnimg.cn/20200205142959194.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4Mjk1NTEx,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4Mjk1NTEx_size_16_color_FFFFFF_t_70_pic_center 1]: https://img-blog.csdnimg.cn/20200205160119620.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM4Mjk1NTEx,size_16,color_FFFFFF,t_70#pic_center
[20200205162015565.png]: https://img-blog.csdnimg.cn/20200205162015565.png
[20200205162003918.png]: https://img-blog.csdnimg.cn/20200205162003918.png
[Github]: https://github.com/shuhaoLIN/LearningAsyncTask