You need to enable JavaScript to run this app. Swift中如何创建通用POST JSON请求函数供所有视图控制器复用
优惠活动
大模型
产品
解决方案
定价
更多

Swift中如何创建通用POST JSON请求函数供所有视图控制器复用

通用POST JSON网络请求封装方案

所有重复的请求搭建、JSON编解码、回调切主线程的逻辑全部抽离到独立的网络管理类中,不依赖任何UI组件,所有视图控制器可以直接调用适配不同接口。

第一步:定义通用基础结构

先抽离所有接口共用的响应结构,避免每个接口单独写相同的字段:

// 通用JSON-RPC响应模板,适配现有接口的统一返回格式
struct APIResponse<T: Codable>: Codable {
    let jsonrpc: String?
    let result: T?
    let error: APIErrorModel?
}

// 通用接口错误返回模型
struct APIErrorModel: Codable {
    let code: Int?
    let message: String?
}

第二步:实现独立的网络管理类

单例模式全局共享,内置所有通用请求逻辑,后续如果需要加公共配置(比如全局请求头、统一日志、Token自动携带),只需要修改这个类内部的代码即可:

import UIKit

final class NetworkManager {
    static let shared = NetworkManager()
    private init() {}
    
    // 全局统一请求头,所有请求自动携带
    private let defaultHeaders: [String: String] = [
        "Content-Type": "application/json"
    ]
    
    /// 通用POST JSON请求方法
    /// - Parameters:
    ///   - urlString: 接口完整地址
    ///   - parameters: 遵循Codable协议的请求参数模型
    ///   - responseType: 响应中result字段对应的模型类型
    ///   - completion: 主线程回调,返回解析完成的响应或错误
    func postRequest<P: Codable, R: Codable>(
        urlString: String,
        parameters: P,
        responseType: R.Type,
        completion: @escaping (Result<APIResponse<R>, Error>) -> Void
    ) {
        // 校验接口地址合法性
        guard let url = URL(string: urlString) else {
            completion(.failure(NetworkError.invalidURL))
            return
        }
        
        // 初始化请求
        var request = URLRequest(url: url)
        request.httpMethod = "POST"
        // 批量配置全局请求头
        defaultHeaders.forEach { request.addValue($0.value, forHTTPHeaderField: $0.key) }
        
        // 编码请求参数为JSON数据
        do {
            let jsonBody = try JSONEncoder().encode(parameters)
            request.httpBody = jsonBody
        } catch {
            completion(.failure(NetworkError.encodeFailed(error)))
            return
        }
        
        // 发起请求
        let task = URLSession.shared.dataTask(with: request) { data, _, error in
            // 统一切回主线程回调,调用方不需要再手动写GCD切换
            DispatchQueue.main.async {
                // 先处理系统层面错误(断网、超时等)
                if let error = error {
                    completion(.failure(error))
                    return
                }
                // 校验响应数据存在
                guard let data = data else {
                    completion(.failure(NetworkError.emptyResponse))
                    return
                }
                // 解码JSON响应
                do {
                    let response = try JSONDecoder().decode(APIResponse<R>.self, from: data)
                    completion(.success(response))
                } catch {
                    completion(.failure(NetworkError.decodeFailed(error)))
                }
            }
        }
        task.resume()
    }
}

// 通用网络错误枚举
enum NetworkError: Error {
    case invalidURL
    case emptyResponse
    case encodeFailed(Error)
    case decodeFailed(Error)
    
    var errorDescription: String? {
        switch self {
        case .invalidURL:
            return "接口地址不合法"
        case .emptyResponse:
            return "接口返回空数据"
        case .encodeFailed(let error):
            return "请求参数编码失败:\(error.localizedDescription)"
        case .decodeFailed(let error):
            return "响应数据解析失败:\(error.localizedDescription)"
        }
    }
}

第三步:视图控制器内调用示例

替换原来重复的请求搭建代码,只需要写参数和业务处理逻辑即可:

func loginService() {
    // 构造和原来一致的请求参数模型
    let loginParams = LoginData(
        jsonrpc: "2.0",
        params: PostLogin(
            email: nameTf.text ?? "",
            password: passwordTf.text ?? "",
            device_id: "2"
        )
    )
    
    // 直接调用通用请求方法
    NetworkManager.shared.postRequest(
        urlString: "https://e/api/login",
        parameters: loginParams,
        responseType: Employees.self
    ) { [weak self] result in
        guard let self = self else { return }
        switch result {
        case .success(let responseModel):
            // 处理接口返回的业务错误
            if let apiError = responseModel.error {
                let alert = UIAlertController(
                    title: "提示",
                    message: apiError.message ?? "Your email is not verified",
                    preferredStyle: .alert
                )
                alert.addAction(UIAlertAction(title: "OK", style: .default))
                alert.addAction(UIAlertAction(title: "Cancel", style: .cancel))
                self.present(alert, animated: true)
                return
            }
            // 处理成功的业务逻辑
            guard let userInfo = responseModel.result else { return }
            let vc = UIStoryboard(name: "Main", bundle: Bundle.main)
                .instantiateViewController(withIdentifier: "ProfileViewController") as? ProfileViewController
            vc?.userData = responseModel
            vc?.tokenKey = userInfo.token
            self.navigationController?.pushViewController(vc!, animated: true)
            
        case .failure(let error):
            // 统一处理系统层面错误
            let alert = UIAlertController(
                title: "错误",
                message: error.localizedDescription,
                preferredStyle: .alert
            )
            alert.addAction(UIAlertAction(title: "OK", style: .default))
            self.present(alert, animated: true)
        }
    }
}

封装后的实际收益

  • 彻底消除每个视图控制器里重复的请求初始化、JSON编码、会话创建代码,新接口开发只需要定义好参数模型、响应模型即可调用,不用重复写模板代码
  • 所有网络层逻辑统一维护,后续新增公共能力(比如自动携带用户Token、统一接口日志打印、请求超时配置)只需要修改NetworkManager内部实现,不需要逐个接口调整
  • 用泛型适配不同的请求参数、响应类型,编译期就能做类型校验,避免运行时的类型转换错误
  • 统一在网络层处理主线程切换,不会出现网络回调在子线程更新UI的崩溃问题

内容的提问来源于stack exchange,提问作者Swift

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.11.01 23:24:03