iOS HTTPCookie基本使用

1、cookie基本介绍

Cookie是在客户端存储服务器状态的一种机制,Web服务器可以通过Set-Cookie或者Set-Cookie2 HTTP头部设置Cookie。

Cookie是由服务器端生成，发送给User-Agent（一般是浏览器或者客户端），浏览器会将Cookie的key/value保存到某个目录下的文本文件内，下次请求同一网站地址时就发送该Cookie给服务器

1.1、Cookie可以分为两类

• 会话Cookie：会话Cookie是临时Cookie,当前会话结束(浏览器退出)时Cookie会被删除。会话Cookie和持久Cookie的区别在于过期时间，如果设置了Discard参数(Cookie 版本1)或者没有设置Expires(Cookie版本0)或Max-Age(Cookie版本1)设置过期时间，则此Cookie为会话Cookie
• 持久Cookie：持久Cookie会存储在用户的硬盘上,浏览器（客户端）退出，然后重新启动后Cookie仍然存在。

1.2、Cookie的版本

Cookie有两个版本,一个是版本0(Netscape Cookies)和版本1(RFC 2965),目前大多数服务器使用的Cookie 0。

1.3、cookie的工作原理

cookie就像服务器给用户贴的标签，用户访问一个web站点的时候，服务器就可以通过这个标签来识别是哪一个用户。
cookie中包含了一个有名字=值（name=value）这样的信息构成的任意列表，并通过Set-Cookie或Set-Cookie2 Http 响应（扩展）的header来设置标签。

cooke可以包含任意信息，但他们通常都只包含一个服务器为了进行追踪而产生的独特的识别码。

浏览器会记住 从服务器返回的Set-Cookie或Set-Cookie2 header中的cookie内容，并将cookie集存储在浏览器的cookie数据库中（ios客户端是存在app的library/cookie沙盒目录下）。将来用户访问统一站点时，浏览器会选中那个服务器贴到用户上的那些cookie,并请求的header中将起传给服务器。

• 更多参考（HTTP权威指南）

2、HTTPCookie

一个NSHTTPCookie对象代表一个HTTP cookie。它是一个不可变的对象，从包含cookie属性的字典中初始化。它支持两种不同的cookie版本：Version 0 和 Version 1

2.1、创建cookie

• 根据URL从响应对象的headerFileds中读取到Cookie相关内容,生成NSHTTPCookie实例对象数组。

// 该方法会忽略headerFileds中与cookie无关的字段，
//如果headerFileds中的cookie没有指定domain,则使用theURL的domain,如果没有指定path,则使用”/”.

class func cookies(withResponseHeaderFields: [String : String], for: URL)

• 用给定的属性生成cookie对象

init?(properties: [HTTPCookiePropertyKey : Any])

2.2、转换cookie为 request headers

• 返回一个字典，通过setValue(_:forHTTPHeaderField:) 方法设置返回的字典到request。然后发送给服务器。

class func requestHeaderFields(with cookies: [HTTPCookie]) -> [String : String]

2.3、cookie的属性

// cookie的注释，说明cookir的用途和目的
 var comment: String? 
 // 注释的链接，进一步说明Cookie
 var commentURL: URL?
 // cookie所属的域
 var domain: String
 
 // 过期时间
 var expiresDate: Date?
 // 是否发送给http服务器
 var isHTTPOnly: Bool
 // cookie是否通过ssl安全链接发送
 var isSecure: Bool
 
 // 在会话结束的时候是否移除cookie(不考虑它的过期时间)
 var isSessionOnly: Bool
 // cookie名
 var name: String
 //cookie将在cookie域中发送此路径的请求，以及所有具有此前缀的路径。“/”路径意味着cookie将被发送到域中的所有URL。
 var path: String
 
 // cookies的所以端口
 var portList: [NSNumber]?
 // cookie的所以属性
 var properties: [HTTPCookiePropertyKey : Any]?
 // 值
 var value: String
 
 // cookie的版本 0或者1
 var version: Int

2.5、重要提示

除非NSURLRequest明确指定不使用cookie(HTTPShouldHandleCookies设为false),否则URL loading system会自动为NSURLRequest发送合适的存储cookie。从NSURLResponse返回的cookie也会根据当前的cookie访问策略(cookie acceptance policy)接收到系统中。

3、HTTPCookieStorage

HTTPCookieStorage单例类提供了管理所有NSHTTPCookie对象的接口，在OS X里,cookie是在所有程序中共享的，而在iOS中,cookie只当当前应用中有效。

通过sharedHTTPCookieStorage方法可获取到共享的NSHTTPCookieStorage单件对象。

3.1、获取单例

class var shared: HTTPCookieStorage { get }

3.2、获取cookie

通过单例对象获去

//当前存储的所有cookie
 var cookies: [HTTPCookie]?
//针对特定URL的cookie
func cookies(for URL: URL) -> [HTTPCookie]?
// 对存储的cookie进行排序
func sortedCookies(using sortOrder: [NSSortDescriptor]) -> [HTTPCookie]

3.3、添加/删除cookie

通过单例对象去操作下面方法

// 删除cookie
func deleteCookie(HTTPCookie)
// 如果cookie接受策略许可，则将cookie存储在cookie存储区中。
func setCookie(HTTPCookie)
// 如果接收方的cookie接受策略允许，则向接收器添加一个cookie数组。
func setCookies([HTTPCookie], for: URL?, mainDocumentURL: URL?)

3.4、改cookie接收策略

一共有三种cookie accept policy,

• always: 接收所有cookie,默认策略.
• case never: 拒绝所有cookie
• onlyFromMainDocumentDomain: 只接收main document domain中的cookie.

var cookieAcceptPolicy: HTTPCookie.AcceptPolicy

public enum AcceptPolicy : UInt {

        case always

        case never

        case onlyFromMainDocumentDomain
    }

3.5、通知相关

• 当HTTPCookieStorage实例中的cookies变化时发出此通知。

static let NSHTTPCookieManagerCookiesChanged: NSNotification.Name

• 当NSHTTPCookieStorage实例的cookie acceptance policy变化时发出此通知。

static let NSHTTPCookieManagerAcceptPolicyChanged: NSNotification.Name

4、Demo

注意url loading system会根据cookie中设置的domain,port,path等信息，在发送请求的时候，针对请求的URL从缓存库中选着合适的cookie,并把它附加到requset的header中 ,然后一起发送给服务器。 如果设置了 request.httpShouldHandleCookies = false,将不会自动发送cookie。

import UIKit

class CookieUseViewController: UIViewController,URLSessionDelegate, URLSessionDataDelegate {

    private var session: URLSession!
    private var url: URL!
    private var request: URLRequest!
    private var reloadButton: UIButton!
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
//        let urlString = "http://api.skyfox.org/api-test.php"
        let urlString = "http://localhost:8181"
        url = URL(string: urlString)
        request = URLRequest(url: url)
        
        // 如果设置了false,那么发送的请求header中就不会自动加上cookie信息
        request.httpShouldHandleCookies = true
        
        // 手动设置cookie（不会持久化到沙盒 Library/Cookies目录）
        var cookieProperties =  [HTTPCookiePropertyKey : Any]()
        cookieProperties[HTTPCookiePropertyKey.name] = "username"
        cookieProperties[HTTPCookiePropertyKey.value] = "my cookie"
        cookieProperties[HTTPCookiePropertyKey.domain] = "localhost"
        cookieProperties[HTTPCookiePropertyKey.originURL] = "localhost"
        cookieProperties[HTTPCookiePropertyKey.path] = "/"
        cookieProperties[HTTPCookiePropertyKey.version] = "0"
        cookieProperties[HTTPCookiePropertyKey.port] = 8181

        cookieProperties[HTTPCookiePropertyKey.expires] = Date(timeIntervalSinceNow: 60 * 60)
        cookieProperties[HTTPCookiePropertyKey.discard] = 0

        let cookie = HTTPCookie(properties: cookieProperties)
        HTTPCookieStorage.shared.setCookie(cookie!)
        

        // 初始化重新加载按钮
        reloadButton = UIButton.createLongButton("重新加载", y: 20)
        self.view.addSubview(reloadButton)
        reloadButton.addTarget(self, action: #selector(btnClicked), for: .touchUpInside)
        
        let clearCookieBtn = UIButton.createLongButton("清空Cookie", y: 80)
        self.view.addSubview(clearCookieBtn)
        clearCookieBtn.addTarget(self, action: #selector(btnClicked), for: .touchUpInside)
        // 初始化session
        initSession()
        
        // 获取cookies，如果cookies过期将获取不到，同时发送请求的时候，也不会设置request的header的Cookie属性
        if let cookies = HTTPCookieStorage.shared.cookies {
            for cookie in cookies {
//                HTTPCookieStorage.shared.deleteCookie(cookie)
                
                print("cookies: \(cookie)\n")
            }
        }
    }
    
    func initSession() {
        let defaultConfiguration = URLSessionConfiguration.default
        
        self.session = URLSession(configuration: defaultConfiguration, delegate: self, delegateQueue: nil)
    }
    
    func btnClicked(sender: UIButton) {
        
        if sender == reloadButton {
            
            session.dataTask(with: self.request).resume()
        }else{
            // 清空cookies
            if let cookies = HTTPCookieStorage.shared.cookies {
                for cookie in cookies {
                    HTTPCookieStorage.shared.deleteCookie(cookie)
                    
                    print("删除cookies: \(cookie)\n")
                }
            }else{
                print("cookies不存在")
            }
        }
    }
    
    // MARK: - URLSessionDataDelegate -
    /// 接到数据开始调用，会调用多次
    func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive data: Data) {
        print("接收数据的长度 = \(data.count)")
    }
    
    func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, didReceive response: URLResponse, completionHandler: @escaping (URLSession.ResponseDisposition) -> Void) {
        print("接收到response")
        //接收到响应，继续处理任务
        completionHandler(.allow)
        
        // 打印返回的reponse， 看header中是否有cookie信息
        if let response = response as? HTTPURLResponse {
            let fields = response.allHeaderFields
            
            print("fields = \(fields.description)")
        }
        // 获取cookies 目录下即可看到二进制形式的cookie信息
        if let cookies = HTTPCookieStorage.shared.cookies {
            for cookie in cookies {
                print("cookie = \(cookie)\n")
            }
        }
        
        // 打印这个路径 在cookie
        let path = NSSearchPathForDirectoriesInDomains(.libraryDirectory, .userDomainMask, true)
        print("文件路径：\(path[0])")
        
    }
        func urlSession(_ session: URLSession, dataTask: URLSessionDataTask, willCacheResponse proposedResponse: CachedURLResponse, completionHandler: @escaping (CachedURLResponse?) -> Void) {
        print("将缓存数据:--\(proposedResponse)")
        
        // 缓存数据
        completionHandler(proposedResponse)
        
    }
    
    func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error?) {
        if let error = error {
            print("error: \(error)")
        }else{
            print("加载数据完成")
        }
    }

}

4.1、cookie的持久化存储

如果服务器设置了Cookie失效时间expiresDate ,sessionOnly:FALSE会被持久化到文件中，kill掉后系统自动保存，下次启动app会自动加载.binarycookies中的Cookies，以下是一条Cookie输出

cookie = 

持久化到了文件中，地址是 沙盒的 /Library/Cookies/iwt.Alert---Custom.binarycookies

• 服务器端代码

以Perfect（swift后台框架）为例说明

var iLoveMyCookie = HTTPCookie(
        name: "PerfectCookie",
        value: "Perfect is awesome",
        domain: "localhost",
        expires: .relativeSeconds(60 * 60),
        path: "/",
        secure: false,
        httpOnly: false
    )
    
    // add the cookie object to the response object to be returned to the client browser.
    response.addCookie(iLoveMyCookie)

4.2、手动存储cookie

如果没设置Cookie失效时间expiresDate:(null)，sessionOnly:true,kill掉后系统不会自动保存Cookie，如果想持久化Cookie 模仿浏览器存住Cookie，使用NSUserDefaults存下即可

// 保存cookie
    func saveCookies() {
        if let cookies = HTTPCookieStorage.shared.cookies {
            // 序列化数据
            let cookiesData = NSKeyedArchiver.archivedData(withRootObject: cookies)
            let defaults = UserDefaults.standard
            // 持久化
            defaults.set(cookiesData, forKey: "com.ss.cookieSave")
            defaults.synchronize()
        }
    }
    // 加载cookie
    func loadSavedCookies() {
        if let data = UserDefaults.standard.object(forKey: "com.ss.cookieSave") {
            // 注意这里返回的是个数组
            let cookies = NSKeyedUnarchiver.unarchiveObject(with: data as! Data)
            
            print("load cookies = \(cookies  as! [HTTPCookie])\n")

            HTTPCookieStorage.shared.setCookies(cookies as! [HTTPCookie], for: nil, mainDocumentURL: nil)
            
            if let cookies = HTTPCookieStorage.shared.cookies {
                for cookie in cookies {
                    print("cookie = \(cookie)\n")
                }
            }
        }
    }

5、参考

• HTTPCookie
• HTTPCookieStorage
• Perfect-Cookie-Demo
• iOS HTTP网络请求Cookie的读取与写入(NSHTTPCookieStorage)
• HTTP权威指南