Что такое StateObject?

Что такое StateObject?

StateObject — это property wrapper (обёртка свойства) в фреймворке SwiftUI, предназначенный для создания и хранения ссылки на экземпляр класса, который соответствует протоколу ObservableObject. Это ключевой инструмент управления состоянием на уровне представления (View), обеспечивающий жизненный цикл объекта, который сохраняется на протяжении всего времени жизни представления, которому он принадлежит.

Основное предназначение

Главная задача @StateObject — инициализировать и владеть объектом состояния. Когда вы помечаете свойство с помощью @StateObject, SwiftUI берёт на себя ответственность за создание экземпляра этого объекта при первой инициализации представления и поддерживает его существование при последующих обновлениях интерфейса. Это гарантирует, что данные не будут потеряны при перерисовке View.

Ключевые характеристики

1. Владение объектом: View, объявляющее @StateObject, является его владельцем. Объект существует столько же, сколько и это View.
2. Инициализация при создании View: SwiftUI создаёт объект только один раз при первом создании View и повторно использует его при обновлениях.
3. Наблюдаемость: Поскольку объект должен соответствовать ObservableObject, любые изменения в его свойствах, помеченных как @Published, автоматически приводят к перерисовке всех представлений, которые на него подписаны.
4. Использование внутри иерархии View: @StateObject должен использоваться только внутри View.body или в методах, которые создают View.

Сравнение с @ObservedObject

Важно отличать @StateObject от @ObservedObject:

• @StateObject — для владения и инициализации объекта.
• @ObservedObject — для подписки на уже существующий объект, созданный где-то ещё (например, переданный из родительского View).

Использование @ObservedObject для инициализации может привести к потере состояния, так как при каждом обновлении View будет создаваться новый экземпляр объекта.

Пример кода

Рассмотрим практический пример. Допустим, у нас есть модель данных — менеджер загрузки:

import SwiftUI
import Combine

// Модель, соответствующая ObservableObject
class DownloadManager: ObservableObject {
    @Published var progress: Double = 0.0
    @Published var isCompleted: Bool = false
    
    func startDownload() {
        // Имитация загрузки
        Timer.scheduledTimer(withTimeInterval: 0.1, repeats: true) { timer in
            if self.progress < 1.0 {
                self.progress += 0.05
            } else {
                self.isCompleted = true
                timer.invalidate()
            }
        }
    }
}

// Представление, которое ВЛАДЕЕТ объектом через @StateObject
struct DownloadView: View {
    // StateObject для инициализации и владения
    @StateObject private var downloadManager = DownloadManager()
    
    var body: some View {
        VStack(spacing: 20) {
            Text("Загрузка: \(Int(downloadManager.progress * 100))%")
            ProgressView(value: downloadManager.progress)
            
            if downloadManager.isCompleted {
                Text("Загрузка завершена!")
                    .foregroundColor(.green)
            } else {
                Button("Начать загрузку") {
                    downloadManager.startDownload()
                }
            }
        }
        .padding()
    }
}

// Родительское представление, которое может перерисовываться
struct ParentView: View {
    @State private var refreshCount = 0
    
    var body: some View {
        VStack {
            DownloadView() // StateObject внутри DownloadView сохранит состояние
            
            Button("Обновить родительский вид") {
                refreshCount += 1
            }
            Text("Родитель обновлён: \(refreshCount) раз")
        }
    }
}

В этом примере:

• DownloadManager — это ObservableObject с публикуемыми свойствами.
• DownloadView создаёт и владеет экземпляром DownloadManager через @StateObject.
• При нажатии кнопки "Обновить родительский вид" ParentView перерисовывается, но DownloadView сохраняет своё состояние, так как downloadManager не создаётся заново благодаря @StateObject.

Когда использовать StateObject

1. Создание объекта внутри View: Когда вы инициализируете ObservableObject непосредственно в теле View.
2. Управление жизненным циклом: Когда нужно, чтобы объект существовал ровно столько, сколько существует View.
3. Источник истины: Когда данный объект является первоисточником данных для этого конкретного View и его дочерних элементов.

Важные замечания

• @StateObject доступен только в iOS 14+, macOS 11+, и других актуальных платформах Apple.
• Не используйте @StateObject для объектов, которые должны существовать вне жизненного цикла View (для этого лучше подходят @EnvironmentObject или внедрение зависимостей).
• Всегда объявляйте @StateObject как private, если объект не предназначен для передачи вниз по иерархии.

В итоге, StateObject — это фундаментальный инструмент в SwiftUI для безопасного управления состоянием, который обеспечивает предсказуемый жизненный цикл объектов данных и предотвращает неожиданную потерю состояния при рекомпозиции интерфейса.