Swift3中的函数命名
maoning
8年前
<p>昨天我开始将 Jayme 迁移到 Swift3,这是我第一次尝试将 Swift2.2的代码迁移到3.0.整个过程非常繁琐,我不得不承认; Swift3跟之前的版本相比是有很大的不同,而且其中大部分的变化都是突然地,而且得花时间去思考这些变化.但是从我们自己的角度来说: 我写 Swift3,越写越开心.</p> <p>在迁移过程中,有很多很多需要去思考的变化,而且,这不仅仅是翻译代码,而是把整个迁移过程分成很多步骤,然后一点一点,有耐心的迁移.当然,代码的变化仅仅是整个迁移工作的一步.</p> <p>如果你已经决定开始迁移你的代码库,那么 <a href="/misc/goto?guid=4959716863562604892" rel="nofollow,noindex">文字链接</a> 是一个很好的帮助.</p> <p>我希望在不久的将来,我会把我迁移经验写一篇博文,包括了整个迁移过程并且总结我在迁移过程中做出的大部分决定.但到目前为止,我只能关注我认为最重要的一个:如何正确地写函数签名。</p> <h2><strong>基础:</strong></h2> <p>让我们开始理解一个观点:Swift3函数命名跟 Swift2的不同.</p> <p>在 Swift2中,当你调用一个函数时,对一个函数的第一个参数标签是忽略的,这样写是为了遵守 <a href="/misc/goto?guid=4959716863667603875" rel="nofollow,noindex">Cocoa框架的命名规范</a> ,所以我们一直都是这样写:</p> <pre> <code class="language-swift">// Swift 2 func handleError(error: NSError) { } let error = NSError() handleError(error) // 很像 OC</code></pre> <p>在 Swift3中,相反,,函数的第一个参数标签可以在函数调用中省略,但在默认情况下,并不能省略:</p> <pre> <code class="language-swift">// Swift 3 func handleError(error: NSError) { } let error = NSError() handleError(error) // Does not compile! 编译过不了 // :no_entry: Missing argument label 'error:' in call</code></pre> <p>所以,这样改一下:</p> <pre> <code class="language-swift">// Swift 3 func handleError(error: NSError) { } let error = NSError() handleError(error: error) // 但是不得不把 'error' 写了三遍 // 辣眼睛:see_no_evil:</code></pre> <p>在这一点上，你可以知道你的代码就会变得无聊和重复…</p> <p>也就是说,如果你想在函数调用中省略第一个参数标签.但是在 Swift3中,你必须明确的写成:</p> <pre> <code class="language-swift">// Swift 3 func handleError(_ error: NSError) { } // �� 注意这个下划线! let error = NSError() handleError(error) // 跟 Swift2一样</code></pre> <p>当你运行 Xcode 的迁移工具时,这是个默认的变化</p> <p>注意函数声明中的下划线,它的意思是当你调用函数是第一个参数不需要标签.这样,我们就可以像 Swift2中那样调用了.</p> <p>此外,你可以意识到, Swift3中的函数命名更具有一致性也更容易理解: 所有的参数标签都是一样的,再也没有像第一个参数标签隐藏这样的了.</p> <p>这样代码可以通过编译,但是你想写的更 Swifty 的话,你得看看 <a href="/misc/goto?guid=4958985687336401617" rel="nofollow,noindex">Swift 3 API design guidelines</a> .</p> <p>一点点建议:反复阅读 <a href="/misc/goto?guid=4958985687336401617" rel="nofollow,noindex">Swift 3 API design guidelines</a> .最好每天早上都读,直到你懂得了用一个新的方式去写 Swift 代码.</p> <p>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.</p> <p>此外，你可以意识到，3是更一致，更容易理解，当涉及到函数命名：所有的参数标签都是相同的，没有这样的东西作为治疗的第一个不同的。</p> <h2><strong>更进一步: 减代码</strong></h2> <p>观察这行代码是怎么重复的</p> <pre> <code class="language-swift">handleError(error)</code></pre> <p>为了使它不重复性和更简洁，您可以从函数命名中删除冗余类型的名称：</p> <pre> <code class="language-swift">// Swift 3 func handle(_ error: NSError) { /* ... */ } let error = NSError() handle(error) // 类型名称减掉了 // 从函数名看,它是多余的</code></pre> <p>这更短，更清晰，更简洁，并鼓励开发人员按照 <a href="/misc/goto?guid=4958985687336401617" rel="nofollow,noindex">Swift 3 API design guidelines</a> 来开发（是的，读一遍，再次！）</p> <p>注意函数调用是清晰的。我们可以知道函数参数是什么，因为有两个事实：</p> <p>1.我们知道它的类型。</p> <p>2.此外，该类型表示的参数正是预期的代表（在这种情况下毫无疑问是一个错误类型)。</p> <h2><strong>减代码并不总是一个问题</strong></h2> <p>现在该打起精神,开始小心一点了!</p> <p>在很多情况下,上面的例子并没有发生.换言说,参数的类型不能反映这个参数本身.</p> <p>来看看下面的例子:</p> <pre> <code class="language-swift">// Swift 2 func requestForPath(path: String) -> URLRequest { } let request = requestForPath("local:80/users")</code></pre> <p>如果你试着将这个代码迁移到 Swift3,根据我们之前学的,你可能会写出这样的代码:</p> <pre> <code class="language-swift">// Swift 3 func request(_ path: String) -> URLRequest { } let request = request("local:80/users")</code></pre> <p>但是这样写还是有点小问题而且可读性不高,让我们在修改一下:</p> <pre> <code class="language-swift">// Swift 3 func request(for path: String) -> URLRequest { } let request = request(for: "local:80/users")</code></pre> <p>现在，虽然这是更具可读性，它并没有解决我上面提到的问题。</p> <p>在调用这个函数的那一刻，你怎么能知道你需要传递的for是需要什么？因为Swift是静态类型的,所有你可以事先知道是该参数预期是字符串类型，但是你需要传入的 path在调用的时候并不知道for 后面跟的是什么参数.</p> <p>有很多这些场景中的参数类型是没有意义的，应该代表什么时，例如：</p> <p>1.一个String有时候并不总是代表 path</p> <p>2.一个int并不总是代表一个状态码。</p> <p>3.[String: String]不总是代表一个 http 标头</p> <p>:warning: 我的建议: 减代码的时候一定要小心!✄</p> <p>回到代码，来解决这个问题第一种方法可以追加参数的名称为参数的标签，使得它在结果明确：</p> <pre> <code class="language-swift">func request(forPath path: String) -> URLRequest { } let request = request(forPath: "local:80/users") // for改成了forPath</code></pre> <p>此代码是准确的，可编译并遵循了设计规范。:tada:万岁！</p> <p>你可以读到这里，但等等，最好的部分是尚未到来...</p> <p>现在，请注意在函数声明这一措辞：</p> <pre> <code class="language-swift">func request(forPath path: String) -> URLRequest { } // The word 'path' appears twice</code></pre> <p>虽然这并不是丑代码，在大多数情况下，这仍然是正确的，而且编译得很顺利，但有一种方法，以避免它。</p> <p>更多关于这在下面的部分......</p> <h2><strong>一些你可能不知道的小技巧</strong></h2> <p>这个想法很简单：让参数类型反映了它的内容，目的就是能够尽量的减少代码。</p> <p>如果我告诉你</p> <pre> <code class="language-swift">typealias Path = String func request(for path: Path) -> URLRequest { } let request = request(for: "local:80/users")</code></pre> <p>在这种情况下，你的参数的类型和入参是具有一致性，因为参数的类型被定义了一个typealias, 把 Path的别名设为 String.</p> <p>这样，你的函数仍然是直观，可读的，明确的，但不重复。</p> <p>同样的，你能想到的，可能在其他常见的场景利用typealias的其他一些例子：</p> <pre> <code class="language-swift">typealias Path = String typealias StatusCode = Int typealias HTTPHeader = [String: String] // etc...</code></pre> <p>这将使你写更清晰的代码，就像我们刚才看到的。</p> <p>然而，极端都不好：输入别名增加了代码的复杂性，你的代码，甚至会变得更多，如果它们嵌套......所以，不要虐待自己.��虽然在某些情况下，他们可以帮你很好，因为我们只看到有时它们实际上是不必要的，只会使你的代码难以效仿。</p> <h3>结论</h3> <p>在很多情况下,你会在 Swift3 的函数命名中栽个跟头.</p> <p>但这些代码片段抵过再多的博文:</p> <pre> <code class="language-swift">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"]) (就好好读系统的 API)</code></pre> <p> </p> <p>来自：http://www.jianshu.com/p/11f4fa4a7f7d</p> <p> </p>