Swift中如何为APIService的网络请求添加自定义请求头

核心问题梳理 #

• 误用data(from: url)方法：这个URLSession便捷方法会自动生成默认请求，无法自定义请求头，必须手动创建URLRequest实例。
• 请求头配置逻辑错误：未初始化URLRequest就尝试设置请求头，属于代码逻辑漏洞，需先创建请求实例再配置参数。

修正后的APIService实现代码 #

import Foundation

class APIService {
    private let customHeaders: [String: String]
    
    // 初始化时传入自定义请求头字典
    init(headers: [String: String]) {
        self.customHeaders = headers
    }
    
    // GET请求示例
    func getRequest(from url: URL, completion: @escaping (Data?, Error?) -> Void) {
        // 1. 创建可配置的URLRequest实例
        var request = URLRequest(url: url)
        
        // 2. 遍历字典，批量添加请求头
        for (headerKey, headerValue) in customHeaders {
            request.setValue(headerValue, forHTTPHeaderField: headerKey)
        }
        
        // 3. 用自定义请求发起网络任务
        URLSession.shared.dataTask(with: request) { data, _, error in
            completion(data, error)
        }.resume()
    }
    
    // POST请求扩展示例
    func postRequest(to url: URL, body: Data?, completion: @escaping (Data?, Error?) -> Void) {
        var request = URLRequest(url: url)
        request.httpMethod = "POST"
        request.httpBody = body
        
        // 复用请求头配置逻辑
        for (headerKey, headerValue) in customHeaders {
            request.setValue(headerValue, forHTTPHeaderField: headerKey)
        }
        
        URLSession.shared.dataTask(with: request) { data, _, error in
            completion(data, error)
        }.resume()
    }
}

关键注意事项 #

• 优先使用URLRequest配置请求：只有通过URLRequest实例，才能灵活添加、修改请求头字段，setValue(_:forHTTPHeaderField:)是标准配置方式。
• 系统保留头字段限制：部分字段（如host）可能被系统自动覆盖，若需强制设置，可尝试在URLRequest中配置，但需注意系统行为限制。
• 避免便捷方法的局限性：data(from: url)等便捷方法仅适用于无自定义配置的简单请求，复杂场景必须手动构建请求。

使用示例 #

// 传入你的自定义请求头字典
let sampleHeaders = ["x-request-id": "d8099384-0720-425d-bfe2-f9cef572f443",
                     "room-id": "123room",
                     "e-uuid": "e8edec14-ce38-42b5-93b0-3fee05fca1eb"]

// 初始化APIService
let apiService = APIService(headers: sampleHeaders)

// 发起请求
if let targetUrl = URL(string: "https://RJB-production.up.railway.app/api/your-target-endpoint") {
    apiService.getRequest(from: targetUrl) { data, error in
        if let error = error {
            print("请求失败：\(error.localizedDescription)")
            return
        }
        guard let responseData = data else {
            print("未获取到返回数据")
            return
        }
        // 处理返回数据
        print("请求成功，数据长度：\(responseData.count)")
    }
}

内容的提问来源于stack exchange，提问作者Pastor J.G Seigle