@FocusedBinding 浅谈

在苹果 WWDC20 中视频中出现了下面的代码,介绍了一个新的属性包装器@FocusedBinding。由于仍处于测试阶段,当前的代码并不能被正确的执行。@FocusedBinding 的资料苹果披露的也很少,网上也没有相关的信息。出于个人兴趣,我对它进行了简单的研究。尽管@FocusedBinding 在目前 Xcode Version 12.0 beta 2 (12A6163b) 的版本上运行还有很多问题,但我基本上对其有了一定的了解。

健康笔记是我开发的一个iOS app,主要服务于有长期健康管理需求的人士。健康笔记提供了强大的自定义数据类型功能,可以满足记录生活中绝大多数的健康项目数据的需要。你可以为每个家庭成员创建各自的健康数据记录笔记,或者针对某个特定项目、特定时期创建对应的笔记。

推广
struct BookCommands: Commands {
 @FocusedBinding(\.selectedBook) private var selectedBook: Book?
  var body: some Commands {
    CommandMenu("Book") {
        Section {
            Button("Update Progress...", action: updateProgress)
                .keyboardShortcut("u")
            Button("Mark Completed", action: markCompleted)
                .keyboardShortcut("C")
        }
        .disabled(selectedBook == nil)
    }
  }

   private func updateProgress() {
       selectedBook?.updateProgress()
   }
   private func markCompleted() {
       selectedBook?.markCompleted()
   }
}

用途

在任意视图(View)之间数据共享、修改、绑定操作。

在 SwiftUI1.0 中,我们可以使用 EnvironmentKey 向子视图传递数据,使用 PreferenceKey 向父视图传递数据。如果我们想在不在同一视图树上的两个平行视图间进行数据传递的话,通常需要使用 Single of truth 或者通过 NotificationCenter 来进行。

在 SwiftUI2.0 中,苹果引入了@FocusedBinding 和@FocusedValue 来解决这个问题。通过定义 FocusedValueKey,我们可以在任意的视图之间,无需通过 Single of truth,便可以直接进行数据共享、修改、绑定。

SwiftUI2.0 —— Commands(macOS 菜单) 这篇文章中,我们通过了 Single of truth 的方式,在 App 这个层级,使 Commnads 可以同其他视图进行数据共享。通过 WWDC 提供的例子,我们可以看出,苹果希望能够提供一种其他的解决方案,完成上述的功能。同样,这种方案也使我们拥有了可以在任意视图(无论是否在同一颗树上,是否有联系)之间进行数据交换。

使用方法

其基本的使用方式和 Environment 很类似,都需要首先定义指定的 Key

struct FocusedMessageKey:FocusedValueKey{
    //同 EnvironmentKey 不同,FocusedValueKey 没有缺省值,且必须是一个可选值。为了下面的演示,在这里我们将数据类型设置为 Binding<String>, 可以设置为任意值类型数据
    typealias Value = Binding<String>
}

extension FocusedValues{
    
    var message:Binding<String>?{
        get{self[FocusedMessageKey.self]}
        set{self[FocusedMessageKey.self] = newValue}
    }
}

由于可以使用在任意视图,所以数据无需注入。和 EnvironmentKey 不同(只在当前注入的视图树之下有效),数据在全域有效。

struct ShowView:View{
    //调用方式同@Environment 几乎一致,使用@FocusedValue 或@FocusedBinding 需不同的引用方式
    @FocusedValue(\.message) var focusedMessage
    //@FocusedBinding(\.message) var focusedMessage1
    var body: some View{
        VStack{
        Text("focused:\(focusedMessage?.wrappedValue ?? "")")
        //Text("focused:\(focusedMessage1 ?? "")")
        }
    }
}

在另一视图对该 FocusedValueKey 数据进行修改。

struct InputView1:View{
    @State private var text = ""
    var body: some View{
        VStack{
        TextField("input1:",text:$text)
            .textFieldStyle(RoundedBorderTextFieldStyle())
            //使 message 和 text 同步
            .focusedValue(\.message, $text)
        }
    }
}

可以在多个视图对同一 FocusedValueKey 进行修改

struct InputView2:View{
    @State private var text = ""
    var body:some View{
        TextField("input2:",text:$text)
            .textFieldStyle(RoundedBorderTextFieldStyle())
            .focusedValue(\.message, $text)
    }
}

最后组装在一起

struct RootView: View {
    var body: some View {
        VStack{
            //三个视图是平行关系,在之前使用 Environment 或者 Preference 都无法在这三个视图间进行数据传递、共享
            InputView1()
            InputView2()
            ShowView()
        }
        .padding(.all, 20)
        .frame(maxWidth:.infinity, maxHeight: .infinity)
    }
}

目前在 iOS 下无法获取 FocusedValueKey 数值,文档中标识是支持 iOS 的,应该在未来会解决

如何用,怎么用?

FoccusedBinding 的引入,进一步完善了 SwiftUI 不同视图中数据操作的功能。不过个人建议还是不要滥用此功能。

由于我们可以在任意视图中修改 key 中的值,一旦滥用,很可能再度陷入代码难以管理的窘境。

对于一些功能很简单,无需使用 MVVM 逻辑的代码,或者 Single of truth 过于臃肿(ObservableObject 研究——想说爱你不容易),可能导致 app 响应问题的代码,可以考虑使用上述的方案。

本博客所有文章除特别声明外,均采用CC 4.0许可协议。转载请注明出处和作者。

关注微信公共号肘子的Swift记事本或在推特上关注@fatbobman,永远不会错过新内容! 您的支持和鼓励将为我的博客写作增添更多的动力! 如果您或身边的朋友有健康数据管理的需求,请使用我开发的app【健康笔记】,正是因为它我才创建了这个博客。

关注