2023年11月29日发(作者:)

详解Swift中的错误处理

前⾔

任何代码都会发⽣错误,这些错误有些是可以补救的,有些则只能让程序崩溃。良好的错误处理能够让你的代码健壮性提⾼,提⾼程序的稳

定性。

本⽂的Swift版本:Swift 3

Objective C

返回nil

如果出错了,就返回空是Objective C中的⼀种常见的处理⽅式。因为在Objective C中,向nil发送消息是安全的。⽐如:

- (instancetype)init

{

self = [super init];

if (self) {

}

//如果初始化失败,会返回nil

return self;

}

断⾔

断⾔指定了我们⽅法的上下⽂,如果断⾔不满⾜,则在Debug环境下会直接crash。

⽐如:AFNetworking中的⽅法

- (void)af_resume {

NSAssert([self respondsToSelector:@selector(state)], @"Does not respond to state");

NSURLSessionTaskState state = [self state];

[self af_resume];

if (state != NSURLSessionTaskStateRunning) {

[[NSNotificationCenter defaultCenter] postNotificationName:AFNSURLSessionTaskDidResumeNotification object:self];

}

}

返回状态码

返回状态码和全局错误信息往往是在⼀起使⽤的。这种错误的处理⽅式常见于⽤Objective C来封装C的代码,或者纯C的⽅法。⽐如sqlite

中的错误处理:

int result = sqlite3_open(dbPath,&_db );

if(result != SQLITE_OK) {//如果出错

}

⼜⽐如,Data写⼊到⽂件

BOOL succeed = [currentData writeToFile:path atomically:YES];

NSError

NSError是Cocoa中推荐的错误处理⽅式

使⽤NSError来处理错误的例⼦遍布整个CocoaTouch框架。

⽐如:NSFileManager

NSFileManager * fm = [NSFileManager defaultManager];

NSError * error;

[fm removeItemAtPath:path error:&error];

⼜⽐如,NSURLSession通过NSError来传递错误信息

[[NSURLSession sharedSession] dataTaskWithURL:url completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError

}];

⼀个NSError包括了错误的详细信息:主要有以下⼏个信息

code 错误的状态码

domain 错误的域

userInfo 错误的详细信息

⽐如,常见的NSURLErrorDomain,也就是⽹络请求失败:

NSURLErrorCancelled = -999,

NSURLErrorBadURL = -1000,

NSURLErrorTimedOut = -1001,

NSURLErrorUnsupportedURL = -1002,

NSURLErrorCannotFindHost = -1003,

//....

NSException

NSException是类似其他语⾔中的异常,你可以通过try-catch等⽅式捕获异常

@try {

//Code that can potentially throw an exception

} @catch (NSException *exception) {

//Handle an exception thrown in the @try block

} @finally {

//Code that gets executed whether or not an exception is thrown

}

当然,你也可以⾃⼰抛出⼀个异常:

[NSException raise:@"ExceptionName" format:@"Contents"];

在Objective C中,通常只有当程序出错,⽆法继续执⾏的时候,我们才会主动抛出⼀个异常。

Objective C的异常处理的效率很低,通常不⽤来做错误处理,⽽且Objective C也没有类似的throw关键字来表明⼀个⽅法会抛出异常,编码起来很

难判断是否需要try-cathe。

Swift中的错误处理

Swift provides first-class support for throwing, catching, propagating, and manipulating recoverable errors at runtime.

Swift提供了⼀套完整的错误抛出-捕获-处理机制。Swift采⽤协议来表⽰错误类型,通过do-try-catch的⽅式来处理可能会抛出异常

Error

的代码。

Optional

可选值表⽰⼀个值要么有值,要么是nil。在Swift中,Optional是⽤enum写的,

public enum Optional : ExpressibleByNilLiteral {

case none

case some(Wrapped)

//...

}

当发⽣错误的时候,返回⼀个可选值是常见的处理⽅式。但是,这种⽅式的有⼀个很明显的缺点:

调⽤者不清楚为什么失败,也就不好进⾏相关的处理。

Error协议与throws

ErrorNSErrorCFError

是⼀个空的协议,⽤来表⽰错误类型。都遵循了这个协议。

throws关键字表明这个⽅法会抛出错误,⽅法调⽤者需要处理错误。

在Swfit中,枚举是⼀个特别适合⽤来处理Error的数据类型。我们⾸先定义⼀个类Person表⽰⼈

enum Sex{

case male

case female

}

class Person{

let sex:Sex

var money:CGFloat

init(sex:Sex ,money:CGFloat) {

self.sex = sex

self.money = money

}

}

Person可以结婚,结婚的时候会发⽣⼀些错误,⽐如钱不够,⽐如性别不对,⽤枚举来表⽰。

enum MarryError : Error{

case lackMoney

使⽤ do-try-catch 代码块

let tom = Person(sex: .male, money: 100000)

let jack = Person(sex: .male, money: 100000)

do{

try (with: jack)

}catch ex {

print("Two Person have same sex")

}catch ney{

print("Oh, they do not have enough moeny")

}catch let error{

print(error)

}

当然,如果不需要区分每⼀个Error,也可以这么调⽤。

do{

try (with: jack)

}catch let error{

print(error)

}

使⽤ try?,对于有返回值的throws函数,使⽤try?会把结果转换为可选值。

let tom = Person(sex: .male, money: 100000)

let jack = Person(sex: .male, money: 100000)

if let result = try? (with: jack){//成功

}else{

print("Error happen")

}

defer关键字

defer关键字⽤来处理类似Ojective C中@try-@catch-@finally中,@finally的作⽤。

⽐如,我们打开⽂件,如果抛出错误的话,我们总希望关闭这个⽂件句柄。

func contents(of filePath:String) throws -> String{

let file = open(filePath,O_RDWR)

defer {

close(file)

}

//...

}

defer代码块的内容在退出作⽤域之前会被执⾏

关于defer,有两点需要注意

多个defer会按照逆序的⽅式执⾏。

当你的程序遇到严重错误,⽐如fatalError,或者强制解析nil,或者segfaults的时候,defer的代码块并不会执⾏。

rethrow

最常见的⽐如,协议⽅法。

Sequencemap

let array = [1,2,3]

let result = {$0 * 2}

由于map函数传⼊的是⼀个闭包,这个闭包可能会抛出错误。由参数抛出的错误最后会向上传递给map函数。

⽐如:

enum MapError : Error{

case invalid

}

func customMapper(input:Int) throws -> Int{

if input < 10{

throw d

}

return input + 1

}

let array = [1,2,3]

let result = (customMapper)

这样是编译不通过的。

调⽤的时候需要:按照上⽂提到的throws关键字的路⼦来

do {

let result = try (customMapper)

} catch let error{

}

所以,这就是rethrows关键字的精髓所在

rethrows 关键字表⽰当参数闭包标记为throws的时候,函数本⾝为throws。如果参数闭包不会抛出错误,则函数也不会。

通过这个关键字,你不必每次都进⾏try-catch

Result类型

我们知道,⼀个函数执⾏要么成功,要么失败。成功的时候我们希望返回数据,失败的时候我们希望得到错误信息,这就是Result类型,⼀

个典型的Result类型如下:

enum Result{

case success(T)

case failure(error:Error)

}

通过Result类型,不再需要可选值或者do-try-catch来包裹你的代码。

我们⽤Result类型对上述marry函数进⾏重写:

extension Person{

func marry(with another: Person) -> Result{

guard != else{

return .failure(error: ex)

}

guard + > 100000 else {

return .failure(error: ney)

}

return .success(true)

}

}

然后,这么调⽤

let tom = Person(sex: .male, money: 100000)

let jack = Person(sex: .male, money: 100000)

let result = (with: jack)

switch result {

case let .success(value):

print(value)

case let .failure(error):

print(error)

}

Result

Swift中有可选链,来处理多个可选值的连续调⽤。同样的,我们也可以为Result类型来添加链式调⽤:

如果上⼀个调⽤结果是.success, 则继续调⽤下⼀个

如果上⼀个调⽤结果是.failure, 则传递failure给下⼀个

我们可以⽤extension来实现

extension Result{

func flatMap(transform:(T) throws -> (V)) rethrows -> Result{

switch self {

case let .failure(error):

return .failure(error: error)

case let .success(data):

return .success(try transform(data))

}

}

}

于是,你就可以这么调⽤了

p({//转换1}).flatMap(//转换2)...

⼀旦失败,中间有⼀次flatMap转换失败,则之后的转换逻辑都不会执⾏

进阶:Result类型在Swift版本的Promise中⼤⾏其道,可以参见的源码,promise让异步处理变得优雅。

assert/precondition

在本⽂最初的的地⽅降到了Objective C的断⾔,同样Swift也有断⾔⽀持。在Swfit中,断⾔是⼀个函数:

func assert(_ condition: @autoclosure () -> Bool,

_ message: @autoclosure () -> String = default,

file: StaticString = #file,

line: UInt = #line)

断⾔仅在Debug模式下进⾏检查,帮助开发者发现代码中的问题。

如果需要在Relase模式下也进⾏检查,则使⽤

precondition

func precondition(_ condition: @autoclosure () -> Bool,

_ message: @autoclosure () -> String = default,

file: StaticString = #file,

line: UInt = #line)

桥接到Objective C

对于如下使⽤NSError来处理错误的的Objective ⽅法

//NSFileManager

- (BOOL)removeItemAtURL:(NSURL *)URL error:(NSError * _Nullable *)error;

在Swift中会被⾃动的转换成

func removeItem(at URL: URL) throws

但是,纯Swfit的Error桥接的Objective C的时候,会有⼀些问题。因为NSError需要 等详细信息。

domaincode

我们可以让Swift的Error实现CustomNSError协议,来提供这些需要的信息。

enum MarryError : Error{

case lackMoney

case wrongSex

}

extension MarryError : CustomNSError{

static let errorDomain = "rror"

var erroCode:Int{

switch self {

case .lackMoney:

return -100001

case .wrongSex:

return -100002

}

}

var errorUserInfo:[String:Any]{

return [:]

}