几个 Swift 代码规范

标签: swift | 发表时间:2015-12-09 14:53 | 作者:SwiftGG翻译组
分享到:
出处:http://segmentfault.com/blogs

作者: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

相关 [swift 代码] 推荐:

几个 Swift 代码规范

- - SegmentFault 最新的文章
作者:Erica Sadun, 原文链接,原文日期:2015-11-17. 译者: mmoaay;校对: lfb_CD;定稿: shanks. 我们需要经常带着新问题来重新审视一下以前的代码规范. Kevin 提供的一套规范:“如果尾部的闭包参数是函数式的就用圆括号. myCollection.map({blah}).filter({blah}).etc myCollection.forEach {} // 或者 dispatch_after(when, queue) {}.

Openstack Swift简介

- - 忘我的追寻
Swift 最初是由 Rackspace 公司开发的高可用分布式对象存储服务,并于 2010 年贡献给 OpenStack 开源社区作为其最初的核心子项目之一,为其 Nova 子项目提供虚机镜像存储服务. Swift 构筑在比较便宜的标准硬件存储基础设施之上,无需采用 RAID(磁盘冗余阵列),通过在软件层面引入一致性散列技术和数据冗余性,牺牲一定程度的数据一致性来达到高可用性和可伸缩性,支持多租户模式、容器和对象读写操作,适合解决互联网的应用场景下非结构化数据存储问题.

Swift 横空出世

- - 移动开发 - ITeye博客
        苹果2014-6-2日的WWDC开发者大会,是名符其实的“开发者大会”,发布新的操作系统,IOS8,4000+的新api,这已经让我们这些程序员够吐槽的了. 不过苹果的技术大拿们似乎不满足于此,推出了新的开发语言--Swift. 我要吐血啦,那些苹果顾的水军编辑们,竟然起哄,“coder们要喜大普奔”啊,艹,明显站着说话不腰疼啊.

swift语言是什么?

- - TechWeb 新酷网站 RSS阅读
译/新浪科技   导语:CNET网站今天刊文称,苹果公司(以下简称“苹果”)在今年的WWDC(全球开发者大会)上发布了一款重要产品:编程语言Swift,并随后发布了对这一语言进行详解的iBook电子书. 终端用户或许很难感知到这一编程语言带来的改变,但这可能推动苹果应用开发者社区的变革. 许多人可能都已忘记苹果WWDC中的“D”代表了“开发者”.

swift学习资料汇总

- - 编程 - 编程语言 - ITeye博客
今年的苹果开发者大会(WWDC)上,公布了ios8的几个新特性,其中包括引入了群聊功能,支持第三方输入法等功能. 但更让开发者感兴趣的莫过于Swift语言的发布了. Swift是apple自创的一门转为cocoa和cocoa touch设计的语言,意用来替换objc. Swift能使代码大量简化,并且开发者们可以在同一款软件中同事使用obj-c,Swift,c语言.

The Right Way to Architect iOS App with Swift

- - limboy's HQ
关于 iOS 架构的文章感觉已经泛滥了,前一阵正好 Android 官方推了一套. App Architecture ,于是就在想,对于 iOS 来说,怎样的架构才是最适合的. 这是第一个也是最重要的问题,为什么会出现各种 Architecture Pattern. 我们来想一下,无论是做一个 App 还是搭一套后台系统,如果是一次性的,今天用完明天就可以扔掉,那么怎么快怎么来,代码重复、代码逻辑、代码格式统统不重要.

Swift编写的一些完整的app

- - ITeye博客
收集了一些实用swift编写的app,这些demo都是不错的值得学习的. 参照了 YANGReal的糗事百科和uitableview的例子,这些虽说是demo,也是完整的app,使用了爱加密的 app加密技术,非常不错,感谢. 我觉得学习一门语言光看是没用的,只有投入到实践项目中去,才能最快速的掌握它,有兴趣的同学可以和我一起来把这个项目完善,目前只做了列表页和内容页两个页面.

OpenStack开源云计算 OpenStack对象存储——Swift

- - 酷勤网-挖经验 [expanded by feedex.net]
OpenStack Object Storage(Swift)是OpenStack开源云计算项目的子项目之一,被称为对象存储,提供了强大的扩展性、冗余和持久性. 本文将从架构、原理和实践等几方面讲述Swift. Swift并不是文件系统或者实时的数据存储系统,它称为对象存储,用于永久类型的静态数据的长期存储,这些数据可以检索、调整,必要时进行更新.

[转] 分布式存储系统(GlusterFS, Swift, Cassandra)设计对比

- - 忘我的追寻
之前转过一篇分布式文件系统比较的文章, 几大分布式文件系统全方位比较,这里再从存储的角度转一个. 应该说者三个开源软件各自侧重的领域不一样,但是都具备分布式存储的特征,因此这篇文章主要是从存储的角度来进行对比. 1、 文件定位:三者均采用hash算法,另外amazon的Dynamo也是采用一致性哈希;还有采用中心路由的定位方式:如HBASE,HDFS.

苹果的新编程语言 Swift 简介

- - 互联网的那点事
原文出处:  Lucia(@peng_gong) 欢迎加入 iOS小组. 这篇文章简要介绍了苹果于 WWDC 2014发布的编程语言——Swift. 在这里我认为有必要提一下 Brec Victor的 Inventing on Principle,Swift编程环境的大部分概念都源自于 Brec这个演讲.