[SwiftData] 03. Dive deeper into SwiftData(SwiftData 자세히 살펴보기)

 

 

SwiftData 자세히 살펴보기 WWDC 영상 번역/정리본입니다.

 

•  목차
  • 00:00 Intro
  • 03:42 Configuring persistence | 앱의 데이터를 유지하도록 모델을 구성하는 방법
  • 07:21 Track and persist changes | 변경 사항을 추적하고 지속하는 방법(ModelContext)
  • 11:20 Modeling at scale | 객체를 다룰 때 SwiftData를 최대한 활용하는 방법
  • 14:54 Wrap-up
• doc
  • SwiftData 공식 문서
  • Adopting SwiftData for a core Data app 샘플 프로젝트
• 선 시청
  • SwiftData 알아보기
  • SwiftData로 스키마 모델링하기

0. Intro

이번에는 SampleTrips 앱을 통해 SwiftData에 대해 알아볼 것입니다. SampleTrips는 여행할 시기와 장소를 쉽게 정리할 수 있는 앱입니다. SwiftData를 활용하면 실행 취소나 앱 전환 시 자동 저장 등 표준 플랫폼 기능을 쉽게 구현할 수 있습니다.

 

Model

Types you already use

1. @Model macro
2. Inferred or explicit structure
3. Deep customization

SwiftData는 Swift로 앱의 데이터를 유지하는 새로운 방법입니다. Class나 Struct 등 기존의 여러 타입들과 함께 활용할 수 있습니다.

이 SwiftData의 핵심은 새로운 매크로 @Model 입니다. 이는 앱에서 유지해야 하는 타입을 SwiftData에 알려 주는 역할을 합니다.

 

아래는 SampleTrips 앱의 Trip 클래스입니다. 여행 정보를 가지는 몇 가지 프로퍼티와 SampleTrips 앱에서 쓰이는 다른 객체에 대한 참조로 구성되어 있습니다.

class Trip {
    var destination: String?
    var end_date: Date?
    var name: String?
    var start_date: Date?
    var bucketListItem: [BucketListItem] = [BucketListItem]()  
    var livingAccommodation: LivingAccommodation?
}

 

이는 아래처럼 수정하여 SwiftData의 Model로 사용할 수 있습니다.

@Model  // << (1)SwiftData로 사용하기 위해 @Model 매크로 추가
final class Trip {
    var destination: String?
    var end_date: Date?
    var name: String?
    var start_date: Date?
  
    @Relationship(.cascade) // << (2)관계 추가
    var bucketListItem: [BucketListItem] = [BucketListItem]()
  
    @Relationship(.cascade) // << (3)관계 추가
    var livingAccommodation: LivingAccommodation?
}

 

SwiftData는 처음의 코드처럼 지속성없이 작성하는 코드와 두번째로 보여드린 지속성이 필요한 코드 사이의 차이를 최소화하여 사용할 수 있습니다. 약간의 수정으로 SwiftData에 해당 Trip 클래스가 유지하고 싶은 모델임을 알렸고, BucketListItem 및 LivingAccommodations와의 관계가 어떻게 동작해야 하는지 작성했습니다.

 

SwiftData는 작성된 코드에서 여러분이 원하는 구조를 자동으로 추론할 수도 있습니다. 또한, 강력한 사용자화 기능을 제공하여 원하는 데이터 저장 방식을 정확히 서술할 수 있게 해줍니다.

 

 

@Model의 역할

@Model 어노테이션을 통해 Trip 클래스는 SwiftData에서 두 가지 중요한 역할을 맡습니다.

• Describe the schema
• Instances used in code

첫 번째는 응용 프로그램의 객체 그래프인 스키마를 서술하는 것이고, 두 번째는 코드를 작성할 수 있는 인터페이스가 되는 것입니다. 즉 두 역할을 수행하는 능력이 @Model 매크로가 달린 클래스를 SwiftData를 사용하는 앱의 접촉 중심점으로 만듭니다.

 

각 역할을 지원하는 API 개념이 있습니다.

 

스키마는 ModelContainer라는 클래스에 적용되어 데이터의 지속 방식을 서술합니다.

ModelContainer는 스키마를 사용하여 모델 클래스의 인스턴스를 보유할 수 있는 데이터베이스를 생성합니다.

 

코드에서 모델 클래스의 인스턴스를 다룰 때는 해당 인스턴스가 ModelContext에 연결됩니다. ModelContext는 메모리에서 인스턴스 상태를 추적하고 관리합니다.

 

이는 SwiftData의 핵심이라고 할 수 있습니다.

 

 

1. Configuring persistence
앱의 데이터를 유지하도록 모델을 구성하는 방법

지속성의 구조를 설명하는 모델의 첫 번째 역할을 살펴보고, ModelContainer와 함께 작동하는 방식을 알아봅시다.

 

Model Container
- ModelContainer로 스키마를 지속성과 통합하는 법

ModelContainer는 데이터가 기기에서 저장되고 지속되는 방식을 서술합니다. ModelContainer를 스키마와 스키마의 지속성을 잇는 다리로 생각할 수 있습니다. 객체가 메모리와 디스크 중 어디에 저장되는지 등의 저장 방식에 대한 서술이 버전 관리와 마이그레이션 그래프 분리 같은 스토리지의 운영 및 개발 시맨틱과 만나는 곳입니다.

• Schema and persistence
• How objects are stored
• Evolution of models
  • Versioning
  • Migration
  • Graph separation
    
    

스키마로 컨테이너를 인스턴스화하는 건 쉽습니다. 작업하려는 타입만 작성하면 SwiftData가 나머지 스키마를 처리해 줍니다. 예를 들어 Trip 클래스가 다른 모델 유형과 관련하므로 ModelContainer가 이 스키마를 추론합니다.

// ModelContainer initialized with just Trip
let container = try ModelContainer(for: Trip.self)

// SwiftData infers related model classes as well
let container = try ModelContainer(for: [Trip.self, BucketListItem.self, LivingAccommodation.self])

 

ModelContainer에는 강력한 이니셜라이저가 많으며, ModelConfiguration이라는 클래스를 사용해 더욱 복잡하게 구성할 수도 있습니다.

 

ModelConfiguration
- ModelConfiguration을 사용하여 지속성 기능을 활성화하는 방법

ModelConfiguration은 스키마의 지속성을 서술합니다. 데이터의 저장 위치를 제어합니다. 일시 데이터는 메모리에 영구 데이터는 디스크에 저장하는 식입니다. ModelConfiguration은 여러분이 선택한 특정 파일 URL을 쓰거나 그룹 컨테이너 권한 등 응용 프로그램의 권한을 사용하여 자동으로 URL을 생성합니다. 또한, 영구 파일이 읽기 전용 모드로 로드되어야 함을 서술하여 민감한 데이터나 템플릿 데이터에 대한 작성을 방지할 수도 있습니다. 마지막으로 두 개 이상의 CloudKit 컨테이너를 쓰는 앱은 이를 스키마 ModelConfiguration의 일부로 지정할 수 있습니다.

 

Describes persistence of a schema

• In memory or on disk
• File location
• Read only
• CloudKit container identifier

 

새로운 Person 클래스와 Address 클래스를 사용해 SampleTrips에 연락처 정보를 추가해봅시다.
👉🏻 ModelConfiguration의 기능으로 앱의 지속성 요구 사항을 간단히 작성할 수 있습니다. 

// 1. 사용할 유형이 모두 포함된 전체 스키마를 선언
let fullSchema = Schema([Trip.self, BucketListItem.self, LivingAccommodations.self, Person.self, Address.self])

// 2. ModelConfiguration을 선언(Trip과 BucketListItem LivingAccommodations 모델을 포함)
let trips = ModelConfiguration(
    schema: Schema([Trip.self, BucketListItem.self, LivingAccommodations.self]),
    url: URL(filePath: "/path/to/trip.store"), // 해당 객체 그래프의 데이터 저장에 사용할 파일의 URL을 선언
    cloudKitContainerIdentifier: "com.example.trips" // SampleTrips 데이터를 CloudKit에 동기화할 때 사용할 CloudKit 컨테이너의 컨테이너 식별자 선언
)

// 3. Person 및 Address가 포함된 새 스키마의 모델을 ModelConfiguration에 선언
// CloudKit 컨테이너 식별자와 고유한 파일 URL과 함께 선언 >>  Trips 그래프에서 데이터를 분리할 수 있게 됨
let people = ModelConfiguration(
    schema: Schema([Person.self, Address.self]),
    url: URL(filePath: "/path/to/people.store"), 
    cloudKitContainerIdentifier: "com.example.people"
) 

// 4. 스키마와 구성(configuration)을 결합하여 ModelContainer를 형성
let container = try ModelContainer(for: fullSchema, trips, people)

 

 

 

수동으로 컨테이너를 인스턴스화하는 것뿐만 아니라 SwiftUI의 새로운 ModelContainer 모디파이어로 원하는 컨테이너를 생성할 수 있습니다. 모디파이어는 응용 프로그램의 어떤 뷰나 씬에도 추가 가능하며 간단한 것부터 강력한 것까지 다양한 ModelContainer를 지원합니다.

@main
struct TripsApp: App {
  var body: some Scene {
    WindowGroup {
      ContentView()
    }
    .modelContainer(container)
  }
}

@main
struct TripsApp: App {
    let fullSchema = Schema([Trip.self, BucketListItem.self, LivingAccommodations.self, Person.self, Address.self])
  
    let trips = ModelConfiguration(
        schema: Schema([Trip.self, BucketListItem.self, LivingAccommodations.self]),
        url: URL(filePath: "/path/to/trip.store"),
        cloudKitContainerIdentifier: "com.example.trips"
    )
  
    let people = ModelConfiguration(
        schema: Schema([Person.self, Address.self]),
        url: URL(filePath: "/path/to/people.store"),
        cloudKitContainerIdentifier: "com.example.people"
    )
  
    let container = try ModelContainer(for: fullSchema, trips, people)
    var body: some Scene {
        WindowGroup {
            ContentView()
        }
        .modelContainer(container)
    }
}

2. Track and persist changes
변경 사항을 추적하고 지속하는 방법(ModelContext)

Model과 ModelContext는 사용자 인터페이스를 작성하거나 모델 객체를 운용할 때 가장 자주 쓰이는 개념입니다. 이번에는 ModelContext가 어떻게 변경 사항을 추적하고, ModelContainer로 수정된 내용을 유지하는지 알아볼 것입니다.

@main
struct TripsApp: App {
   var body: some Scene {
      WindowGroup {
          ContentView()
      }
      .modelContainer(container) // << modelContainer 모디파이어 
   }
}

struct ContentView: View {
    @Query var trips: [Trip] // << 여행 쿼리
    @Environment(\.modelContext) var modelContext
  
    var body: some View {
        NavigationStack (path: $path) {
            List(selection: $selection) {
                ForEach(trips) { trip in
                    TripListItem(trip: trip)
                        .swipeActions(edge: .trailing) {
                            Button(role: .destructive) {
                                modelContext.delete(trip) // << 데이터 삭제
                            } label: {
                                Label("Delete", systemImage: "trash")
                            }
                        }
                }
                .onDelete(perform: deleteTrips(at:))
            }
        }
    }
}

 

뷰나 씬 코드에서 modelContainer 모디파이어를 사용하면 특정한 방식으로 앱 환경을 준비합니다. 모디파이어는 @Environment의 새 modelContext 키를 컨테이너의 mainContext에 바인딩합니다. MainContext는 뷰나 씬에서 ModelObjects와 함께 작업하기 위한 특별한 MainActor-aligned model context입니다. @Environment에서 모델 컨텍스트를 사용하면 뷰의 코드가 쿼리에서 사용하는 컨텍스트에 쉽게 액세스할 수 있으며, 삭제 같은 작업을 수행할 수 있게 됩니다.

 

그래서 모델 콘텍스트는 사용과 액세스가 쉽지만 실제 역할은 뭘까요?
👉🏻 ModelContext는 응용 프로그램이 관리하는 데이터에 대한 뷰로 생각할 수 있습니다.

 

작업할 데이터는 사용 중인 모델 콘텍스트로 페칭됩니다. SampleTrips의 경우 예정된 여행 뷰가 리스트에 데이터를 로드할 때 각 여행 객체를 메인 콘텍스트로 가져옵니다. 여행을 수정하면 해당 변경 사항이 스냅샷으로 모델 콘텍스트에 기록됩니다. 새 여행을 추가하거나 기존 여행을 삭제하는 등 다른 변경 사항이 발생하면 콘텍스트가 이러한 변경의 상태를 추적하고 유지하다가 'context.save()'를 호출하면 멈춥니다. 삭제된 여행이 리스트에서 사용자에게 보이지 않더라도 저장을 호출하여 해당 삭제를 지속하기 전까지는 ModelContext에 남아 있다는 뜻입니다. save()가 호출되면 콘텍스트가 변경 사항을 ModelContainer에 지속시키고 상태를 지웁니다.

 

리스트에 표시하는 등 콘텍스트에서 객체를 계속 참조한다면 해당 객체는 사용이 끝날 때까지 콘텍스트에 남게 됩니다. 그 시점에 객체가 해제되고 콘텍스트가 비워집니다.

 

ModelContext

ModelContext는 바인딩된 ModelContainer와 함께 작동합니다. 뷰에서 가져온 객체를 추적하고 저장이 실행될 때 변경 사항을 전파합니다. 또한 ModelContext는 롤백과 재설정 같은 기능도 지원해 필요한 경우 캐싱된 상태를 지울 수 있습니다. 그래서 실행 취소 및 자동 저장 등의 기능을 지원하기 때문에 이상적이라고 할 수 있습니다 :)

• Track objects in use
• Propagates changes to ModelContainer
• Clear changes with rollback or reset

 

@main
struct TripsApp: App {
   @Environment(\.undoManager) var undoManager
   var body: some Scene {
        WindowGroup {
            ContentView()
        }
        .modelContainer(for: Trip.self, isUndoEnabled: true)
    }
}

SwiftUI에서 ModelContainer 모디파이어는 isUndoEnabled argument를 가지고 있습니다. 윈도우의 undoManager를 컨테이너의 mainContext에 바인딩하는 인자입니다. 다시 말해 메인 콘텍스트에 변경 사항이 생기면 세 손가락으로 밀기나 흔들기 등의 시스템 제스처로 추가 코드 없이 변경을 실행 취소 혹은 실행 복귀 할 수 있습니다.

 

Undo with ModelContext

모델 객체에 변경이 발생하면 ModelContext는 자동으로 실행 취소 및 실행 복귀 동작을 등록합니다. ModelContainer 모디파이어가 쓰는 환경의 undoManager는 윈도우나 윈도우 그룹의 일부로 시스템에서 제공됩니다. 그래서 세 손가락으로 밀기나 흔들기 같은 시스템 제스처가 응용 프로그램에서 자동으로 작동합니다.

• Automatically registers actions
• modelContainer() the environment’s undoManager
• Supports standard system gestures

 

ModelContext Autosave

ModelContext가 지원하는 또 다른 표준 시스템 기능은 바로 자동 저장입니다. 자동 저장이 활성화되면 모델 콘텍스트는 시스템 이벤트에 저장됩니다. 포그라운드나 백그라운드로 응용 프로그램이 전환되는 등의 이벤트입니다.

• Main context automatically saves
• System events
• Periodically as app is used

@main
struct TripsApp: App {
   var body: some Scene {
        WindowGroup {
            ContentView()
        }
        .modelContainer(for: Trip.self, isAutosaveEnabled: false) // <-- 자동저장 비활성화
    }
}

메인 콘텍스트도 응용 프로그램이 쓰이는 동안 주기적으로 저장됩니다. 자동 저장은 응용 프로그램에서 기본적으로 활성화되며 필요시 ModelContainer 수정자의 isAutosaveEnabled 인자로 비활성화할 수 있습니다.

수동으로 만든 모델 콘텍스트에선 자동 저장이 비활성화됩니다.

 

3. Modeling at scale
객체를 다룰 때 SwiftData를 최대한 활용하는 방법

응용 프로그램이 모델 객체를 사용하는 곳은 사용자 인터페이스뿐만이 아닙니다. 이번에는 SwiftData로 쉽고 안전하게 강력하고 확장 가능한 코드를 작성하는 법을 알아봅시다.

 

Model Context at Scale

백그라운드 큐에서 데이터를 다루는 작업과 원격 서버나 다른 영구 메커니즘과의 동기화 배치 처리는 모두 주로 집합이나 그래프 형태로 모델 객체를 동반합니다.

• Background operations
• Sync
• Batch Processing

 

let context = self.newSwiftContext(from: Trip.self)
var trips = try context.fetch(FetchDescriptor<Trip>())

이 중 많은 작업이 ModelContext의 페치 메서드로 작업할 객체 집합을 가져옵니다.

 

이 예제에서는 Trip 모델의 FetchDescriptor로 여행 어레이가 Trip 객체 컬렉션임을 Swift에 알립니다. 캐스팅이나 복잡한 결과 투플을 걱정할 필요가 없습니다.

let context = self.newSwiftContext(from: Trip.self)
let hotelNames = ["First", "Second", "Third"]

var predicate = #Predicate<Trip> { trip in
    trip.livingAccommodations.filter {
        hotelNames.contains($0.placeName)
    }.count > 0
}

var descriptor = FetchDescriptor(predicate: predicate)
var trips = try context.fetch(descriptor)

 

새로운 Predicate 매크로를 사용해서 FetchDescriptor로 손쉽게 복잡한 쿼리를 만들 수 있습니다.

예를 들어 특정 호텔에서 숙박하는 여행을 찾거나 활동을 예약해야 하는 여행을 찾을 수 있습니다. SwiftData에서는 하위 쿼리와 조인을 지원하는 복잡한 쿼리도 모두 순수하게 Swift로 작성할 수 있습니다.

let context = self.newSwiftContext(from: Trip.self)

predicate = #Predicate<Trip> { trip in
    trip.livingAccommodations.filter {
        $0.hasReservation == false
    }.count > 0
}

descriptor = FetchDescriptor(predicate: predicate)
var trips = try context.fetch(descriptor)

 

Predicate는 여러분이 만든 모델을 쓰고 SwiftData는 그 모델에서 생성된 스키마를 사용하여 이러한 서술부를 데이터베이스 쿼리로 변환합니다.

 

FetchDescriptor

FetchDescriptor는 새로운 Foundation Predicate 매크로의 기능을 스키마와 결합하여 컴파일러 인증 쿼리를 Apple 플랫폼에서 지속시켜 줍니다. FetchDescriptor와 SortDescriptor 등 관련 클래스는 제네릭으로 결과 유형을 형성하고, 사용 가능한 모델 프로퍼티를 컴파일러에 알려 줍니다. 여러 가지 조정 옵션인 offset과 limit faulting 및 prefetching 매개변수가 있습니다.

• Compiler validated queries
• Typed by model
• Additional parameters
  • Offset/limit
  • Faulting/prefetching

이 모든 기능은 ModelContext의 enumerate 함수에서 결합됩니다. 이는 single call site에서 플랫폼 모범 사례를 캡슐화하여 암묵적으로 배치 순회 및 열거 패턴을 만들 수 있도록 설계되었습니다.

context.enumerate(FetchDescriptor<Trip>()) { trip in
    // Operate on trip
}

 

enumerate는 FetchDescriptor가 아무리 복잡해도 훌륭히 작동합니다. 간단한 것부터 강력한 것까지 모두 지원합니다. enumerate는 배칭이나 mutation guards 등의 플랫폼 모범 사례를 자동으로 구현합니다. 이는 사용 예에 맞게 사용자화할 수 있습니다.

let predicate = #Predicate<Trip> { trip in
    trip.bucketListItem.filter {
        $0.hasReservation == false
    }.count > 0
}

let descriptor = FetchDescriptor(predicate: predicate)
descriptor.sortBy = [SortDescriptor(\.start_date)]

context.enumerate(descriptor) { trip in
    // Remind me to make reservations for trip
}

 

 

예를 들어 enumerate 배치의 기본 크기는 객체 5천 개입니다. 순회 중 I/O 작업을 줄이기 위해 메모리 증가를 감안하고 1만으로 변경할 수 있습니다. 이미지나 동영상 기타 고용량 데이터를 포함하는 무거운 객체 그래프의 경우 더 작은 배치 크기를 사용할 수 있습니다. 배치 크기를 줄이면 메모리 증가는 감소하지만 열거 중 I/O가 증가합니다.

let predicate = #Predicate<Trip> { trip in
    trip.bucketListItem.filter {
        $0.hasReservation == false
    }.count > 0
}

let descriptor = FetchDescriptor(predicate: predicate)
descriptor.sortBy = [SortDescriptor(\.start_date)]

context.enumerate(
    descriptor,
    batchSize: 10000 // << HERE !!!!
) { trip in
    // Remind me to make reservations for trip
}

 

enumerate는 기본적으로 mutation guard를 포함합니다 규모가 큰 순회에서 발생하는 성능 문제는 대부분 열거 중 콘텍스트에 갇힌 변형 때문입니다. allowEscapingMutations로 의도된 결과임을 enumerate에 알릴 수 있습니다. 설정하지 않은 경우 열거를 수행하는 ModelContext가 더티로 발견되면 enumerate가 예외를 발생시켜 이미 순회한 객체의 해제를 막습니다.

let predicate = #Predicate<Trip> { trip in
    trip.bucketListItem.filter {
        $0.hasReservation == false
    }.count > 0
}

let descriptor = FetchDescriptor(predicate: predicate)
descriptor.sortBy = [SortDescriptor(\.start_date)]

context.enumerate(
    descriptor,
    batchSize: 500,
    allowEscapingMutations: true  // <-- HERE!!!
) { trip in
    // Remind me to make reservations for trip
}

 

4. Wrap-up

이번 세션에서는 스키마와 ModelConfiguration으로 효과적인 지속성을 구성하는 법을 알아봤습니다. 또한 ModelContainer와 ModelContext로 실행 취소와 실행 복귀 등 표준 시스템 기능을 쉽게 적용하는 방법도 배웠습니다. 이제 FetchDescriptor와 enumerate를 통해 이전보다 안전하고 우수한 코드를 SwiftData에서 작성할 수 있습니다.

• Adopt Schema and ModelConfiguration
• Adopt undo and redo
• Adopt FetchDescriptor and enumerate