iOS-Weekly项目：如何让CompletionHandler更安全

在iOS开发中，CompletionHandler（完成处理程序）是一种常见的异步编程模式，用于在异步操作完成后执行回调代码。然而，如果不当使用，CompletionHandler可能会导致内存泄漏、回调多次执行或线程安全问题。本文将探讨如何让CompletionHandler变得更安全可靠。

CompletionHandler的基本概念

CompletionHandler是一个在异步操作完成后被调用的闭包（closure），通常用于网络请求、数据库操作或其他耗时任务完成后通知调用方。它的基本形式如下：

func fetchData(completion: @escaping (Result<Data, Error>) -> Void) {
    // 异步操作
    URLSession.shared.dataTask(with: url) { data, response, error in
        if let error = error {
            completion(.failure(error))
        } else if let data = data {
            completion(.success(data))
        }
    }.resume()
}

CompletionHandler的常见问题

1. 内存泄漏

当CompletionHandler捕获了self（通常是视图控制器）时，如果不在适当的时候释放，会导致循环引用和内存泄漏。

2. 多次调用

CompletionHandler被设计为应该只调用一次，但有时由于编程错误可能会被多次调用，导致不可预期的行为。

3. 线程安全问题

CompletionHandler可能在任意线程被调用，如果回调中涉及UI更新而没有切换到主线程，会导致崩溃。

让CompletionHandler更安全的策略

1. 使用weak捕获避免循环引用

fetchData { [weak self] result in
    guard let self = self else { return }
    // 处理结果
}

2. 确保只调用一次

可以创建一个包装器来确保CompletionHandler只被调用一次：

class Once {
    private var hasBeenCalled = false
    private let closure: () -> Void
    
    init(_ closure: @escaping () -> Void) {
        self.closure = closure
    }
    
    func call() {
        guard !hasBeenCalled else { return }
        hasBeenCalled = true
        closure()
    }
}

使用方式：

func fetchData(completion: @escaping (Result<Data, Error>) -> Void) {
    let once = Once {
        completion(.success(Data()))
    }
    
    // 确保只调用一次
    once.call()
    // 第二次调用不会执行
    once.call()
}

3. 自动切换到主线程

对于需要更新UI的CompletionHandler，可以自动切换到主线程：

func fetchData(completion: @escaping (Result<Data, Error>) -> Void) {
    URLSession.shared.dataTask(with: url) { data, response, error in
        DispatchQueue.main.async {
            if let error = error {
                completion(.failure(error))
            } else if let data = data {
                completion(.success(data))
            }
        }
    }.resume()
}

4. 使用Result类型代替多个可选参数

Swift的Result类型可以更清晰地表达成功或失败的状态：

func fetchData(completion: @escaping (Result<Data, Error>) -> Void)

这比传统的(data: Data?, error: Error?)方式更安全，因为可以确保要么成功要么失败，不会出现两者都为nil或都有值的情况。

高级安全模式

1. 使用Promise/Future模式

Promise/Future模式可以提供更强大的异步操作组合能力，并内置了许多安全机制：

func fetchData() -> Future<Data, Error> {
    return Future { promise in
        URLSession.shared.dataTask(with: url) { data, response, error in
            if let error = error {
                promise(.failure(error))
            } else if let data = data {
                promise(.success(data))
            }
        }.resume()
    }
}

2. 使用Combine框架

在支持Combine的系统中，可以使用Publisher来处理异步操作：

func fetchData() -> AnyPublisher<Data, Error> {
    URLSession.shared.dataTaskPublisher(for: url)
        .map(\.data)
        .eraseToAnyPublisher()
}

最佳实践总结

1. 总是使用[weak self]捕获避免循环引用
2. 确保CompletionHandler只被调用一次
3. 对于UI更新，确保在主线程执行
4. 使用Result类型明确表达成功/失败状态
5. 考虑使用更高级的异步模式如Promise或Combine

通过遵循这些原则，可以大大减少CompletionHandler相关的错误，使异步代码更加健壮和可维护。