AsyncTaskとProgressDialogでネットワーク接続

androidにおいて, AsyncTaskでスレッドをたててネットワーク接続を行う事は良くあると思います. ただ, キャンセル処理などまで考慮すると, いろいろ考えないといけない事が多くエラーの原因となります. こういった定型ルーチンはテンプレート化しておくと便利なので, メモしておきます.

public class MyActivity extends Activity { private MyNetworkTask _task = null; @Override public void onPause(){ if(_task != null){ _task.closeDialog(); if(_task.isCancelled() == false){ _task.cancel(true); } } super.onPause(); }

順番が前後しますが, 通信タスクをonPause()でキャンセルする処理. _taskに通信用タスクを保存しておいて, ダイアログを閉じたりタスクをキャンセルしたりします. ここでダイアログを閉じなくても_task.cancelの中で呼び出される Asynctask#onCancelled で閉じるのですが, 一応年の為に. また, super.onPause()を呼び出す事を忘れない様に.

private class MyNetworkTask extends AsyncTask<String, Integer, String> { private ProgressDialog _dialog = null; @Override protected void onPreExecute(){ _dialog = new ProgressDialog(MyActivity.this); _dialog.setMessage(getResources().getText(R.string.index_loading)); _dialog.setIndeterminate(true); _dialog.setCancelable(true); _dialog.setOnCancelListener(new DialogInterface.OnCancelListener() { public void onCancel(DialogInterface dialog) { _task.cancel(false); } }); _dialog.show(); }

通信用のAsyncTaskはActivity内のprivate classとして定義しておきます. こうするとMyActivityのメンバ変数 (_task) や関数にアクセスできるので便利です. タスクの実行開始時 (onPreExecute()) はダイアログ生成して表示しています. setOnCancelListenerはbackボタンを押した時の処理です. これをいれておかないとbackボタンを押した時, ダイアログが閉じられてしまいます.

@Override protected void onProgressUpdate(Integer... progress) { if(_dialog != null && _dialog.isShowing()){ _dialog.setMessage(getResources().getText(progress[0])); }

途中経過の表示部分. 途中経過を文字を表示するようにしています. 後でもでてきますが AsyncTask#cancelを呼び出しても, AsyncTaskのスレッドが即座に停止する訳ではありません. このため, _dialogがちゃんと存在するかのチェックを入れています.

@Override protected String doInBackground(String... params) { while(isCancelled()){ } } protected void onCancelled(){ closeDialog(); _task = null; super.onCancelled(); } @Override protected void onPostExecute(String result){ closeDialog(); _task = null; } protected void closeDialog(){ if(_dialog != null && _dialog.isShowing()){ _dialog.dismiss(); _dialog = null; } }

doInBackground()がタスクの本体ですが, AsyncTask#cancelを呼び出してもタスク用スレッドが停止するのではなく, タスク終了後の処理 (onPostExecute)がキャンセルされるだけです. このため, doInBackgroundでは自分がキャンセルされていないか isCanceledでチェックする必要があります.

また, キャンセルされた場合は, onPostExecuteは呼び出されませんので, onCancelledでキャンセルされた時の後片付けを行う必要があります.