Swift之Result Builder

Result Builder是一个自定义的类型，添加了相关语法，用来以自然地、声明的方式来创建嵌套的数据，比如链表和树。使用Result Builder的代码中可以包含原始的Swift语法，比如if和for以方便掌控条件数据或者重复的数据。

如下代码定义了一个新的类型，用来显示一行由*和文本组成的数据。

protocol Drawable {
    func draw() -> String
}

struct Line: Drawable {
    func draw() -> String {
        return elements.map { $0.draw() }.joined(separator: "")
    }
    var elements: [Drawable]
}

struct Space: Drawable {
    func draw() -> String {
        return " "
    }
}

struct Text: Drawable {
    func draw() -> String {
        return content
    }
    init(_ content: String) {
        self.content = content
    }
    var content: String
}

struct Stars: Drawable {
    func draw() -> String {
        return String(repeating: "*", count: length)
    }
    
    var length: Int
}

struct AllCaps: Drawable {
    func draw() -> String {
        content.draw().uppercased()
    }
    
    var content: Drawable
    
}

Drawable协议定义了可以被绘制的组件的要求，比如直线和形状：组件类型必须实现协议要求的draw()方法。结构体Line代表一条直线的绘制，并且他是大多数可绘制类型的最高层次的容器。为了绘制Line，结构体调用各个组件的draw()方法，然后把各个结果字符串连接成一个字符串。Text结构体包装了一个字符串并使其成为绘制的一部分。AllCaps结构体包装并修改另一个可以绘制的实例---把其中的字母全部变为大写。

利用这些类型，通过调用其初始化器很容易绘制一幅图：

let name: String? = "Ravi Patel"
let manualDrawing = Line(elements: [
    Stars(length: 3),
    Text("Hello"),
    Space(),
    AllCaps(content: Text((name ?? "World") + "!")),
    Stars(length: 2)
])
print(manualDrawing.draw())
// Prints: ***Hello RAVI PATEL!**

代码可以正常运行，但是略显笨拙。AllCaps里面的深层次嵌套括号使人难以理解。name是nil的时候使用"World"替换的补充逻辑必须使用??操作符，当使用更复杂的字符串时，这个逻辑会变得更加困难。你完全没有办法在你需要的时候使用switch或者for循环来构建图片的片段。Result Builder能够让你重构代码使其更像正常的 Swift代码。

通过在类型声明前添加@resultBuilder特性来定义一个Result Builder。下面的代码定义了一个叫做DrawingBuilder的Result Builder，它可以让你使用声明式语法来描述绘制过程。

@resultBuilder
struct DrawingBuilder {
    static func buildBlock(_ components: Drawable...) -> Drawable {
        return Line(elements: components)
    }
    static func buildEither(first component: Drawable) -> Drawable {
        return component
    }
    static func buildEither(second component: Drawable) -> Drawable {
        return component
    }
}

DrawingBuilder定义了三个方法，实现了Result Builder的部分语法规则。buildBlock(_:)方法为在一个代码块中实现绘制一系列直线提供了支持---把多个可以绘制的组件组合到了一个Line中。buildEither(first:)和buildEither(second:)为if-else提供了支持。

可以把@DrawingBuilder应用在函数参数上，并把传入函数的闭包转换成Result Builder根据闭包创建的值。代码如下：

func draw(@DrawingBuilder content: () -> Drawable ) -> Drawable {
    return content()
}

func caps(@DrawingBuilder content: () -> Drawable ) -> Drawable {
    return AllCaps(content: content())
}

func makeGreeting(for name: String? = nil) -> Drawable {
    let greeting = draw {
        Stars(length: 3)
        Text("Hello")
        Space()
        caps {
            if let name = name {
                Text(name + "!")
            } else {
                Text("World!")
            }
        }
        Stars(length: 2)
    }
    return greeting
}

let genericGreeting = makeGreeting()
print(genericGreeting.draw()) 
// Prints ***Hello WORLD!**

makeGreeting(for:)需要一个name参数并使用它构造一个个性化的问候。drwa(_:)和caps(_:)函数都需要一个标记了@DrawingBuilder的闭包作为参数。当你调用这些函数，你使用了DrawingBuilder定义的特殊语法。Swift把一幅绘制内容的声明式描述转化为一系列的DrawingBuilder上的函数调用，来构造作为函数参数传进来的值。例如，Swift把caps(_:)的调用转化为下面的代码：

let capsDrawing = caps {
    let partialDrawing:Drawable
    if let name = name {
        let text = Text(name + "!")
        partialDrawing = DrawingBuilder.buildEither(first: text)
    } else {
        let text = Text("World!")
        partialDrawing = DrawingBuilder.buildEither(second: text)
    }
    return partialDrawing
}

Swift把if-else的代码块转化为buildEither(first:)和buildEither(second:)函数的调用。尽管在你的代码里面们不会调用这些函数，展示出来的转换结果使得弄清楚当你使用DrawingBuilder语法时Swift是如何转换你的代码这件事变得比较容易。

为特殊绘制语法添加for循环的支持，只需要在DrawingBuilder中添加buildArray(_:)方法：

extension DrawingBuilder {
    static func buildArray(_ components: [Drawable]) -> Drawable {
        return Line(elements: components)
    }
}

let manyStars = draw {
    Text("Stars:")
    for length in 1...3 {
        Space()
        Stars(length: length)
    }
}

print(manyStars.draw())
// Prints Stars: * ** ***

上面的代码中，for循环创建了一批可以绘制的组件，buildArray(_:)方法把这一批组件转化为一个Line组件。

想要了解更多关于Swift把创建器语法转化为创建器类型方法的调用的原理，参考Swift特性下面关于resultBuilder的讲解。