SwiftUI의 Property Wrapper들

Property Wrapper

• Swift 5.1 부터 소개 된 Property Wrapper이지만 SwiftUI에서 본격적으로 사용됨
• Property wrapper를 직접 생성하는 것도 가능하지만 SwiftUI에서는 불필요
• SwiftUI는 총 17개의 Property Wrapper들을 제공

Property Wrapper	기능	데이터의 소유주
@AppStorage	UserDefault로부터 값을 읽고 씀.	X
@State	하나의 view(구조체) 내에서 작은 단위의 value type 데이터를 수정.	O
@Binding	다른 view가 소유하고 있는 value type을 가르키며 해당 값이 바뀌면 외부의 값도 바뀜.	X
@FocusedBinding	key window에 있는 값 변화를 관찰(ex. 현재 선택 된 text field).	X
@FocusedValue	FocusedBinding의 간단한 형태.	X
@StateObject	ObservableObject protocol을 따르는 Reference type의 새로운 객체를 저장.	O
@ObservedObject	ObservableObject protocol을 따르는 Reference type의 외부 클래스에 있는 객체를 가르킴.	X
@Environment	System으로부터 데이터(color scheme, accessibility option 등)를 읽을 수 있게 해줌. 직접 추가도 가능	X
@EnvironmentObject	Environment에 저장한 shared object를 읽어옴.	X
@Published	ObservableObject 내의 property에 붙으며 해당 값이 바뀌면 이 property를 쓰는 view를 새로 그림.	O
@FetchRequest	CoreData의 특정 entity에 대한 fetch request를 시작	O
@GestureState	지금 진행되고 있는 gesture와 관련된 값을 저장(ex. 얼마나 swipe 했는가)	O
@Namespace	creates an animation namespace to allow matched geometry effects	O
@UIApplicationDelegateAdaptor	class를 iOS app에서 app delegate으로 생성 및 등록	O
@NSApplicationDelegateAdaptor	class를 macOS app에서 app delegate으로 생성 및 등록	O
@ScaledMetric	reads the user’s Dynamic Type setting and scales numbers up or down based on an original value you provide	O
@SceneStorage	상태 복구를 위해 적은 양의 데이터를 저장&복구	O

@UIApplicationDelegateAdaptor

• 최신 SwiftUI는 AppDelegate을 생성해주지 않지만 AppDelegate들의 메소드들이 필요할 때가 있음
• miniVIBE에서는 didFinishLaunchingWithOptions 를 통해 launch 된 시점을 잡을 필요가 있어서 사용
• AppDelegate 클래스를 생성해주고 @main 안에서 해당 property wrapper를 써서 관리 가능

class AppDelegate: NSObject, UIApplicationDelegate {
   func application(_ application: UIApplication,
                    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil) -> Bool {
      // action
      return true
   }
}

@main
struct OurApp: App {
   @UIApplicationDelegateAdaptor(AppDelegate.self) var appDelegate
   ...
}

@State

• 구조체는 value type이라서 내부 property들의 값 변경이 (원칙적으로는) 안됨
• @State를 사용할 경우, 그 값을 저장하는 곳이 구조체 내부가 아닌 SwiftUI가 관리하는 shared storage로 바뀜. 따라서 state 값에 따라 언제든지 SwiftUI가 이 구조체를 없애고 재생성 가능. (빈번히 일어남)
• 다른 view 들과 공유하지 않는 것이 원칙. (Apple은 private으로 생성할 것을 권장)
• miniVIBE 에서는 Player에서 메뉴창이 열려있는지 판별하고 조절 확인하기 위해 사용

struct PlayerView: View {
   @State private var isMenuOpen: Bool = false
   ...
   var body: some View {
      ZStack {
      // 다양한 component
      }
      .fullScreenCover(isMenuOpen: $isLyricsOpen) {
         // 보여질 content(ex. MenuView)
      }
   }
}

@Binding

• 값의 source는 외부에 있으며 두 군데 모두에서 값을 공유해야할 때 사용(@State의 값을 넘겨받는 등)
• miniVIBE에서는 Player에서 가사창이 열려있는지를 하위 view에서 값을 조절

struct PlayerThumbnail: View {
   @Binding var isLyricsOpen: Bool
   ...
   var body: some View {
      ...
      Text("Open")
         .onTapGesture {
            isOpenLyrics = true
         }
   }
}

@Environment

• 사전에 정의된 key 값들로 작동
• miniVIBE에서는 modal 창을 닫기 위해 사전에 정의된 presentationMode 사용

struct PlayerMenu: View {
   @Environment(\.presentationMode) var presentationMode
   ...
   var body: some View {
      Button {
         presentationMode.wrappedValue.dismiss()
      }, label: { Image(systemName: "xmark") }
   }
}

@EnvironmentObject

• 주로 SwiftUI app 전반에서 쓰일 공유 데이터를 위해 쓰이는 property wrapper
• ObservableObject를 따라야 함
• EnvironmentObject를 가지는 view가 생성의 책임을 지지 않고 SwiftUI의 Environment에 의해 제공
• A, B, C, D view가 부모-자식 관계를 형성하고 있고 A에서 생성된 observable한 객체를 D가 필요로 할때 중간 B, C가 넘겨주지 않아도 됨
  • A가 생성해서 environment에 넣으면 hierarchy에 있는 B, C, D 모두 접근 가능
• miniVIBE에서는 현재 재생과 관련된 class는 모든 뷰에서 접근 가능해야 하므로 App(최상단)에서 생성 후 environment에 넣음

class NowPlaying: ObservableObject {
   ...
}

@main
struct MiniVibeApp: App {
   let nowPlaying = NowPlaying()
   ...
   var body: some Scene {
      WindowGroup {
         MainTab()
            .environmentObject(nowPlaying)
      }
   }
}

@ObservedObject

• 현재 View 외부의 data를 관찰하고자 할 때 사용
• 실수로 저장하고 있던 object를 메모리에서 해제시킬 경우가 생김

@StateObject

• View 내에서 reference type을 생성하고 무조건 메모리에 있어야 할 때 사용

@Published

• ObservableObject 내의 property 앞에 붙이면 해당 property의 값이 바뀌었음을 알리고 해당 값을 쓰는 view는 바뀐 값에 맞게 업데이트하게 해줌
• miniVIBE에서는 View-ViewModel 바인딩을 @Published로 함