详细解析几个和网络请求有关的类(二十五) —— NSHTTPCookie之设置删除和通信(二)

版本记录

版本号 时间
V1.0 2018.05.23

前言

我们做APP发起网络请求,一般都是使用框架,这些框架的底层也都是苹果的API,接下来几篇就一起来看一下和网络有关的几个类。感兴趣的可以看上面几篇文章。
1. 详细解析几个和网络请求有关的类 (一) —— NSURLSession
2. 详细解析几个和网络请求有关的类(二) —— NSURLRequest和NSMutableURLRequest
3. 详细解析几个和网络请求有关的类(三) —— NSURLConnection
4. 详细解析几个和网络请求有关的类(四) —— NSURLSession和NSURLConnection的区别
5. 详细解析几个和网络请求有关的类(五) —— 关于NSURL加载系统(一)
6. 详细解析几个和网络请求有关的类(六) —— 使用NSURLSession(二)
7. 详细解析几个和网络请求有关的类(七) —— URL数据的编码和解码(三)
8. 详细解析几个和网络请求有关的类(八) —— 处理重定向和其他请求更改(四)
9. 详细解析几个和网络请求有关的类(九) —— 身份验证挑战和TLS链验证(五)
10. 详细解析几个和网络请求有关的类(十) —— 理解获取缓存(六)
11. 详细解析几个和网络请求有关的类(十一) —— Cookies和自定义协议(七)
12. 详细解析几个和网络请求有关的类(十二) —— URL Session的生命周期(八)
13. 详细解析几个和网络请求有关的类(十三) —— NSURLResponse(一)
14. 详细解析几个和网络请求有关的类(十四) —— NSHTTPCookie(一)
15. 详细解析几个和网络请求有关的类(十五) —— NSHTTPCookieStorage(一)
16. 详细解析几个和网络请求有关的类(十六) —— NSURLCache(一)
17. 详细解析几个和网络请求有关的类(十七) —— NSCachedURLResponse(一)
18. 详细解析几个和网络请求有关的类(十八) —— NSURLAuthenticationChallenge(一)
19. 详细解析几个和网络请求有关的类(十九) —— NSURLProtectionSpace(一)
20. 详细解析几个和网络请求有关的类(二十) —— NSURLCredential(一)
21. 详细解析几个和网络请求有关的类(二十一) —— NSURLCredentialStorage(一)
22. 详细解析几个和网络请求有关的类(二十二) —— NSStream(一)
23. 详细解析几个和网络请求有关的类(二十三) —— NSInputStream(一)
24. 详细解析几个和网络请求有关的类(二十四) —— NSOutputStream(一)

回顾

上一篇讲述了NSOutputStream这个类的详细信息以及一些注意要点,下面这篇我们继续深入一下看一下Cookie的常用用法和使用场景。

在开始之前可以看一下前面写过的一篇文章。

14. 详细解析几个和网络请求有关的类(十四) —— NSHTTPCookie(一)


cookie的设置和删除

1. 设置cookie

下面我们看一下如何设置cookie

就是获取NSHTTPCookie,然后利用NSHTTPCookieStorage进行设置。类似代码如下

+ (nullable NSHTTPCookie *)cookieWithProperties:(NSDictionary *)properties;
    NSHTTPCookie *tokenCookie = [NSHTTPCookie cookieWithProperties:@{NSHTTPCookieName:@"token",
                                                                     NSHTTPCookieValue:[CPUserManager token],
                                                                     NSHTTPCookiePath:@"/",
                                                                     NSHTTPCookieDomain:@".alipay.com",
                                                                     NSHTTPCookieOriginURL:@".alipay.com"}];
    NSHTTPCookie *userIdCookie = [NSHTTPCookie cookieWithProperties:@{NSHTTPCookieName:@"userId",
                                                                      NSHTTPCookieValue:[CPUserManager userID],
                                                                      NSHTTPCookiePath:@"/",
                                                                      NSHTTPCookieDomain:@".alipay.com",
                                                                      NSHTTPCookieOriginURL:@".alipay.com"}];
    [[NSHTTPCookieStorage sharedHTTPCookieStorage] setCookie:tokenCookie];
    [[NSHTTPCookieStorage sharedHTTPCookieStorage] setCookie:userIdCookie];

下面看一下输出结果



2. 删除cookie

删除特定URL的cookie

    NSURL *url = [NSURL URLWithString:@"www.alipay.com"];
    NSArray *cookiesArr = [[NSHTTPCookieStorage sharedHTTPCookieStorage] cookiesForURL:url];
    for (NSHTTPCookie *cookie in cookiesArr) {
        [[NSHTTPCookieStorage sharedHTTPCookieStorage] deleteCookie:cookie];
    }

删除所有的cookie

    NSArray *cookiesArr = [[NSHTTPCookieStorage sharedHTTPCookieStorage] cookies];
    for (NSHTTPCookie *cookie in cookiesArr) {
        [[NSHTTPCookieStorage sharedHTTPCookieStorage] deleteCookie:cookie];
    }

删除特定的cookie

NSURL *url = [NSURL URLWithString:@"www.baidu.com"];
NSArray *cookieArr = [[NSHTTPCookieStorage sharedHTTPCookieStorage] cookiesForURL:url];
for (NSHTTPCookie *cookie in cookieArr) {
    if ([cookie.name isEqualToString:@"cookieName"]){
        [[NSHTTPCookieStorage sharedHTTPCookieStorage] deleteCookie:cookie];
    }
}

可以删除名称为cookieNamecookie


携带cookie进行通信

前面文章说了这么多,那么cookie在iOS中到底有什么用呢?其实其中的一个应用场景就是在某一个域中种植cookie可以实现和H5或者服务端之间的数据交互。具体化一下,比如下面两个场景:

  • 我的等级(H5)界面。这个界面就需要我们将userId和token带给H5,才会显示正确的结果。
  • 我的关注(H5)界面,这个界面同样需要我们将userId和token带给H5,才会显示正确的结果。

这里我们就可以将userId和token种植在对应域下面,H5获取这个数据,就会显示正确的结果,要不H5就会显示默认值,有界面但是界面的初始化值是不对的。

关于种植cookie,分为在苹果原生网络框架和AFN网络框架两种情况下进行说明。

1. 苹果自带网络请求库携带cookie通信

UIWebView框架

具体代码实现如下所示:

  // 创建一个可变字典存放cookie

    NSMutableDictionary *fromappDict = [NSMutableDictionary dictionary];
    [fromappDict setObject:@"alipayApp" forKey:NSHTTPCookieName];
    [fromappDict setObject:@"ios" forKey:NSHTTPCookieValue];
    // kDomain是公司app网址
    [fromappDict setObject:kDomain forKey:NSHTTPCookieDomain];
    [fromappDict setObject:kDomain forKey:NSHTTPCookieOriginURL];
    [fromappDict setObject:@"/" forKey:NSHTTPCookiePath];
    [fromappDict setObject:@"0" forKey:NSHTTPCookieVersion];

    // 将可变字典转化为cookie
    NSHTTPCookie *cookie = [NSHTTPCookie cookieWithProperties:fromappDict];

    // 获取cookieStorage
    NSHTTPCookieStorage *cookieStorage = [NSHTTPCookieStorage sharedHTTPCookieStorage]
 
    // 存储cookie
    [cookieStorage setCookie:cookie];

这样就在UIWebView中种植了cookie,可以和服务端还有H5进行通信了。

  • UIWebView使用时间较长,只要在cookieStorage中设置了相应的cookie,每次就会自动带上。

  • 弊端是随着与H5的交互增加,Cookie占用的空间越来越大,每次交互都夹带大量的cookie,不仅增加服务器端压力,也浪费用户的流量。

WKWebView框架

WKWebView相比于UIWebView,具有如下优点:

  • 速度快了一倍,内存却减少为原来的一半。

  • cookie不再是自动携带,需要手动设置。

  • 增减了一些代理方法,更方便的进行协议拦截和进度条展示。

(a) 在创建的时候存放到WKUserScript中进行添加cookie

    WKWebViewConfiguration *webConfig = [[WKWebViewConfiguration alloc] init];
    // 设置偏好设置
    webConfig.preferences = [[WKPreferences alloc] init];
    // 默认为0
    webConfig.preferences.minimumFontSize = 10;
    // 默认认为YES
    webConfig.preferences.javaScriptEnabled = YES;
    // 在iOS上默认为NO,表示不能自动通过窗口打开
    webConfig.preferences.javaScriptCanOpenWindowsAutomatically = NO;

    // web内容处理池
    webConfig.processPool = [[WKProcessPool alloc] init];
    // 将所有cookie以document.cookie = 'key=value';形式进行拼接
    #warning 然而这里的单引号一定要注意是英文的,不要问我为什么告诉你这个(手动微笑)
    NSString *cookieValue = @"document.cookie = 'fromapp=ios';document.cookie = 'channel=appstore';";
    
    // 加cookie给h5识别,表明在ios端打开该地址
    WKUserContentController* userContentController = WKUserContentController.new;
    WKUserScript * cookieScript = [[WKUserScript alloc]
                                   initWithSource: cookieValue
                                   injectionTime:WKUserScriptInjectionTimeAtDocumentStart forMainFrameOnly:NO];
    [userContentController addUserScript:cookieScript];
    webConfig.userContentController = userContentController;

    WKWebView *wkWebView = [[WKWebView alloc] initWithFrame:frame configuration:webConfig];

    wkWebView.UIDelegate = wkWebView;
    wkWebView.navigationDelegate = wkWebView;

(b) 加载某个url的时候添加cookie

如果WKWebView在加载url的时候需要添加cookie,需要先手动获取当前NSHTTPCookieStorage中的所有cookie,然后将cookie放到NSMutableURLRequest请求头中。

- (void)loadRequestWithUrlString:(NSString *)urlString 
{    
    // 在此处获取返回的cookie
    NSMutableDictionary *cookieDic = [NSMutableDictionary dictionary];
    
    NSMutableString *cookieValue = [NSMutableString stringWithFormat:@""];
    NSHTTPCookieStorage *cookieJar = [NSHTTPCookieStorage sharedHTTPCookieStorage];
    
    for (NSHTTPCookie *cookie in [cookieJar cookies]) {
        [cookieDic setObject:cookie.value forKey:cookie.name];
    }
    
    // cookie重复,先放到字典进行去重,再进行拼接
    for (NSString *key in cookieDic) {
        NSString *appendString = [NSString stringWithFormat:@"%@=%@;", key, [cookieDic valueForKey:key]];
        [cookieValue appendString:appendString];
    }

    NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:urlString]];
    [request addValue:cookieValue forHTTPHeaderField:@"Cookie"];

    [self loadRequest:request];
}

2. AFNetworking携带cookie通信

   // 获取AFHTTPRequestOperationManager
    AFHTTPRequestOperationManager *operationManager = [AFHTTPRequestOperationManager manager];
    
    // 创建可变字典用于存放Cookie
    NSMutableDictionary *cookieDic = [NSMutableDictionary dictionary];
    
    // 存放新添加的cookie
    NSMutableString *cookieValue = [NSMutableString stringWithFormat:@"fromapp=ios;"];

    // 获取
    NSHTTPCookieStorage *cookieJar = [NSHTTPCookieStorage sharedHTTPCookieStorage];

   for (NSHTTPCookie *cookie in [cookieJar cookies]) {
        [cookieDic setObject:cookie.value forKey:cookie.name];
    }
    
    // cookie重复,先放到字典去重,再进行拼接
    for (NSString *key in cookieDic) {
        NSString *appendString = [NSString stringWithFormat:@"%@=%@;", key, [cookieDic valueForKey:key]];
        [cookieValue appendString:appendString];
    }

    // 将cookie存到请求头中
    [operationManager.requestSerializer setValue:cookieValue forHTTPHeaderField:@"Cookie"];

Cookie的防过期处理

iOS中,应用退出,会话结束的时候,Cookies是默认被丢弃的,而浏览器默认是保存的。所以我们还需要对Cookies做一些简单的操作,防止iOS中cookie过期,具体如下所示:

    NSHTTPCookieStorage* cookieStorage = [NSHTTPCookieStorage sharedHTTPCookieStorage];
    NSArray *cookies = [cookieStorage cookiesForURL:[NSURL URLWithString:baseUrl]];
    NSMutableArray *propertiesList = [[NSMutableArray alloc] init];
    [cookies enumerateObjectsUsingBlock:^(NSHTTPCookie * _Nonnull cookie, NSUInteger idx, BOOL * _Nonnull stop) {
        NSMutableDictionary *properties = [[cookie properties] mutableCopy];
        //将cookie过期时间设置为一年后
        NSDate *expiresDate = [NSDate dateWithTimeIntervalSinceNow:3600*24*30*12];
        properties[NSHTTPCookieExpires] = expiresDate;
        //下面一行是关键,删除Cookies的discard字段,应用退出,会话结束的时候继续保留Cookies
        [properties removeObjectForKey:NSHTTPCookieDiscard];
         //重新设置改动后的Cookies
        [cookieStorage setCookie:[NSHTTPCookie cookieWithProperties:properties]];
    }];

参考文章

1. ios 网络通信过程cookie的使用
2. iOS的Cookie存取看我绝对够!!
3. 关于ios的Cookie那些事
4. iOS Cookies 每次退出应用都被清除解决方法

后记

本篇主要讲述了cookie的设置删除以及携带cookie进行通信的示例,感兴趣的给个赞和关注,谢谢~~~

详细解析几个和网络请求有关的类(二十五) —— NSHTTPCookie之设置删除和通信(二)_第1张图片

你可能感兴趣的:(详细解析几个和网络请求有关的类(二十五) —— NSHTTPCookie之设置删除和通信(二))