swift - ResultBuilder

什么是 result builder？

struct ContentView: View {
     var body: some View {
         // This is inside a result builder
         VStack {
             Text("Hello World!") // VStack and Text are 'build blocks'
         }
     }
 }

@ViewBuilder var body: Self.Body { get }

自定义一个 result builder

NSAttributedString {
    "Hello "
      .color(.red)
    "World"
      .color(.blue)
      .underline(.blue)
}

一、创建一个函数构造器

@resultBuilder
struct AttributedStringBuilder {
  static func buildBlock(_ segments: NSAttributedString...) -> NSAttributedString {
    let string = NSMutableAttributedString()
    segments.forEach { string.append($0) }
    return string
  }
}

二、创建一个方便的初始化器

extension NSAttributedString {
  convenience init(@AttributedStringBuilder _ content: () -> NSAttributedString) {
    self.init(attributedString: content())
  }
}

// MARK: - extension
extension NSAttributedString {
    func apply(_ attributes: [NSAttributedString.Key:Any]) -> NSAttributedString {
        let mutable = NSMutableAttributedString(string: self.string, attributes: self.attributes(at: 0, effectiveRange: nil))
        mutable.addAttributes(attributes, range: NSMakeRange(0, (self.string as NSString).length))
        return mutable
    }

    func foregroundColor(_ color: UIColor) -> NSAttributedString {
        self.apply([.foregroundColor : color])
    }

    func font(_ font: UIFont) -> NSAttributedString {
        self.apply([.font: font])
    }
}

extension String {
    func foregroundColor(_ color: UIColor) -> NSAttributedString {
        NSAttributedString(string: self, attributes: [.foregroundColor : color])
    }
    func font(_ font: UIFont) -> NSAttributedString {
        NSAttributedString(string: self, attributes: [.font: font])
    }
}

三、大功告成

        let str = NSAttributedString {
            "hello "
                .foregroundColor(.red)
                .font(.systemFont(ofSize: 14))
            "world!"
                .foregroundColor(.label)
                .font(.systemFont(ofSize: 20, weight: .bold))
        }

// 对应 block 中没有值返回的情况
static func buildBlock(_ components: Component...) -> Component

// 通过一个或多个值来构建    必须实现
static func buildBlock(_ components: Component...) -> Component
Combines an array of partial results into a single partial result. A result builder must implement this method.

// 通过可选值来构建，可以支持不包含 else 的 if 语句
static func buildOptional(_ component: Component?) -> Component
Builds a partial result from a partial result that can be nil. Implement this method to support if statements that don’t include an else clause.

// 支持通过条件来变化的值，通过下面这两个方法支持包含 switch 和 if-else 的语句
static func buildEither(first: Component) -> Component
Builds a partial result whose value varies depending on some condition. Implement both this method and buildEither(second:) to support switch statements and if statements that include an else clause.

static func buildEither(second: Component) -> Component
Builds a partial result whose value varies depending on some condition. Implement both this method and buildEither(first:) to support switch statements and if statements that include an else clause.

// 通过数组来构建 可以支持 forin 语句
static func buildArray(_ components: [Component]) -> Component
Builds a partial result from an array of partial results. Implement this method to support for loops.

// 通过 Expression 来生成，Expression 为自定义的表达式 具体可以看官方文档中的例子
static func buildExpression(_ expression: Expression) -> Component
Builds a partial result from an expression. You can implement this method to perform preprocessing—for example, converting expressions to an internal type—or to provide additional information for type inference at use sites.

// 用于对最外层的 `buildBlock` 结果的再包装。例如，让结果构建器隐藏一些它并不想对外的类型（转换成可对外的类型）。
static func buildFinalResult(_ component: Component) -> FinalResult
Builds a final result from a partial result. You can implement this method as part of a result builder that uses a different type for partial and final results, or to perform other postprocessing on a result before returning it.

// 如果提供了 `buildLimitedAvailability` 的实现，构建器提供了对 API 可用性检查（如 `if #available(..)`）的支持。
static func buildLimitedAvailability(_ component: Component) -> Component
Builds a partial result that propagates or erases type information outside a compiler-control statement that performs an availability check. You can use this to erase type information that varies between the conditional branches.

总结

ViewBuilder 研究（上）-- 掌握 Result builders | 肘子的Swift记事本

作为一个严重依赖 SwiftUI 的开发者，同视图打交道是最平常不过的事情了。从第一次接触 SwiftUI 的声明式编程方式开始，我便喜欢上了这种写代码的感觉。但接触地越多，碰到的问题也越多。起初，我单纯地将很多问题称之为灵异现象，认为大概率是由于 SwiftUI 的不成熟导致的。随着不断地学习和探索，发现其中有相当部分的问题还是因为自己的认知不够所导致的，完全可以改善或避免。 我将通过上下两篇博文，对构建 SwiftUI 视图的 ViewBuilder 进行探讨。上篇将介绍 ViewBuilder 背后的实现者 -- result builders ; 下篇将通过对 ViewBuilder 的仿制，进一步地探寻 SwiftUI 视图的秘密。 希望在阅读完两篇文章后能消除或减轻你对下列疑问的困惑： 如何让自定义视图、方法支持 ViewBuilder 为什么复杂的 SwiftUI 视图容易在 Xcode 上卡死或出现编译超时 为什么会出现 "Extra arguments" 的错误提示（仅能在同一层次放置有限数量的视图） 为什么要谨慎使用 AnyView 如何避免使用 AnyView 为什么无论显示与否，视图都会包含所有选择分支的类型信息 为什么绝大多数的官方视图类型的 body 都是 Never ViewModifier 同特定视图类型的 modifier 之间的区别 result builders

https://www.fatbobman.com/posts/viewBuilder1/

ViewBuilder 研究（下） -- 从模仿中学习 | 肘子的Swift记事本

在 上篇 中，我们对 result builders 做了较详细的介绍。本篇我们将通过对 ViewBuilder 的仿制，探索更多有关 SwiftUI 视图背后的秘密。 本文中的视图是指符合 SwiftUI View 协议的各种类型 开发者通过 SwiftUI 框架提供的基础视图类型将自定义的视图串联起来，这些视图将向 SwiftUI 提供如下的信息： 开发者通过声明的方式对用户界面进行轻量级描述。 SwiftUI 会在恰当的时机从开发者创建的视图 body 属性中读取这些描述并进行绘制。 我们常说，视图是状态的函数。对于单个视图来说，它的状态是由所有与之相关的依赖共同组成的。视图的依赖包括：视图的基本属性（无需符合 DynamicProperty 协议）、可驱动视图更新的属性 （ 符合 DynamicProperty 协议，例如 @State、@Environment 等）以及 onRecevie 等元素。 SwiftUI 根据视图层次结构（视图树）中的视图类型和具体位置来区分视图（谁是谁）。对 SwiftUI 来说视图的类型本身就是最重要的信息之一。 与当前视图有关的一些轻量级代码。 SwiftUI 从加载视图、响应状态到屏幕绘制大概经历如下过程： 从根视图开始按视图层级结构沿特定分支（依据初始状态）逐个实例化视图，直到满足当前全部的显示所需 上述实例化后的视图值（结构值，非 body 值）将被保存在 SwiftUI 的托管数据池中 根据视图的依赖信息在 AttributeGraph

https://www.fatbobman.com/posts/viewBuilder2/

附本篇文章中的Demo代码：