Swift — 链式编程实现(适配 Objc)

使用 Swift 实现链式编程,并且兼容 Objc

Swift — 链式编程实现(适配 Objc)
Photo by Karine Avetisyan / Unsplash

链式编程是面向对象编程中同一个对象多个方法被调用的常用语法,可读性比较好。链式编程一般通过小数点.链接各个方法,使之成为一句代码,方法被依次调用。

Swift 实现简单的链式编程

Swift 实现链式编程比较简单,只需要让每个方法返回实例本身即可。例如:

@discardableResult
func A() -> Self {
    // do some thing...
    print("A method called")
    return self
}	

关键字 @discardableResult 让编译器忽略返回值未使用的警告,因为链式方法末尾的返回值大部分情况下是不会被接受/使用的。

如法炮制,多写几个类似的方法,就能实现链式调用了:

@discardableResult
func B(param: String) -> Self {
    // do some thing...
    print("B method called, param: \(param)")
    return self
}

@discardableResult
func C(param: String, param2: Int) -> Self {
    // do some thing...
    print("C method called, param: \(param), param2: \(param2)")
    return self
}

链式调用:

SwiftDSL.defaultConfig.A().B(param: "123").C(param: "456", param2: 789)

// output
// A method called
// B method called, param: 123
// C method called, param: 456, param2: 789

适配 Objc

使用 Objc 语言也能实现链式调用,但肯定不是像 Swift 那样通过返回实例本身的方法实现,而是通过 block 属性实现。例如:

@property (nonatomic, copy, readonly) __kindof MyClass * (^chainA)(void);

- (__kindof MyClass * _Nonnull (^)(void))chainA {
    return ^__kindof MyClass *(void) {
        // to do sth...
        return self;
    };
}

这是因为 Objc 中是通过中括号[]调用方法的,并不是小数点。如果用一大串的[]一个一个调用方法,就违背了链式思想的本意了。

下面介绍一下如何将 Swift 的链式代码适配 Objc。

使用 Swift 代码编写 Objc 能够使用的链式方法,同样需要借助属性来实现。不过这里的属性是不需要存储的(只读),只是一个计算的媒介。

@objc(A)
var dsl_A: (() -> SwiftDSL) {
    return A
}

上面代码给对象添加了一个计算属性 dsl_A,返回值为方法A,或者叫A的签名。这个计算属性本身的类型是一个 block,返回值为对象本身的类型。属性之所以命名为dsl_A,是为了避免和A存在命名冲突,因为二者存在于同一个 Swift 代码中。并且使用@objc(A)为这个属性在 Objc 里改名为 A,有点绕……

Swift 链式方法A本身是设置了对 Objc 不可见的,因为 Objc 并不能通过方法的形式实现链式调用,只能通过属性实现。因此借助了一个dsl_A属性实现 Objc 的适配。

整个一套下来,代码如下:

public extension SwiftDSL {
    @discardableResult
    func A() -> Self {
        // do some thing...
        print("A method called")
        return self
    }
    
    @discardableResult
    func B(param: String) -> Self {
        // do some thing...
        print("B method called, param: \(param)")
        return self
    }
    
    @discardableResult
    func C(param: String, param2: Int) -> Self {
        // do some thing...
        print("C method called, param: \(param), param2: \(param2)")
        return self
    }
}

// MARK: - For Objc
@available(swift, obsoleted: 1.0)
public extension SwiftDSL {
    @objc(A)
    var dsl_A: (() -> SwiftDSL) {
        return A
    }
    
    @objc(B)
    var dsl_B: ((_ string: String) -> SwiftDSL) {
        return B(param:)
    }
    
    @objc(C)
    var dsl_C: ((_ string: String, _ param2: Int) -> SwiftDSL) {
        return C(param:param2:)
    }
}

关键字@available(swift, obsoleted: 1.0)是为了将dsl_A,dsl_B,dsl_C这些专门给 Objc 用的属性只暴露给 Objc,Swift 无法调用。

在 Unit Test 里测试一下:

- (void)testAPI {
    SwiftDSL.defaultConfig.A().B(@"123").C(@"456", 789);
}

// output
// Test Case '-[SwiftDSLTests testAPI]' started.
// A method called
// B method called, param: 123
// C method called, param: 456, param2: 789

方法调用顺序以及输出结果是符合预期的🎉。

完整代码见 SwiftDSL

知识共享许可协议
知识共享许可协议


本作品为作者原创文章,采用 CC BY-NC-SA 4.0 进行许可。普通转载请附上原文出处链接及本许可声明;如有商业转载需求,请联系作者。

Read more

iOS 18 初体验

iOS 18 初体验

错过了凌晨的的 WWDC24 发布会,今早从各大媒体中获悉了此次版本更新的主要内容。与之前爆料的内容相近,此次更新主要是针对 AI 、桌面和隐私等。 到公司后发现 iOS 18 的开发者预览版已经可以安装了。于是到工位立马插电开始下载更新系统。这也是我第一次在自己日常使用的设备上安装 beta 版系统,之前都是在测试机上尝鲜。 下面是系统更新之后的一些体验。 控制中心更灵活了 * 控制中心左上角增加了一个加号➕按钮,点击后可以添加更多控制中心选项(长按空白区域也能触发)。这个功能是把「设置」中的控制中心设置挪到了控制中心面板上。 * 右上角增加了一个电源按钮,点击后可以选择是否要滑动关机,取消后立即进入锁定状态,必须使用密码才能解锁。 * 控制中心支持翻页了。可以上下滑动切换页面,目前我的设备上分页分别为「常用」「音乐」「网络连接」。如果开启了「家庭」的话,还会多一个家庭的分页。实测这个分页会影响控制中心的关闭手势—想要上滑关闭控制中心时,系统却将其识别成了上滑翻页。子页面可以通过长按移出和添加。 * 控制中心选项按钮支持调节大小了,并且支持了更多类型的选项(甚至可以

By Gray
绘画临摹·其一

绘画临摹·其一

新 iPad Pro 到手后,我第一时间把几年前买的 procreate 重新下载安装到了新设备上。我自知我没有多少艺术细胞,但还是按耐不住内心创作的渴望。尤其是前段时间看了《月亮和六便士》之后,这种渴望就愈来愈强了。 生命在于创作。绘画是一种创作的形式,也是表达和记录生活的一种方式。我在小红书上收藏了一些绘画的笔记,照着临摹了一些。 第一张我给它起名叫《日》。图层比较简单,依靠一些色彩和高斯模糊特效就可以完成。整体效果还是不错的~ 第二幅是雨天景色,主题色是绿。原作者画的很棒,但是我临摹的不太行,好多细节没有处理好,比如山峦的边缘没有涂抹好,山峦缺乏层次感,山峦和水面(是的,底下是水…)的交界处也没有清晰的表示出来,水面颜色不够通透。原作里面有几头牛,我实在画不出来,索性放弃了。 原作链接: 小红书 端午粽子简笔画。这个还是比较简单的。 原帖: 小红书 蓝天白云。 原帖: 小红书

By Gray