Swift：轻量级API的设计（二）

韦弦zhy

发布于 2020-02-18 15:39:29

5330

发布于 2020-02-18 15:39:29

文章被收录于专栏：韦弦的偶尔分享

Swift的最强大功能之一就是在设计API方面给我们提供了极大的灵活性。这种灵活性不仅使我们能够定义易于理解和使用的函数和类型，还使我们能够创建给人以非常轻量级为第一印象的API，同时在需要的时候仍可以逐步暴露更多功能和复杂性。

本周，让我们看一下使这些轻量级API得以创建的一些核心语言功能，以及我们如何使用它们来通过组合的力量使功能或系统更加强大。

简书 - API

部分前置内容请先查看 Swift：轻量级API的设计（一）

可变参数和更进一步的组合

接下来，让我们看一下另一个非常有趣的语言功能——可变参数(variadic parameters)——以及它们可以解锁的API设计选择。

现在，我们说我们正在开发一个使用基于形状的绘图来创建其用户界面的一部分的应用程序，并且我们已经使用了与上述类似的基于结构的方法来建模每种形状的绘制方式到DrawingContext中：

struct Shape {
    var drawing: (inout DrawingContext) -> Void
}

上面我们使用inout关键字来启用值类型（DrawingContext）的传递，就好像它是引用一样。有关该关键字的更多信息以及一般的值语义，请查看在Swift中使用值语义。

就像我们以前如何使用静态工厂方法轻松创建ImageTransform值一样，我们现在也能够将每个形状的绘图代码封装在完全独立的方法中，如下所示：

extension Shape {
    static func square(at point: Point, sideLength: Double) -> Self {
        Shape { context in
            let origin = point.movedBy(
                x: -sideLength / 2,
                y: -sideLength / 2
            )

            context.move(to: origin)
            context.drawLine(to: origin.movedBy(x: sideLength))
            context.drawLine(to: origin.movedBy(x: sideLength, y: sideLength))
            context.drawLine(to: origin.movedBy(y: sideLength))
            context.drawLine(to: origin)
        }
    }
}

由于将每个形状简单地建模为一个值，因此绘制它们的数组变得非常容易——我们要做的就是创建一个DrawingContext实例，然后将其传递到每个形状的闭包中以构建最终图像：

func draw(_ shapes: [Shape]) -> Image {
    var context = DrawingContext()
    
    shapes.forEach { shape in
        context.move(to: .zero)
        shape.drawing(&context)
    }
    
    return context.makeImage()
}

调用上面的函数看起来也很优雅，因为我们再次可以使用点语法来大大减少执行工作所需的语法量：

let image = draw([
    .circle(at: point, radius: 10),
    .square(at: point, sideLength: 5)
])

但是，让我们看看是否可以使用可变参数来更进一步。虽然不是Swift独有的功能，但结合Swift真正灵活的参数命名功能后，使用可变参数可以产生一些非常有趣的结果。

当参数被标记为可变参数时（通过在其类型中添加**...**后缀），我们基本上可以将任意数量的值传递给该参数——编译器会自动为我们将这些值组织到一个数组中，例如这个：

func draw(_ shapes: Shape...) -> Image {
    ...
    // 在我们的函数中，"shapes"仍然是一个数组：
    shapes.forEach { ... }
}

完成上述更改后，我们现在可以从对draw函数的调用中删除所有数组文字，而使它们看起来像这样：

let image = draw(.circle(at: point, radius: 10),
                 .square(at: point, sideLength: 5))

这看起来似乎不是很大的变化，但特别是在设计用更低级别的API来创建更多更高级别的API（例如我们的`draw`函数）时，使用可变参数可以使这类API感觉更加轻量级和方便。

但是，使用可变参数的一个缺点是，预先计算的值数组不能再作为单个参数传递。值得庆幸的是，在这种情况下，可以通过创建一个特殊的组(group)形状（就像draw函数本身一样），在一组基础形状上进行迭代并绘制它们来轻松解决：

extension Shape {
    static func group(_ shapes: [Shape]) -> Self {
        Shape { context in
            shapes.forEach { shape in
                context.move(to: .zero)
                shape.drawing(&context)
            }
        }
    }
}

完成上述操作后，我们现在可以再次轻松地将一组预先计算的Shape值传递给我们的draw函数，如下所示：

let shapes: [Shape] = loadShapes()
let image = draw(.group(shapes))

不过，真正酷的是，上述groupAPI不仅使我们能够构造形状数组，而且还使我们能够更轻松地将多个形状组合到更高级的组件中。例如，这是我们如何使用一组组合形状来表示整个图形（例如logo）的方法：

extension Shape {
    static func logo(withSize size: Size) -> Self {
        .group([
            .rectangle(at: size.centerPoint, size: size),
            .text("The Drawing Company", fittingInto: size),
            ...
        ])
    }
}

由于上述logo与其他方法一样都是Shape，因此只需调用一次draw方法就可以轻松绘制它，并使用与之前相同的优雅点语法：