詳解Android中AsyncTask的使用

在Android中實現異步任務機制有兩種方式,Handler和AsyncTask。

Handler模式需要爲每一個任務創建一個新的線程,任務完成後通過Handler實例向UI線程發送消息,完成界面的更新,這種方式對於整個過程的控制比較精細,但也是有缺點的,例如代碼相對臃腫,在多個任務同時執行時,不易對線程進行精確的控制。關於Handler的相關知識,前面也有所介紹,不清楚的朋友們可以參照一下。

爲了簡化操作,Android1.5提供了工具類android.os.AsyncTask,它使創建異步任務變得更加簡單,不

再需要編寫任務線程和Handler實例即可完成相同的任務。

先來看看AsyncTask的定義:

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

三種泛型類型分別代表“啓動任務執行的輸入參數”、“後臺任務執行的進度”、“後臺計算結果的類型”。在特定場合下,並不是所有類型都被使用,如果沒有被使用,可以用java.lang.Void類型代替。

一個異步任務的執行一般包括以下幾個步驟:

1.execute(Params... params),執行一個異步任務,需要我們在代碼中調用此方法,觸發異步任務的執行。

2.onPreExecute(),在execute(Params... params)被調用後立即執行,一般用來在執行後臺任務前對UI做一些標記。

3.doInBackground(Params... params),在onPreExecute()完成後立即執行,用於執行較爲費時的操作,此方法將接收輸入參數和返回計算結果。在執行過程中可以調用publishProgress(Progress... values)來更新進度信息。

4.onProgressUpdate(Progress... values),在調用publishProgress(Progress... values)時,此方法被執行,直接將進度信息更新到UI組件上。

5.onPostExecute(Result result),當後臺操作結束時,此方法將會被調用,計算結果將做爲參數傳遞到此方法中,直接將結果顯示到UI組件上。

在使用的時候,有幾點需要格外注意:

1.異步任務的實例必須在UI線程中創建。

2.execute(Params... params)方法必須在UI線程中調用。

3.不要手動調用onPreExecute(),doInBackground(Params... params),onProgressUpdate(Progress... values),onPostExecute(Result result)這幾個方法。

4.不能在doInBackground(Params... params)中更改UI組件的信息。

5.一個任務實例只能執行一次,如果執行第二次將會拋出異常。

接下來,我們來看看如何使用AsyncTask執行異步任務操作,我們先建立一個項目,結構如下:

結構相對簡單一些,讓我們先看看MainActivity.java的代碼:

package com.scott.async;

import java.io.ByteArrayOutputStream;
import java.io.InputStream;

import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.HttpStatus;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.DefaultHttpClient;

import android.app.Activity;
import android.os.AsyncTask;
import android.os.Bundle;
import android.util.Log;
import android.view.View;
import android.widget.Button;
import android.widget.ProgressBar;
import android.widget.TextView;

public class MainActivity extends Activity {
	
	private static final String TAG = "ASYNC_TASK";
	
	private Button execute;
	private Button cancel;
	private ProgressBar progressBar;
	private TextView textView;
	
	private MyTask mTask;
	
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.main);
        
        execute = (Button) findViewById(R.id.execute);
        execute.setOnClickListener(new View.OnClickListener() {
			@Override
			public void onClick(View v) {
				//注意每次需new一個實例,新建的任務只能執行一次,否則會出現異常
				mTask = new MyTask();
				mTask.execute("http://www.baidu.com");
				
				execute.setEnabled(false);
				cancel.setEnabled(true);
			}
		});
        cancel = (Button) findViewById(R.id.cancel);
        cancel.setOnClickListener(new View.OnClickListener() {
			@Override
			public void onClick(View v) {
				//取消一個正在執行的任務,onCancelled方法將會被調用
				mTask.cancel(true);
			}
		});
        progressBar = (ProgressBar) findViewById(R.id.progress_bar);
        textView = (TextView) findViewById(R.id.text_view);
        
    }
    
    private class MyTask extends AsyncTask<String, Integer, String> {
    	//onPreExecute方法用於在執行後臺任務前做一些UI操作
    	@Override
    	protected void onPreExecute() {
    		Log.i(TAG, "onPreExecute() called");
    		textView.setText("loading...");
    	}
    	
    	//doInBackground方法內部執行後臺任務,不可在此方法內修改UI
		@Override
		protected String doInBackground(String... params) {
			Log.i(TAG, "doInBackground(Params... params) called");
			try {
				HttpClient client = new DefaultHttpClient();
				HttpGet get = new HttpGet(params[0]);
				HttpResponse response = client.execute(get);
				if (response.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
					HttpEntity entity = response.getEntity();
					InputStream is = entity.getContent();
					long total = entity.getContentLength();
					ByteArrayOutputStream baos = new ByteArrayOutputStream();
					byte[] buf = new byte[1024];
					int count = 0;
					int length = -1;
					while ((length = is.read(buf)) != -1) {
						baos.write(buf, 0, length);
						count += length;
						//調用publishProgress公佈進度,最後onProgressUpdate方法將被執行
						publishProgress((int) ((count / (float) total) * 100));
						//爲了演示進度,休眠500毫秒
						Thread.sleep(500);
					}
					return new String(baos.toByteArray(), "gb2312");
				}
			} catch (Exception e) {
				Log.e(TAG, e.getMessage());
			}
			return null;
		}
		
		//onProgressUpdate方法用於更新進度信息
		@Override
    	protected void onProgressUpdate(Integer... progresses) {
			Log.i(TAG, "onProgressUpdate(Progress... progresses) called");
			progressBar.setProgress(progresses[0]);
			textView.setText("loading..." + progresses[0] + "%");
    	}
    	
		//onPostExecute方法用於在執行完後臺任務後更新UI,顯示結果
		@Override
		protected void onPostExecute(String result) {
			Log.i(TAG, "onPostExecute(Result result) called");
			textView.setText(result);
			
			execute.setEnabled(true);
			cancel.setEnabled(false);
		}
		
		//onCancelled方法用於在取消執行中的任務時更改UI
		@Override
		protected void onCancelled() {
			Log.i(TAG, "onCancelled() called");
			textView.setText("cancelled");
			progressBar.setProgress(0);
			
			execute.setEnabled(true);
			cancel.setEnabled(false);
		}
    }
}

佈局文件main.xml代碼如下:
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:orientation="vertical"
    android:layout_width="fill_parent"
    android:layout_height="fill_parent">
    <Button
    	android:id="@+id/execute"
    	android:layout_width="fill_parent"
    	android:layout_height="wrap_content"
    	android:text="execute"/>
    <Button
    	android:id="@+id/cancel"
    	android:layout_width="fill_parent"
    	android:layout_height="wrap_content"
    	android:enabled="false"
    	android:text="cancel"/>
	<ProgressBar 
	    android:id="@+id/progress_bar" 
	    android:layout_width="fill_parent" 
	    android:layout_height="wrap_content" 
	    android:progress="0"
	    android:max="100"
	    style="?android:attr/progressBarStyleHorizontal"/>
	<ScrollView
		android:layout_width="fill_parent" 
	    android:layout_height="wrap_content">
		<TextView
			android:id="@+id/text_view"
			android:layout_width="fill_parent" 
		    android:layout_height="wrap_content"/>
	</ScrollView>
</LinearLayout>

因爲需要訪問網絡,所以我們還需要在AndroidManifest.xml中加入訪問網絡的權限:

<uses-permission android:name="android.permission.INTERNET"/>

我們來看一下運行時的界面:

以上幾個截圖分別是初始界面、執行異步任務時界面、執行成功後界面、取消任務後界面。執行成功後,整個過程日誌打印如下:

如果我們在執行任務時按下了“cancel”按鈕,日誌打印如下:

可以看到onCancelled()方法將會被調用,onPostExecute(Result result)方法將不再被調用。

上面介紹了AsyncTask的基本應用,有些朋友也許會有疑惑,AsyncTask內部是怎麼執行的呢,它執行的過程跟我們使用Handler又有什麼區別呢?答案是:AsyncTask是對Thread+Handler良好的封裝,在android.os.AsyncTask代碼裏仍然可以看到Thread和Handler的蹤跡。下面就向大家詳細介紹一下AsyncTask的執行原理。

我們先看一下AsyncTask的大綱視圖:

我們可以看到關鍵幾個步驟的方法都在其中,doInBackground(Params... params)是一個抽象方法,我們繼承AsyncTask時必須覆寫此方法;onPreExecute()、onProgressUpdate(Progress... values)、onPostExecute(Result result)、onCancelled()這幾個方法體都是空的,我們需要的時候可以選擇性的覆寫它們;publishProgress(Progress... values)是final修飾的,不能覆寫,只能去調用,我們一般會在doInBackground(Params... params)中調用此方法;另外,我們可以看到有一個Status的枚舉類和getStatus()方法,Status枚舉類代碼段如下:

        //初始狀態
	private volatile Status mStatus = Status.PENDING;
	
	public enum Status {
        /**
         * Indicates that the task has not been executed yet.
         */
        PENDING,
        /**
         * Indicates that the task is running.
         */
        RUNNING,
        /**
         * Indicates that {@link AsyncTask#onPostExecute} has finished.
         */
        FINISHED,
    }

/**
     * Returns the current status of this task.
     *
     * @return The current status.
     */
    public final Status getStatus() {
        return mStatus;
    }

可以看到,AsyncTask的初始狀態爲PENDING,代表待定狀態,RUNNING代表執行狀態,FINISHED代表結束狀態,這幾種狀態在AsyncTask一次生命週期內的很多地方被使用,非常重要。

介紹完大綱視圖相關內容之後,接下來,我們會從execute(Params... params)作爲入口,重點分析一下AsyncTask的執行流程,我們來看一下execute(Params... params)方法的代碼段:

public final AsyncTask<Params, Progress, Result> execute(Params... params) {
        if (mStatus != Status.PENDING) {
            switch (mStatus) {
                case RUNNING:
					//如果該任務正在被執行則拋出異常
					//值得一提的是,在調用cancel取消任務後,狀態仍未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)");
            }
        }
		
		//改變狀態爲RUNNING
        mStatus = Status.RUNNING;

		//調用onPreExecute方法
        onPreExecute();

        mWorker.mParams = params;
        sExecutor.execute(mFuture);

        return this;
    }

代碼中涉及到三個陌生的變量:mWorker、sExecutor、mFuture,我們也會看一下他們的廬山真面目:

關於sExecutor,它是java.util.concurrent.ThreadPoolExecutor的實例,用於管理線程的執行。代碼如下:

	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 BlockingQueue<Runnable> sWorkQueue =
            new LinkedBlockingQueue<Runnable>(10);
	//新建一個線程工廠
    private static final ThreadFactory sThreadFactory = new ThreadFactory() {
        private final AtomicInteger mCount = new AtomicInteger(1);
		//新建一個線程
        public Thread newThread(Runnable r) {
            return new Thread(r, "AsyncTask #" + mCount.getAndIncrement());
        }
    };
	//新建一個線程池執行器,用於管理線程的執行
    private static final ThreadPoolExecutor sExecutor = new ThreadPoolExecutor(CORE_POOL_SIZE,
            MAXIMUM_POOL_SIZE, KEEP_ALIVE, TimeUnit.SECONDS, sWorkQueue, sThreadFactory);

 mWorker實際上是AsyncTask的一個的抽象內部類的實現對象實例,它實現了Callable<Result>接口中的call()方法,代碼如下:

private static abstract class WorkerRunnable<Params, Result> implements Callable<Result> {
        Params[] mParams;
    }

而mFuture實際上是java.util.concurrent.FutureTask的實例,下面是它的FutureTask類的相關信息:

/**
 * A cancellable asynchronous computation.
 * ...
 */
public class FutureTask<V> implements RunnableFuture<V> {

public interface RunnableFuture<V> extends Runnable, Future<V> {
    /**
     * Sets this Future to the result of its computation
     * unless it has been cancelled.
     */
    void run();
}

可以看到FutureTask是一個可以中途取消的用於異步計算的類。

下面是mWorker和mFuture實例在AsyncTask中的體現:

    private final WorkerRunnable<Params, Result> mWorker;
    private final FutureTask<Result> mFuture;
	
	public AsyncTask() {
        mWorker = new WorkerRunnable<Params, Result>() {
            //call方法被調用後,將設置優先級爲後臺級別,然後調用AsyncTask的doInBackground方法
			public Result call() throws Exception {
                Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND);
                return doInBackground(mParams);
            }
        };

		//在mFuture實例中,將會調用mWorker做後臺任務,完成後會調用done方法
        mFuture = new FutureTask<Result>(mWorker) {
            @Override
            protected void done() {
                Message message;
                Result result = null;

                try {
                    result = get();
                } 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) {
					//發送取消任務的消息
                    message = sHandler.obtainMessage(MESSAGE_POST_CANCEL,
                            new AsyncTaskResult<Result>(AsyncTask.this, (Result[]) null));
                    message.sendToTarget();
                    return;
                } catch (Throwable t) {
                    throw new RuntimeException("An error occured while executing "
                            + "doInBackground()", t);
                }

				//發送顯示結果的消息
                message = sHandler.obtainMessage(MESSAGE_POST_RESULT,
                        new AsyncTaskResult<Result>(AsyncTask.this, result));
                message.sendToTarget();
            }
        };
    }

 我們看到上面的代碼中,mFuture實例對象的done()方法中,如果捕捉到了CancellationException類型的異常,則發送一條“MESSAGE_POST_CANCEL”的消息;如果順利執行,則發送一條“MESSAGE_POST_RESULT”的消息,而消息都與一個sHandler對象關聯。這個sHandler實例實際上是AsyncTask內部類InternalHandler的實例,而InternalHandler正是繼承了Handler,下面我們來分析一下它的代碼:

	private static final int MESSAGE_POST_RESULT = 0x1;	//顯示結果
    private static final int MESSAGE_POST_PROGRESS = 0x2;	//更新進度
    private static final int MESSAGE_POST_CANCEL = 0x3;	//取消任務

    private static final InternalHandler sHandler = new 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
					//調用AsyncTask.finish方法
                    result.mTask.finish(result.mData[0]);
                    break;
                case MESSAGE_POST_PROGRESS:
                    //調用AsyncTask.onProgressUpdate方法
					result.mTask.onProgressUpdate(result.mData);
                    break;
                case MESSAGE_POST_CANCEL:
					//調用AsyncTask.onCancelled方法
                    result.mTask.onCancelled();
                    break;
            }
        }
    }

我們看到,在處理消息時,遇到“MESSAGE_POST_RESULT”時,它會調用AsyncTask中的finish()方法,我們來看一下finish()方法的定義:

private void finish(Result result) {
        if (isCancelled()) result = null;
        onPostExecute(result);	//調用onPostExecute顯示結果
        mStatus = Status.FINISHED;	//改變狀態爲FINISHED
    }

原來finish()方法是負責調用onPostExecute(Result result)方法顯示結果並改變任務狀態的啊。

另外,在mFuture對象的done()方法裏,構建一個消息時,這個消息包含了一個AsyncTaskResult類型的對象,然後在sHandler實例對象的handleMessage(Message msg)方法裏,使用下面這種方式取得消息中附帶的對象:

AsyncTaskResult result = (AsyncTaskResult) msg.obj;  

這個AsyncTaskResult究竟是什麼呢,它又包含什麼內容呢?其實它也是AsyncTask的一個內部類,是用來包裝執行結果的一個類,讓我們來看一下它的代碼結構:

    @SuppressWarnings({"RawUseOfParameterizedType"})  
    private static class AsyncTaskResult<Data> {  
        final AsyncTask mTask;  
        final Data[] mData;  
      
        AsyncTaskResult(AsyncTask task, Data... data) {  
            mTask = task;  
            mData = data;  
        }  
    }  

看以看到這個AsyncTaskResult封裝了一個AsyncTask的實例和某種類型的數據集,我們再來看一下構建消息時的代碼:

    //發送取消任務的消息  
    message = sHandler.obtainMessage(MESSAGE_POST_CANCEL,  
            new AsyncTaskResult<Result>(AsyncTask.this, (Result[]) null));  
    message.sendToTarget();  

    //發送顯示結果的消息  
    message = sHandler.obtainMessage(MESSAGE_POST_RESULT,  
             new AsyncTaskResult<Result>(AsyncTask.this, result));  
    message.sendToTarget();  

在處理消息時是如何使用這個對象呢,我們再來看一下:

    result.mTask.finish(result.mData[0]);  

    result.mTask.onProgressUpdate(result.mData); 

概括來說,當我們調用execute(Params... params)方法後,execute方法會調用onPreExecute()方法,然後由ThreadPoolExecutor實例sExecutor執行一個FutureTask任務,這個過程中doInBackground(Params... params)將被調用,如果被開發者覆寫的doInBackground(Params... params)方法中調用了publishProgress(Progress... values)方法,則通過InternalHandler實例sHandler發送一條MESSAGE_POST_PROGRESS消息,更新進度,sHandler處理消息時onProgressUpdate(Progress... values)方法將被調用;如果遇到異常,則發送一條MESSAGE_POST_CANCEL的消息,取消任務,sHandler處理消息時onCancelled()方法將被調用;如果執行成功,則發送一條MESSAGE_POST_RESULT的消息,顯示結果,sHandler處理消息時onPostExecute(Result result)方法被調用。

經過上面的介紹,相信朋友們都已經認識到AsyncTask的本質了,它對Thread+Handler的良好封裝,減少了開發者處理問題的複雜度,提高了開發效率,希望朋友們能多多體會一下。


發佈了10 篇原創文章 · 獲贊 3 · 訪問量 8萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章