Dev

Swift — 链式编程实现（适配 Objc）

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

Gray

22 Aug 2023 — 4 min read

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

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