[译] Swift3中的函数命名-CSDN博客

###写在前面第二次翻译博客,虽然感觉比上一次翻的顺利一点,但是还是磕磕绊绊,不过对自身提高有不少的帮助,若有什么错误,望大家指出.原文链接

昨天我开始将 Jayme 迁移到 Swift3,这是我第一次尝试将 Swift2.2的代码迁移到3.0.整个过程非常繁琐,我不得不承认; Swift3跟之前的版本相比是有很大的不同,而且其中大部分的变化都是突然地,而且得花时间去思考这些变化.但是从我们自己的角度来说: 我写 Swift3,越写越开心. 在迁移过程中,有很多很多需要去思考的变化,而且,这不仅仅是翻译代码,而是把整个迁移过程分成很多步骤,然后一点一点,有耐心的迁移.当然,代码的变化仅仅是整个迁移工作的一步.

如果你已经决定开始迁移你的代码库,那么文字链接是一个很好的帮助.

我希望在不久的将来,我会把我迁移经验写一篇博文,包括了整个迁移过程并且总结我在迁移过程中做出的大部分决定.但到目前为止,我只能关注我认为最重要的一个:如何正确地写函数签名。

###基础: 让我们开始理解一个观点:Swift3函数命名跟 Swift2的不同.

在 Swift2中,当你调用一个函数时,对一个函数的第一个参数标签是忽略的,这样写是为了遵守 Cocoa框架的命名规范,所以我们一直都是这样写:

// Swift 2 
func handleError(error: NSError) { }
let error = NSError()
handleError(error) // 很像 OC
复制代码

在 Swift3中,相反,,函数的第一个参数标签可以在函数调用中省略,但在默认情况下,并不能省略:

// Swift 3
func handleError(error: NSError) { }
let error = NSError()
handleError(error)  // Does not compile! 编译过不了
// ⛔ Missing argument label 'error:' in call
复制代码

所以,这样改一下:

// Swift 3
func handleError(error: NSError) { }
let error = NSError()
handleError(error: error)    
// 但是不得不把 'error' 写了三遍
// 辣眼睛?
复制代码

在这一点上，你可以知道你的代码就会变得无聊和重复… 也就是说,如果你想在函数调用中省略第一个参数标签.但是在 Swift3中,你必须明确的写成:

// Swift 3
func handleError(_ error: NSError) { }
// ? 注意这个下划线!
let error = NSError()
handleError(error)  // 跟 Swift2一样
复制代码

当你运行 Xcode 的迁移工具时,这是个默认的变化

注意函数声明中的下划线,它的意思是当你调用函数是第一个参数不需要标签.这样,我们就可以像 Swift2中那样调用了.

此外,你可以意识到, Swift3中的函数命名更具有一致性也更容易理解: 所有的参数标签都是一样的,再也没有像第一个参数标签隐藏这样的了.

这样代码可以通过编译,但是你想写的更 Swifty 的话,你得看看 Swift 3 API design guidelines.

一点点建议:反复阅读 Swift 3 API design guidelines.最好每天早上都读,直到你懂得了用一个新的方式去写 Swift 代码.

Furthermore, you can realize that Swift 3 is more consistent and easier to understand when it comes to functions naming: All parameter labels are treated the same; there is no such thing as treating the first one differently. 此外，你可以意识到，3是更一致，更容易理解，当涉及到函数命名：所有的参数标签都是相同的，没有这样的东西作为治疗的第一个不同的。

###更进一步: 减代码观察这行代码是怎么重复的

handleError(error)
复制代码

为了使它不重复性和更简洁，您可以从函数命名中删除冗余类型的名称：

// Swift 3
func handle(_ error: NSError) { /* ... */ }
let error = NSError()
handle(error)   // 类型名称减掉了
// 从函数名看,它是多余的
复制代码

这更短，更清晰，更简洁，并鼓励开发人员按照 Swift 3 API design guidelines来开发（是的，读一遍，再次！）注意函数调用是清晰的。我们可以知道函数参数是什么，因为有两个事实： 1.我们知道它的类型。 2.此外，该类型表示的参数正是预期的代表（在这种情况下毫无疑问是一个错误类型)。

###减代码并不总是一个问题现在该打起精神,开始小心一点了!

在很多情况下,上面的例子并没有发生.换言说,参数的类型不能反映这个参数本身. 来看看下面的例子:

// Swift 2
func requestForPath(path: String) -> URLRequest {  }
let request = requestForPath("local:80/users")
复制代码

如果你试着将这个代码迁移到 Swift3,根据我们之前学的,你可能会写出这样的代码:

// Swift 3
func request(_ path: String) -> URLRequest {  }
let request = request("local:80/users")
复制代码

但是这样写还是有点小问题而且可读性不高,让我们在修改一下:

// Swift 3
func request(for path: String) -> URLRequest {  }
let request = request(for: "local:80/users")
复制代码

现在，虽然这是更具可读性，它并没有解决我上面提到的问题。

在调用这个函数的那一刻，你怎么能知道你需要传递的for是需要什么？因为Swift是静态类型的,所有你可以事先知道是该参数预期是字符串类型，但是你需要传入的 path在调用的时候并不知道for 后面跟的是什么参数.

有很多这些场景中的参数类型是没有意义的，应该代表什么时，例如： 1.一个String有时候并不总是代表 path 2.一个int并不总是代表一个状态码。 3.[String: String]不总是代表一个 http 标头

⚠️ 我的建议: 减代码的时候一定要小心!✄ 回到代码，来解决这个问题第一种方法可以追加参数的名称为参数的标签，使得它在结果明确：

func request(forPath path: String) -> URLRequest {  }
let request = request(forPath: "local:80/users")
// for改成了forPath
复制代码

此代码是准确的，可编译并遵循了设计规范。?万岁！

你可以读到这里，但等等，最好的部分是尚未到来...

现在，请注意在函数声明这一措辞：

func request(forPath path: String) -> URLRequest {  }
// The word 'path' appears twice
复制代码

虽然这并不是丑代码，在大多数情况下，这仍然是正确的，而且编译得很顺利，但有一种方法，以避免它。更多关于这在下面的部分...... ###一些你可能不知道的小技巧这个想法很简单：让参数类型反映了它的内容，目的就是能够尽量的减少代码。如果我告诉你

typealias Path = String      
func request(for path: Path) -> URLRequest {  }
let request = request(for: "local:80/users")
复制代码

在这种情况下，你的参数的类型和入参是具有一致性，因为参数的类型被定义了一个typealias, 把 Path的别名设为 String.

这样，你的函数仍然是直观，可读的，明确的，但不重复。同样的，你能想到的，可能在其他常见的场景利用typealias的其他一些例子：

typealias Path = String
typealias StatusCode = Int
typealias HTTPHeader = [String: String]
// etc...
复制代码

这将使你写更清晰的代码，就像我们刚才看到的。然而，极端都不好：输入别名增加了代码的复杂性，你的代码，甚至会变得更多，如果它们嵌套......所以，不要虐待自己.?虽然在某些情况下，他们可以帮你很好，因为我们只看到有时它们实际上是不必要的，只会使你的代码难以效仿。

###结论在很多情况下,你会在 Swift3 的函数命名中栽个跟头. 但这些代码片段抵过再多的博文:

func remove(at position: Index) -> Element {  }
employees.remove(at: x)

func remove(_ member: Element) -> Element?  {  }
allViews.remove(cancelButton)

func url(forPath path: String) -> URL {  }
let url = url(forPath: "local:80/users")

typealias Path = String // Alternative
func url(for path: Path) -> URL {  }
let url = url(for: "local:80/users")

func entity(from dictionary: [String: Any]) -> Entity { /* ... */ }
let entity = entity(from: ["id": "1", "name": "John"])
复制代码