Swift 3 API 设计准则

jopen 7年前

本文由 星夜暮晨( 简书

翻译自苹果 Swift 官方网站

原文 Swift 3 API Design Guidelines

2015年12月4日

一款编程语言标准库的设计理念,往往对这门编程语言给人的整体感觉有很大影响。好的标准库就好似语言本身的扩展一般,并且保证标准库内部的一致性可以有效提升整体的开发体验。为了搭建一个好的 Swift 标准库,Swift 3 的其中一个主要目标就是要定义一组 API 设计准则,并且始终如一地应用这些准则。

Swift API 设计准则包含了几个主要目标,它们都旨在统一 Swift 的开发风格。这些主要目标分别是:

  • Swift API 设计准则:实际的 API 设计准则我们目前正在积极开发中。目前, Swift API 设计准则 的最新样稿已经可以查看了!

  • Swift 标准库:整个 Swift 标准库正在审查和更新,以便能够遵循 Swift API 设计准则。实际的工作正在 Swift 仓库中的 swift-3-api-guidelines 分支进行。

  • 导入 Objective-C API:将 Objective-C API 翻译成 Swift 的工作正在进行,采用了几种 启发式逻辑 ,这是为了让 Objective-C API 能够更好地匹配 Swift API 设计准则。 Objective-C API 的 Swift 翻译指南 这个提议描述了哪一种翻译方式是有效的。当然,由于这个过程采用了一系列的启发式逻辑方法,因此我们会跟踪其对 Cocoa 和 Cooca Touch 所造成的影响,包括使用这些框架的 Swift 代码的工作情况。 Swift 3 API 设计指南审查 仓库提供了一种如何查看这种自动翻译过程的方法,以便查看对使用 Cocoa 和 Cocoa Touch 的 Swift 代码的影响。将不会被翻译为 Swift 的某些特殊 Objective-C API 将会被标记出来(比如说使用 NS_SWIFT_NAME 宏),以提升最终所得的 Swift 代码的质量。虽然这种变化主要影响的是 Apple 平台,但是它也会对提供了和 Objective-C 框架相同的 API 的跨平台 Swift 核心库 (比如说 Swift 中使用的 Objective-C 运行时)造成一定的直接影响。

  • Swift 设计准则检查:目前现有的 Swift 代码都遵循了不同的编码风格,甚至还包括了 针对 Cocoa 的 Objective-C 代码指南 。借助用来导入 Objective-C API 的启发式逻辑,Swift 编译器(可以)能够检查常见的 API 设计模式,找出不符合 Swift API 设计准则的 API,并提供建议。

  • Swift 2 迁移到 Swift 3:Swift 标准库和导入 Objective-C API 将会是 Swift 的一次重大更新,对源代码进行了一次全新的更正操作。因此,我们还需要创建一个能够将 Swift 2 代码迁移到 Swift 3 API 的迁移器。

所有这些主要工作都正在积极地开发当中。如果您对上述工作有兴趣,那么可以 check out Swift API design guidelinesSwift standard library changesObjective-C API importer changes 提议以及目前的 review repository ,然后加入 swift-evolution mailing list 上的讨论组中。