AsyncTask クラス

定義

[Android.Runtime.Register("android/os/AsyncTask", DoNotGenerateAcw=true)]
[Java.Interop.JavaTypeParameters(new System.String[] { "Params", "Progress", "Result" })]
public abstract class AsyncTask : Java.Lang.Object

[<Android.Runtime.Register("android/os/AsyncTask", DoNotGenerateAcw=true)>]
[<Java.Interop.JavaTypeParameters(new System.String[] { "Params", "Progress", "Result" })>]
type AsyncTask = class
    inherit Object

継承

Object

JavaObject

Object

AsyncTask

派生

Android.OS.AsyncTask<TParams,TProgress,TResult>

属性

RegisterAttribute JavaTypeParametersAttribute

注釈

AsyncTask は、UI スレッドを適切かつ簡単に使用できるようにすることを目的としていました。 ただし、最も一般的なユース ケースは UI に統合することで、構成の変更時にコンテキスト リーク、不在着信コールバック、またはクラッシュを引き起こす可能性があります。 また、プラットフォームの異なるバージョンでの動作に矛盾があり、 doInBackgroundからの例外を飲み込み、 Executorを直接使用するよりも多くのユーティリティを提供しません。

AsyncTask は、 Thread と Handler に関するヘルパー クラスとして設計されており、汎用スレッド フレームワークを構成しません。 AsyncTasks は、短い操作 (最大で数秒) に使用することが理想的です。スレッドを長時間実行し続ける必要がある場合は、java.util.concurrent、Executor、ThreadPoolExecutorなど、FutureTask パッケージによって提供されるさまざまな API を使用することを強くお勧めします。

非同期タスクは、バックグラウンド スレッドで実行され、その結果が UI スレッドで発行される計算によって定義されます。 非同期タスクは、 Params、 Progress 、 Resultと呼ばれる 3 つのジェネリック型と、 onPreExecute、 doInBackground、 onProgressUpdate 、 onPostExecuteと呼ばれる 4 つのステップによって定義されます。

<div class="special reference"><h3>Developer Guides</h3>

タスクとスレッドの使用の詳細については、「 プロセスとスレッド」 開発者ガイドを参照してください。

</部>

<h2>Usage</h2>

AsyncTask を使用するには、サブクラス化する必要があります。 サブクラスは少なくとも 1 つのメソッド (#doInBackground) をオーバーライドし、ほとんどの場合、2 つ目のメソッド (#onPostExecute) をオーバーライドします。

サブクラス化の例を次に示します。

private class DownloadFilesTask extends AsyncTask<URL, Integer, Long> {
                protected Long doInBackground(URL... urls) {
                    int count = urls.length;
                    long totalSize = 0;
                    for (int i = 0; i < count; i++) {
                        totalSize += Downloader.downloadFile(urls[i]);
                        publishProgress((int) ((i / (float) count) * 100));
                        // Escape early if cancel() is called
                        if (isCancelled()) break;
                    }
                    return totalSize;
                }

                protected void onProgressUpdate(Integer... progress) {
                    setProgressPercent(progress[0]);
                }

                protected void onPostExecute(Long result) {
                    showDialog("Downloaded " + result + " bytes");
                }
            }

作成されると、タスクは非常に単純に実行されます。

new DownloadFilesTask().execute(url1, url2, url3);

<h2>AsyncTask のジェネリック型</h2>

非同期タスクで使用される 3 つの型は次のとおりです。

<ol><li>Params: 実行時にタスクに送信されるパラメーターの型。</li><li>Progress: バックグラウンド計算中に発行された進行状況ユニットの種類。</li><li>Result, バックグラウンド計算の結果の型.</li></ol>

すべての型が非同期タスクで常に使用されるわけではありません。 型を未使用としてマークするには、 Void型を使用します。

private class MyTask extends AsyncTask<Void, Void, Void> { ... }

<h2>4 ステップ</h2>

非同期タスクが実行されると、タスクは次の 4 つの手順を実行します。

<ol><li>#onPreExecute() タスクが実行される前に UI スレッドで呼び出されます。 この手順は、通常、タスクのセットアップに使用されます。たとえば、ユーザー インターフェイスに進行状況バーが表示されます。</li><li>#doInBackground、 #onPreExecute() の実行が完了した直後にバックグラウンド スレッドで呼び出されます。 この手順は、時間がかかる可能性があるバックグラウンド計算を実行するために使用されます。 非同期タスクのパラメーターは、この手順に渡されます。 計算の結果は、このステップによって返される必要があり、最後のステップに戻されます。 この手順では、 #publishProgress を使用して 1 つ以上の進行状況を発行することもできます。 これらの値は、 #onProgressUpdate step.< の UI スレッドで公開されます。/li><li>#onProgressUpdate。 #publishProgressの呼び出し後に UI スレッドで呼び出されます。 実行のタイミングは定義されていません。 このメソッドは、バックグラウンド計算の実行中に、ユーザー インターフェイスに任意の形式の進行状況を表示するために使用されます。 たとえば、進行状況バーをアニメーション化したり、テキスト フィールドにログを表示したりするために使用できます。</li><li>#onPostExecute。バックグラウンド計算の完了後に UI スレッドで呼び出されます。 バックグラウンド計算の結果は、parameter.< としてこのステップに渡されます。/li></ol>

<h2>タスクの実行</h2>

タスクは、 #cancel(boolean)を呼び出すことによっていつでも取り消すことができます。 このメソッドを呼び出すと、後続の呼び出しで #isCancelled() が true を返します。 このメソッドを呼び出した後、#onCancelled(Object)の代わりに#onPostExecute(Object)#doInBackground(Object[])戻った後に呼び出されます。 タスクができるだけ早く取り消されるようにするには、可能であれば (たとえばループ内で) #isCancelled()から定期的に#doInBackground(Object[])の戻り値を確認する必要があります。

<h2>スレッドルール</h2>

このクラスが正常に動作するためには、いくつかのスレッドルールに従う必要があります。

<ul><li>AsyncTask クラスは UI スレッドに読み込む必要があります。 これは、android.os.Build.VERSION_CODES#JELLY_BEAN.< の時点で自動的に行われます/li><li>タスク インスタンスは UI スレッドで作成する必要があります。</li><li>#execute は UI スレッドで呼び出す必要があります。</li><li>#onPreExecute()、#onPostExecute、#doInBackground、#onProgressUpdateを手動で呼び出さない</li><li>タスクは 1 回だけ実行できます (2 回目の実行が試行されると例外がスローされます)。</li></ul>

<h2>Memory observability</h2>

AsyncTask では、すべてのコールバック呼び出しが同期され、明示的な同期なしで次のことが保証されます。

<ul><li>AsyncTask オブジェクトの構築を含め、 #onPreExecuteのメモリ効果、および #executeの呼び出しの前に実行されたその他の何かが #doInBackgroundに表示されます。 <li>#doInBackgroundのメモリ効果は#onPostExecuteに見えます。 <li>#doInBackgroundの呼び出しの前にある#publishProgressのメモリ効果は、対応する#onProgressUpdate呼び出しに表示されます。 (ただし、#doInBackgroundは引き続き実行され、#doInBackgroundの後の更新が進行中の#onProgressUpdate呼び出しに干渉しないように注意する必要があります)。<li>#cancelの呼び出しに先行するメモリ効果は、結果として true を返す#isCancelledの呼び出しの後、または結果の#onCancelledの呼び出し中および呼び出し後に表示されます。 </ul>

<h2>実行順序</h2>

最初に導入されたとき、AsyncTasks は 1 つのバックグラウンド スレッドで順次実行されました。 android.os.Build.VERSION_CODES#DONUT以降、これはスレッドのプールに変更され、複数のタスクが並列に動作できるようになります。 android.os.Build.VERSION_CODES#HONEYCOMB以降では、並列実行によって発生する一般的なアプリケーション エラーを回避するために、タスクが 1 つのスレッドで実行されます。

本当に並列実行が必要な場合は、#executeOnExecutor(java.util.concurrent.Executor, Object[])を使用して#THREAD_POOL_EXECUTORを呼び出すことができます。

このメンバーは非推奨です。 代わりに、標準の java.util.concurrent または Kotlin コンカレンシー ユーティリティを 使用してください。

Javaドキュメント。

このページの一部は、によって作成および共有され、に記載されている条件に従って使用される作業に基づく変更です。