《重构与模式》Swift 版之参数对象

作者:Natasha The Robot,原文链接,原文日期:2016-05-28
译者:Channe;校对:Cee;定稿:千叶知风

我最近在读《重构与模式》 。昨天(译注:原文日期的昨天),在我写描述了一个拥有多个参数的对象的《创建方法》时,想到了@modocache关于iOS API 设计中的 Swift 模式超棒的演讲,尤其是关于参数对象部分。我第一次看的时候获益匪浅,因此我希望记录下来。

问题

假设你在写一个 BananaUIKit 库,包含了一个简单的 BananaAlertView:

最开始的代码可能想这样:

public class BananaAlertView {
    
    public static func show(
        withTitle title: String,
        message: String,
        dismissButtonText: String)
    {
        // 具体实现
    }
}

这个实现很好,直到一位使用这个框架的用户请求能够将 BananaAlertView 的颜色由棕色换为黄色...

为了确保更改这个框架不影响其他用户,我们使用 Swift 的默认参数:

public class BananaAlertView {
    
    public static func show(
        withTitle title: String,
        message: String,
        dismissButtonText: String,
        // 新的无痛更改
        tintColor: UIColor = .yellowColor())
    {
        // 具体实现
    }
}

只要我们给方法添加参数,它就能很好的工作。但是如果我们想要将参数添加到别的东西就不行了,比如 BananaAlertView 上一个按钮被点击后的闭包:

public class BananaAlertView {
    
    // 按钮被点击后的动作
    public typealias ButtonCallback = (buttonIndex: Int) -> Void
    
    public static func show(
        withTitle title: String,
        message: String,
        dismissButtonText: String,
        // 回调参数
        dismissButtonCallback: ButtonCallback)
    {
        // 具体实现
    }
}

// 用法

BananaAlertView.show(
    withTitle: "This is Bananas",
    message: "Someone has been monkeying around 🙈",
    dismissButtonText: "Banana",
    dismissButtonCallback: { buttonIndex in
        // 具体实现
    })

但是假如我们需要改变闭包的参数呢?假如客户端同样需要按钮的文本呢?

解决方式就是为 ButtonCallback 添加一个按钮文本的参数:

public typealias ButtonCallback = (buttonIndex: Int, buttonTitle: String) -> Void

但是这破坏了一切...当调用 show 方法时,ButtonCallback 方法此时需要两个参数,而不是原来的一个了。

// 用法

BananaAlertView.show(
    withTitle: "This is Bananas",
    message: "Someone has been monkeying around 🙈",
    dismissButtonText: "Banana", 
    // 破坏了原来的调用
    // 闭包需要带有两个参数:buttonIndex 和 buttonText
    dismissButtonCallback: { buttonIndex in
        // 具体实现
    })

于是我们该怎么办?此时参数对象就该上场了!

解决方案

解决方案是为闭包创建一个参数对象:

public class BananaAlertView {
    
    // 参数对象
    public struct ButtonCallbackParameters {
        let buttonIndex: Int
        let buttonTitle: String
    }
    
    // 现在只需要一个参数
    public typealias ButtonCallback = (parameters: ButtonCallbackParameters) -> Void
    
    public static func show(
        withTitle title: String,
        message: String,
        dismissButtonText: String,
        dismissButtonCallback: ButtonCallback)
    {
        // 具体实现
    }
}

BananaAlertView.show(
    withTitle: "This is Bananas",
    message: "Someone has been monkeying around 🙈",
    dismissButtonText: "Banana",
    // 参数对象包含所有调用者需要的参数
    dismissButtonCallback: { parameters in
        if parameters.buttonTitle == "Banana" {
            // 具体处理代码
        }
    })

现在需要添加额外的参数时,代码依旧能工作得非常好。buttonCallback 完全不需要变动。

 public struct ButtonCallbackParameters {
        let buttonIndex: Int
        let buttonTitle: String
        // 新参数
        let buttonCount: Int
}

当然,你也可以轻松删除或移除参数:

public struct ButtonCallbackParameters {
        let buttonIndex: Int
        // 下个版本中移除 buttonTitle
        @available(*, deprecated=2.0)
        let buttonTitle: String
        let buttonCount: Int
}

其他用法

当然,可以重构方法时用更通用的方式来获得越来越多的参数:

public class BananaAlertView {
    
    // 显示警告视图时,视图选项不是必须的
    // 这里能够提供默认值
    public struct AlertViewOptions {
        public let dismissButtonText = "Bananana"
        public let tintColor = UIColor.yellowColor()
        public let animationDuration: NSTimeInterval = 1
    }
    
    public static func show(
        withTitle title: String,
        message: String,
        options: AlertViewOptions)
    {
        // 具体实现
    }
}

权衡

和其他设计模式一样,学会和用好完全是两件事,知道它们是好事,但是在使用前需要权衡一下。找到最佳的平衡点是我们码农的工作,需要不断努力才能找到最佳实践🙅。

对于参数对象来说,好处是能够为未来预留 API,但是这样的预留是有负担的。你不能为此给每个方法和闭包都新建一个新结构体。

所以,请明智的使用!

最后,我强烈推荐观看 @modocache 演讲的完整视频。

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

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

推荐阅读更多精彩内容