几个 Swift 代码规范

作者:Erica Sadun,原文链接,原文日期:2015-11-17
译者:mmoaay;校对:lfb_CD;定稿:shanks

我们需要经常带着新问题来重新审视一下以前的代码规范。

Kevin 提供的一套规范:“如果尾部的闭包参数是函数式的就用圆括号。如果是程序式的就用花括号。”

myCollection.map({blah}).filter({blah}).etc
myCollection.forEach {} // 或者 
dispatch_after(when, queue) {}

样式一致性与闭包是否有返回值相关。目前存在的争议是我们是否应该在尾部花括号的左边留空格。

self 的使用规范:“当编译器可以自动推断成员类型时,你就可以在使用隐式成员表达式时省略 self。但无论何时,只要一个方法调用会反射到一个实例,就要使用 self。“

仔细考虑下面 for 循环语句中的 where 分支。contains 方法就是在没有明确对象的情况下调用的。那是谁做了 contains 操作呢? 因为方法参数中没有传入容器对象,所以这个对象只能是调用这个方法的实例。

for (flagLessOne, string) in strings.enumerate() 
    where contains(
        Features(rawValue: 1<<(flagLessOne + 1))) {
    nameArray.append(string)
}

完全合格的调用明确指出了原本模糊不清的对象,同时极大滴提高了代码的可读性:

for (flagLessOne, string) in strings.enumerate() 
    where self.contains(
        Features(rawValue: 1<<(flagLessOne + 1))) {
    nameArray.append(string)
}

条件级联绑定的规范:“除非你做的是 varlet 混合的条件绑定,只用一个 if let 或者 if var 就可以了,需要的话可以自由添加空格。“

不要使用下面的方式:

if let x = x, let y = y, let z = z {blah}

使用这种:

if let x = x, y = y, z = z {blah}

省略多余的 let 关键字可以让级联绑定更加简洁,而且 Xcode 会帮你对这些代码的格式进行很好的调整:

if let
    x = x,
    y = y,
    z = z {
    ...blah...
}

尽管级联绑定避免了 pre-Swift 2 中的“鞭尸金字塔(pyramids of doom)“,但它们又导致了“恐怖便秘块(constipated blocks of horror)“的问题。这种问题主要出现在下面两种情况:

  • 存在大量的串行绑定,再加上空行和注释时(就像下面的代码)

  • 使用了一系列 guard 语句时。

    if let
    // 以字典的方式访问 JSON
    json = json as? NSDictionary,

     // 检查结果数组
     resultsList = json["results"] as? NSArray,
    
     // 提取第一项
     results = resultsList.firstObject as? NSDictionary,
    
     // 提取名字和价格
     name = results["trackName"] as? String, 
     price = results["price"] as? NSNumber {
    
     // ... blah blah ...
    

    }

模式匹配关键字的规范:“如果都是绑定,那就要把绑定组合起来。”

通过把关键字移动到元组外面的方式来把多模式匹配绑定组合起来。将下面的代码:

if case (let x?, let y?) = myOptionalTuple {
    print(x, y)
}

替换为:

if case let (x?, y?) = myOptionalTuple {
    print(x, y)
}

isEmpty 的使用规范:“如果你在检测一个集合元素的个数,你可能就是在犯错。”用 isEmpty 替换 count == 0

void 的使用规范:“使用 void 返回类型,而不是 ()。”下面是一个返回 -> Void 而不是 -> () 的方法。

func doThis() -> Void 
func notThis() -> ()

! 的使用规范:“每当你在 Swift 中用惊叹号的时候,一只小猫就会死。”尽可能的避免使用强制转换和强制解包。

创建集合的规范:“使用显式类型和空集合。”类型在赋值操作符的左边,空实例在赋值操作符的右边。

把下面的代码:

var x = [String: Int]() // 以及
var y = [Double]()
var z = Set<String>()
var mySet = MyOptionSet()

替换为:

var x: [String: Int] = [:]
var y: [Double] = []
var z: Set<String> = []
var mySet: MyOptionSet = []

引用

Mike Ash”的冒号规范:“右侧加上空格,而左侧不需要。”Or no soup for you!

应该使用:

[key: value] // 以及
struct Foo: MyProtocol

而不是:

[key : value]
struct Foo : MyProtocol

从 Objective-C 过来的规范

  • 不要在 if 和 switch 条件两边或者 return 关键词上加 Objective-C 样式的圆括号。
  • 为所有常量使用“骆驼拼写法”,如 allTheConstants 而不是 ALL_CAPS
  • 用 Swift 的构造器替代传统的,例如:用 CGPoint(x: 1, y:1) 替代 CGPointMake(1, 1)
  • 避免使用行尾分号,尽管这样是可以编译通过的。但是它们会让你的代码看起来很糟糕,而且用起来体验也很差。

更新

当然,这不是说说而已,我已经在代码中进行了实践:

这里写图片描述
这里写图片描述

github 代码地址

本文由 SwiftGG 翻译组翻译,已经获得作者翻译授权,最新文章请访问 http://swift.gg

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,122评论 6 505
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,070评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,491评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,636评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,676评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,541评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,292评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,211评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,655评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,846评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,965评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,684评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,295评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,894评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,012评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,126评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,914评论 2 355

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,657评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,133评论 25 707
  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 12,103评论 4 62
  • 你说 你个小蠢货 因为不知道哪个环节出了错 大家要在五号紧张的考期去补上那节技能实习课 你说不要说的太多 要去做 ...
    菀卿阅读 126评论 0 0
  • 自去年三月在F+订花以来,每个周六,固定的收花日。每次鲜花送来,小朋友总是要来认一认花儿,也陆续知道了很多不...
    未央_半树蔷薇阅读 459评论 0 4