URLSession、Alamofire、Moya的http请求报文组织

http报文格式

借用网上一个图

http报文格式.png

总结起来就是url(请求行)— header(请求头部)— body(请求数据)

完整的http网络请求有两个报文,一个是请求报文,一个是响应报文。这里只关注请求报文。

header里有很多字段,比较常用的就是content-type字段,这个字段决定了body的编码格式。

Content-Type常见的几种格式

  • application/x-www-form-urlencoded url编码

    说明body中的东西看起来是这样的

    id=1234&name=%E5%86%85%E5%AD%98%E4%BB%8B%E7%BB%8D/

    这种有百分号的编码叫URLEncoding,又叫百分号编码

  • application/json

    这种编码是现在接口请求中最常用的格式,表示body里的内容是json字符格式

    {

    ​ "name": xxxx,

    ​ "id": 1234

    }

  • multipart/form-data

    这个格式的body由0到多个item组成,item之间有分界线。item内部也有head和body,item的head由content-disposition和content-type组成。借用这篇文章的例子说明一下格式

    --ZnGpDtePMx0KrHh_G0X99Yef9r8JZsRJSXC
    Content-Disposition: form-data; name="city"
    
    Santa colo
    --ZnGpDtePMx0KrHh_G0X99Yef9r8JZsRJSXC
    Content-Disposition: form-data;name="desc"
    Content-Type: text/plain; charset=UTF-8
    Content-Transfer-Encoding: 8bit
    
    ...
    --ZnGpDtePMx0KrHh_G0X99Yef9r8JZsRJSXC
    Content-Disposition: form-data;name="pic"; filename="photo.jpg"
    Content-Type: application/octet-stream
    Content-Transfer-Encoding: binary
    
    ... binary data of the jpg ...
    --ZnGpDtePMx0KrHh_G0X99Yef9r8JZsRJSXC--
    

URLSession中组织http请求报文

下面是一个使用URLSession实现的没有参数的网络请求

        let request = URLRequest(url: URL(string: "https://www.baidu.com")!)
        let task = URLSession.shared.dataTask(with: request) { (data, response, error) in
        }
        task.resume()

系统提供的URLSession网络库不会帮我们组织http报文。如果我们想带上参数,就得自己组织http报文。如果想像get的方式增加参数,就得手动修改url进行参数拼接。如果想把数据放在body里,得把自己要传输的数据组织成urlencode或json或其他想要格式的数据,然后把数据用utf8编码变成二进制,放到request的httpBody属性上,再设置一下header的content-type成对应类型。如果是urlencode,就这样设置

request.setValue("application/x-www-form-urlencoded", forHTTPHeaderField: "Content-Type")

或者这样

request.setValue("application/x-www-form-urlencoded; charset=UTF-8", forHTTPHeaderField: "Content-Type")

        var urlString = "https://www.baidu.com"
        
        urlString.append("?name=xxx&id=1234") //GET,把参数拼接到url后面。这里省略了urlencode编码。

        var request = URLRequest(url: URL(string: urlString)!)
        
        let task = URLSession.shared.dataTask(with: request) { (data, response, error) in
        }
        task.resume()

        var urlString = "https://www.baidu.com"
        
        var request = URLRequest(url: URL(string: urlString)!)
        
                // POST,把json格式的参数放到body里
        do {
            let bodyJsonData = try JSONSerialization.data(withJSONObject: ["name": "xxxx", "id": 12133], options: JSONSerialization.WritingOptions.prettyPrinted)
            request.httpBody = bodyJsonData
            request.setValue("application/json", forHTTPHeaderField: "Content-Type")
        } catch {
        }

        let task = URLSession.shared.dataTask(with: request) { (data, response, error) in
        }
        task.resume()
        

Alamofire组织http报文

使用Alamofire组织一个参数拼接到url上的请求:

        let urlString = "https://www.baidu.com"
        let param = ["name": "xxxx", "id": 12133] as [String : Any]
        request(URL(string: urlString)!, method: .get, parameters: param, encoding: URLEncoding.queryString, headers: nil).response { (response) in
        }

可以看到我们直接传了一个参数字典给Alamofire,所以是Alamofire帮我们把传进去的param进行url编码,然后拼到url后面。如果request方法到ecoding参数给URLEncoding.httpBody,Alamofire是会把参数进行url编码,然后进行utf8编码转变成二进制数据放到request的httpbody上

Alamofire中负责组织数据的是遵循ParameterEncoding协议的类,Alamofire中遵循这个协议的有三个类 URLEncoding、JSONEncoding、PropertyListEncoding,我们也可以根据需要自定义。顾名思义,这几个类分别负责url编码、json格式数据组织、plist文件格式数组组织。Alamofire按照request方法中的encoding参数对数据进行组织。JSONEncoding和PropertyListEncoding组织的数据只能放在httpbody中,而URLEncoding组织的数据可以拼接在url后面。

Moya的方式

下面是一个把参数用URLEncoding编码方式放到httpbody中的网络请求

//首先把request里需要的数据定义出来
enum BaiduAPI {
    case home
}

extension BaiduAPI: TargetType {
    var baseURL: URL {
        return URL(string: "https://www.baidu.com")!
    }
    
    var path: String {
        return ""
    }
    
    var method: Moya.Method {
        return .post
    }
    
    var sampleData: Data {
        return Data()
    }
    
    var task: Task {
        return .requestParameters(parameters: ["name": "xxxx", "id": 12133], encoding: URLEncoding.httpBody)
    }
    
    var headers: [String : String]? {
        return nil
    }
}

    func moyaQuest() {
        let moya = MoyaProvider()
        moya.request(BaiduAPI.home) { (result) in
        }
    }

可以看到moya把http请求报文需要的信息都模版化了。其中task属性是数据承载体,也是承载着数据组织形式。Task是个枚举,它给开发者提供了几种数据的组合方式,比如同时需要把参数拼接在url上和放到body里的场景,可以用requestCompositeData,requestCompositeParameters,uploadCompositeMultipart。Moya会把TargetType转成EndPoint,再把EndPoint转成URLRequest。

你可能感兴趣的:(URLSession、Alamofire、Moya的http请求报文组织)