質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

87.92%

非同期処理の途中で中断する方法について

解決済

回答 2

投稿 編集

  • 評価
  • クリップ 3
  • VIEW 22K+

score 15

例えば以下のようにawait / asyncで時間のかかる処理を非同期に動かしている途中で、
キャンセルボタン等によって動作を中断して終わらせるにはどうのようにしたら良いでしょうか

private async void button_Click(object sender, EventArgs e)
{
  int intValue = await GetintValue.ToString();
}
private async Task<int> GetintValue()
{
  await //何か重い処理
  return 1;
}

重い処理は内部が隠蔽されているクラスライブラリを想定しています。

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 2

checkベストアンサー

+7

こんにちは。

async/await、Taskで「正しく」非同期キャンセルをやるなら、CancellationTokenを使います。
GetintValueメソッドに引数としてCancellationTokenを受け取るようにして、メソッド内部でIsCancellationRequestedプロパティかThrowIfCancellationRequested()メソッドを用いて途中キャンセル時のフローを構築します。
await //何か重い処理重い処理の内部で中断するには、重い処理にも再帰的にCancellationTokenを引き渡していきます。一般的な非同期ライブラリのAPIであれば、時間を要する可能性がある処理には大抵CancellationTokenを受け入れるオーバーロードが存在しています。

private async void button_Click(object sender, EventArgs e)
{
  int intValue = await GetintValue(どこかのCancellationToken).ToString();
}

private async Task<int> GetintValue(CancellationToken token)
{
  await 何か重い処理(token); // 重い処理にもtokenを渡す

  if (token.IsCancellationRequested)
    return -1; // キャンセル状態か判定して何かしたり

  token.ThrowIfCancellationRequested(); // キャンセル状態だったらいきなり例外をぶっ放して止めたり

  return 1;
}

それぞれの非同期メソッドに渡すCancellationTokenは基本的にCancellationTokenSourceから生成します。そして、CancellationTokenSourceのCancel()メソッドを呼ぶことでtokenがCanceled状態になります。

// 仮にフィールドに置く
private readonly CancellationTokenSource cts;

// ...
{
  await GetintValue(this.cts.Token); // ctsからtokenを取り出して渡す
}

// ...キャンセルボタンとか
{
  this.cts.Canel(); // どこかでCancel()メソッドを呼ぶと非同期に走っているGetintValueメソッドがキャンセルされる
}

あと、ThrowIfCancellationRequested()メソッドを用いてキャンセルする場合、非同期メソッドのTaskの状態がRunningでもCompletedでもなくCanceled状態になるため、キャンセルされたということが明確になるためオススメです。


追記

TaskではなくIAsyncActionの非同期キャンセルということだったので追記します、おそらくTaskより簡単に処理できます。(UWP関係はほぼ触ったことないので間違ってるかもしれません)

IAsyncActionインターフェースはそれ自体がCancel()メソッドを持っており、かつAwaitableになっているものです。
awaitを使って非同期メソッドのフローに組み込む前に、それ自身のキャンセル機構を呼び出せるように設計するだけで良いです。

private IAsyncInfo _asyncTask; // とりあえず非同期処理そのものを監視するための変数

{
    var scan = _adapter.ScanAsync(); // まずawaitをつけないで実行し、IAsyncActionを取得
    this._asyncTask = scan; // 先にフィールドとか外部に渡す
    await scan; // その後await
}

// ...Cancelボタン
{
    this._asyncTask?.Cancel(); // IAsyncInfoのCancel()メソッドを呼ぶだけ
}

さらに別の方法をとして、通常のTaskのように、CancellationTokenを使ったキャンセル機構に一元化したい場合に、CancellationToken.Register()メソッドを利用することもできます。
以下はもっと良い方法を教えていただいたので末尾に追記してます。

async Task GetintValue(CancellationToken token)
{
    var scan = _adapter.ScanAsync(); // まずawaitをつけないで実行
    token.Register(() => scan.Cancel()); // tokenがCancel状態になったときにScanAsyncをキャンセルするように登録
    await scan; // その後await
}

// ...Cancelボタン
{
    this.cts.Cancel(); // 普通のTaskのようにCancellationTokenSourceのCancel()メソッドを呼んでキャンセルできる
}

さらに追記
IAsyncActionをTaskとして取り扱える拡張メソッドが存在することを教えていただきました。(asmさんありがとうございます)
これを利用するとCancellationTokenを利用するキャンセル処理を自然に実装できます。async/awaitやTaskと組み合わせる場合では、これが一番良い方法だと思います。

async Task GetintValue(CancellationToken token) // 引数で受け取って
{
    await _adapter.ScanAsync().AsTask(token); // AsTaskメソッドにtokenを渡して、awaitするだけ
}

// ...Cancelボタン
{
    this.cts.Cancel(); // 普通のTaskのようにCancellationTokenSourceのCancel()メソッドを呼んでキャンセルできる
}

投稿

編集

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2018/03/08 14:43

    AsTask拡張メソッドあるんだ〜〜〜!!
    どう考えてもそれを使うべきですね!

    キャンセル

  • 2018/03/08 17:31 編集

    お二人ともありがとうございました。
    private readonly CancellationTokenSource cts;
    で宣言しているctsが、実行時にnullですと言われて少し戸惑いましたが、
    private CancellationTokenSource cts;
    としたうえで
    cts = new CancellationTokenSource();
    を挟むことによってうまくキャンセルさせられたと思います。
    この運用でも大丈夫でしたでしょうか

    キャンセル

  • 2018/03/08 18:34

    この回答のctsは、既にフィールドにセットしてあると仮定したものなので、実運用では初期化構文を使ってもコンストラクタで宣言でも、フィールドを使わずローカル変数で取り扱っても構いません。キャンセルしたいときにちゃんと参照が辿れるようになっていれば問題ないです。

    キャンセル

+2

こんにちは。

私は、terminatedフラグを用意します。初期値はfalseで中断させたい時にtrueを設定します。そして、「何か重い処理」の中で時々それをチェックし、trueだったら中断させます。

なお、terminatedフラグをtrueにした後、安易にGatintValue()の終了を待つと確実にデッドロックするので要注意です。
ケースバイケースで対処してます。なかなか一般的な解が見つかっていませんが、私はSynchronizationContextを使うことが多いです。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 87.92%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る