Android
 Computer >> コンピューター >  >> プログラミング >> Android

AndroidでAsyncTaskにタイムアウトを設定する方法【サンプルコード付きで解説】

はじめに

このチュートリアルでは、AndroidアプリでAsyncTaskにタイムアウトを設定する方法を、実際に動作するサンプルコードとともに解説します。EditTextに入力した秒数だけバックグラウンド処理をスリープさせ、その間の進捗状況をProgressDialogで表示するシンプルなデモアプリを作成していきます。

実装手順

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

Android Studioを開き、メニューから「File」→「New Project」を選択します。必要な項目をすべて入力して、新しいプロジェクトを作成してください。

ステップ2:activity_main.xml にレイアウトを定義する

res/layout/activity_main.xml に以下のコードを追加します。秒数を入力するための EditText と、非同期タスクを起動する Button を配置しています。

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout
xmlns:android="https://schemas.android.com/apk/res/android"
    xmlns:tools="https://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:padding="16dp"
    tools:context=".MainActivity">
    <EditText
        android:layout_marginTop="50dp"
        android:id="@+id/enterTime"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_centerHorizontal="true"
        android:background="@android:drawable/editbox_background"
        android:inputType="number"/>
    <Button
        android:id="@+id/btnRun"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="Run Async task"
        android:layout_below="@+id/enterTime"
        android:layout_centerHorizontal="true" />
</RelativeLayout>

ステップ3:MainActivity.java にロジックを実装する

src/MainActivity.java に以下のコードを記述します。ボタンがタップされると AsyncTaskRunner が起動し、doInBackground() 内で入力された秒数分だけ Thread.sleep() により処理を一時停止します。onPreExecute() でProgressDialogを表示し、onPostExecute() で完了時にダイアログを閉じてToastを表示する構成です。

import androidx.appcompat.app.AppCompatActivity;
import android.app.ProgressDialog;
import android.os.AsyncTask;
import android.os.Bundle;
import android.view.View;
import android.widget.Button;
import android.widget.EditText;
import android.widget.Toast;
public class MainActivity extends AppCompatActivity {
    Button button;
    EditText editTextTime;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        button = findViewById(R.id.btnRun);
        editTextTime = findViewById(R.id.enterTime);
        button.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                AsyncTaskRunner runner = new AsyncTaskRunner();
                String sleepTime = editTextTime.getText().toString();
                runner.execute(sleepTime);
            }
        });
    }
    private class AsyncTaskRunner extends AsyncTask<String, String, String> {
        ProgressDialog progressDialog;
        @Override
        protected String doInBackground(String... params) {
            publishProgress("AsyncTask started...");
            String resp;
            try {
                int time = Integer.parseInt(params[0]) * 1000;
                Thread.sleep(time);
                resp = "Slept for " + params[0] + " seconds";
            }
            catch (Exception e) {
                e.printStackTrace();
                resp = e.getMessage();
            }
            return resp;
        }
        @Override
        protected void onPostExecute(String result) {
            progressDialog.dismiss();
            Toast.makeText(MainActivity.this, "AsyncTask Terminated", Toast.LENGTH_SHORT).show();
        }
        @Override
        protected void onPreExecute() {
            progressDialog = ProgressDialog.show(MainActivity.this, "ProgressDialog", "Wait for " + editTextTime.getText().toString() + " seconds");
        }
        @Override
        protected void onProgressUpdate(String... text) {
            Toast.makeText(MainActivity.this, "" + text[0], Toast.LENGTH_SHORT).show();
        }
    }
}

ステップ4:AndroidManifest.xml を確認する

androidManifest.xml に以下のコードを追加します。

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="https://schemas.android.com/apk/res/android" package="app.com.sample">
    <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>

アプリを実行してみよう

それでは、作成したアプリを実行してみましょう。ここでは、実機のAndroidスマートフォンをパソコンに接続しているものとします。Android Studioからアプリを起動するには、プロジェクト内のいずれかのアクティビティファイルを開き、ツールバーの「Run」アイコンをクリックします。デバイスを選択すると、スマートフォンの画面に以下のように表示されます。

AndroidでAsyncTaskにタイムアウトを設定する方法【サンプルコード付きで解説】

AndroidでAsyncTaskにタイムアウトを設定する方法【サンプルコード付きで解説】

補足:get() メソッドでタイムアウトを実装する

AsyncTaskには、処理の完了を指定した時間だけ待機する get(long timeout, TimeUnit unit) メソッドが用意されています。指定時間内に処理が完了しなかった場合は java.util.concurrent.TimeoutException がスローされるため、これを catch して cancel(true) を呼び出すことで、実質的なタイムアウト処理を実現できます。

try {
    // 最大5秒間だけ完了を待機する例
    String result = runner.get(5, TimeUnit.SECONDS);
} catch (TimeoutException e) {
    runner.cancel(true); // タイムアウト時にタスクをキャンセル
}

ただし、get() は呼び出し元のスレッドをブロックするため、UIスレッド上で直接呼び出すと画面が固まる点には注意が必要です。

補足:AsyncTaskとProgressDialogは非推奨

なお、AsyncTask および ProgressDialog は API レベル30(Android 11)以降で非推奨(Deprecated)となっています。新規開発では、Kotlin Coroutines や ExecutorService、WorkManager といったモダンな非同期処理の仕組みを利用することが推奨されます。一方、既存プロジェクトの保守やレガシーコードの理解においては、本記事のような基本的な使い方を押さえておくことが役立ちます。

  1. Android版Gmailの通知をカスタマイズする方法|アカウント別・ラベル別の通知音設定ガイド

    Android版のGmailアプリは、外出先でも手軽にメールをチェックできる便利なツールです。動作が速く安定しており、移動中やパソコンから離れている間も最新のメールを見逃しません。多くの方はGoogleアカウントを設定したあと、デフォルト設定のまま使っていることでしょう。それでも十分快適に活用できます。しかし、ご存知でしたか?実はAndroid版Gmailでは、アカウントごとに異なる通知音を設定したり、ラベルごとに個別の通知を設定したりできるのです。この記事では、Gmailの通知をカスタマイズする具体的な手順を詳しく解説します。通知音を変更する基本の手順デフォルトの通知音に飽きてしまったら、簡

  2. Outlook for Androidアプリでメールを設定する方法【初心者向け完全ガイド】

    Outlookは数十年にわたり、世界中の個人ユーザーや企業に愛用され続けてきた定番のメール管理ツールです。パソコンでは主要なメールクライアントとして活用している方も多いでしょうが、スマートフォンではまだ使いこなせていないという方も少なくありません。実は、AndroidスマートフォンへのOutlookの導入は非常に簡単で、わずか数分で完了します。Outlookを使えば、他のどのメールアプリよりも効率的にメールを整理できるだけでなく、スパムや悪意ある攻撃者からあなたを守るというセキュリティ面での大きなメリットも得られます。この記事では、Android端末にOutlookを設定する具体的な手順を詳し