Swift5.5での非同期処理async/awaitの追加

はじめに

Xcode13がリリースされ、Swift5.5が使用できるようになりましたね。今回はその5.5で追加されたasync/awaitが気になったので調べてみました。

async/await

Swiift5.5から新しく「async」「await」が使用できるようになり、非同期処理が追加されました。今までの非同期処理の例だと以下のような書き方をしていたのが

func download(from url: URL,
              completion: @escaping (Data) -> Void)

download(from: url) { data in
// ここで非同期に受け取った data を使う
}

こういう書き方に変わります。

func download(from url: URL) async -> Data

let data = await download(from: url)
// ここで非同期に受け取った data を使う

それでは早速使い方をみていきたいと思います。

実装

使い方としては非同期で実行したい関数にasyncを宣言することで使用できます。

func download(from url: URL) async -> Data

このように引数の宣言の後ろにasyncを付けます。関数自体にasyncキーワードを付けたことで、この関数の中は非同期なコンテキストになり、他のasyncが付いた関数を呼び出すことが可能になります。asyncが付いた関数を呼び出す際は、クロージャで完了を受け取る代わりに awaitというキーワードを付けて呼び出すことで、結果を待つことができます。実際どのような動きをするかサンプルを作成したいと思います。

シーケンス実行

例えばAPIからの戻り値を使って再度API通信を行いたいなど、非同期を連続してシーケンス実行を行いたい場合は、今までだと下記のようにコールバックを用いて行っていました。

download(from: url) { data in 
    // ここで非同期に受け取った data を使って再度非同期処理を実行 
    getImage(data) { image in
    }
}

そうすると上記のようにどんどん構造が深くなっていき、さらに非同期処理を重ねるとコールバックが連鎖していき可読性も悪く、修正も困難でした。そこで今回追加されたasync/awaitを使用すると以下のように書くことができます。

class ViewController: UIViewController {
    
    var count = 0

    override func viewDidLoad() {
        super.viewDidLoad()
    }

    override func viewWillAppear(_ animated: Bool) {
        super.viewWillAppear(animated)
        Task {
            let num = await countSummary()
            print("count=",num)
            print("countSummary end")
        }
        print("viewWillAppear end")
    }
    
    func countSummary() async -> Int {
        let a = await countUp(num: 1)
        let b = await countUp(num: 2)
        let c = await countUp(num: 3)
        let d = await countUp(num: 4)
        let e = await countUp(num: 5)
        print("SUM=", a + b + c + d + e)
        return count
    }

    func countUp(num:Int) async -> Int {
        let interval  = TimeInterval(arc4random() % 100 + 1) / 100
        Thread.sleep(forTimeInterval: interval)
        count += num
        print("num=",num)
        print("count=",count)
        return count
    }
}

一つ注意なのですが、非同期処理(asyncが宣言されていない関数)からasyncの関数を呼ぶ場合はTaskで括ってあげてください。

上記の処理を実行すると以下のようなログが出力されます。

viewWillAppear end
num= 1
count= 1
num= 2
count= 3
num= 3
count= 6
num= 4
count= 10
num= 5
count= 15
SUM= 35
count= 15
countSummary end

countSummary内でcountUpを一つづつawaitしているので上から順に実行されていることがわかります。また、コールバックで待つことなく通常の処理の書き方で書くことができ、可読性も高く良いと思います。

パラレル実行

複数の計算を非同期で並列で実行し、全ての結果をまつなどパラレルで実行したいときもあると思います。以前まではDispatchGroupeを使用してなんとか実装できていましたが、enterとleaveで管理しなくてはならず、コールバックが深くなっていくと漏れが発生する可能性が高く慎重に実装しなくてはなりませんでした。しかし、async/awaitを使用することでパラレルも簡単に実装できます。

上記のサンプルのcountSummaryを以下のように、countUpをasyncで実行し、結果をawaitで待ちます。

func countSummary() async -> Int {
    async let a = countUp(num: 1)
    async let b = countUp(num: 2)
    async let c = countUp(num: 3)
    async let d = countUp(num: 4)
    async let e = countUp(num: 5)
    print("SUM=",await a + b + c + d + e)
    return count
}

これでcountUpを並列で実行しつつ、結果をawaitで待つことができます。これを実行すると以下のようなログが出力されます。

viewWillAppear end
num= 2
count= 2
num= 3
count= 5
num= 1
count= 6
num= 4
count= 10
num= 5
count= 15
SUM= 38
count= 15
countSummary end

このようにcountUpが並列で実行されてパラレルになっているのがわかると思います。

メインスレッド問題

async/awaitを使用しても、描画の更新などはメインスレッドで行わなくてはいけないのは変わりありません。awaitで復帰する際にどのスレッドに居るかはわからないので、await後にメインスレッドにて実行が必要な処理は明示的にスレッドを指定して行わなくてはいけません。今までだとDispatchQueueを使用して以下のように書いていました。

DispatchQueue.main.async {
    // メインスレッド
}

そうするとDispatchQueue内でasync/awaitを使用するにはまたTaskを消しなくてはならないので、新しく以下のようにメインスレッド実行が可能になりました。

await MainActor.run {
    // メインスレッドで実行する処理
}

さいごに

async/await を用いて書き直したことで、コードの行数もネストの深さも減って読みやすさが向上しただけでなく、エラーハンドリングに try や throw を用いることが可能になるので、ぜひ今後もキャッチアップを続けたいと思います。

おすすめ書籍