Logo
Overview

SwiftUIの再レンダリングの仕組みを理解する

tkgstrator tkgstrator
April 8, 2021
4 min read
Swift

SwiftUI の再レンダリングの仕組みを理解する

求められている仕様

親ビューを以下のように定義する。

import SwiftUI


struct ContentView: View {


    @State var placeholders: [PlaceholderView] = Array(repeating: PlaceholderView(), count: 4)


    var body: some View {
        HStack {
            ForEach(placeholders) { placeholder in
                placeholder
                    .onTapGesture {
                        placeholder.animateState()
                    }
            }
        }
    }
}

親ビューは子ビュー（PlaceholderView）の配列を持っておき、タップされるとその子ビューが持つメソッドであるanimateState()が呼ばれるという仕組みである。

で、子ビューを以下のように定義する。

import SwiftUI


struct PlaceholderView: View, Identifiable {
    var id: String = UUID().uuidString


    @State var backgroundColor: Color = .clear
    @State var borderColor: Color = .blue


    var body: some View {
        Circle()
            .strokeBorder(borderColor)
            .background(backgroundColor)
            .frame(width: 16, height: 16, alignment: .center)
    }


    func animateState() {
        backgroundColor = .black
        borderColor = .red
    }
}

で、これを実行してみると確かにPlaceholder.animateState()は呼び出されているのだが、animateState()内で backgroundColor の値を変えているのに Debug Area で内部データを見てみると変わっていない。

色々原因が思いつくのだが、その理由の一つは @State の値はそれ自身か子ビューからしか変更することができないという制約ため。この場合だと PlaceholderView の親ビューである ContentView から変更されようとしているので動かないというわけだ。

改善手法

親ビューから呼ばれても変わらないので、自身から呼び出すように変更する。

自身といってもvar bodyから呼ばれる必要があるようだ。

import SwiftUI


struct ContentView: View {


    @State var placeholders: [PlaceholderView] = Array(repeating: PlaceholderView(), count: 4)


    var body: some View {
        HStack {
            ForEach(placeholders) { placeholder in
                placeholder
                // ここでの処理を削除
            }
        }
    }
}

まず、親ビューの処理を削除する。どうせ動かないのだから消しても問題はない。

import SwiftUI


struct PlaceholderView: View, Identifiable {
    var id: String = UUID().uuidString


    @State var backgroundColor: Color = .clear
    @State var borderColor: Color = .blue


    var body: some View {
        Circle()
            .strokeBorder(borderColor)
            .background(backgroundColor)
            .frame(width: 16, height: 16, alignment: .center)
            // ここに処理を追加
            .onTapGesture {
                animateState()
            }
    }


    func animateState() {
        backgroundColor = .black
        borderColor = .red
    }
}

次に子ビューに処理を追加する。要するに「親ビュー -> 子ビュー -> 処理」という流れのうち「親ビュー -> 子ビュー」の段階で State を変更できないような仕組みになっていたのでこれを「子ビュー -> 処理」という直接処理をするような仕組みに変更するのである。

すると理想通りの動作をした。

仕様を変更する

struct ContentView: View {


    @State var passcode: [Int?] = []


    var body: some View {
        VStack(spacing: 30) {
            HStack {
                ForEach(Range(0...3)) { _ in
                    PlaceholderView()
                }
            }
            Button(action: { addSign() }, label: { Text("COUNT") })
        }
    }


    func addSign() {
        passcode.append(nil)


        if passcode.count >= 4 {
            passcode.removeAll()
        }
    }
}


struct PlaceholderView: View {


    @State var backgroundColor: Color = .clear
    @State var borderColor: Color = .blue


    var body: some View {
        Circle()
            .strokeBorder(borderColor)
            .background(backgroundColor)
            .frame(width: 16, height: 16, alignment: .center)
    }
}

ContentView のボタンをタップすればカウントが増えていき、4 になったら 0 に戻るというシンプルなプログラムである。

が、これでは何回ボタンが入力されたかをテキストで表示しておりダサい。最大入力数が 4 だとわかっているのだから、入力された文字の数だけ PlaceholderView の見た目を変更してユーザが認識できるような UI の方が理にかなっているのである。

では、ボタンが押されたときに子ビューである PlaceholderView の見た目を更新するためにはどうすればいいだろうか。

結論から言うと

子ビューの見た目を親ビューからうまいこと変化させる仕組みは（多分）存在しません。

おとなしく Binding を使いましょう。例えば以下のように State で現在の状態を渡した場合には PlaceholderView が変更を受け取ることができません。

// NGなコード
import SwiftUI


struct ContentView: View {


    private var length: Int
    @State var passcode: [Int?] = []
    @State var lockStates: [LockState]


    init(length: Int) {
        self.length = length
        self._lockStates = State(initialValue: Array(repeating: .inactive, count: length))
    }


    var body: some View {
        VStack(spacing: 30) {
            HStack {
                ForEach(Range(0...length - 1)) { index in
                    PlaceholderView(state: lockStates[index])
                }
            }
            Text("\(passcode.count)")
            Button(action: { addSign() }, label: { Text("COUNT") })
        }
    }


    func addSign() {
        passcode.append(nil)


        if passcode.count >= length {
            passcode.removeAll()
        } else {
            lockStates[passcode.count] = .active
        }
    }
}


struct PlaceholderView: View, Identifiable {


    var id: String = UUID().uuidString


    @State var backgroundColor: Color = .clear
    @State var borderColor: Color = .blue
    @State var lockState: LockState


    init(state lockState: LockState) {
        self._lockState = State(initialValue: lockState)
    }


    var body: some View {
        Circle()
            .strokeBorder(borderColor)
            .background(backgroundColor)
            .frame(width: 16, height: 16, alignment: .center)
            .onChange(of: lockState) { value in
                animateState()
            }
    }


    func animateState() {
        backgroundColor = .black
    }
}


public enum LockState: CaseIterable {
    case active
    case inactive
}

値が変化する可能性のあるものを受け取り、それによってビューを再レンダリングするためには State ではなく Binding を受け取る必要があるためです。

import SwiftUI


struct ContentView: View {


    private var length: Int
    @State var passcode: [Int?] = []
    @State var lockStates: [LockState]


    init(length: Int) {
        self.length = length
        self._lockStates = State(initialValue: Array(repeating: .inactive, count: length))
    }


    var body: some View {
        VStack(spacing: 30) {
            HStack {
                ForEach(Range(0...length - 1)) { index in
                    PlaceholderView(state: $lockStates[index])
                }
            }
            Text("\(passcode.count)")
            Button(action: { addSign() }, label: { Text("COUNT") })
        }
    }


    func addSign() {
        passcode.append(nil)


        if passcode.count >= length {
            passcode.removeAll()
            lockStates = Array(repeating: .inactive, count: length)
        } else {
            lockStates[passcode.count - 1] = .active
        }
    }
}


struct PlaceholderView: View, Identifiable {


    var id: String = UUID().uuidString
    @State var backgroundColor: Color = .clear
    @State var borderColor: Color = .blue
    // ここをBindingにして変更を受け取れるようにする
    @Binding var lockState: LockState


    // ここもBinding型を受け取れるようにする
    init(state lockState: Binding<LockState>) {
        // この書き方大事なので覚えておく
        self._lockState = lockState
    }


    var body: some View {
        Circle()
            .strokeBorder(borderColor)
            .background(backgroundColor)
            .frame(width: 16, height: 16, alignment: .center)
            .onChange(of: lockState) { value in
                animateState()
            }
    }


    func animateState() {
        backgroundColor = .black
    }
}


public enum LockState: CaseIterable {
    case active
    case inactive
}


struct ContentView_Previews: PreviewProvider {
    static var previews: some View {
        ContentView(length: 5)
    }
}

というわけで、これでボタンを押せばそれに応じて背景色が変わるようにできました。

要するに、受け取る側が Binding でさえ受け取ってしまえば変更可能だということです。

じゃあ Binding で渡せばいいのでanimateState(state: Binding<LockState>)みたいにすればよいのではないかという気もしてくる。

が、そうすると今度は SwiftUI が構造体で定義してしまうので値を変更できない。変更するためにはmutatingを付ける必要がある。なんかいろいろめんどくさそうなので普通にイニシャライザで渡してしまったほうが良いかもしれない。

おまけ

このままだと一瞬でボタンの中身が切り替わってしまうので、ゆっくり切り替わるように実装する。

withAnimation {
    animateState(state: value)
}

こうやってwithAnimationをつければアニメーションをつけて変化してくれるので便利。

一通りの動作を実装してみる