【Alamofire源码解析】10 - SessionDelegate

SessionDelegate负责处理URLSession的所有回调。作者的整体思路:声明了与每个回调一一对应的closure,然后再实现session的所有回调。在回调的实现里面,1) 如果是必须要实现的回调,先判断我们是否有给对应的closure赋值,如果有,执行我们的closure;如果没有,使用默认的实现;2)不是必须要实现的回调,直接调用closure。

1. 与回调对应的closures

声明了与每个回调一一对应的closure,如果我们要重写默认的实现,给对应的closure赋值即可

/// 对应 `urlSession(_:didBecomeInvalidWithError:)` 回调
open var sessionDidBecomeInvalidWithError: ((URLSession, Error?) -> Void)?

/// 对应 `urlSession(_:didReceive:completionHandler:)` 回调
open var sessionDidReceiveChallenge: ((URLSession, URLAuthenticationChallenge) -> (URLSession.AuthChallengeDisposition, URLCredential?))?

/// 对应 `urlSession(_:didReceive:completionHandler:)` 回调
open var sessionDidReceiveChallengeWithCompletion: ((URLSession, URLAuthenticationChallenge, @escaping (URLSession.AuthChallengeDisposition, URLCredential?) -> Void) -> Void)?

/// ......

2. 属性和初始化

// 请求重试器
var retrier: RequestRetrier?
// 因为SessionManager强引用了SessionDelegate,所以这里要用weak修饰,不然会造成循环引用
weak var sessionManager: SessionManager?

// 如果我们有多个网络请求都使用默认的SessionManager,
// 那么这几个请求的session对应的回调都是由同一个SessionDelegate来处理的,
// 所以需要把请求用字典的形式存储起来
private var requests: [Int: Request] = [:]
private let lock = NSLock()

/// 使用下标的形式存取requests字典,并且加了锁,保证线程安全
open subscript(task: URLSessionTask) -> Request? {
    get {
        lock.lock() ; defer { lock.unlock() }
        return requests[task.taskIdentifier]
    }
    set {
        lock.lock() ; defer { lock.unlock() }
        requests[task.taskIdentifier] = newValue
    }
}

public override init() {
    super.init()
}

3. 重写NSObject方法

返回回调是否有对应的closure。

open override func responds(to selector: Selector) -> Bool {
    // 代码省略
}

4. 实现对应的回调

如果不是必须要实现的回调,直接调用closure,没啥好说的,这里直接忽略。只讲解必须要实现的回调。

1) URLSessionDelegate

// 服务器向客户端索取请求证书
open func urlSession(
    _ session: URLSession,
    didReceive challenge: URLAuthenticationChallenge,
    completionHandler: @escaping (URLSession.AuthChallengeDisposition, URLCredential?) -> Void)
{
    // 先判断我们是否有提供对应的closure
    guard sessionDidReceiveChallengeWithCompletion == nil else {
        sessionDidReceiveChallengeWithCompletion?(session, challenge, completionHandler)
        return
    }

    // 初始化一个默认的配置,就像客户端没有实现这个回调
    var disposition: URLSession.AuthChallengeDisposition = .performDefaultHandling
    var credential: URLCredential?

    // 如果提供了sessionDidReceiveChallenge closure,执行它,并更新disposition和credential
    if let sessionDidReceiveChallenge = sessionDidReceiveChallenge {
        (disposition, credential) = sessionDidReceiveChallenge(session, challenge)
    } else if challenge.protectionSpace.authenticationMethod == NSURLAuthenticationMethodServerTrust { // 需要的认证方法是ServerTrust
    
        // 获取保护区域的主机地址
        let host = challenge.protectionSpace.host

        // 判断我们是否提供了服务器信任策略
        if let serverTrustPolicy = session.serverTrustPolicyManager?.serverTrustPolicy(forHost: host),
            let serverTrust = challenge.protectionSpace.serverTrust {
            
            // 评估serverTrust对这个主机地址是否有效
            if serverTrustPolicy.evaluate(serverTrust, forHost: host) {
                // 评估通过,把disposition更新为使用证书;并更新证书
                disposition = .useCredential
                credential = URLCredential(trust: serverTrust)
            } else {
                // 评估不通过,取消认证,整个请求也会被取消
                disposition = .cancelAuthenticationChallenge
            }
        }
    }
    
    // 最后执行completionHandler
    completionHandler(disposition, credential)
}

2) URLSessionTaskDelegate

// 服务器向客户端索取请求证书
open func urlSession(
    _ session: URLSession,
    task: URLSessionTask,
    didReceive challenge: URLAuthenticationChallenge,
    completionHandler: @escaping (URLSession.AuthChallengeDisposition, URLCredential?) -> Void)
{
    // 先判断我们是否有提供对应的closure
    guard taskDidReceiveChallengeWithCompletion == nil else {
        taskDidReceiveChallengeWithCompletion?(session, task, challenge, completionHandler)
        return
    }

    // 判断是否有提供taskDidReceiveChallenge closure
    if let taskDidReceiveChallenge = taskDidReceiveChallenge {
        // 有提供,执行completionHandler
        let result = taskDidReceiveChallenge(session, task, challenge)
        completionHandler(result.0, result.1)
    } else if let delegate = self[task]?.delegate { // 没有提供closure,判断是否有delegate
        // 有delegate,执行delegate的实现
        delegate.urlSession(
            session,
            task: task,
            didReceive: challenge,
            completionHandler: completionHandler
        )
    } else {
        // 最后,执行对应的session回调
        urlSession(session, didReceive: challenge, completionHandler: completionHandler)
    }
}

// metrics收集好,更新metrics(不支持watchOS)
@available(iOS 10.0, macOS 10.12, tvOS 10.0, *)
@objc(URLSession:task:didFinishCollectingMetrics:)
open func urlSession(_ session: URLSession, task: URLSessionTask, didFinishCollecting metrics: URLSessionTaskMetrics) {
    self[task]?.delegate.metrics = metrics
}

// 数据传输任务完成
open func urlSession(_ session: URLSession, task: URLSessionTask, didCompleteWithError error: Error?) {
    /// 不需要重试的时候调用
    let completeTask: (URLSession, URLSessionTask, Error?) -> Void = { [weak self] session, task, error in
        // 在closure里面使用了[weak self],先判断self是否还在
        guard let strongSelf = self else { return }

        // 执行taskDidComplete
        strongSelf.taskDidComplete?(session, task, error)

        // 执行代理的didCompleteWithError
        strongSelf[task]?.delegate.urlSession(session, task: task, didCompleteWithError: error)

        // 发出任务完成通知
        NotificationCenter.default.post(
            name: Notification.Name.Task.DidComplete,
            object: strongSelf,
            userInfo: [Notification.Key.Task: task]
        )

        // 对应的请求完成,设置为nil
        strongSelf[task] = nil
    }

    guard let request = self[task], let sessionManager = sessionManager else {
        completeTask(session, task, error)
        return
    }

    // 在检查错误之前,执行所以验证
    request.validations.forEach { $0() }

    var error: Error? = error

    if request.delegate.error != nil {
        error = request.delegate.error
    }

    if let retrier = retrier, let error = error { // 如果有error,并且有重试器
        // 询问重试器是否要重试
        retrier.should(sessionManager, retry: request, with: error) { [weak self] shouldRetry, timeDelay in
            // 判断是否要重试,不需要则执行执行completeTask
            guard shouldRetry else { completeTask(session, task, error) ; return }

            DispatchQueue.utility.after(timeDelay) { [weak self] in
                guard let strongSelf = self else { return }
                
                // 使用sessionManager重试请求,并返回重试成功与否
                let retrySucceeded = strongSelf.sessionManager?.retry(request) ?? false

                if retrySucceeded, let task = request.task { // 重试请求成功
                    strongSelf[task] = request
                    return
                } else {
                    // 重试请求失败,执行completeTask
                    completeTask(session, task, error)
                }
            }
        }
    } else {
        // 没有错误和重试器,执行completeTask
        completeTask(session, task, error)
    }
}

3) URLSessionDataDelegate & URLSessionDownloadDelegate & URLSessionStreamDelegate

这是三个代理协议对应的实现都比较简单,要么直接执行对应的closure;要么先判断是否有对应的closure,如果就执行closure,如果没有就执行对应代理的实现。如果有任何问题,欢迎留言,我会尽力解答。

有任何问题,欢迎大家留言!

欢迎加入我管理的Swift开发群:536353151,本群只讨论Swift相关内容。

原创文章,转载请注明出处。谢谢!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,390评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,821评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,632评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,170评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,033评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,098评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,511评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,204评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,479评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,572评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,341评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,213评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,576评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,893评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,171评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,486评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,676评论 2 335

推荐阅读更多精彩内容

  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 11,943评论 4 60
  • 刑场上,一身素白的音跪在王的面前,此时的音还一片茫然的看着眼前一身龙袍的王,他眼中没有一丝情感,就那样注视着音,似...
    堕魔阅读 285评论 0 2
  • 不知从什么时候开始 我开始追寻光明 一直身处黑暗 ...
    柠檬wjk阅读 266评论 0 0
  • 依旧是个人学习经验的记录,非常浅显的内容,如果可以帮到小白们,那就再好不过啦! 前些天由于下载一些素材,需要1个金...
    AAAAAAlone阅读 15,949评论 6 12
  • 杰拉德走了 兰帕德走了 德罗巴走了…… 没有一个人可以一直保持状态, 时间老人将你我老去, 离开也许是又一次冲锋号...
    昆仑鹰阅读 200评论 0 0