使用URLEncodedFormParameterEncoder编码POST登录请求Body失败问题

问题背景 #

我有个POST登录API，要求将password参数作为HTTP Body中的纯字符串传递。使用Alamofire的URLEncodedFormParameterEncoder尝试编码参数时失败，返回错误：

No request created yet.

调试后发现问题出在URLEncodedFormEncoder的encode(_ value: Encodable)方法，它抛出了invalidRootObject错误——因为该编码器默认要求编码的根对象是键值对结构，而我传入的是纯字符串，两者不匹配。

以下是我的相关代码：

Routable协议实现 #

import Foundation
import Alamofire

enum EncodeMode {
    case encoding(parameterEncoding: ParameterEncoding, parameters: Parameters? = nil, headers: [HTTPHeader]? = nil)
    case encoder(parameterEncoder: ParameterEncoder, parameter: Encodable, urlParameters: Parameters? = nil, headers: [HTTPHeader]? = nil)
}

protocol Routeable: URLRequestConvertible {
    var baseURL: URL { get }
    var path: String { get }
    var method: HTTPMethod { get }
    var encodeMode: EncodeMode { get }
}

extension Routeable {
    func asURLRequest() throws -> URLRequest {
        let url = baseURL.appendingPathComponent(path)
        var urlRequest: URLRequest
        switch encodeMode {
        case .encoding(let parameterEncoding, let parameters, let headers):
            urlRequest = try parameterEncoding.encode(URLRequest(url: url), with: parameters)
            urlRequest.method = method
            headers?.forEach { urlRequest.headers.add($0) }
        case .encoder(let parameterEncoder, let parameter, let urlParameters, let headers):
            urlRequest = try URLEncoding.default.encode(URLRequest(url: url), with: urlParameters)
            urlRequest.method = method
            urlRequest = try parameterEncoder.encode(parameter, into: urlRequest)
            headers?.forEach { urlRequest.headers.add($0) }
        }
        return urlRequest
    }
}

UserRouter实现 #

enum UserRouter: Routeable {
    case login(email: String, password: String)
    
    var encodeMode: EncodeMode {
        switch self {
        case let .login(email, password):
            return .encoder(parameterEncoder: URLEncodedFormParameterEncoder.default,
                            parameter: password,
                            urlParameters: ["email": email])
        }
    }

    // 省略baseURL、path、method的实现
}

解决方案 #

1. 自定义字符串参数编码器 #

URLEncodedFormParameterEncoder是为键值对表单设计的，不适合纯字符串Body场景。我们需要自定义一个编码器：

import Alamofire

struct StringParameterEncoder: ParameterEncoder {
    func encode<Parameters>(_ parameters: Parameters, into request: URLRequest) throws -> URLRequest where Parameters : Encodable {
        guard let string = parameters as? String else {
            throw AFError.parameterEncodingFailed(reason: .encoderFailed(error: EncodingError.invalidValue(parameters, EncodingError.Context(codingPath: [], debugDescription: "参数必须为String类型"))))
        }
        
        var request = request
        request.httpBody = string.data(using: .utf8)
        // 根据API要求设置Content-Type，比如text/plain或application/json
        request.headers.add(.contentType("text/plain"))
        return request
    }
}

2. 修改UserRouter使用自定义编码器 #

把原来的URLEncodedFormParameterEncoder.default替换成自定义的StringParameterEncoder()：

enum UserRouter: Routeable {
    case login(email: String, password: String)
    
    var encodeMode: EncodeMode {
        switch self {
        case let .login(email, password):
            return .encoder(parameterEncoder: StringParameterEncoder(),
                            parameter: password,
                            urlParameters: ["email": email])
        }
    }

    // 补全协议要求的其他属性
    var baseURL: URL {
        URL(string: "https://你的API域名.com")!
    }
    
    var path: String {
        "/login"
    }
    
    var method: HTTPMethod {
        .post
    }
}

注意事项 #

• 请根据API实际要求调整StringParameterEncoder中的Content-Type头，比如如果API接受JSON格式的字符串，可设置为application/json。
• 原Routeable协议的encoder分支逻辑无需修改，只要编码器能正确处理纯字符串参数即可。

内容的提问来源于stack exchange，提问作者Giorgio