NSURLSession最全攻略

• NSURLSession：请求会话对象，可以用系统提供的单例对象，也可以自己创建。

• NSURLSessionConfiguration：对session会话进行配置，一般都采用default。

• NSURLSessionTask：负责执行具体请求的task，由session创建。

    sharedSession

    sessionWithConfiguration:

    sessionWithConfiguration:delegate:delegateQueue:

1. 创建一个NSURLSessionConfiguration配置请求。

2. 通过Configuration创建NSURLSession对象。

3. 通过session对象发起网络请求，并获取task对象。

4. 调用[task resume]方法发起网络请求。

   
   

    NSURLSessionConfiguration *config = [NSURLSessionConfiguration defaultSessionConfiguration];
    NSURLSession *session = [NSURLSession sessionWithConfiguration:config
                                                          delegate:self
                                                     delegateQueue:[NSOperationQueue mainQueue]];
    NSURLSessionDataTask *task = [session dataTaskWithURL:[NSURL URLWithString:@"http://www.baidu.com"]];
    [task resume];

• NSURLSessionDataTask：处理普通的Get、Post请求。

• NSURLSessionUploadTask：处理上传请求，可以传入对应的上传文件或路径。

• NSURLSessionDownloadTask：处理下载地址，提供断点续传功能的cancel方法。

    - (NSURLSessionDataTask *)dataTaskWithRequest:(NSURLRequest *)request;
    - (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromFile:(NSURL *)fileURL;
    - (NSURLSessionDownloadTask *)downloadTaskWithRequest:(NSURLRequest *)request;

    - (NSURLSessionDataTask *)dataTaskWithURL:(NSURL *)url completionHandler:(void (^)(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error))completionHandler;
    - (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromData:(nullable NSData *)bodyData completionHandler:(void (^)(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error))completionHandler;
    - (NSURLSessionDownloadTask *)downloadTaskWithURL:(NSURL *)url completionHandler:(void (^)(NSURL * _Nullable location, NSURLResponse * _Nullable response, NSError * _Nullable error))completionHandler;

    - (void)getTasksWithCompletionHandler:(void (^)(NSArray<NSURLSessionDataTask *> *dataTasks, NSArray<NSURLSessionUploadTask *> *uploadTasks, NSArray<NSURLSessionDownloadTask *> *downloadTasks))completionHandler;

    - (void)getAllTasksWithCompletionHandler:(void (^)(NSArray<__kindof NSURLSessionTask *> *tasks))completionHandler);

    [NSURLSession sessionWithConfiguration:config delegate:self delegateQueue:nil];

    - (void)URLSession:(NSURLSession *)session
                  task:(NSURLSessionTask *)task
    willPerformHTTPRedirection:(NSHTTPURLResponse *)response
            newRequest:(NSURLRequest *)request
     completionHandler:(void (^)(NSURLRequest *))completionHandler
    {
        NSURLRequest *redirectRequest = request;

        if (self.taskWillPerformHTTPRedirection) {
            redirectRequest = self.taskWillPerformHTTPRedirection(session, task, response, request);
        }

        if (completionHandler) {
            completionHandler(redirectRequest);
        }
    }

    NSURLSessionConfiguration *config = [NSURLSessionConfiguration defaultSessionConfiguration];
    NSURLSession *session = [NSURLSession sessionWithConfiguration:config
                                                          delegate:self
                                                     delegateQueue:[NSOperationQueue mainQueue]];

    @property (class, readonly, strong) NSURLSessionConfiguration *defaultSessionConfiguration;

    @property (class, readonly, strong) NSURLSessionConfiguration *ephemeralSessionConfiguration;

    URLCredentialStorage
    Ephemeral <__NSCFMemoryURLCredentialStorage: 0x600001bc8320>

    HTTPCookieStorage
    Ephemeral <NSHTTPCookieStorage cookies count:0>

    + (NSURLSessionConfiguration *)backgroundSessionConfigurationWithIdentifier:(NSString *)identifier;

    timeoutIntervalForRequest

    timeoutIntervalForResource

    @property (nullable, copy) NSDictionary *HTTPAdditionalHeaders;

    @property (nullable, retain) NSHTTPCookieStorage *HTTPCookieStorage;

    @property (nullable, retain) NSURLCredentialStorage *URLCredentialStorage;

    @property (nullable, retain) NSURLCache *URLCache;

    @property (nullable, retain) NSURLCache *URLCache;

    [[NSURLCache alloc] initWithMemoryCapacity:30 * 1024 * 1024 
                                  diskCapacity:30 * 1024 * 1024 
                                  directoryURL:[NSURL URLWithString:filePath]];

    @property NSInteger HTTPMaximumConnectionsPerHost;

    Connection: Keep-Alive

    Connection: Close

    - (void)URLSession:(NSURLSession *)session 
                  task:(NSURLSessionTask *)task 
    didFinishCollectingMetrics:(NSURLSessionTaskMetrics *)metrics;

    @property (copy, readonly) NSArray<NSURLSessionTaskTransactionMetrics *> *transactionMetrics;

    @property (copy, readonly) NSDateInterval *taskInterval;

    @property (assign, readonly) NSUInteger redirectCount;

    // 请求对象
    @property (copy, readonly) NSURLRequest *request;
    // 响应对象，请求失败可能会为nil
    @property (nullable, copy, readonly) NSURLResponse *response;
    // 请求开始时间
    @property (nullable, copy, readonly) NSDate *fetchStartDate;
    // DNS解析开始时间
    @property (nullable, copy, readonly) NSDate *domainLookupStartDate;
    // DNS解析结束时间，如果解析失败可能为nil
    @property (nullable, copy, readonly) NSDate *domainLookupEndDate;
    // 开始建立TCP连接时间
    @property (nullable, copy, readonly) NSDate *connectStartDate;
    // 结束建立TCP连接时间
    @property (nullable, copy, readonly) NSDate *connectEndDate;
    // 开始TLS握手时间
    @property (nullable, copy, readonly) NSDate *secureConnectionStartDate;
    // 结束TLS握手时间
    @property (nullable, copy, readonly) NSDate *secureConnectionEndDate;
    // 开始传输请求数据时间
    @property (nullable, copy, readonly) NSDate *requestStartDate;
    // 结束传输请求数据时间
    @property (nullable, copy, readonly) NSDate *requestEndDate;
    // 接收到服务端响应数据时间
    @property (nullable, copy, readonly) NSDate *responseStartDate;
    // 服务端响应数据传输完成时间
    @property (nullable, copy, readonly) NSDate *responseEndDate;
    // 网络协议，例如http/1.1
    @property (nullable, copy, readonly) NSString *networkProtocolName;
    // 请求是否使用代理
    @property (assign, readonly, getter=isProxyConnection) BOOL proxyConnection;
    // 是否复用已有连接
    @property (assign, readonly, getter=isReusedConnection) BOOL reusedConnection;
    // 资源标识符，表示请求是从Cache、Push、Network哪种类型加载的
    @property (assign, readonly) NSURLSessionTaskMetricsResourceFetchType resourceFetchType;
    // 本地IP
    @property (nullable, copy, readonly) NSString *localAddress;
    // 本地端口号
    @property (nullable, copy, readonly) NSNumber *localPort;
    // 远端IP
    @property (nullable, copy, readonly) NSString *remoteAddress;
    // 远端端口号
    @property (nullable, copy, readonly) NSNumber *remotePort;
    // TLS协议版本，如果是http则是0x0000
    @property (nullable, copy, readonly) NSNumber *negotiatedTLSProtocolVersion;
    // 是否使用蜂窝数据
    @property (readonly, getter=isCellular) BOOL cellular;

    (Request) <NSURLRequest: 0x600000c80380> { URL: http://vfx.mtime.cn/Video/2017/03/31/mp4/170331093811717750.mp4 }
    (Response) <NSHTTPURLResponse: 0x600000ed9420> { URL: http://vfx.mtime.cn/Video/2017/03/31/mp4/170331093811717750.mp4 } { Status Code: 200, Headers {
        "Accept-Ranges" =     (
            bytes
        );
        Age =     (
            1063663
        );
        "Ali-Swift-Global-Savetime" =     (
            1575358696
        );
        Connection =     (
            "keep-alive"
        );
        "Content-Length" =     (
            20472584
        );
        "Content-Md5" =     (
            "YM+JxIH9oLH6l1+jHN9pmQ=="
        );
        "Content-Type" =     (
            "video/mp4"
        );
        Date =     (
            "Tue, 03 Dec 2019 07:38:16 GMT"
        );
        EagleId =     (
            dbee142415764223598843838e
        );
        Etag =     (
            "\"60CF89C481FDA0B1FA975FA31CDF6999\""
        );
        "Last-Modified" =     (
            "Fri, 31 Mar 2017 01:41:36 GMT"
        );
        Server =     (
            Tengine
        );
        "Timing-Allow-Origin" =     (
            "*"
        );
        Via =     (
            "cache39.l2et2[0,200-0,H], cache6.l2et2[3,0], cache16.cn548[0,200-0,H], cache16.cn548[1,0]"
        );
        "X-Cache" =     (
            "HIT TCP_MEM_HIT dirn:-2:-2"
        );
        "X-M-Log" =     (
            "QNM:xs451;QNM3:71"
        );
        "X-M-Reqid" =     (
            "m0AAAP__UChjzNwV"
        );
        "X-Oss-Hash-Crc64ecma" =     (
            12355898484621380721
        );
        "X-Oss-Object-Type" =     (
            Normal
        );
        "X-Oss-Request-Id" =     (
            5DE20106F3150D38305CE159
        );
        "X-Oss-Server-Time" =     (
            130
        );
        "X-Oss-Storage-Class" =     (
            Standard
        );
        "X-Qnm-Cache" =     (
            Hit
        );
        "X-Swift-CacheTime" =     (
            2592000
        );
        "X-Swift-SaveTime" =     (
            "Sun, 15 Dec 2019 15:05:37 GMT"
        );
    } }
    (Fetch Start) 2019-12-15 15:05:59 +0000
    (Domain Lookup Start) 2019-12-15 15:05:59 +0000
    (Domain Lookup End) 2019-12-15 15:05:59 +0000
    (Connect Start) 2019-12-15 15:05:59 +0000
    (Secure Connection Start) (null)
    (Secure Connection End) (null)
    (Connect End) 2019-12-15 15:05:59 +0000
    (Request Start) 2019-12-15 15:05:59 +0000
    (Request End) 2019-12-15 15:05:59 +0000
    (Response Start) 2019-12-15 15:05:59 +0000
    (Response End) 2019-12-15 15:06:04 +0000
    (Protocol Name) http/1.1
    (Proxy Connection) NO
    (Reused Connection) NO
    (Fetch Type) Network Load
    (Request Header Bytes) 235
    (Request Body Transfer Bytes) 0
    (Request Body Bytes) 0
    (Response Header Bytes) 866
    (Response Body Transfer Bytes) 20472584
    (Response Body Bytes) 20472584
    (Local Address) 192.168.1.105
    (Local Port) 63379
    (Remote Address) 219.238.20.101
    (Remote Port) 80
    (TLS Protocol Version) 0x0000
    (TLS Cipher Suite) 0x0000
    (Cellular) NO
    (Expensive) NO
    (Constrained) NO
    (Multipath) NO

    - (NSData *)readNextBuffer {
        if (self.maxSegment <= self.currentIndex) {
            return nil;
        }

        if(!self.fileHandler){
            NSString *filePath = [self uploadFile];
            NSFileHandle *fileHandle = [NSFileHandle fileHandleForReadingAtPath:filePath];
            self.fileHandler = fileHandle;
        }
        [self.fileHandler seekToFileOffset:(self.currentIndex) * self.segmentSize];
        NSData *data = [self.fileHandler readDataOfLength:self.segmentSize];
        return data;
    }

multipart/from-data规范定义在rfc2388，详细字段可以看一下规范。

--boundary
 Content-Disposition: form-data; name="参数名"
 参数值
 --boundary
 Content-Disposition:form-data;name=”表单控件名”;filename=”上传文件名”
 Content-Type:mime type
 要上传文件二进制数据
 --boundary--

    - (NSData *)writeMultipartFormData:(NSData *)data 
                            parameters:(NSDictionary *)parameters {
        if (data.length == 0) {
            return nil;
        }

        NSMutableData *formData = [NSMutableData data];
        NSData *lineData = [@"\r\n" dataUsingEncoding:NSUTF8StringEncoding];
        NSData *boundary = [kBoundary dataUsingEncoding:NSUTF8StringEncoding];

        // 拼接上传参数
        [parameters enumerateKeysAndObjectsUsingBlock:^(id key, id obj, BOOL *stop) {
            [formData appendData:boundary];
            [formData appendData:lineData];
            NSString *thisFieldString = [NSString stringWithFormat:@"Content-Disposition: form-data; name=\"%@\"\r\n\r\n%@", key, obj];
            [formData appendData:[thisFieldString dataUsingEncoding:NSUTF8StringEncoding]];
            [formData appendData:lineData];
        }];

        // 拼接上传信息
        [formData appendData:boundary];
        [formData appendData:lineData];
        NSString *thisFieldString = [NSString stringWithFormat:@"Content-Disposition: form-data; name=\"%@\"; filename=\"%@\"\r\nContent-Type: %@", @"name", @"filename", @"mimetype"];
        [formData appendData:[thisFieldString dataUsingEncoding:NSUTF8StringEncoding]];
        [formData appendData:lineData];
        [formData appendData:lineData];

        // 拼接上传文件
        [formData appendData:data];
        [formData appendData:lineData];
        [formData appendData: [[NSString stringWithFormat:@"--%@--\r\n", kBoundary] dataUsingEncoding:NSUTF8StringEncoding]];

        return formData;
    }

    NSString *headerField = [NSString stringWithFormat:@"multipart/form-data; charset=utf-8; boundary=%@", kBoundary];
    [request setValue:headerField forHTTPHeaderField:@"Content-Type"];

    NSUInteger size = [[[NSFileManager defaultManager] attributesOfItemAtPath:uploadPath error:nil] fileSize];
    headerField = [NSString stringWithFormat:@"%lu", size];
    [request setValue:headerField forHTTPHeaderField:@"Content-Length"];

    // 发起网络请求
    NSURLSessionUploadTask *uploadTask = [self.backgroundSession uploadTaskWithRequest:request fromData:fromData];
    [uploadTask resume];

    // 请求完成后调用，无论成功还是失败
    - (void)URLSession:(NSURLSession *)session
                  task:(NSURLSessionTask *)task
    didCompleteWithError:(NSError *)error {

    }

    // 更新上传进度，会回调多次
    - (void)URLSession:(NSURLSession *)session
                  task:(NSURLSessionTask *)task
       didSendBodyData:(int64_t)bytesSent
        totalBytesSent:(int64_t)totalBytesSent
    totalBytesExpectedToSend:(int64_t)totalBytesExpectedToSend {

    }

    // 数据接收完成回调
    - (void)URLSession:(NSURLSession *)session
              dataTask:(NSURLSessionDataTask *)dataTask
        didReceiveData:(NSData *)data {

    }

    // 处理后台上传任务，当前session的上传任务结束后会回调此方法。
    - (void)URLSessionDidFinishEventsForBackgroundURLSession:(NSURLSession *)session {

    }

    - (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromData:(NSData *)bodyData;
    - (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromFile:(NSURL *)fileURL;

    // 将分片写入到本地
    NSString *filePath = [NSString stringWithFormat:@"%@/%ld", [self segmentDocumentPath], currentIndex];
    BOOL write = [formData writeToFile:filePath atomically:YES];

    // 创建分片文件夹
    - (NSString *)segmentDocumentPath {
        NSString *documentName = [fileName md5String];
        NSString *filePath = [[SVPUploadCompressor compressorPath] stringByAppendingPathComponent:documentName];
        BOOL needCreateDirectory = YES;
        BOOL isDirectory = NO;
        if ([[NSFileManager defaultManager] fileExistsAtPath:filePath isDirectory:&isDirectory]) {
            if (isDirectory) {
                needCreateDirectory = NO;
            } else {
                [[NSFileManager defaultManager] removeItemAtPath:filePath error:nil];
            }
        }

        if (needCreateDirectory) {
            [[NSFileManager defaultManager] createDirectoryAtPath:filePath
                                      withIntermediateDirectories:YES
                                                       attributes:nil
                                                            error:nil];
        }
        return filePath;
    }

    if ([Reachability reachableViaWiFi]) {
        self.segmentSize = 500 * 1024;
    } else if ([Reachability reachableViaWWAN]) {
        self.segmentSize = 300 * 1024;
    }

iPhone串行上传：715 kb/s
iPhone并行上传：2909 kb/s

    /// 已上传成功片段数组
    @property (nonatomic, strong) NSMutableArray *successSegments;
    /// 待上传队列的数组
    @property (nonatomic, strong) NSMutableArray *uploadSegments;

    NSURLSessionConfiguration *config = [NSURLSessionConfiguration defaultSessionConfiguration];
    NSURLSession *session = [NSURLSession sessionWithConfiguration:config 
                                                          delegate:self 
                                                     delegateQueue:[NSOperationQueue mainQueue]];

    NSURL *url = [NSURL URLWithString:@"http://vfx.mtime.cn/Video/2017/03/31/mp4/170331093811717750.mp4"];
    NSURLRequest *request = [[NSURLRequest alloc] initWithURL:url];
    NSURLSessionDownloadTask *downloadTask = [session downloadTaskWithRequest:request];
    [downloadTask resume];

    // 从服务器接收数据，下载进度回调
    - (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask
                 didWriteData:(int64_t)bytesWritten
            totalBytesWritten:(int64_t)totalBytesWritten
    totalBytesExpectedToWrite:(int64_t)totalBytesExpectedToWrite {
        CGFloat progress = (CGFloat)totalBytesWritten / (CGFloat)totalBytesExpectedToWrite;
        self.progressView.progress = progress;
    }

    // 下载完成后回调
    - (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask
    didFinishDownloadingToURL:(NSURL *)location {

    }

    Range:bytes=512000-

    Content-Range:bytes 512000-/1024000

    NSString *library = NSSearchPathForDirectoriesInDomains(NSLibraryDirectory, NSUserDomainMask, YES).firstObject;
    NSString *resumePath = [library stringByAppendingPathComponent:[self.downloadURL md5String]];
    [self.downloadTask cancelByProducingResumeData:^(NSData * _Nullable resumeData) {
        [resumeData writeToFile:resumePath atomically:YES];
    }];

    NSString *library = NSSearchPathForDirectoriesInDomains(NSLibraryDirectory, NSUserDomainMask, YES).firstObject;
    NSString *resumePath = [library stringByAppendingPathComponent:[self.downloadURL md5String]];
    NSData *resumeData = [[NSData alloc] initWithContentsOfFile:resumePath];
    self.downloadTask = [self.session downloadTaskWithResumeData:resumeData];
    [self.downloadTask resume];

    - (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask
     didResumeAtOffset:(int64_t)fileOffset
    expectedTotalBytes:(int64_t)expectedTotalBytes;

    NSURLSessionConfiguration *config = [NSURLSessionConfiguration backgroundSessionConfigurationWithIdentifier:@"identifier"];
    [NSURLSession sessionWithConfiguration:config delegate:self delegateQueue:[NSOperationQueue mainQueue]];

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

        NSURLSessionConfiguration *config = [NSURLSessionConfiguration backgroundSessionConfigurationWithIdentifier:@"identifier"];
        [NSURLSession sessionWithConfiguration:config delegate:self delegateQueue:[NSOperationQueue mainQueue]];

        return YES;
    }

    - (void)application:(UIApplication *)application handleEventsForBackgroundURLSession:(NSString *)identifier completionHandler:(void (^)(void))completionHandler {
        ViewController *vc = (ViewController *)self.window.rootViewController;
        vc.completionHandler = completionHandler;
    }

    @property BOOL sessionSendsLaunchEvents;

1. 视频地址一般都是从服务端获取的，所以需要先请求接口获取下载地址。这个地址可以是某个接口就已经请求下来的，也可以是某个固定格式拼接的。

2. 现在有很多视频App都是有免流服务的，例如腾讯大王卡、蚂蚁宝卡之类的，免流服务的本质就是对m3u8、ts、mp4地址重新包一层，请求数据的时候直接请求运营商给的地址，运营商对数据做了一个中转操作。

3. 以流视频m3u8为例，有了免流地址，先下载m3u8文件。这个文件一般都是加密的，下载完成后客户端会对m3u8文件进行decode，获取到真正的m3u8文件。

4. m3u8文件本质上是ts片段的集合，视频播放播的还是ts片段。随后对m3u8文件进行解析，获取到ts片段地址，并将ts下载地址转成免流地址后逐个下载，也可以并行下载。

5. m3u8文件下载后会以固定格式存在文件夹下，文件夹对应被缓存的视频。ts片命名以数字命名，例如0.ts，下标从0开始。

6. 所有ts片段下载完成后，生成本地m3u8文件。

7. m3u8文件分为远端和本地两种，远端的就是正常下载的地址，本地m3u8文件是在播放本地视频的时候传入。格式和普通m3u8文件差不多，区别在于ts地址是本地地址，例如下面的地址。

    #EXTM3U
    #EXT-X-TARGETDURATION:30
    #EXT-X-VERSION:3
    #EXTINF:9.28,
    0.ts
    #EXTINF:33.04,
    1.ts
    #EXTINF:30.159,
    2.ts
    #EXTINF:23.841,
    3.ts
    #EXT-X-ENDLIST

• 起始标签，此标签必须在整个文件的开头。

#EXTM3U

• 结束标签，此标签必须在整个文件的末尾。

#EXT-X-ENDLIST

• 当前文件版本，如果不指定则默认为1

#EXT-X-VERSION

• 所有ts片段最大时长。

#EXT-X-TARGETDURATION

• 当前ts片段时长。

#EXTINF

    https://data.vod.itc.cn/m3u8
    https://data.vod.itc.cn/segment1.ts

    A background URLSession with identifier backgroundSession already exists

    [[NSNotificationCenter defaultCenter] addObserver:self
                                                 selector:@selector(willTerminateNotification)
                                                     name:UIApplicationWillTerminateNotification
                                                   object:nil];

    - (void)willTerminateNotification {
        [self.session getAllTasksWithCompletionHandler:^(NSArray<__kindof NSURLSessionTask *> * _Nonnull tasks) {
            if (tasks.count) {
                [self.session finishTasksAndInvalidate];
            }
        }];
    }