Alamofire5.0源码分析(一)

前言

Alamofire在5.0进行一次重构，现在还未正式发布，下面的分析都基于5.0.0-rc.3版本

问题

在进入正文之前，先看下下面这几个问题，希望你看完这篇文章，能回答以下问题？

1. Session，SessionDelegate，Request它们之间的关系？

let urlString = "https://api.apiopen.top/getJoke?page=1&count=2&type=text"
let request = AF.request(urlString).responseJSON { (resp) in
    print(resp)
}
//假设请求3秒之后就回来了
DispatchQueue.main.asyncAfter(deadline: .now() + 10) {
    request.responseJSON { (resp) in
        print(resp)
    }
}

2. 都知道Alamofire是对URLSession的封装，上面那段代码，DataTask是什么时候创建的，又是什么发送的?
3. 在请求回来之后，再多次设置响应，是否能进行回调?
4. responseJSON里面都做了些什么事?

Alamofire中主要的类或协议图

image

Session，SessionDelegate，Request，RequestDelegate主要属性介绍

Session属性:

1. let session: URLSession，系统的URLSession，用于创建task
2. let delegate: SessionDelegate，session的代理，用于处理请求的各种回调
3. let startRequestsImmediately: Bool，是否立即发出请求
4. let rootQueue: DispatchQueue，内部的回调和状态更新所处的队列，必须是串行队列
5. let requestQueue: DispatchQueue，创建Request所在的队列，默认是target为rootQueue的串行队列
6. let serializationQueue: DispatchQueue，反序列化Response数据时所在的队列，默认是target为rootQueue的串行队列
7. let interceptor: RequestInterceptor?，request拦截器，是RequestAdapter和RequestRetrier的合并，用于在发送请求之前修改Request和请求失败之后的重试策略
8. let serverTrustManager: ServerTrustManager?，安全认证管理者
9. let redirectHandler: RedirectHandler?，重定向的回调
10. let cachedResponseHandler: CachedResponseHandler?，缓存的回来
11. let eventMonitor: CompositeEventMonitor，事件监听器
12. var requestTaskMap:RequestTaskMap,用于存放task、request以及task的状态
13. var activeRequests:Set<Request> = [],用于所有活跃的request

SessionDelegate属性:

1. private let fileManager: FileManager，用于下载的回调里，处理文件
2. weak var stateProvider: SessionStateProvider? ，用于在URLSessionDelegate获取request信息以及回调给外面状态
3. var eventMonitor: EventMonitor?，在各种回调里，调用事件监听器对应的方法，让外界处理

SessionStateProvider协议定义的方法：

1. var serverTrustManager: ServerTrustManager? { get }获取安全认证管理者
2. var redirectHandler: RedirectHandler? { get }获取重定向的处理者
3. var cachedResponseHandler: CachedResponseHandler? { get }获取缓存响应的处理者
4. func request(for task: URLSessionTask) -> Request?通过task获取Request
5. func didGatherMetricsForTask(_ task: URLSessionTask)收集到性能指标之后的回调
6. func didCompleteTask(_ task: URLSessionTask)请求完成的回调
7. func credential(for task: URLSessionTask, in protectionSpace: URLProtectionSpace) -> URLCredential?获取身份验证的证书
8. func cancelRequestsForSessionInvalidation(with error: Error?)，URLSession无效的回调

Request属性：

1. let underlyingQueue: DispatchQueue，内部回调的异步串行队列
2. let serializationQueue: DispatchQueue，序列化所在的队列，同Session
3. let eventMonitor: EventMonitor?，事件监听器，同Session
4. let interceptor: RequestInterceptor?，request拦截器，同Session
5. weak var delegate: RequestDelegate?，requestDelegate
6. protectedMutableState: Protector<MutableState>，存放着request的各种信息
   1. state状态
   2. uploadProgressHandler上传的进度回调
   3. downloadProgressHandler下载的进度回调
   4. redirectHandler重定向的回调
   5. cachedResponseHandler缓存的回调
   6. cURLHandler，curl的回调
   7. responseSerializers，响应序列化的集合
   8. responseSerializerCompletions，响应序列化回调的集合
   9. requests，当前请求所有的request
   10. tasks，当前请求所有的task
   11. metrics，当前请求所有的指标
   12. retryCount，已经重试的次数
   13. 错误信息
7. 其他属性都间接或这届的依赖于protectedMutableState

RequestDelegate协议定义的方法:

1. var sessionConfiguration: URLSessionConfiguration { get }，获取Session配置
2. var startImmediately: Bool { get }，是否立即发送请求
3. func cleanup(after request: Request)，此次请求已结束，清除此次请求
4. func retryResult(for request: Request, dueTo error: AFError, completion: @escaping (RetryResult) -> Void)，询问代理是否需要重试
5. func retryRequest(_ request: Request, withDelay timeDelay: TimeInterval?)，告诉代理在多久之后重试

Session，SessionDelegate，Request之间的关系

image

1. Session创建之后会创建URLSession，此时Session.delegate和URLSession.delegate都指向SessionDelegate的实例
2. Session.delegate指向SessionDelegate是为了持有它，不让他释放，URLSession.delegate指向它，是让它执行URLSession以及URLSessionTask的各种回调
3. SessionDelegate.stateProvider会指向Session
4. 当调用Session.request方法之后，会创建Request，并把Request放入Session.activeRequests中
5. Request.delegate会指向Session

Request的创建流程图

image

根据此流程图回答上面的问题

1. dataTask是在Session.didCreateURLRequest中创建的，由于创建完Request，无论是操作Request还是response函数内部操作都是异步，执行顺序无法确定，所以发送请求有可能在这2个地方，一是Session.updateStatesForTask，二是在Request.resume函数中
2. 在请求回来之后，再多次设置响应，从上面的流程图可以看出，会直接调用回调
3. response中除了做了流程图内的事之外，在执行回调之前，会先把data反序列化对应的格式，若序列化失败，会调用代理来询问是否需要重试，若反序列化成功，则调用回调

Request请求完成之后到调用响应回调的流程图

image