Swift 圣战:干净的命名空间

作者:Erica Sadun,原文链接,原文日期:2016-11-17
译者:星夜暮晨;校对:Crystal Sun;定稿:CMB

sssilver 留言说:「我发现我司的代码普遍都是这种情况:每个类都包含了一堆的静态方法。我问同事为什么不直接编写方法,他们回答说是不想污染命名空间。在类似 Rust 之类的语言当中,所有内容都位于模块内部。那么在 Swift 当中常见的做法是如何呢?」

Swift 偏好于使用命名空间将函数及常量独立出来。这同样适用于模块内部的 API,您可以很轻易地获取常见的命名空间。如果您想要让命名空间保持干净、集中的话,那么通常而言,将内容限制在类型和协议当中是挺不错的选择。

这种做法使得 Swift 较以前的版本而言,更倾向于使用层次结构。Swift 更适合:

  • 将常量放置到适合的类型当中,以完成命名空间的构建;
  • 将函数放置到它们所需要服务的类型或者协议当中,可以使用静态方法,或者将首个参数移除然后将这个函数改造为一个实例方法;
  • 添加子类型,而不是将所有东西都集中在父类型当中,这会污染命名空间。子类型使得父类以及其嵌套类型 (nested type) 在相互引用的时候减少引用的复杂度,因此 Shape.Triangle 以及 Shape.Circle 都可以很清楚地明白对方的作用;
  • 将只会被一个方法调用的函数嵌入到这个方法当中,而不是创建另一个只用于服务相同对象的方法;
  • 将运算符实现代码移到它们所作用的类型当中,这样便可以减少全局命名空间当中所实现的运算符数目。

此前您很可能创建了如下锁匙的公共常量和函数,现在最好是将它们合并到既有类型或者工具 (utility) 类型当中:

public let π = CGFloat(Double.pi) // 不建议
public let τ = π * 2.0 // 不建议

public func halt() { // 不建议
    PlaygroundPage.current.finishExecution()
}

extension CGFloat { 
    /// 存放 π 常量,建议
    public static let (pi, π) = (CGFloat(Double.pi), CGFloat(Double.pi))
 
    /// 存放 τ 常量,建议
    public static let (tau, τ) = (2 * pi, 2 * pi)
}

extension PlaygroundPage {
    // 这看起来好看不少
    public static func halt() {
        current.finishExecution()
    }
}

将全局量作为静态成员嵌入到类型当中,使得命名空间更加干净、Swift 化,并且还让性能开销降到最低。只要条件允许,您应该尽量去扩展苹果所提供的类型 (例如 CGFloat 以及 PlaygroundPage ),而不是创建新的类型 (例如 MathConstants 或者 PlaygroundRuntimeSupport)。

与此同时,不要强行将常量和函数放到并不适合的类当中。如果您必须要创建一个新的类型来生成一个新的命名空间,那么请使用不包含枚举值的枚举,这将保证这个类型无法被构造出来。

在文章发布之后,我可能还会有新的思路,所以如果我遗漏了些什么,请联系我,我会及时地更新这篇文章。

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

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

推荐阅读更多精彩内容