[SwiftData] 01. Meet SwiftData (SwiftData 만나보기)

 

SwiftData 만나보기 WWDC 영상 번역/정리본입니다.

 

 

•  목차
  • 00:00 Intro
  • 01:07 Using the model macro | Swift에 있는 데이터를 직접 모델링하는 새로운 @Model 매크로
  • 03:17 Working with your data | SwiftData로 데이터를 가져오고 수정하는 법
  • 07:02 Use SwiftData with SwiftUI | SwiftData와 매끄럽게 작동하는 다른 플랫폼 프레임워크 소개
  • 08:10 Wrap-up
• doc
  • SwiftData 공식 문서
  • Adopting SwiftData for a core Data app 샘플 프로젝트

 

0. Intro

SwiftData는 데이터 모델링 및 관리 프레임워크로 최신 Swift 앱을 더 업그레이드시켜 줍니다.

SwiftUI와 자연스럽게 통합되기 때문에 CloudKit, Widget 같은 기능과 같이 활용할 수 있습니다.

 

1. Using the model macro

@Model

• Powerful new Swift macro
• Define your schema with code
• Add SwiftData funcionality to model types

@Model은 Swift 코드에서 데이터베이스 스키마 정의를 돕는 새로운 Swift 매크로입니다.

SwiftData 스키마는 보통의 Swift 코드이며, 필요한 경우 추가 메타데이터를 프로퍼티에 주석화할 수 있습니다.

 

Trip 클래스에 @Model 매크로를 추가해 스키마를 생성해볼까요?

class Trip {
	var name: String
	var destination: String
	var endData: Date
	var startData: Date
	
	var bucketList: [BucketListItem]? = []
	var livingAccommodation: LivingAccommodation?
}

import SwiftData

@Model
class Trip {
	var name: String
	var destination: String
	var endData: Date
	var startData: Date
	
	var bucketList: [BucketListItem]? = []
	var livingAccommodation: LivingAccommodation?
}

SwiftData의 모델들은 앱의 스키마에 대한 Source of Truth이며, 유지하는 경험을 줄 수 있는데요. 클래스의 저장 프로퍼티에 변화를 주어 유지되는 프로퍼티로 바꿉니다.

 

Attributes

• Attributes inferred from properties
• Support for basic value types
• Complex value types
  • Struct, Enum, Codable, Collections of value types

SwiftData는 자연적으로 값 타입 프로퍼티가 바로 속성으로 사용됩니다. 문자열, 정수형, 실수형 등 기본 값 타입이 포함됩니다. 또한, 구조체, 열거형과 같은 더 복잡한 값 타입도 포함되고 컬렉션 등 변환 가능한 타입도 포함됩니다.

 

Relationships

• Relationships are inferred from reference types
  • Other model types
  • Collections of model types

SwiftData는 참조형 타입을 관계로 설계합니다.

모델 타입과 모델 타입의 관계 그리고 컬렉션 사이에 관계를 생성할 수 있습니다.

 

Additional metadata

• @Model은 타입에 대한 저장 프로퍼티를 모두 수정합니다.
• 프로퍼티에 대한 메타데이터를 사용해 스키마 구축 방식을 변경할 수 있습니다.
  • @Attribute으로는 유일한 제약조건 추가가 가능합니다.
  • @Relationship으로는 인버스 방식을 선택하고, 삭제 전파 규칙을 지정할 수 있습니다.
• @Transient로는 특정 프로퍼티를 포함하지 말라고 SwiftData에 명령할 수 있습니다.

 

Trip 예시에서, 저장 프로퍼티에 메타데이터를 추가하여 SwiftData의 스키마 생성을 조정해볼까요?

 

import SwiftData

@Model
class Trip {
	var name: String
	var destination: String
	var endData: Date
	var startData: Date
	
	var bucketList: [BucketListItem]? = []
	var livingAccommodation: LivingAccommodation?
}

 

import SwiftData

@Model
class Trip {
	@Attribute(.unique) var name: String // @Attribute(.unique)로 프로퍼티가 유일하도록 지정
	var destination: String
	var endData: Date
	var startData: Date
	
	@Relationship(.cascade) var bucketList: [BucketListItem]? = [] // @Relationship로 관계를 설정하고, (.cascade)로 관련된 항목은 같이 삭제되도록 설정
	var livingAccommodation: LivingAccommodation?
}

 

SwiftData 모델링에 대해 좀 더 알아보려면 'Model your schema with SwiftData' 세션을 확인해 보세요.

 

2. Working with your data

@Model 타입으로 작업하고 운영을 위해 사용해야하는 두 가지 주요 객체 ModelContainer, ModelContext를 알아볼까요?

 

ModelContainer

• Persistence backend
• Customized with configurations
• Provides schema migration options

ModelContainer는 모델 타입에 유지되는 백엔드를 제공합니다. 스키마를 지정하여, 기본 설정을 사용하거나 구성하거나 마이그레이션 옵션으로 커스텀할 수 있습니다.

 

저장하고픈 모델 타입 목록을 지정하기만 하면 모델 컨테이너를 생성할 수 있습니다. 컨테이너가 설정되면 ModelContext로 데이터를 가져와 저장할 준비가 끝납니다.

1) 컨테이너를 커스텀하고 싶은 경우, configuration을 사용해 URL, CloudKit, 그룹 컨테이너 식별자 마이그레이션 옵션을 바꿀 수 있습니다.

import SwiftData

// 기본
let container = try ModelContainer([Trip.self, LigingAccommodation.self]) 

// 커스텀
let customContainer = try ModelContainer(for: [Trip.self, LigingAccommodation.self],
																				configurations: ModelConfiguration(url: URL("path"))) 

 

 

2) SwiftUI에서 컨테이너를 설정해 뷰 환경에서 바로 생성할 수도 있습니다.

import SwiftData
import SwiftUI

@main
struct TripsApp: App {
	var body: some Scene {
		WindowGroup {
			ContentView()
		}
		.modelContainer(for:
			[Trip.self,
			LivingAccommodation.self]
		)
	}
}

 

ModelContext

• Tracking updates
• Fetching models
• Saving changes
• Undoing changes

ModelContext는 모델의 모든 변경 사항을 관찰하고 모델에 적용할 수 있는 많은 작업을 제공합니다. ModelContext는 업데이트를 추적하고 데이터를 가져오며 변경 사항을 저장하거나 실행 취소를 하는 인터페이스입니다.

 

사용방법을 알아볼까요 !?

• SwiftUI 뷰 안에서 사용하기
  SwiftUI에서는 ModelContainer를 생성한 후에 후에 뷰 계층에서 ModelContext를 가져올 수 있습니다.

import SwiftData
import SwiftUI

struct ContextView: View {
	@Environment(\\.modelContext) private var context
}

• 뷰가 아닌 곳에서 사용하기
  • 방법 1) 뷰 계층 구조 밖에서는 모델 컨테이너에게 공통의 메인 액터 바운드 컨텍스트를 달라고 요청할 수 있습니다.
  • 방법 2) 또는, 주어진 컨테이너에 대한 새로운 컨텍스트를 인스턴스화할 수도 있습니다.

import SwiftData

let context = container.mainContext // 방법 1
let context = ModelContext() // 방법 2

 

컨텍스트를 가져왔으니, 데이터를 가져올 준비가 정말 다 되었습니다!!

 

Fetching your data

• New Swift native types
  • Predicate
  • PetchDescriptor
• Improvements to SortDescriptor

Predicate, FetchDescriptor와 같은 새 Swift 네이티브 타입과 SortDescriptor의 개선에서 SwiftData의 장점을 누릴 수 있습니다 !

 

Predicate

• Fully type checked
• #Predicate construction instead of text parsing
• Autocompleted keypaths

iOS 17에 새로 등장하는 Predicate는 Swift 네이티브 타입과 함께 동작합니다. 그리고 강력하게 형식화(분류)된 구조를 위해 Swift 매크로를 사용합니다. 이는 완전한 타입 검사가 이루어져 NSPredicate를 대체하며, Xcode만 있다면 자동완성 기능으로 구현하기도 쉽습니다.

샘플 Trip 앱에 대한 서술자 구축 예시를 살펴봅시다.

let tripPredicate = #Predicate<Trip> { 
	$0.destination == "New York" && // ‘뉴욕'이 목적지인 여행을 지정
	$0.name.contains("birthday") && // 생일과 연관된 여행들로 쿼리 범위 줄이기
	$0.startDate > today // 향후 계획된 여행에만 관심이 있다고 지정
}

 

가져오고자 하는 여행이 무엇인지 결정했다면 새로운 FetchDescriptor 타입을 사용하여 ModelContext에 해당 여행을 가져오라고 명령할 수 있습니다.

let descriptor = FetchDescriptor<Trip>(predicate: tripPredicate)

let trips = try context.fetch(descriptor)

 

SortDescriptor

• Updated to support all Comparable types
• Swift native keypaths

SortDescriptor는 FetchDescriptor와 함께 일부 업데이트되어, 네이티브 Swift 타입과 키패스를 지원합니다.

 

SortDescriptor를 활용해 여행의 순서를 지정하는 데에 사용해볼까요?

let descriptor = FetchDescriptor<Trip>(
	sortBy: SortDescriptor(\\Trip.name),
	predicate: tripPredicate
)

let trips = try context.fetch(descriptor)

 

More FetchDescriptor options

"FetchDescriptor"는 여러분의 SwiftData의 맞춤형 쿼리를 위해 다양한 방법을 제공합니다.

• Relationships to prefetch
• Result limits
• Exclude unsaved changes

Predicate와 Sort 외에도 관련 객체를 지정해 미리 가져오거나 저장되지 않은 변경 사항을 제외해 결과 카운트를 제한하는 등 많은 것들을 할 수 있습니다.

 

Modifying your data

ModelContext를 사용해 데이터 생성, 삭제, 수정을 아주 쉽게 만들기도 합니다.

• Basic operations
  • Inserting
  • Deleting
  • Saving
  • Changing

아래 코드와 같이 Swift 클래스와 같은 모델 객체를 만든 후 컨텍스트에 추가하여 변화 추적 및 유지와 같은 SwiftData 기능을 사용할 수 있습니다.

var myTrip = Trip(name: "Birthday Trip",  destination: "New York")
// ...

// 추가 방법
context.insert(myTrip)

// 삭제 방법
context.delete(myTrip)

// 변경사항 저장 방법 (ModelContext에 값을 저장하고 지속 컨테이너에 커밋하라고 요청) 
try context.save()

 

Modifying your data

• @Model macro modifies setters for change tracking and observation
• Updates automatically by the ModelContext

모델 객체에 대한 프로퍼티 값을 바꾸는 것은 평상시 프로퍼티 setter를 사용하는 것만큼이나 쉽습니다.

@Model 매크로는 저장된 프로퍼티를 수정해 ModelContext가 변경 사항을 자동 추적하고 다음 저장 Operation에 포함시키는 것을 돕습니다.

SwiftData 컨테이너와 컨텍스트, 작업에 대해서는 ‘Dive Deeper into SwiftData’세션 확인 !

 

3. Use SwiftData with SwiftUI

• Seamless integration with SwiftUI
• Easy Configuration
• Automatically fetch data and update views

SwiftData는 SwiftUI를 고려하여 만들어졌기에 둘이 함께 사용하는 것은 아주 쉽습니다. 따라서 SwiftUI는 SwiftData를 사용해볼 수 있는 가장 쉬운 방법입니다.

SwiftData 컨테이너를 설정하는 것이든 데이터를 가져오거나 뷰 업데이트를 하는 것이든 관련된 API가 구축되어있기 때문에, 새 SwiftUI scene, view modifiers는 SwiftData 앱 구축을 시작할 수 있는 가장 쉬운 방법입니다.

 

View modifiers

• Leverage scene and view modifiers
• Configure data store with .modelContainer
• Propagated throughout SwiftUI environment
• SwiftUI will propagate your model context in its environment.

SwiftUI를 통해 데이터 스토어 구성 옵션 변경, 실행 취소 자동저장 토글이 가능하며, SwiftUI는 해당 환경에서 모델 컨텍스트를 전파합니다.

 

SwiftUI 코드를 확인해볼까요?

import SwiftData
import SwiftUI

struct ContentView: View {
	@Query(sort: \\.startDate, order: .reverse) var trips: [Trip]
	@Environment(\\.modelContext) var modelContext
	
	var body: some View [
		NavigationStack() {
			List {
				ForEach(trips) { trip in
					// ...
				}
			}
		}
	}
}

일단 설정하고 나면 가장 쉬운 데이터 사용 방식은 새로운 @Query 프로퍼티 래퍼입니다. 단 한 줄의 코드로 데이터베이스에 저장된 무엇이든 쉽게 로딩하고 필터링할 수 있습니다.

 

Observing changes

• No need for @Published
• SwiftUI automatically refreshes

SwiftData는 모델 프로퍼티에 대해 새로운 observable 기능을 지원합니다.

SwiftUI는 observed 프로퍼티의 변경 사항을 자동으로 새로고침합니다.

SwiftUI와 SwiftData의 프레임워크를 함께 사용하는 법은 'Build an app with SwiftData' 세션을 확인해 보세요.

 

4. Wrap-up

• Define your schema using @Model
• Configure your ModelContainer
• Leverage SwiftUI and SwiftData