SwiftUI 中的属性包装器

SwiftUI中,包装器详细说明

下面罗列17个包装器的说明。
@AppStorage 从 UserDefaults 读取和写入值。
@Binding 引用另一个视图拥有的值类型数据。在本地更改绑定也会更改远程数据。
@Environment 允许我们从系统读取数据,例如配色方案,可访问性选项和特征集,但是如果需要,您可以在此处添加自己的密钥。
@EnvironmentObject 读取我们放入环境中的共享对象。
@FetchRequest 为特定实体启动核心数据获取请求。
@FocusedBinding 旨在监视键窗口中的值,例如当前选定的文本字段。
@FocusedValue 是 @FocusedBinding 的简单版本,不会为您解开绑定值。
@GestureState 存储与当前正在进行的手势关联的值,例如您滑动了多远,除非在手势停止时它将重置为其默认值。
@Namespace 创建一个动画名称空间,以允许匹配的几何效果,该效果可以由其他视图共享。
@NSApplicationDelegateAdaptor 用于创建类并将其注册为 macOS 应用程序的应用程序委托。
@ObservedObject 引用符合 ObservableObject 协议的外部类的实例。
@Published 附加到 ObservableObject 内的属性,并告诉 SwiftUI 它应该在更改此属性时刷新使用此属性的所有视图。
@ScaledMetric 会读取用户的动态类型设置,并根据您提供的原始值向上或向下缩放数字。
@SceneStorage 使我们可以保存和还原少量数据以进行状态还原。
@State 允许我们在视图本地操作少量的值类型数据。
@StateObject 用于存储符合 ObservableObject 协议的引用类型数据的新实例。
@UIApplicationDelegateAdaptor 用于创建一个类并将其注册为iOS应用程序的应用程序委托。


SwiftUI属性包装器.png

@State、@Binding、@ObservedObject和@EnvironmentObject是几个重要的属性包装器,它们各自在数据管理和视图更新中扮演着不同的角色。有的配合使用,下面给出几个例子介绍下用法

State

@State用于在视图中声明可变的状态属性,并自动更新视图。当@State修饰的属性值发生变化时,SwiftUI会自动重新渲染视图以反映这些变化。
在这个例子中,count是一个@State属性,它控制着一个计数器的值。当按钮被点击时,count的值会增加,并且由于count是@State属性,SwiftUI会自动更新视图以显示新的计数值。

struct ContentView: View {
    @State private var count: Int = 0
    
    var body: some View {
        VStack {
            Image(systemName: "globe")
                .imageScale(.large)
                .foregroundStyle(.tint) 
            Text("Hello, SwiftUI \(count)")
            Button(action: {
                count += 1
            }, label: {
                Text("Increment")
            })  
        }
        .padding()
    }
}

Binding

@Binding用于在不同视图之间传递和共享可读写的值。它创建了一个对属性的引用,以便多个视图可以共享同一份数据,并且对数据的更改会在所有引用的地方生效。

在这个例子中,ParentView有一个@State属性isChildViewVisible,它控制ChildView的可见性。通过@Binding,ChildView能够访问并修改isChildViewVisible的值,从而控制自己的显示状态。

struct ParentView: View {
    
    @State private var isChildViewVisible = false
    var body: some View {
        VStack {
            Toggle(isOn: $isChildViewVisible) {
                Text("Show Child View")
            }
            if isChildViewVisible {
                ChildView(isVisible: $isChildViewVisible)
            }
        }
    }
}

struct ChildView: View {
    @Binding var isVisible: Bool
    var body: some View {
        Text("Child View")
            .padding()
        Button(action: {
            isVisible = false
        }) {
            Text("Hide")
        }
    }
}

StateObject

@StateObject
@StateObject用于在SwiftUI视图中创建并管理一个可观察的对象(通常是实现了ObservableObject协议的类)。这个对象会在视图的生命周期内保持唯一,即使视图被重新渲染。
在这个例子中,ViewModel是一个实现了ObservableObject协议的类,它有一个@Published属性text。ContentView使用@StateObject来创建并管理ViewModel的实例。当按钮被点击时,text属性的值会更新,并且由于ViewModel是可观察的,ContentView会自动重新渲染以显示新的文本。

class ViewModel: ObservableObject {  
    @Published var text = "Hello, World!"  
}  
  
struct ContentView: View {  
    @StateObject var viewModel = ViewModel()  

    var body: some View {  
        VStack {  
            Text(viewModel.text)  
            Button(action: {  
                viewModel.text = "Updated Text!"  
            }) {  
                Text("Update Text")  
            }  
        }  
    }  
}  

ObservedObject

@ObservedObject用于观察引用类型对象的变化,并在对象更改时更新视图。它通常用于管理外部对象的状态,并在该对象发生变化时自动刷新视图。
在这个例子中,UserData是一个遵循ObservableObject协议的类,它有一个@Published属性name。ContentView使用@ObservedObject来观察UserData对象,当name属性发生变化时,ContentView会自动更新以显示新的名称。

//必须要集成 ObservableObject
class UserData: ObservableObject {
  //需要监听的属性需要  Published
    @Published var name: String = ""
}
  
struct UserDataContentView: View {
    @ObservedObject var user = UserData()
    var body: some View {
        VStack {
            //user.name 绑定到TextField上
            TextField("Enter your name", text: $user.name)
                .textFieldStyle(.roundedBorder)
            Text("Hello, \(user.name)!")
        }
    }
}

AppStorage

@AppStorage 是 SwiftUI 中的一个属性包装器,它允许开发者将属性的值存储在 UserDefaults 中,并在应用程序的不同启动之间保留这些值。这对于存储用户偏好设置等非常有用。

声明和用法
要使用 @AppStorage,你需要将其附加到你的属性上,并指定一个键(key)和一个默认值。例如:
@AppStorage("user_name") var username: String = "Guest"
在这个例子中,username 属性使用 @AppStorage 进行存储和检索,它的键为 "user_name",默认值为 "Guest"。如果 UserDefaults 中已经存在 "user_name" 这个键对应的值,那么 username 将被初始化为那个值;如果不存在,则使用默认值 "Guest"。

struct ContentView: View {  
    @AppStorage("user_name") var username: String = "Guest"  
  
    var body: some View {  
        VStack {  
            Text("Hello, \(username)!")  
            Button("Change Username") {  
                username = "NewUser"  
            }  
        }  
    }  
}

在这个示例中,username 属性使用 @AppStorage 进行存储和检索。当用户点击 "Change Username" 按钮时,username 的值会更改为 "NewUser",并且在应用程序的不同启动之间保留这个更改。

注意事项

  • 数据类型匹配:存储的数据类型必须与属性的声明类型匹配。@AppStorage 支持基本数据类型(如 String、Int、Bool 等),但不能直接用于自定义类或结构体。
  • 默认值:如果不设置默认值,则变量的类型为可选值类型(如 String?)。
  • UserDefaults:@AppStorage 底层使用 UserDefaults 来存储数据。因此,对 UserDefaults 的操作将直接影响对应的 @AppStorage。
  • 数据安全性:由于 UserDefaults 的数据相对容易提取,因此不要在其中保存与隐私有关的重要数据。
  • 数据同步:为了效率的考量,UserDefaults 中的数据在发生变化时并不会立即持久化,系统会在认为合适的时机才将数据保存在硬盘中。因此,可能发生数据不能完全同步的情况,严重时有数据彻底丢失的可能。

EnvironmentObject

@EnvironmentObject用于在应用程序中共享和访问全局数据。它允许你在应用程序的任何视图中访问和使用共享数据,而无需手动传递它们。
在这个例子中,UserData是一个全局的ObservableObject,它存储了用户的信息。ContentView使用@EnvironmentObject来访问UserData对象,并在视图中显示用户名称。在MyApp中,userData对象被创建并通过.environmentObject方法注入到ContentView中,使得ContentView能够访问到全局的用户数据。

class UserData: ObservableObject {
    @Published var name: String = "John"
}

struct ContentView: View {
    @StateObject var userData = UserData()
    var body: some View {
        VStack {
            UserDataContentView().environmentObject(userData)
        }
        .padding()
    }
}

struct UserDataContentView: View {
    @EnvironmentObject var userData: UserData
    var body: some View {
        VStack {
            Text("Hello, \(userData.name)!")
        }
    }
}

FocusState

@FocusState用于管理视图中的焦点状态。在需要键盘输入或特定交互的视图中,@FocusState可以帮助开发者确定哪个视图当前具有焦点,并相应地调整UI。
由于SwiftUI的TextField默认不支持直接的焦点API,上述示例中的.focused($isFocused)是假设性的,用于说明@FocusState的概念。在实际应用中,你可能需要借助UIViewRepresentable或其他技术来实现焦点管理。

struct ContentView: View {  
    @FocusState var isFocused: Bool  
  
    var body: some View {  
        VStack {  
            TextField("Type something...", text: .constant(""))  
                .focused($isFocused)  
            Button(action: {  
                isFocused = !isFocused  
            }) {  
                Text(isFocused ? "Lose Focus" : "Gain Focus")  
            }  
        }  
    }  
}  
  
// 注意:由于TextField在SwiftUI中默认不支持直接的focus API,这里使用了伪代码来展示概念。  
// 在实际应用中,你可能需要使用自定义的UIViewRepresentable来包装UIKit的UITextField或使用其他方法来实现焦点管理。

Environment

@Environment 属性包装器
虽然@Environment属性包装器在SwiftUI中不如@EnvironmentObject常见,但它用于访问系统级的环境值,如布局方向、颜色方案等。这些值由SwiftUI框架自动管理,并在需要时传递给视图。
@Environment是获取系统环境变量的。例如isEnabled,editMode,presentationMode,horizontalSizeClass,verticalSizeClass等。
示例(假设性代码,因为@Environment通常不直接用于访问这些值,而是使用其他方式,如@Environment(.keyPath)):

struct MyView: View {  
    // 假设的代码,实际中不会这样使用@Environment直接访问系统值  
    // @Environment var layoutDirection: LayoutDirection // 这不是有效的用法  
  
    // 正确的用法是使用@Environment和键路径  
    @Environment(\.layoutDirection) var layoutDirection: LayoutDirection  
  
    var body: some View {  
        // 根据布局方向调整UI  
        if layoutDirection == .leftToRight {  
            // ...  
        } else {  
            // ...  
        }  
    }  
}

请注意,上面的@Environment var layoutDirection: LayoutDirection示例是假设性的,因为@Environment通常与键路径一起使用(如@Environment(.layoutDirection)),而不是直接声明变量类型。在SwiftUI中,你更可能会看到像@Environment(.layoutDirection) var layoutDirection: LayoutDirection这样的用法。

总的来说,@EnvironmentObject是SwiftUI中用于在视图之间共享可观察对象的强大工具,而@Environment(与键路径一起使用时)则用于访问系统级的环境值。

参考: https://zhuanlan.zhihu.com/p/663955261

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容