非同期で繰り返し行っているAPI通信を、繰り返している途中でもキャンセルさせたい

Question

前提・実現したいこと

画面①でテーブルセルをタップするとAPI通信で情報を取得し、それを画面②にテーブルで表示させるアプリを作っています。
画面②に遷移すると「戻る」ボタンがあり、画面①に戻れるようになるのですが、APIレスポンスに時間がかかることが想定されているため、API通信中に戻るボタンが押された時はAPI通信を中断させたいです。

API通信は複数回行っており、forEachで引数を変えながら非同期で回っています。

該当のソースコード

// セルタップしたとき
func tableView(_ tableView: UITableView, didSelectRowAt indexPath: IndexPath) {
                
	//API通信
	let queue = DispatchQueue.global(qos: .default)
	queue.async {
		self.doMultiAsyncProcess(code: tapCode)
	}
}

// 非同期でAPI通信を行う
func doMultiAsyncProcess(code: String) {
        
	let dispatchGroup = DispatchGroup()
	let dispatchQueue = DispatchQueue(label: "queue", attributes: .concurrent)
        
	// 非同期処理を実行
	list.forEach { (value) in
		dispatchGroup.enter()
		dispatchQueue.async(group: dispatchGroup) {
			Thread.sleep(forTimeInterval: Double.random(in: 1..<2))
			// API通信開始
			self.getAPIResult(item:value, code:code)
			dispatchGroup.leave()
		}
	}
}

試したこと

forEachをbreakで抜けようかと思いましたが、出来ないことを知り断念。
forEachをfor-inで書き直し、フラグで管理しながらif文でbreak記述もしましたが、なぜかbreakしてくれず。

本当は非同期の通信を止めるか、メソッドの処理を中断などさせたいのですが、ググっても分からず。
処理のキャンセルはどうやるのが良いのでしょうか。
よろしくお願いします。

Answer 1

オペレーションキューとブロックオペレーションを使って次のようにするのはいかがでしょうか。
(listの情報がないので、一旦Intの配列で実装しています。)

BlockOperationに渡した処理の中で、キャンセル状態を監視してキャンセルされていたら自らやめるようにすれば処理のキャンセルを実現できます。

    let list = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]

    private var operationQueue: OperationQueue?

    /// 複数の処理を並列に実行する
    func doMultiAsyncProcess(code: String) {
        guard operationQueue == nil else { return }

        operationQueue = OperationQueue()

        let blockOperation = BlockOperation()
        let currentQueue = operationQueue
        blockOperation.completionBlock = {
            // 全部完了したときの処理。キャンセルした場合も呼ばれる。
            print("All process for (code) has been done.")
            // キャンセルされて次の処理が始まっていたら違うキューに変わっている
            if currentQueue == self.operationQueue {
                self.operationQueue = nil
            }
        }
        
        // 非同期処理をオペレーションに登録
        list.forEach { (value) in
            blockOperation.addExecutionBlock {
                guard !blockOperation.isCancelled else { return }
                Thread.sleep(forTimeInterval: Double.random(in: 1..<2))
                guard !blockOperation.isCancelled else { return }
                // API通信開始
                self.getAPIResult(item:value, code: code, operation: blockOperation)
            }
        }

        // 実行開始
        operationQueue?.addOperation(blockOperation)
    }

    /// 実行中の処理をキャンセルする。
    func cancellMultiAsyncProcess() {
        guard let queue = operationQueue else { return }
        print("Request cancell of the operations.")
        queue.cancelAllOperations()
        operationQueue = nil
    }
    
    /// サーバーと通信する。ダミーで単にウェイトして通信した事にする処理としています。また、キャンセルで中断するためにオペレーションも伝えています。
    func getAPIResult(item: Int, code: String, operation: Operation) {
        print("getAPIResult(item:(item), code:(code) is started.")
        Thread.sleep(forTimeInterval: Double.random(in: 1..<5))
        if operation.isCancelled {
            print("getAPIResult(item:(item), code:(code) Cancelled.")
        } else {
            print("getAPIResult(item:(item), code:(code) received a result.")
        }
    }

多分こんな感じでいいと思いますが、問題あれば教えてください。

なお、元のソースでDispatchGroupへのenter()とleave()の呼び出しは必要ありません。

追記

並列度合いを調整するには、オペレーションキューのmaxConcurrentOperationCountを使うと簡単です。
この場合は、キューが処理数を制御できるように、ひとつひとつの処理をそれぞれ別のBlockOperationに分割して登録することになります。また、こうすると全処理の完了検知にBlockOperationのcompletionを使うことができないので、かわりに、completionの処理を一つのBlockOperationとして、他の処理が終わったら実行するように設定してオペレーションキューに入れました。
このように変更したdoMultiAsyncProcessは以下のようになると思います。

    func doMultiAsyncProcess(code: String) {
        guard operationQueue == nil else { return }

        operationQueue = OperationQueue()
        // 並行処理数を3つまでに制限。
        operationQueue?.maxConcurrentOperationCount = 3
        
        // 全部が完了したら実行する処理。(キャンセルした時は呼ばれない)
        let currentQueue = operationQueue
        let completion = BlockOperation()
        completion.addExecutionBlock {
            print("All process for (code) has been done.")
            if currentQueue == self.operationQueue {
                self.operationQueue = nil
            }
        }

        // 非同期処理をオペレーションキューに登録
        list.forEach { (value) in
            var blockOperation = BlockOperation()
            blockOperation.addExecutionBlock {
                guard !blockOperation.isCancelled else { return }
                Thread.sleep(forTimeInterval: Double.random(in: 1..<2))
                guard !blockOperation.isCancelled else { return }
                // API通信開始
                self.getAPIResult(item:value, code: code, operation: blockOperation)
            }
            completion.addDependency(blockOperation)
            operationQueue?.addOperation(blockOperation)
        }
        operationQueue?.addOperation(completion)
    }

Comments

[nkrmn_a]

確かに全部の通信が同時に発生しています。
DispatchGroupは、メソッドの制御をしてほしいためです。
叩くサーバの関係上、直列にしてしまうとレスポンスが大変遅くなってしまうため並列にしております。
メソッドが実行済みなのは承知しているのですが、実行中にキャンセルする方法などはないのでしょうか…

[eytyet]

ForEachが済んでいるのを理解しつつ、breakでやめられると思ったという事ですか？

キャンセルという言葉で、具体的に何をされたいのでしょうか。通信をとめるなら、通信プロトコル上の処理の話になります。受け取った結果を処理するのをやめるなら、自分で処理しないように書くとよいです。

DispatchQueueにはキャンセル機構はありませんが、OperationQueueならキャンセルもできます。そういう意味のご質問でしょうか。

DispatchGroupについては、どのように使えているのか、私にはちゃんと理解できていないようです。すいません。よくみたら、sleep時間がランダムなので、通信順序は不定なのですね。DispatchGroupに、enter順に実行するような機能があるのでしょうか？

[nkrmn_a]

すみません、私自身どの方法でやるのが正解なのかわかっていなく、迷走した状態での質問だったので混乱させてしまいました。

処理のキャンセルというのは、私は通信であれ受け取った結果の処理であれ、メソッドの内部で動いている処理を、という風に思っていました。今書いている記述だと通信と結果の処理を同一メソッド内で行っているので、そのメソッド自体を止める方法はあるのかなと思い質問した次第です。

OperationQueueのキャンセルも調べましたが、どのような場合に向いているのか、どういう動き方をしているのか理解できなかったため、他の方法を考えていました。
OperationQueueはどのようなものなのでしょうか。この場合OperationQueueを使うのは向いているのでしょうか…。

DispatchGroupは以下のサイトを参考にしました。簡単にいうと非同期処理が全て終わった検知をしてくれています。全てのleaveが実行された後に、全非同期完了後にしたい処理を実行できます。また、sleep時間はランダムですが、通信順序というよりは通信開始のタイミングが不定です。
https://qiita.com/shtnkgm/items/d9b78365a12b08d5bde1

[nkrmn_a]

ありがとうございます！キャンセルできるようになりました。

それと重ねて質問失礼します。。(もし新しく質問立てた方がいい件でしたらそういたします）
forEachで回したblockOperationをoperationQueueに一気にaddして実行していると思います。
operationQueueでlistに入っている数ぶん一気に通信が回る（と解釈しています）ので、結構負荷が大きく動作が遅くなってしまいました。
負荷を減らすことができる方法をご存知でしたら教えていただきたいです。
負荷がかかり過ぎたらアプリが落ちる可能性などはあり得ますでしょうか…？

[eytyet]

メモリが足りなくなれば落ちると思います。
動作が遅くなってしまった、というのは、メインスレッドの動作が邪魔されるほどサブスレッドが重いということでしょうか。並列の度合いを制御したいということでしたら、OperationQueueのmaxConcurrentOperationCountを使って並列の個数を制限できます。それを使うためにブロックオペレーションを複数に分割して、completionをそれら全部にaddDependencyして一つのオペレーションとして作成して実行するという手もあるかと思います。(この場合は、キャンセル時にはcompletionが呼ばれません。)

[nkrmn_a]

並列の度合いを制御したいということです。
"completionをそれら全部にaddDependencyして"という部分がよく分かっていないのですが、複数のブロックオペレーションそれぞれ一つずつにcompletionをaddDependencyするという解釈で正しいですか？