NSURLSession系列（五）- cookie

1 cookie

cookie与cache类似，我们大致按照分析cache的思路分析一下cookie，分为以下几步：

检查与设置cookie；
用不用cookie；
cookie策略

1.1检查cookie

与cache类似的是系统指定了默认的cookie单例，如下：

NSHTTPCookieStorage *cookieStorage = [NSHTTPCookieStorage sharedHTTPCookieStorage];

与cache不同的是，sharedHTTPCookieStorage 是一个只读属性，即cookie我们改变默认的cookie对象，这一部分会在下一小结分析。我们依旧可以查询和设置cookie对象中的内容，只是不能把对象整个替换掉。
NSHTTPCookieStorage是存储cookie的对象，里面的内容是NSHTTPCookie对象。如下图：

cookie1.png

查询cookie单例中的内容，代码如下：

NSArray *cookies = [NSHTTPCookieStorage sharedHTTPCookieStorage].cookies;
    [cookies enumerateObjectsUsingBlock:^(id  _Nonnull obj, NSUInteger idx, BOOL * _Nonnull stop) {
        if (![obj isKindOfClass:[NSHTTPCookie class]]) {
            @throw @"this is not cookie";
        }
        NSHTTPCookie *cookie = (NSHTTPCookie*)obj;
        NSLog(@"%@",cookie.domain);
        NSLog(@"%@",cookie.name);
        NSLog(@"%@",cookie.value);
    }];

对cookie的增删改查，系统提供了如下方法：

- (void)setCookie:(NSHTTPCookie *)cookie;
- (void)deleteCookie:(NSHTTPCookie *)cookie;
- (void)removeCookiesSinceDate:(NSDate *)date NS_AVAILABLE(10_10, 8_0);

1.2 用不用cookie

NSHTTPCookieStorage没有像cache一样提供init方法，因此我们也没法指定自己的cookie对象用于缓存。猜测苹果压根就没想开放出不同session用不同的cookie对象。注意NSHTTPCookie是提供了init方法的。
虽然不能指定cookie的存储对象，但是我们可以选择用不用cookie。当某个session的所有请求都不需要cookie时，我们有三种方式：

将HTTPCookieStorage设为nil
这样cookie将无处安放，也就没有cookie；
将HTTPCookieAcceptPolicy设为NSHTTPCookieAcceptPolicyNever
客户端不接受服务器发来的cookie
HTTPShouldSetCookies设为NO
发送请求时不带cookie
HTTPShouldHandleCookies为NO
如果单个请求想不带cookie可以设置NSMutableURLRequest的HTTPShouldHandleCookies为NO。

1.3 cookie策略

上一节中讲到，影响整个session cache行为的是NSURLSessionConfiguration的requestCachePolicy属性。而影响整个session cookie行为的是NSURLSession的HTTPCookieAcceptPolicy属性和HTTPShouldSetCookies的开关。这两个属性的不同是：HTTPCookieAcceptPolicy策略决定客户端何时存储服务器发送来的cookie；HTTPShouldSetCookies决定客户端发送请求时带不带cookie。NSMutableURLRequest只有HTTPShouldHandleCookies这个开关来决定是否带cookie请求。作为一个请求，它没法决定是否存储cookie。

1.3.1 NSHTTPCookieAcceptPolicy

HTTPCookieAcceptPolicy有如下三中策略：

NSHTTPCookieAcceptPolicyAlways
接受所有cookie
NSHTTPCookieAcceptPolicyNever
从来不接受cookie
NSHTTPCookieAcceptPolicyOnlyFromMainDocumentDomain
这个是默认值,只会对主域名的Cookie进行缓存，子域名或者请求资源的相关cookie并不会缓存。
在NSURLConfiguration中说明HTTPCookieAcceptPolicy的默认值是NSHTTPCookieAcceptPolicyOnlyFromMainDocumentDomain。而在NSHTTPCookieAcceptPolicy枚举中说明默认的枚举类型是NSHTTPCookieAcceptPolicyAlways。测试发现其默认枚举类型是NSHTTPCookieAcceptPolicyOnlyFromMainDocumentDomain。

1.3.2 HTTPShouldSetCookies与HTTPShouldHandleCookies

HTTPShouldSetCookies与HTTPShouldHandleCookies这一对开关影响请求是否使用cookie。HTTPShouldSetCookies是NSURLSession中的属性，HTTPShouldHandleCookies是NSURLRequest的属性。与cache类似，HTTPShouldHandleCookies的优先级更高。当HTTPShouldHandleCookies手动设置为YESE时，请求时必定会带上本地的cookie。注意是手动改为YES，如果保持默认值不变系统就会以NSURLSession的HTTPShouldSetCookies为准。HTTPShouldHandleCookies默认值也是YES。HTTPShouldSetCookies设置为NO时，所有通过该session的请求，在不修改HTTPShouldHandleCookies默认值的情况下都不会带有cookie。如果想带有cookie，需要手动设置请求header中的cookie。