@Queryマクロに頼らないSwiftDataの使い方

Mobile Act OSAKA 17
https://mobileact.connpass.com/event/374447/

Transcript

1. @Queryマクロに頼らないSwiftDataの使い方 大西伊吹(@ionishi321)
2. 自己紹介 struct Profile { let name = "大西 伊吹(おいぶ@ionishi321)" let company = "akippa株式会社(iOSエンジニア)" let hometown = "愛媛" let hobbies = ["水泳", "個人開発"] } 1
3. SwiftDataを使ったことある人 2
4. SwiftDataとは iOS17から利用できる、データの永続化のためのライブラリ SwiftUIやSwift Concurrencyで扱いやすい Swift Macroなどを活用して、簡潔に実装できるように設計されている 全てをSwiftコードで記述可能 3
5. SwiftDataを使ってみよう！ 4
6. SwiftDataを使ってみよう！ まずはModelを定義 @Model // マクロで簡単にモデル化 final class TodoModel { @Attribute(.unique) var id: UUID var content: String init(id: UUID, content: String) { self.id = id self.content = content } } 5
7. SwiftDataを使ってみよう！ 次に@Queryマクロを使って呼び出し struct ListWithMacroView: View { @Query var todos: [TodoModel] // マクロで簡単にViewに描画 var body: some View { … } } 6
8. SwiftDataを使ってみよう！ 親ViewにmodelContainerを渡しましょう！ 各Viewから@Environment(\.modelContext) で取得できま す！ @main struct SampleApp: App { var body: some Scene { WindowGroup { ListWithMacroView() } .modelContainer(for: TodoModel.self) // modelContainerを設定 } } 7
9. SwiftDataを使ってみよう！ ModelContainer経由でinsertとdeleteを準備しよう struct ListWithMacroView: View { @Environment(\.modelContext) private var modelContext // 追加 @Query var todo: [TodoModel] var body: some View { … } private func insertTodo(todoModel: TodoModel) { … } // 追加 private func deleteTodo(todoModel: TodoModel) { … } // 追加 } 8
10. これで完璧！ 9
11. 本当に? 10
12. 現状の問題点 @Query マクロはSwiftUIのView内でしか使えない Viewが状態もロジックも保持しており、ユニットテストが書きづらい ユニットテストがない状態だと、AIによるサポートを受けづらい @Query マクロは MainActor で動く UIがカクつくなど、ユーザーのUXに影響があるかも データの量が増えるほどに、リスクは増していく 11
13. @Queryマクロは便利 でも、このままではアプリがスケールしない! 12
14. @Queryマクロを使わない方法の模索 @Queryマクロ以外での永続化データの取得方法 ️ModelContextがfetchメソッドを提供している ️View以外からも実行可能 ️@Queryマクロのようなデータ同期の仕組みは持たない 13
15. @Queryマクロを使わない方法の模索 GlobalActorでSwiftDataのCRUD処理を行う方法 ️ModelActorプロトコルを使えば、バックグラウンドでCRUD処理が可能 ️SwiftDataのモデルがActor境界を超えられないため工夫が必要 14
16. これらのアイディアを取り入れたアーキテクチャ MainActor View2 UI の構築 ViewModel2 @Observable 表⽰状態の整形 Store @Observable 各ViewModel へのデータの公開・同期 Repository CRUD 処理 Entity View1 UI の構築 ViewModel1 @Observable 表⽰状態の整形 購読 購読 購読 Background Actor SwiftDataClient ModelActor SwiftData 操作 Model / Entity の変換 SwiftData 永続化 Model 購読 Entity 15
17. SwiftDataClient ModelActorに準拠し、SwiftDataへのCRUD処理を全て担う アクター境界を超えるため、入出力にはSendableなEntityを利用する actor SwiftDataClient: ModelActor { … private init(modelContainer: ModelContainer) { … } // CRUD処理を行うメソッド // 入出力にはSendableなEntityを使い、内部でModelに変換して扱う func get<T: EntityConvertible>(id: UUID, from modelType: T.Type) -> T.Entity? { … } func fetch<T: EntityConvertible>(descriptor: FetchDescriptor<T>) -> [T.Entity] { … } func insert<T: EntityConvertible>(entity: T.Entity, from modelType: T.Type) { … } func delete<T: EntityConvertible>(entity: T.Entity, from modelType: T.Type) { … } } 16
18. SwiftDataClient テスト用に、 inMemory なSwiftDataを扱うインスタンスを返せるようにすること で、依存するRepositoryのテストを書きやすくする extension SwiftDataClient { // 本番環境用のインスタンス static let liveValue: SwiftDataClient = .init(modelContainer: modelContainer(forTest: false)) // テスト用のinMemoryなインスタンス static var testValue: SwiftDataClient { .init(modelContainer: modelContainer(forTest: true)) } private static func modelContainer(forTest: Bool) -> ModelContainer { … } } 17
19. Entity Sendable, Codable, Identifiable, Hashableに準拠した構造体 SwiftDataのModelごとに対応したEntityを作成する protocol EntityProtocol: Sendable, Codable, Hashable, Identifiable { var id: UUID { get } } struct TodoEntity: EntityProtocol { var id: UUID var content: String } 18
20. Repository SwiftDataClientを使って、各ModelのCRUD処理を実装する Entityの具体的なプロパティを参照する処理があれば、ここで処理 struct TodoRepository: TodoRepositoryProtocol{ let swiftDataClient: SwiftDataClient func fetchTodos() async -> [TodoEntity] { … } func insertTodo(entity: TodoEntity) async { … } func deleteTodo(id: UUID) async { … } } 19
21. Store Observableなクラスとして実装し、SSOTとして読み出した永続化データの公開を 責務とする @MainActor @Observable final class TodoStore: TodoStoreProtocol { private(set) var todos = [TodoEntity]() // Entity公開用プロパティ @ObservationIgnored var todoRepository: any TodoRepositoryProtocol init(todoRepository: any TodoRepositoryProtocol) { self.todoRepository = todoRepository Task { await syncTodos() } } func syncTodos() async { … } // todosを最新の状態と同期するメソッド func insertTodo(entity: TodoEntity) async { … } func deleteTodo(id: UUID) async { … } } 20
22. ViewModel TodoStoreが公開するObservableなプロパティを購読し、Viewに表示すべき状態に 整える @MainActor @Observable final class ListWithoutMacroViewModel { let todoStore: any TodoStoreProtocol init(todoStore: any TodoStoreProtocol) { self.todoStore = todoStore } var todos: [TodoEntity] { todoStore.todos } // Storeで公開されたプロパティを参照 func insertTodo(todoEntity: TodoEntity) async { … } func deleteTodo(id: UUID) async { … } } 21
23. View @Query マクロを含む状態とロジックをViewModelに分離したことで、UIを構築す る責務のみに整理される struct ListWithoutMacroView: View { @State private var viewModel: ListWithoutMacroViewModel init(viewModel: ListWithoutMacroViewModel) { self.viewModel = viewModel } var body: some View { ForEach(viewModel.todos, id: \.self) { todo in … } // ViewModel.todosを使ってUIを作成 } } 22
24. まとめ @Query マクロを使うと非常に簡潔に永続化データを扱えるが、スケールさせづら い fetchメソッドとModelActorを活用すれば、SwiftDataをテスタブルに扱える ただし、コード量は圧倒的に増える スライドとサンプルコードをGitHubで公開しています！ 23
25. ご清聴ありがとうございました！ 24