深入解读 Swift Evolution SE-0256:`{Mutable}ContiguousCollection` 协议提案
深入解读 Swift Evolution SE-0256:{Mutable}ContiguousCollection 协议提案
本篇文章基于 Swift 官方演进仓库中的提案文档 proposals/0256-contiguous-collection.md,系统梳理 SE-0256 的核心内容:为何要在 Collection 协议族之上引入 ContiguousCollection 与 MutableContiguousCollection 两个新协议、它们与已实现的 SE-0237 方法 withContiguousStorageIfAvailable 之间的分工关系,以及围绕 Array 连续存储边界条件的完整讨论。读完本文,你将理解 Swift 标准库在"不安全缓冲指针访问"与"泛型协议抽象"之间的设计权衡,并掌握用协议约束在编译期强制"连续内存"这一能力的完整思考路径。
一、提案背景:从 SE-0237 到 SE-0256 的演进
SE-0256 并非凭空出现,它的直接前身是 SE-0237(Introduce withContiguous{Mutable}StorageIfAvailable methods),后者已在 Swift 5.0 中实现。
SE-0237 解决的核心问题是:withUnsafeBufferPointer 与 withUnsafeMutableBufferPointer 这两个能拿到底层不安全缓冲的方法,只存在于 Array 等具体类型上,泛型代码无法使用。为此 SE-0237 在 Sequence 与 MutableCollection 上引入了两个新方法:
protocol Sequence {
func withContiguousStorageIfAvailable<R>(
_ body: (UnsafeBufferPointer<Element>) throws -> R
) rethrows -> R?
}
protocol MutableCollection {
public mutating func withContiguousMutableStorageIfAvailable<R>(
_ body: (inout UnsafeMutableBufferPointer<Element>) throws -> R
) rethrows -> R?
}
这两个方法的语义是"如果有连续底层存储就用,没有就返回 nil,由调用方决定如何回退"。SE-0237 文档指出,这种设计让 sort 之类的泛型算法能在拿到连续缓冲时获得显著加速(例如将元素在辅助存储间来回移动时可以使用整块内存移动),而在拿不到时仍能退回到常规路径。
SE-0237 的"Alternatives considered"一节明确记录:它最初提出的正是两个协议(ContiguouslyStored 与 MutableContiguouslyStored),但因为引入了更低层的定制点(customization points),这两个协议当时被认为没有必要,于是被搁置——"如果存在需要在编译期断言连续性的合理使用场景,这些协议可以被重新提出"。SE-0256 正是这一承诺的兑现:被搁置的协议因新的使用场景而重新提上议程。
二、动机:为什么需要"编译期保证连续存储"的协议
SE-0237 提供的是运行时探测("有没有?有就用,没有就回退"),但有一类操作只希望在存在快速路径时才可用。提案给出的典型例子是 Swift 友好的 vDSP 算法封装。
2.1 withContiguousStorageIfAvailable 模式的局限
假设你要给 vDSP_vadd 写一个便捷封装(提案明确声明这只是简化示例,并非关于 vDSP 封装本身的提案):
func dspAdd<A: Collection, B: Collection>(
_ a: A, _ b: B, _ result: inout [Float]
) where A.Element == Float, B.Element == Float {
let n = a.count
// 尝试访问底层连续缓冲:
let wasContiguous: ()?? =
a.withContiguousStorageIfAvailable { abuf in
b.withContiguousStorageIfAvailable { bbuf in
vDSP_vadd(abuf.baseAddress!, 1, bbuf.baseAddress!, 1, &result, 1, UInt(n))
}
}
// 如果不连续,就创建两个数组重试
if wasContiguous == nil || wasContiguous! == nil {
dspAdd(Array(a), Array(b), &result)
}
}
这段代码延续了 sort 的模式:有快速路径就走快速路径,没有就回退到慢路径。注意这里使用了嵌套的 withContiguousStorageIfAvailable 与双重可选(()??)来判断两个输入是否都提供了连续存储——这本身就是一种笨拙的写法。
2.2 回退路径可能适得其反
提案指出,对 vDSP_vsaddi 这类函数来说,回退策略是完全错误的:这些函数相比手写循环往往只存在"很薄但真实存在的"性能优势,而为了调用它去分配并初始化两个数组(Array(a)、Array(b)),其开销很可能远超使用该函数省下的那点时间。这等于鼓励调用方误用——用户可能根本没意识到,这样写的性能比重新组织代码用普通循环还差。
针对这个问题,有两种可能的缓解手段,但都不完美:
- 在非连续输入上 trap:能更早地暴露问题,用户第一次使用就会意识到
Range这类类型不该配这个 API; - 更理想的是用 Swift 的类型系统来强制:让"连续存储"成为泛型约束的一部分,从源头引导用户走向正确解。
SE-0256 选择的是第二条路:用协议约束在编译期完成保证。
三、提案方案:两个新协议
SE-0256 提议引入两个新协议,为"底层连续存储的可访问性"提供编译期保证:
/// A collection that supports access to its underlying contiguous storage.
public protocol ContiguousCollection: Collection
where SubSequence: ContiguousCollection {
/// Calls a closure with a pointer to the array's contiguous storage.
func withUnsafeBufferPointer<R>(
_ body: (UnsafeBufferPointer<Element>) throws -> R
) rethrows -> R
}
/// A collection that supports mutable access to its underlying contiguous
/// storage.
public protocol MutableContiguousCollection: ContiguousCollection, MutableCollection
where SubSequence: MutableContiguousCollection {
/// Calls the given closure with a pointer to the array's mutable contiguous
/// storage.
mutating func withUnsafeMutableBufferPointer<R>(
_ body: (inout UnsafeMutableBufferPointer<Element>) throws -> R
) rethrows -> R
}
几个设计要点值得展开:
- 继承关系:
ContiguousCollection精化(refine)Collection;MutableContiguousCollection同时精化ContiguousCollection与MutableCollection,保证"可变连续"类型必然同时是"只读连续"类型。 SubSequence约束:两个协议都通过where SubSequence: ...要求子序列同样连续。这很关键——例如对ArraySlice这类切片,索引切片后得到的仍然是连续缓冲;SE-0237 文档中也强调,提供withContiguousStorageIfAvailable实现的类型"必须保证其SubSequence的等价缓冲可以通过把指针按到切片startIndex的距离前进得到"。- 闭包签名:可变版本的闭包参数是
inout UnsafeMutableBufferPointer<Element>,意味着闭包内可以整体替换缓冲指针。SE-0237 的 Alternatives 一节讨论过这个inout的设计取舍:它确实暗示用户可以把缓冲换成完全不同的一个,但这换来的是显著更好的使用手感(ergonomics),且改动Array现有实现属于源码破坏性变更,因此保留inout。
3.1 计划的一致性声明
提案计划为以下类型添加一致性:
| 类型 | 声明的协议 |
|---|---|
Array、ArraySlice、ContiguousArray |
MutableContiguousCollection |
UnsafeBufferPointer |
ContiguousCollection |
UnsafeMutableBufferPointer |
MutableContiguousCollection |
Slice |
条件一致:Base: ContiguousCollection 时声明 ContiguousCollection;Base: MutableContiguousCollection 时声明 MutableContiguousCollection |
3.2 顺带的默认实现
提案还指出,符合 ContiguousCollection 的类型应该自动获得 Collection.withContiguousStorageIfAvailable 的默认实现——通过一个调用 withUnsafeBufferPointer 的扩展实现;MutableContiguousCollection 同理,为 withMutableContiguousStorageIfAvailable 提供默认实现。这样一来,新协议不仅提供编译期保证,还让 SE-0237 的两个方法在"连续类型"上有了免费且直接的实现路径,两条演进路线在此合流。
四、详细设计:用协议约束重构 dspAdd
引入协议后,dspAdd 可以重写为无需任何运行时探测、无需回退路径的干净泛型函数:
func dspAdd<A: ContiguousCollection, B: ContiguousCollection, R: MutableContiguousCollection>(
_ a: A, _ b: B, _ result: inout R
) where A.Element == Float, B.Element == Float, R.Element == Float {
let n = a.count
a.withUnsafeBufferPointer { abuf in
b.withUnsafeBufferPointer { bbuf in
result.withUnsafeMutableBufferPointer { rbuf in
vDSP_vadd(abuf.baseAddress!, 1, bbuf.baseAddress!, 1, rbuf.baseAddress!, 1, UInt(n))
}
}
}
}
这个版本带来的改善是立体的:
- 编译期排除错误用法:把
Range或Repeating这类不连续的集合传入,会在编译期直接报错,而不是运行期静默变慢或 trap; - 结果缓冲泛型化:
R: MutableContiguousCollection让结果参数不再局限于具体的[Float]数组,可以传入任意可变连续集合。提案特别指出,这在实际中很重要——vDSP类函数常以分块(tiled)模式使用,需要反复传入数组切片,泛型结果缓冲正好贴合这种场景; - 实现显著简化:双重可选的嵌套探测逻辑消失了,函数体只剩直接的三层闭包调用。
五、兼容性与 ABI 影响
提案对兼容性的结论非常明确:
- 源码兼容性(Source compatibility):纯增量改动,不影响现有源码;
- ABI 稳定性:新增协议属于增量改动,可以在 ABI 稳定之后引入;在已宣布 ABI 稳定的平台上需要添加可用性(availability)标注;
- API resilience:不适用(N/A)。
六、替代方案分析
提案在"Alternatives considered"一节系统对比了在缺少该协议时的三类替代做法,这对理解协议的价值边界很有帮助:
-
库自行声明协议并对标准库类型做回溯一致性(retroactive conformance)
- 问题一:非标准类型不会自动符合,调用方需要手动为自己的类型声明一致性;而标准库协议更可能被其他类型广泛采纳;
- 问题二:如果这种模式变得普遍,会出现多个库各自声明同名/同义协议,造成生态碎片化。
-
使用
IfAvailable变体并在文档中声明"不连续类型效率低下"- 这把执行正确用法的责任完全推给用户;
- 在泛型上下文中尤其不可行——调用函数往往根本不知道自己正在使用哪个具体类型。
-
使用
IfAvailable变体,在拿不到连续存储时 trap- 好处:能立刻提醒调用方存在低效用法,例如传入
Range的调用每次都会失败,任何测试都能发现; - 致命缺陷:某些类型对
IfAvailable的响应是有时成功、有时失败。例如环形缓冲区(ring buffer)在未发生回绕时通常能提供单一连续缓冲,一旦回绕就不能。对这种类型 trap 会导致不可预测的崩溃——SE-0237 文档同样提到,环形缓冲区这类"由多个连续区域组成"的集合需要单独处理,不属于该方法/协议的设计范围。
- 好处:能立刻提醒调用方存在低效用法,例如传入
这三条替代路径的缺陷,恰好从反面论证了"用协议在编译期表达连续性保证"的必要性。
七、Array 与惰性桥接(lazy bridging)的边界
让 Array 符合这些协议存在一个必须正视的例外情况,提案用一整节专门讨论。
Array 核心上就是一块连续存储的内存块,天然适合符合 ContiguousCollection。但在 Darwin 平台上,出于 Objective-C 互操作的目的有一个专门豁免:当类(class)类型的 NSArray 从 Objective-C 桥接进来时,它保持为 NSArray,Array 会把元素访问转发给那个桥接的 NSArray。这不同于 NSArray 自身——后者把存储抽象到更高程度,可以向多种不同后端呈现"类数组"接口。
提案给出了 Array 连续存储的完整清单:
| 场景 | 是否连续存储 |
|---|---|
| 在 Swift 中创建的数组 | 总是连续 |
| 元素为 struct / enum 的数组 | 总是连续 |
| 无 Objective-C 运行时平台(非 Darwin)上的数组 | 总是连续 |
类元素且从 NSArray 桥接而来的数组 |
唯一可能不连续的情况;即便如此,很多 NSArray 本身也连续存储,可以零成本或摊销成本地给出指针 |
提案要求把这些注意事项(caveat)明确记录在协议文档和 Array 文档上。同时指出,这种"文档化例外"的做法在 Swift 中已有先例:浮点类型对 Comparable 的一致性、部分惰性随机访问类型上 first/last 的复杂度、以及 Array 现有的 withUnsafeBufferPointer 实现,都采用同样的模式。
此外还有一个容易忽略的细节:这些例外只适用于不可变变体。数组在调用任何 mutating 方法时,第一件事就是确保自己是唯一引用且连续的,所以即使是惰性桥接的数组,在发生修改的那一刻也会变为连续。这种复制在其它场景(如被多引用的 CoW 缓冲)中也会自然发生——也就是说,MutableContiguousCollection 路径上的 Array 行为比只读路径更可预期。
对 vDSP 这类使用场景而言,这些边界并不构成问题:涉及的 Float 等元素类型是 struct,struct 数组总是连续存储。
八、提案状态与后续演进
8.1 提案状态:Rejected
需要特别说明的是,SE-0256 的最终状态是 Rejected(被拒绝)。提案的 Review Manager 是 Ted Kremenek,决策记录指向 Swift 论坛上的讨论(Rationale)。这意味着 ContiguousCollection / MutableContiguousCollection 这两个协议最终并未进入标准库——如果你在当前 Swift 版本中尝试使用它们,是无法找到的。
但这不意味着 SE-0256 的思想没有落地。它至少产生了三方面影响:
- SE-0237 的方法路线成为主流:
withContiguous{Mutable}StorageIfAvailable已在 Swift 5.0 实现,是当前泛型代码访问连续缓冲的标准入口; - 运行时探测 + 文档约定的组合:如 SE-0247(Contiguous Strings) 所体现的,Swift 5.0 中
String.UTF8View.withContiguousStorageIfAvailable()对连续字符串成功、对非连续字符串返回nil,用户需要自行处理回退;SE-0247 正是针对这种"用户在黑暗中摸索"的痛点,为String/Substring增加了isContiguousUTF8、makeContiguousUTF8()、withUTF8等直接能力; - "连续内存安全访问"被后续提案接棒:SE-0256 关注的是"如何确认底层是连续缓冲",而后续的 SE-0447(Span: Safe Access to Contiguous Storage)、SE-0456(Stdlib
SpanProperties) 与 SE-0467(MutableSpan) 走得更远:它们指出withUnsafeBufferPointer()、withContiguousStorageIfAvailable()等闭包式 API 依赖不安全类型、难以相互组合,因此引入带边界检查、借用语义的非逃逸类型Span,作为"对连续内存做本地处理"的通货类型。可以说,SE-0256 讨论中反复出现的"安全地、可泛型地访问连续存储"这一核心诉求,最终由Span系列提案以更安全的形式承接。
8.2 对本仓库读者的参考
如果你想在真实代码中体会 SE-0256 讨论的原始语境,建议按此顺序阅读:
- SE-0237 提案——了解
withContiguousStorageIfAvailable的设计、默认返回nil的语义、以及"连续调用不一定得到同一指针"等文档化约定; - SE-0256 提案(本文主文档)——理解协议路线的完整设计与其被拒绝前的全部论证;
- SE-0247 提案——看"连续字符串"如何在实际标准库能力中落地;
- SE-0447 提案——看连续内存访问的下一代形态。
结语
SE-0256 是一份"被拒绝但仍具高度参考价值"的提案:它清晰地演示了 Swift 协议抽象设计中的一个经典张力——运行期探测(IfAvailable)与编译期保证(协议约束)之间如何取舍,以及当回退路径本身可能损害性能时,为什么类型系统约束是更优解。它的 SubSequence 约束写法、默认实现衔接、Array 桥接边界的清单化分析,乃至被拒绝后由 Span 系列提案接棒的历史轨迹,都为理解 Swift 标准库在内存安全与性能之间的长期演进提供了不可多得的原始素材。