SwiftUI 内省

SwiftUI 内省允许你获取 SwiftUI 视图的底层 UIKit 或 AppKit 元素。

例如，使用 SwiftUI 内省，你可以访问 UITableView 来修改分隔符，或访问 UINavigationController 来自定义标签栏。

工作原理

SwiftUI 内省通过在选定视图上方添加一个不可见的 IntrospectionView，并在其下方添加一个不可见的"锚点"视图，然后通过两者之间的 UIKit/AppKit 视图层次结构来查找相关视图。

例如，当内省一个 ScrollView 时...

ScrollView {
    Text("Item 1")
}
.introspect(.scrollView, on: .iOS(.v13, .v14, .v15, .v16, .v17, .v18)) { scrollView in
    // 对 UIScrollView 进行操作
}

... 它将：

1. 在 ScrollView 前后添加标记视图。
2. 遍历两个标记视图之间的所有子视图，直到找到 UIScrollView 实例（如果有的话）。

[!重要] 尽管这种内省方法本身非常可靠，不太可能出错，但未来的操作系统版本需要明确选择加入内省（.iOS(.vXYZ)），因为主要操作系统版本之间的底层 UIKit/AppKit 视图类型可能存在差异。

默认情况下，.introspect 修饰符直接作用于其接收者。这意味着从你尝试内省的视图内部调用 .introspect 将不会产生任何效果。然而，有时这是不可能或者过于不灵活的，在这种情况下，你可以内省一个祖先，但你必须通过覆盖内省的 scope 来明确选择这种方式：

ScrollView {
    Text("Item 1")
        .introspect(.scrollView, on: .iOS(.v13, .v14, .v15, .v16, .v17, .v18), scope: .ancestor) { scrollView in
            // 对 UIScrollView 进行操作
        }
}

在生产环境中使用

SwiftUI 内省旨在生产环境中使用。它不使用任何私有 API。它只使用公开可用的方法检查视图层次结构。该库采用防御性方法来检查视图层次结构：不对元素的布局方式做任何硬性假设，不强制转换为 UIKit/AppKit 类，如果找不到 UIKit/AppKit 视图，.introspect 修饰符将被简单忽略。

安装

Swift Package Manager

Xcode

Package.swift

let package = Package(
    dependencies: [
        .package(url: "https://github.com/siteline/swiftui-introspect", from: "1.0.0"),
    ],
    targets: [
        .target(name: <#目标名称#>, dependencies: [
            .product(name: "SwiftUIIntrospect", package: "swiftui-introspect"),
        ]),
    ]
)

CocoaPods

pod 'SwiftUIIntrospect', '~> 1.0'

内省

已实现

• Button
• ColorPicker
• DatePicker
• 带.compact样式的DatePicker
• 带.field样式的DatePicker
• 带.graphical样式的DatePicker
• 带.stepperField样式的DatePicker
• 带.wheel样式的DatePicker
• Form
• 带.grouped样式的Form
• .fullScreenCover
• List
• 带.bordered样式的List
• 带.grouped样式的List
• 带.insetGrouped样式的List
• 带.inset样式的List
• 带.sidebar样式的List
• ListCell
• Map
• NavigationSplitView
• NavigationStack
• 带.columns样式的NavigationView
• 带.stack样式的NavigationView
• PageControl
• 带.menu样式的Picker
• 带.segmented样式的Picker
• 带.wheel样式的Picker
• .popover
• 带.circular样式的ProgressView
• 带.linear样式的ProgressView
• ScrollView
• .searchable
• SecureField
• .sheet
• Slider
• Stepper
• Table
• TabView
• 带.page样式的TabView
• TextEditor
• TextField
• 带.vertical轴的TextField
• Toggle
• 带button样式的Toggle
• 带checkbox样式的Toggle
• 带switch样式的Toggle
• VideoPlayer
• View
• ViewController
• Window

**缺少某个元素？**请发起讨论。作为临时解决方案，您可以实现自己的可内省视图类型。

无法实现

示例

List

List {
    Text("Item")
}
.introspect(.list, on: .iOS(.v13, .v14, .v15)) { tableView in
    tableView.backgroundView = UIView()
    tableView.backgroundColor = .cyan
}
.introspect(.list, on: .iOS(.v16, .v17, .v18)) { collectionView in
    collectionView.backgroundView = UIView()
    collectionView.subviews.dropFirst(1).first?.backgroundColor = .cyan
}

ScrollView

ScrollView {
    Text("Item")
}
.introspect(.scrollView, on: .iOS(.v13, .v14, .v15, .v16, .v17, .v18)) { scrollView in
    scrollView.backgroundColor = .red
}

NavigationView

NavigationView {
    Text("Item")
}
.navigationViewStyle(.stack)
.introspect(.navigationView(style: .stack), on: .iOS(.v13, .v14, .v15, .v16, .v17, .v18)) { navigationController in
    navigationController.navigationBar.backgroundColor = .cyan
}

TextField

TextField("Text Field", text: <#Binding<String>#>)
    .introspect(.textField, on: .iOS(.v13, .v14, .v15, .v16, .v17, .v18)) { textField in
        textField.backgroundColor = .red
    }

高级用法

实现自己的可内省类型

**缺少某个元素？**请发起讨论。

如果SwiftUI Introspect（不太可能）不支持您正在寻找的SwiftUI元素，您可以实现自己的可内省类型。

例如，以下是该库如何实现可内省的TextField类型：

import SwiftUI
@_spi(Advanced) import SwiftUIIntrospect

public struct TextFieldType: IntrospectableViewType {}

extension IntrospectableViewType where Self == TextFieldType {
    public static var textField: Self { .init() }
}

#if canImport(UIKit)
extension iOSViewVersion<TextFieldType, UITextField> {
    public static let v13 = Self(for: .v13)
    public static let v14 = Self(for: .v14)
    public static let v15 = Self(for: .v15)
    public static let v16 = Self(for: .v16)
    public static let v17 = Self(for: .v17)
    public static let v18 = Self(for: .v18)
}

extension tvOSViewVersion<TextFieldType, UITextField> {
    public static let v13 = Self(for: .v13)
    public static let v14 = Self(for: .v14)
    public static let v15 = Self(for: .v15)
    public static let v16 = Self(for: .v16)
    public static let v17 = Self(for: .v17)
    public static let v18 = Self(for: .v18)
}

extension visionOSViewVersion<TextFieldType, UITextField> { public static let v1 = Self(for: .v1) public static let v2 = Self(for: .v2) } #elseif canImport(AppKit) extension macOSViewVersion<TextFieldType, NSTextField> { public static let v10_15 = Self(for: .v10_15) public static let v11 = Self(for: .v11) public static let v12 = Self(for: .v12) public static let v13 = Self(for: .v13) public static let v14 = Self(for: .v14) public static let v15 = Self(for: .v15) } #endif

### 对未来平台版本进行内省

默认情况下,内省适用于特定的平台版本。这对于定期维护的代码库来说是一个合理的默认设置,以获得最大的可预测性,但对于例如库开发人员来说,这并不总是一个好的选择,他们可能希望覆盖尽可能多的未来平台版本,以便为他们的库提供长期未来功能的最佳机会,而无需定期维护。

对于这种情况,SwiftUI Introspect 在高级 SPI 后面提供了基于范围的平台版本谓词:

```swift
import SwiftUI
@_spi(Advanced) import SwiftUIIntrospect

struct ContentView: View {
    var body: some View {
        ScrollView {
            // ...
        }
        .introspect(.scrollView, on: .iOS(.v13...)) { scrollView in
            // ...
        }
    }
}

请记住,这应该谨慎使用,并充分了解任何未来的操作系统版本都可能破坏预期的内省类型,除非明确可用。例如,如果在上面的例子中,假设 iOS 19 停止在底层使用 UIScrollView,那么在该平台上永远不会调用自定义闭包。

将实例保留在自定义闭包之外

有时,您可能需要将内省的实例保留的时间比自定义闭包的生命周期更长。在这种情况下,@State 不是一个好选择,因为它会产生保留循环。相反,SwiftUI Introspect 在高级 SPI 后面提供了 @Weak 属性包装器:

import SwiftUI
@_spi(Advanced) import SwiftUIIntrospect

struct ContentView: View {
    @Weak var scrollView: UIScrollView?

    var body: some View {
        ScrollView {
            // ...
        }
        .introspect(.scrollView, on: .iOS(.v13, .v14, .v15, .v16, .v17, .v18)) { scrollView in
            self.scrollView = scrollView
        }
    }
}

社区项目

以下是由 SwiftUI Introspect 库支持的开源库列表:

如果您正在开发基于 SwiftUI Introspect 的库或知道一个这样的库,请随时提交 PR 将其添加到列表中。