用原生 Swift 构建网络层：一份面向协议的指南

2023-12-08 07:44:43

引言

在这个快节奏的技术时代，网络连接已成为应用程序开发不可或缺的一部分。在 Swift 中，编写自己的网络层可以为你的应用程序提供定制化和灵活性，同时还能提高性能和可维护性。在本指南中，我们将深入了解如何使用面向协议的方法在原生 Swift 中构建一个强大的网络层。

面向协议的架构

面向协议的方法涉及创建抽象协议，定义一组方法和属性，具体类型必须遵守这些方法和属性。这样做的好处包括：

可扩展性： 通过使用协议，你可以轻松地添加新功能或替换旧功能，而无需更改现有代码。
松散耦合： 协议将不同的组件解耦，允许它们独立开发和维护。
测试便利性： 你可以通过创建协议的模拟实现来轻松测试依赖它的组件。

设计网络层

我们的网络层将包含以下组件：

NetworkRequest 协议： 定义网络请求的通用接口，包括发送请求和解析响应所需的方法。
NetworkRouter 协议： 定义如何构建请求 URL 和参数的方法。
NetworkService 类： 协调网络请求并负责解析响应。

实施网络请求协议

protocol NetworkRequest {
    associatedtype ResponseType: Decodable
    var endpoint: Endpoint { get }
    var method: HTTPMethod { get }
    var headers: [String: String]? { get }
    var body: Data? { get }
    
    func decode(_ data: Data) throws -> ResponseType
}

此协议定义了网络请求的基本特性，包括请求端点、HTTP 方法、请求头和请求正文。它还提供了一个 decode 方法，用于解析响应数据。

实施网络路由器协议

protocol NetworkRouter {
    func request<T: NetworkRequest>(_ request: T) -> URLRequest
}

此协议定义了用于创建 URL 请求的方法。具体实现将根据请求类型和端点信息生成 URL 请求。

实施网络服务类

class NetworkService {
    private let session: URLSession
    
    init(session: URLSession = .shared) {
        self.session = session
    }
    
    func perform<T: NetworkRequest>(_ request: T, completion: @escaping (Result<T.ResponseType, Error>) -> Void) {
        let urlRequest = NetworkRouter().request(request)
        session.dataTask(with: urlRequest) { (data, response, error) in
            if let error = error {
                completion(.failure(error))
                return
            }
            
            guard let data = data else {
                completion(.failure(NSError(domain: "com.myapp.error", code: 1, userInfo: nil)))
                return
            }
            
            do {
                let decodedResponse = try request.decode(data)
                completion(.success(decodedResponse))
            } catch {
                completion(.failure(error))
            }
        }.resume()
    }
}

此类负责协调网络请求并解析响应。它使用 URLSession 来发送请求并接收响应。

使用网络层

有了这些组件之后，就可以使用网络层来发出 HTTP 请求。以下是如何发出 GET 请求的示例：

enum MyEndpoint: Endpoint {
    case user(id: String)
}

struct GetUserRequest: NetworkRequest {
    typealias ResponseType = User
    var endpoint: Endpoint { MyEndpoint.user(id: "123") }
    var method: HTTPMethod = .get
}

let networkService = NetworkService()
networkService.perform(GetUserRequest()) { (result) in
    switch result {
    case .success(let user):
        // Process user data
    case .failure(let error):
        // Handle error
    }
}