3.8 共享布局信息


GeometryReader

GeometryReader 视图的构建闭包内返回了一个 GeometryProxy 类型的结构体,通过它可以获取到如下信息:

  • size:GeometryReader 视图的尺寸。
  • frame(in:):GeometryReader 视图在不同坐标空间内的 frame 信息。
  • safeAreaInsets:GeometryReader 视图的安全区域。

示例中通过 GeometryProxy 实例获取到视图的 size 后,设置两个蓝色方块的高度分别为父视图的 1/3 和 2/3:

1
2
3
4
5
6
7
8
9
VStack {
  Rectangle()
    .fill(.blue)
    .frame(height: proxy.size.height / 3)
  
  Rectangle()
    .fill(.blue)
    .frame(height: proxy.size.height * 2 / 3)
}

> 查看示例

GeometryProxy 中的 frame(in:) 方法参数 coordinateSpace 是一个枚举类型:

1
2
3
case global // 参考系为屏幕或窗口
case local // 参考系为自身
case named(AnyHashable) // 参考系为自定义

示例中设置橙色区域高度为 400,GeometryReader 视图高度为 300:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
VStack {
  GeometryReader { proxy in
    VStack {
      //...
    }
    .onAppear {
      globalFrame = proxy.frame(in: .global)
      localFrame = proxy.frame(in: .local)
      namedFrame = proxy.frame(in: .named("VStack"))
    }
  }
  .frame(height: 300)
}
.frame(height: 400)
.background(.orange)
.coordinateSpace(name: "VStack")

最终获取到的 globalFrame 以屏幕或窗口为参考坐标系,localFrame 以 GeometryReader 自身为参考,而 namedFrame 以指定的 VStack 为参考系。

PreferenceKey

PreferenceKey 可以用于收集视图树中的数据,将其传递给其它视图。

比如想要获取视图树中任意一个 view 的尺寸,先实现 PreferenceKey 协议用于保存获取到的尺寸信息:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
fileprivate struct BoundsPreferenceKey: PreferenceKey {
  
  // 没有设置 PreferenceKey 时的默认值
  static var defaultValue: CGRect = .zero
  
  // 收集视图树中的数据
  // nextValue 是惰性调用的,需要时才会去获取相应的值
  static func reduce(value: inout CGRect, nextValue: () -> CGRect) {
    value = nextValue()
  }
}

然后为 View 扩展一个 Modifier:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
fileprivate struct SizeModifer: ViewModifier {
  let onChange: (CGSize) -> Void
  
  func body(content: Content) -> some View {
    content
      .background(
        GeometryReader { proxy in
          Color.clear
            // 获取尺寸信息并传递给 BoundsPreferenceKey
            .anchorPreference(
              key: BoundsPreferenceKey.self,
              value: .bounds
            ) {
              proxy[$0]
            }
            // 监听 BoundsPreferenceKey 值的变化并回传
            .onPreferenceChange(BoundsPreferenceKey.self) {
              onChange($0.size)
            }
        }
      )
  }
}

fileprivate extension View {
  
  func onChangeOfSize(
    perform action: @escaping (CGSize) -> Void
  ) -> some View {
    modifier(SizeModifer(onChange: action))
  }
}

这里用了一个取巧的办法,我们给需要获取尺寸的 view 添加一个透明背景,通过 GeometryReader 拿到这个透明背景的尺寸信息后,使用 anchorPreference 方法将获取到的尺寸传给自定义的 BoundsPreferenceKey 进行保存,同时使用 onPreferenceChange 方法监听 BoundsPreferenceKey 的变化并将其回传出去。

SwiftUI 的布局系统本身就比较复杂,如果可以通过其它方法实现想要的布局效果,建议尽量避免使用 PreferenceKey。也许有了 Layout 协议之后,GeometryReader 和 PreferenceKey 的出场率会更低,但无妨了解一下,兴许有些冷门的问题还需要它们来解决。