【Android】実行中のAsyncTaskをキャンセルする方法をサンプルコード付きで解説

Android開発では、ネットワーク通信などの時間のかかる処理をバックグラウンドで実行するためにAsyncTaskがよく利用されます。本記事では、実行中のAsyncTaskをキャンセルする方法を、実際に動作するサンプルコードとともにわかりやすく解説します。

AsyncTaskとは？

AsyncTaskは、バックグラウンドスレッド上で処理を実行し、その結果をメインスレッド（UIスレッド）に反映させるためのクラスです。バックグラウンド処理の実行中でも、ユーザーは以下のコードを使って処理をキャンセルできます。

AsynTaskExample mAsyncTask = new AsyncTaskExample();
mAsyncTask.cancel(true);

引数にtrueを渡すと、バックグラウンドスレッドに対して割り込み（interrupt）が試みられます。なお、長時間ループするような処理の場合は、doInBackground()内でisCancelled()を定期的にチェックしておくと、キャンセル要求により柔軟に対応できるのでおすすめです。

サンプルアプリの概要

ここでは、「ボタンを押すとインターネットから画像をダウンロードし、ImageViewに表示する」というシンプルなアプリを例に、ダウンロード中にタスクをキャンセルする実装方法を紹介します。

ステップ1：新規プロジェクトを作成する

Android Studioを起動し、メニューから「File」⇒「New Project」を選択します。必要な項目をすべて入力して、新しいプロジェクトを作成しましょう。

ステップ2：レイアウトファイル（res/layout/activity_main.xml）を編集する

以下のコードをactivity_main.xmlに追加します。このレイアウトには、ダウンロードを開始するButtonと、取得した画像を表示するImageViewが配置されています。

<?xml version = "1.0" encoding = "utf-8"?>
<LinearLayout xmlns:android = "https://schemas.android.com/apk/res/android"
   xmlns:tools = "https://schemas.android.com/tools"
   android:id = "@+id/rootview"
   android:layout_width = "match_parent"
   android:layout_height = "match_parent"
   android:orientation = "vertical"
   android:background = "#c1c1c1"
   android:gravity = "center_horizontal"
   tools:context = ".MainActivity">
   <Button
      android:id = "@+id/asyncTask"
      android:text = "Download"
      android:layout_width = "wrap_content"
      android:layout_height = "wrap_content" />
   <ImageView
      android:id = "@+id/image"
      android:layout_width = "300dp"
      android:layout_height = "300dp" />
</LinearLayout>

上記のコードでは、ボタンをクリックするとインターネット上のソースから画像をダウンロードし、ImageViewに表示する仕組みになっています。

ステップ3：MainActivity.javaを実装する

次に、src/MainActivity.javaに以下のコードを追加します。

package com.example.andy.myapplication;

import android.app.ProgressDialog;
import android.content.DialogInterface;
import android.graphics.Bitmap;
import android.graphics.BitmapFactory;
import android.os.AsyncTask;
import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.view.View;
import android.widget.Button;
import android.widget.ImageView;
import android.widget.Toast;
import java.io.IOException;
import java.io.InputStream;
import java.net.HttpURLConnection;
import java.net.URL;

public class MainActivity extends AppCompatActivity {
   URL ImageUrl = null;
   InputStream is = null;
   Bitmap bmImg = null;
   ImageView imageView = null;
   AsyncTaskExample asyncTask = null;
   ProgressDialog p;
   @Override
   protected void onCreate(Bundle savedInstanceState) {
      super.onCreate(savedInstanceState);
      setContentView(R.layout.activity_main);
      Button button = findViewById(R.id.asyncTask);
      imageView = findViewById(R.id.image);
      button.setOnClickListener(new View.OnClickListener() {
         @Override
         public void onClick(View v) {
            asyncTask = new AsyncTaskExample();
            asyncTask.execute("https://www.tutorialspoint.com/images/tp-logo-diamond.png");
         }
      });
   }
   private class AsyncTaskExample extends AsyncTask {
      @Override
      protected void onPreExecute() {
         super.onPreExecute();
         p = new ProgressDialog(MainActivity.this);
         p.setMessage("Please wait...It is downloading");
         p.setIndeterminate(true);
         p.setCancelable(true);
         p.setOnCancelListener(new DialogInterface.OnCancelListener() {
            @Override
            public void onCancel(DialogInterface dialog) {
               asyncTask.cancel(true);
               Toast.makeText(MainActivity.this,"AsyncTask is stopped",Toast.LENGTH_LONG).show();
            }
         });
         p.show();
      }
      @Override
      protected Bitmap doInBackground(String... strings) {
         try {
            try {
               Thread.sleep(10000);
            } catch (InterruptedException e) {
               e.printStackTrace();
            }
            ImageUrl = new URL(strings[0]);
            HttpURLConnection conn = (HttpURLConnection) ImageUrl .openConnection();
            conn.setDoInput(true);
            conn.connect();
            is = conn.getInputStream();
            BitmapFactory.Options options = new BitmapFactory.Options();
            options.inPreferredConfig = Bitmap.Config.RGB_565;
            bmImg = BitmapFactory.decodeStream(is, null, options);
         } catch (IOException e) {
            e.printStackTrace();
         }
         return bmImg;
      }
      @Override
      protected void onPostExecute(Bitmap bitmap) {
         super.onPostExecute(bitmap);
         if(imageView != null) {
            p.hide();
            imageView.setImageBitmap(bitmap);
         } else {
            p.show();
         }
      }
   }
}

ポイントは、onPreExecute()内で表示しているProgressDialogです。setCancelable(true)を設定しているため、ダイアログの外側をタップするとOnCancelListenerが呼び出され、その中でasyncTask.cancel(true)を実行してタスクを中断しています。同時に、キャンセルされたことをユーザーに伝えるToastも表示されます。

ステップ4：AndroidManifest.xmlに権限を追加する

インターネットから画像を取得するため、manifest.xmlにインターネット権限を追加します。

<?xml version = "1.0" encoding = "utf-8"?>
<manifest xmlns:android = "https://schemas.android.com/apk/res/android"
   package = "com.example.andy.myapplication">
   <uses-permission android:name = "android.permission.INTERNET"/>
   <application
      android:allowBackup = "true"
      android:icon = "@mipmap/ic_launcher"
      android:label = "@string/app_name"
      android:roundIcon = "@mipmap/ic_launcher_round"
      android:supportsRtl = "true"
      android:theme = "@style/AppTheme">
      <activity android:name = ".MainActivity">
         <intent-filter>
            <action android:name = "android.intent.action.MAIN" />
            <category android:name = "android.intent.category.LAUNCHER" />
         </intent-filter>
      </activity>
   </application>
</manifest>

上記のコードでは、インターネット上のソースから画像を取得できるよう、INTERNET権限を宣言しています。

アプリを実行して動作を確認する

それでは、実際にアプリを起動して動きを確認してみましょう。実機のAndroidスマートフォンをパソコンに接続した状態で、Android Studioでプロジェクトのアクティビティファイルを開き、ツールバーの「Run」アイコンをクリックします。接続したモバイルデバイスを選択すると、端末側に次のようなデフォルト画面が表示されます。

ボタンをクリックすると、ダウンロード中であることを示すプログレスバー（進捗ダイアログ）が表示されます。この状態でダイアログ以外の場所をタップすると、キャンセル処理が実行され、次の画面のように「AsyncTask is stopped（タスク停止）」というメッセージが表示されます。

この画面を見ると、AsyncTaskが停止され、画像がまだダウンロードされていないことが確認できます。

一方、タスクをキャンセルせずにそのまま待つと、上記のように画像のダウンロードが完了し、ImageViewに正しく表示されます。

補足：ProgressDialogは非推奨（Deprecated）

なお、本記事のサンプルで使用しているProgressDialogは、APIレベル26以降で非推奨となっています。現在のAndroid開発では、レイアウトXML内にProgressBarを配置し、表示・非表示をコードから制御する方法が推奨されています。新規プロジェクトで実装する場合は注意してください。