阅读 355

Swift:enum你会用吗?

这是我参与更文挑战的第11天,活动详情查看: 更文挑战

前言

我一直在思考如何去讲解Swift中的枚举类型,它是如此让人熟悉,不免就让你跟着编程经验走,列举几个状态就感觉万事大吉了。它是如此让人陌生,当你深刻的理解其广泛的用途后,你不得不叹服苹果在设计enum是多么让人眼前一亮。

我思来想去,还是从Swift中最有特点的两个系统枚举入手:Optional和Result,而著名的第三库中选择的话,Alamofire中细化的AFError也是全面理解Swift中enum的很好的范例。

AFError

由于Alamofire中AFError这个文件中注释加上代码已经接近900行了,所以我在举例说明中会精简很大一部分,通过抛砖引玉的方式让大家了解Swift中的enum的特点特色。

import Foundation

public enum AFError: Error {
    
    /// The underlying reason the `.urlRequestValidationFailed`
    public enum URLRequestValidationFailureReason {
        /// URLRequest with GET method had body data.
        case bodyDataInGETRequest(Data)
    }
    
    /// `URLRequest` failed validation.
    case urlRequestValidationFailed(reason: URLRequestValidationFailureReason)
}

// MARK: - Error Descriptions

extension AFError: LocalizedError {
    public var errorDescription: String? {
        switch self {
        case .explicitlyCancelled:
            return "Request explicitly cancelled."
        case let .invalidURL(url):
            return "URL is not valid: \(url)"
        case let .parameterEncodingFailed(reason):
            return reason.localizedDescription
        case let .parameterEncoderFailed(reason):
            return reason.localizedDescription
        case let .multipartEncodingFailed(reason):
            return reason.localizedDescription
        case let .requestAdaptationFailed(error):
            return "Request adaption failed with error: \(error.localizedDescription)"
        case let .responseValidationFailed(reason):
            return reason.localizedDescription
        case let .responseSerializationFailed(reason):
            return reason.localizedDescription
        case let .requestRetryFailed(retryError, originalError):
            return """
            Request retry failed with retry error: \(retryError.localizedDescription), \
            original error: \(originalError.localizedDescription)
            """
        case .sessionDeinitialized:
            return """
            Session was invalidated without error, so it was likely deinitialized unexpectedly. \
            Be sure to retain a reference to your Session for the duration of your requests.
            """
        case let .sessionInvalidated(error):
            return "Session was invalidated with error: \(error?.localizedDescription ?? "No description.")"
        #if !(os(Linux) || os(Windows))
        case let .serverTrustEvaluationFailed(reason):
            return "Server trust evaluation failed due to reason: \(reason.localizedDescription)"
        #endif
        case let .urlRequestValidationFailed(reason):
            return "URLRequest validation failed due to reason: \(reason.localizedDescription)"
        case let .createUploadableFailed(error):
            return "Uploadable creation failed with error: \(error.localizedDescription)"
        case let .createURLRequestFailed(error):
            return "URLRequest creation failed with error: \(error.localizedDescription)"
        case let .downloadedFileMoveFailed(error, source, destination):
            return "Moving downloaded file from: \(source) to: \(destination) failed with error: \(error.localizedDescription)"
        case let .sessionTaskFailed(error):
            return "URLSessionTask failed with error: \(error.localizedDescription)"
        }
    }
}


extension AFError.URLRequestValidationFailureReason {
    var localizedDescription: String {
        switch self {
        case let .bodyDataInGETRequest(data):
            return """
            Invalid URLRequest: Requests with GET method cannot have body data:
            \(String(decoding: data, as: UTF8.self))
            """
        }
    }
}
复制代码

我们先一点点的分析吧:

  • enum是一种特殊的struct!

  • enum可以遵守协议,你看开头一上来就是public enum AFError: Error,表示就是这个AFError遵守Error协议,感兴趣的可以看看Error到底是什么喔。

  • enum是可以带参数的,我们看这个例子case urlRequestValidationFailed(reason: URLRequestValidationFailureReason)

这个urlRequestValidationFailed带了一个reason参数,这个参数的类型是URLRequestValidationFailureReason,仔细看URLRequestValidationFailureReason,它其实也是个枚举,并且带参数:

public enum URLRequestValidationFailureReason {
    /// URLRequest with GET method had body data.
    case bodyDataInGETRequest(Data)
}
复制代码

怎么样,有点晕了没?够酸爽了吧?这还不够呢,我们接着看:

enum不仅能带参数、遵守协议,还能写分类,并扩展只读计算属性与函数,extension AFError: LocalizedError中就是遵守LocalizedError协议,并实现LocalizedError协议中的属性var errorDescription: String?

我们看看这个只读计算属性的里面其中的一个实现:

case let .urlRequestValidationFailed(reason):
    return "URLRequest validation failed due to reason: \(reason.localizedDescription)"
复制代码

这个case let的意思是:如果是urlRequestValidationFailed这种情况,获取这个枚举中的reason参数,并且进行字符串表达,除了上面这种表达,经常的书写方式还有下面几种:

/// 将let放在取枚举值的地方,我个人比较喜欢这种写法
case .urlRequestValidationFailed(let reason):

/// 不关心枚举带参,用_代替
case .urlRequestValidationFailed(_):

/// 直接只显示枚举的状态,省略参数显示
case .urlRequestValidationFailed:
复制代码

最后一个extension AFError.URLRequestValidationFailureReason展示了在内嵌的在AFError中的URLRequestValidationFailureReason类型应该如何编写分类。

怎么样?单单看一个Alamofire的AFError就有不少的收获吧?

Swift中的enum,是我目前学习过的编程语言中功能最强大的enum了。

Result

下面的是官方的Result的源码,我只写出了主干功能,大家看了,想想enum又支持什么功能呢?

@frozen public enum Result<Success, Failure> where Failure : Error {

    /// A success, storing a `Success` value.
    case success(Success)

    /// A failure, storing a `Failure` value.
    case failure(Failure)
    
    /// 其他的内容我省略了
}
复制代码

官方提供的Result枚举在Swift5之后才正式上线,而Github开源的,我们可以看这个库Result,它的.gitignore创建于6年前,可以看到Result类型的出现并不是偶然,它的出现更多是因为功能上的诉求。

当前的异步回调中,最常见的情况有两种:回调成功抑或回调失败,在早期的Swift回调中,我们经常看见这样写:

typealias Callback<Success, SomeError: Error> = (Success?, SomeError?) -> Void
复制代码

因为我知道回调到底是否成功,所以Success与SomeError都是可选类型,使用Result类型后,我们就可以这么写了:

typealias ResultCallback<Success, SomeError: Error> = (Result<Success, SomeError>) -> Void
复制代码

回调的结果,有两种情况,真实可靠——case success和case failure,直接减少了可选类型的使用,也就精简了判空的逻辑。

通过Result这个枚举,我们可以看出Swift中的enum是支持泛型的!!!

如果你一直使用过Alamofire和Kingfisher,你会发现它们里面的回调变迁也是围绕这个上面两个闭包的例子进行演化的。

最后来介绍一下Swift中的可选类型。

Optional

下面的是官方的Optional的源码,我只写出了主干功能,是不是和Result非常相似呢?

@frozen public enum Optional<Wrapped> : ExpressibleByNilLiteral {

    /// The absence of a value.
    ///
    /// In code, the absence of a value is typically written using the `nil`
    /// literal rather than the explicit `.none` enumeration case.
    case none

    /// The presence of a value, stored as `Wrapped`.
    case some(Wrapped)
}
复制代码

而我经常看见的String?这个写法,不过是Optional<String>的糖语法罢了。

最后举一个enum的典型例子

enum NumberType: String {
    case one, two, three, four, five
}

let s: NumberType = .one

print(s.rawValue)
复制代码

s.rawValue的类型是String,而打印出来的就是字符串"one"。

这种enum NumberType: String写法,本质上告诉编译器枚举中的rawValue值是String类型,怎么样,有木有有点晕呢?

大家思考一下下面这种情况:

enum NumberValue: Int {
    case one = 3, two, three, four, five
}
复制代码

NumberValue.two.rawValue是什么呢?

总结

Swift中的enum,不仅是过去认知中仅仅表示状态的简单类型,它有以下这些特性:

  • 支持遵守协议

  • 支持泛型使用

  • 支持编写扩展

  • 支持带参数

  • 支持继承基础数据类型,表示枚举的rawValue的类型

还有其他有点意思的特性可能目前还没有概括全面,我想表达的是,enum的设计是颠覆性,而灵活运用这些enum特性,才是最难的。

明日继续

转眼就是端午小长假了,而休息日是我更文最难的时刻,之所以会先讲解enum是因为它和我们需要讲解的网络请求封装库Moya非常密切。

大家加油!

文章分类
iOS
文章标签