SwiftUIでスリープ機能を実装しよう

スリープ処理は難しい

アプリを開発しているうえで必要になってくるのが、なにか重い処理をしたときにそれが外部端末あるいはサーバに負荷がかかることを防ぐために短期間での同時アクセスをしないようにするという仕組みである。

アプリ自体がアプリ自体に重い処理をさせるのであればどこにも迷惑をかけないのでいいのだが、外部サーバに大量にリクエストを投げていては困るというわけである。

なので例えばサーバに何かを問い合わせる処理 A は 5 秒おきにしか実行しないというような場合を考えよう。つまり、A を行ってから 5 秒間は何もしないという動作が欲しいのである。

この仕様を満たすアプリを設計するためのコードの書き方について解説する。

スレッドを理解する

Swift ではmainスレッドとglobalスレッドの二つが存在する。

mainスレッドではMain Queueのみが実行され、globalスレッドではGlobal Queueだけが実行される。どちらのスレッドに処理（Queue）を追加するかは基本的にシステムが自動的に行なってくれるのだがDispatchQueueを指定することで任意のスレッドに処理を渡すことができる。

Global Queueには実行優先度があり、高い方から順にhigh、default、low、backgroundとなっている。

ただし、これらの実行優先度を直接指定することはなく、普通は Enum を使って指定する :w

userInteractive

UI の更新など、即座にタスクが実行されてほしい場合に利用する。

userInitiated

ボタンのタップなどで非同期に処理をする場合に利用する。優先度highが割り当てられる。

default

デフォルトの優先度。

utility

プログレスバーや、計算処理、ダウンロード処理などで使う。

background

すぐには利用しないデータのプリフェッチなどで使う。

unspecified

特筆すべき優先度がないことを示す。システム側で自動的に優先度が割り当てられる。

さまざまなスリープ処理

Swift にはさまざまなスリープ処理があるのだが、まずは単にスリープ処理を入れることだけを考えてみる。

これは自分も含め、初学者がよく引っかかってしまうトラップになっているので備忘録として残しておきたい。

今回はテストアプリとして、ボタンを押すと 1 秒おきに時刻を取得し、それをリストとしてリアルタイムで反映させるものを考えよう。

プログラムとしてはひどく基本的なものなのでコード自体の詳しい解説は割愛する。

sleep を使う

Swift には標準でsleepコマンドがあるのでそれを利用する。

1
import SwiftUI
2

3
struct ContentView: View {
4
    @State var dateList: [String] = []
5
    var body: some View {
6
        List {
7
            ForEach(dateList, id:\.self) { date in
8
                Text(date)
9
            }
10
        }
11
        Button(action: { runDispatchQueue() }, label: {
12
            Text("Run")
13
        })
14
    }
15

16
    private func runDispatchQueue() {
17
        for _ in 0 ..< 10 {
18
            dateList.append("\(Date().description) on \(Thread.current.isMainThread)")
19
            sleep(1)
20
        }
21
    }
22
}

ところがこのコードは想定通りの動作をしない。というのもrunDispatchQueueがメインスレッドで実行されてしまうからだ。

つまり、sleep(1)はメインスレッドを 1 秒間停止するという意味になり、それを 10 回繰り返すのでトータル 10 秒間メインスレッドが停止してしまう。

メインスレッドが停止するということは画面の再描画がされないのでフリーズしたような状態になってしまうことを意味する。更に「処理 ->1 秒停止」なので処理中はメインスレッドが動いているため画面の再描画がされそうな気もするのだが、実際にはされないことにも注意しよう。

Thread.sleep を使う

ではsleepではなくThread.sleepを使ってみてはどうかということになるが、これも結局rundDispatchQueue()がメインスレッドで実行されているのでメインスレッドが止まってしまう。

1
private func runDispatchQueue() {
2
    dateList.removeAll(keepingCapacity: true)
3
    for _ in 0 ..< 10 {
4
        dateList.append("\(Date().description) on \(Thread.current.isMainThread)")
5
        Thread.sleep(forTimeInterval: 1)
6
    }
7
}

Serial Queue で実行してみよう

では次にDispatchQueue.globalを使い、処理をGlobal Queueとして渡すことにする。

DispatchQueue.globalには async（非同期）と async（同期）の二つがあり、更に並列処理か逐次処理がある。つまり、全部で四通りの実行の仕方があることになる。

ただし、今回は負荷をかけないためのコーディングについて考えるので並列処理（同時に複数実行）は考えず、逐次処理（同時に一つだけ実行）を考える。

::: tip Sleep について

DispatchQueue.global内でsleepまたはThread.sleepを使ってみたのですが、どちらでも動作に違いはありませんでした。

:::

Serial + Sync

syncを指定するとDispatchQueueのクロージャが全部終了してから呼び出し元に制御を返します。

1
import SwiftUI
2

3
struct ContentView: View {
4
    @State var dateList: [String] = []
5
    // 逐次処理
6
    let queue = DispatchQueue(label: "work.tkgstrator.dispatch_queue_serial")
7

8
    var body: some View {
9
        List {
10
            ForEach(dateList, id:\.self) { date in
11
                Text(date)
12
            }
13
        }
14
        Button(action: { runDispatchQueue() }, label: {
15
            Text("Run")
16
        })
17
    }
18

19
    private func runDispatchQueue() {
20
        dateList.removeAll(keepingCapacity: true)
21
        for loop in 0 ..< 10 {
22
            queue.sync {
23
                dateList.append("\(loop) -> \(Date().description) on \(Thread.current.isMainThread)")
24
                Thread.sleep(forTimeInterval: 1)
25
            }
26
        }
27
    }
28
}

よってこれは以下のように動作します。

• メインスレッドがrunDispatchQueueを実行
• グローバルスレッドがループを実行
  • その間メインスレッドはグローバルスレッドが完了するのを待つ
  • 待っている間は当然sleepしているとの同じ状態
• グローバルスレッドが制御を返す
• dateListが変化しているので画面の再描画が行われる

::: tip ナゼ？

DispatchQueueではグローバルスレッドを指定しているはずなのだが、何故かメインスレッドで実行される。

これに限らず、Syncを使うとメインスレッドで実行されてしまう。そういう宿命なのだろうか。

:::

しかも実行してみるとGlobal Queueとして実行しているはずなのに何故かメインスレッドで実行されています、謎です。

Serial + Async

次にAsyncを使って実行してみます。

これはメインスレッドを止めずに裏で実行するような感じですので期待通りの結果が得られます。

1
private func runDispatchQueue() {
2
    dateList.removeAll(keepingCapacity: true)
3
    for loop in 0 ..< 10 {
4
        queue.async {
5
            dateList.append("\(loop) -> \(Date().description) on \(Thread.current.isMainThread)")
6
            Thread.sleep(forTimeInterval: 1)
7
        }
8
    }
9
}

つまり、ちゃんと 1 秒毎にデータが 1 つずつ増えていき、その順番も内容も間違っていないということです。

別のスレッドを動かす

Sync + Main.Sync

Sync内でMain.Asyncを動かすとどうなるのでしょうか。

これをするとdateList.append()を行うのとsleepをするスレッドが同じであるにも関わらず、先にすぐに処理が終わるdateList.append()を実行した後に 10 秒間のスリープ処理が入ります。

つまり、ボタンを押した瞬間にフリーズして全く同じデータ（ボタンを押した時刻）が 10 秒後に描画されます。

1
private func runDispatchQueue() {
2
    dateList.removeAll(keepingCapacity: true)
3
    for loop in 0 ..< 10 {
4
        queue.async {
5
            dateList.append("\(loop) -> \(Date().description) on \(Thread.current.isMainThread)")
6
            print("\(loop) -> \(Date().description) on \(Thread.current.isMainThread)")
7
            DispatchQueue.main.async {
8
                Thread.sleep(forTimeInterval: 1)
9
            }
10
        }
11
    }
12
}

Async + Main.Async

次にAsync内でメインスレッドを動かしてみます。

すると、dateList.append()とsleepが別スレッドで実行されるため、ボタンを押して 1 秒後に画面が一気に再描画されます。つまり、データは全部同一の時刻が表示されるため、中身は正しくありません。

1
private func runDispatchQueue() {
2
    dateList.removeAll(keepingCapacity: true)
3
    for loop in 0 ..< 10 {
4
        queue.async {
5
            dateList.append("\(loop) -> \(Date().description) on \(Thread.current.isMainThread)")
6
            print("\(loop) -> \(Date().description) on \(Thread.current.isMainThread)")
7
            DispatchQueue.main.async {
8
                Thread.sleep(forTimeInterval: 1)
9
            }
10
        }
11
    }
12
}

AsyncAfter を使う

メインスレッドには指定時間後に処理を実行するDispatchQueue.main.asyncAfterという仕様が存在します。

1
private func runDispatchQueue() {
2
    dateList.removeAll(keepingCapacity: true)
3
    for loop in 0 ..< 10 {
4
        DispatchQueue.main.asyncAfter(deadline: .now() + TimeInterval(loop)) {
5
            dateList.append("\(Date().description) on \(Thread.current)")
6
        }
7
    }
8
}

このとき.now() + 定数という書き方をしてしまうと定数秒後に 10 回のループが同時に実行されてしまうので、現在時刻である.now()から少しずつズレて実行できるようにdeadlineの値は変数にすべきです。

こうすれば想定通りの仕様を満たします。DispatchQueue.global.asyncを使ったときと違うのはメインスレッドで実行されるという点でしょう。

::: danger 処理の重さに注意

ただし、注意しなければいけないのは時間がかかる処理に対してはこの手法は使えないということです。何故なら、処理の予約がボタンを押した瞬間にMain Queueとして保存されているためです。

例えば、5 秒かかるような処理に対してこのコードを書くと、処理が終わっていないにも関わらず次の Queue が実行されてしまいます。DispatchQueue.global.asyncの場合は処理が終わってから +1 秒後というコードのため、このような問題は発生しません。

:::

まとめ

スリープ処理をしたいのであればDispatchQueue.global.asyncを使おう。