从数据流角度管窥 Moya 的实现：构建请求

Posted 2021-01-22 feng9exe

相信大家都封装过网络层。

虽然系统提供的网络库以及一些著名的第三方网络库（AFNetworking, Alamofire）已经能满足各种 HTTP/HTTPS的网络请求，但直接在代码里用起来，终归是比较晦涩，不是那么的顺手。所以我们都会倾向于根据自己的实际需求，再封装一个更好用的网络层，加入一些特殊处理。同时也让业务代码更好地与底层的网络框架隔离和解耦。

Moya实际上做的就是这样一件事，它在 Alamofire的基础上又封装了一层，让我们不必处理过多的底层细节。按照官方文档的说法：

It‘s less of a framework of code and more of a framework of how to think about network requests.

对于应用层开发者来说，一个 HTTP/HTTPS的网络请求流程很简单，即客户端发起请求，服务端接收到请求处理后再将响应数据回传给客户端。对于客户端来说，大体只需要做两件事：构建请求并发送、接收响应并处理。如下一个简单的流程：

 

 

我们这里从普通数据请求的整个流程来看看 Moya的基本实现。

操控者 MoyaProvider

在梳理流程之前，有必要了解一下 MoyaProvider。我把这个 MoyaProvider称为 Moya的操控者。在 Moya层，它是整个数据流的管理者，包括构建请求、发起请求、接收响应、处理响应。也许类似的，我们自己封装的网络库也会有这样一个角色，如 NetworkManager。我们来看看它和 Moya中其它类/结构体的关系。

 

 

与我们直接打交道最多的也是这个类，不过我们不在这细讲，在这里它不是主角。我们来结合数据流，来看看数据在这个类中怎么流转。

构建 Request

一个基本的 HTTP/HTTPS普通数据请求通常包含以下几个要素：

• URL
• 请求参数
• 请求方法
• 请求报头信息
• 可选的认证信息

对于 Alamofire来说，最终是构建一个 Request，然后使用不同的请求对象，依赖于这些信息来发起请求。所以，构建请求的终点是 Request。

不过官方文档给了一个构建 Request的流程图：

 

 

我们来看看这个流程。

请求的起点 Target

Target是构建一个请求的起点，它包含一个请求所需要的基本信息。不过一个 Target不是定义单一一个请求，而是定义一组相关的请求。这里先了解一下 TargetType协议：

public protocol TargetType {
    var baseURL: URL { get }
    var path: String { get }
    var method: Moya.Method { get }

    /// Provides stub data for use in testing.
    var sampleData: Data { get }

    var task: Task { get }
    var validationType: ValidationType { get }
    var headers: [String: String]? { get }
}
复制代码

为了控制篇幅，我把不需要的注释都删了，下同。sampleData主要是用于本地 mock数据，在文章中不做描述。

可以看到这个协议包含了一个请求所需要的基本信息：用于拼接 URL的 baseURL和 path、请求方法、请求报头等。我们自定义的 Target必须实现这个接口，并根据需要设置请求信息，这个应该很好理解。

如果只是描述一个请求的话，可能使用 struct会好一些；而如果是一组的话，那还是用枚举方便些（话说枚举用得好不好，直接体现了 Swift水平好不好）。来看看官方的例子：

public enum GitHub {
    case zen
    case userProfile(String)
    case userRepositories(String)
}

extension GitHub: TargetType {
    public var baseURL: URL { return URL(string: "https://api.github.com")! }
    
    ......
}
复制代码

这基本是标配。枚举的关联对象是请求所需要的参数，如果请求参数过多，最好放在一个字典里面。

至于 task属性，其类型 Task是一个枚举，定义了请求的实际任务类型，比如说是普通的数据请求，还是上传下载。这个属性可以关注一下，因为请求的参数都是附在这个属性上。

在扩展 TargetType时，可以根据不同的接口来配置不同的 baseURL、path、method等信息。不过可能会导致一个问题：在一个大的独立工程里面，通常接口有几十上百个。如果你把所有的接口都放一个枚举里面，你可能最后会发现，各种 switch会把这个文件撑得很长。所以，还需要根据实际情况来看看如何去划分我们的接口，让代码分散在不同的文件里面（MultiTarget专门用来干这事，可以研究一下）。

到这一步，我们得到的数据是一个 Target枚举，它包含了构建一组请求所需要的信息。实际上，我们主要的任务就是去定义这些枚举，后面的构建过程，如果没有特殊需求，基本上就是个黑盒了。

有了 Target，我们就可以用具体的枚举值来发起请求了，

gitHubProvider.request(.userRepositories(username)) { result in
	......
}
复制代码

大多数时候，业务层代码需要做的就是这些了。是不是很简单？

下面我们来看看 Moya的黑盒子里面做了些什么？

Endpoint

按理说，我们构建好 Target并把对应的信息丢给 MoyaProvider后，MoyaProvider直接去构建一个 Request，然后发起请求就行了。而在从上面的图可以看到，Target和 Request之间还有一个 Endpoint。这是啥玩意呢？我们来看看。

在 MoyaProvider的 request方法中调用了 requestNormal方法。这个方法的第一行就做了个转换操作，将 Target转换成 Endpoint对象：

func requestNormal(_ target: Target, callbackQueue: DispatchQueue?, progress: Moya.ProgressBlock?, completion: @escaping Moya.Completion) -> Cancellable {
    let endpoint = self.endpoint(target)
    ......
}
复制代码

endpoint()方法实际上调用的是 MoyaProvider的 endpointClosure属性：

public typealias EndpointClosure = (Target) -> Endpoint

open let endpointClosure: EndpointClosure

open func endpoint(_ token: Target) -> Endpoint {
    return endpointClosure(token)
}
复制代码

EndpointClosure的用途实际上就是将 Target映射为 Endpoint。我们可以自定义转换方法，并在初始 MoyaProvider时传递给 endpointClosure参数，像这样：

let endpointClosure = { (target: MyTarget) -> Endpoint in
    let defaultEndpoint = MoyaProvider.defaultEndpointMapping(for: target)
    return defaultEndpoint.adding(newHTTPHeaderFields: ["APP_NAME": "MY_AWESOME_APP"])
}

let provider = MoyaProvider<GitHub>(endpointClosure: endpointClosure)
复制代码

如果不想自定义，那么就用 Moya提供的默认转换方法就行。

哦，还没看 Endpoint到底长啥样：

open class Endpoint {
    public typealias SampleResponseClosure = () -> EndpointSampleResponse

    open let url: String
    open let method: Moya.Method
    open let task: Task
    open let httpHeaderFields: [String: String]?
    
    ......
}
复制代码

是不是觉得和 TargetType差不多？那问题来了，为什么要 Endpoint呢？

我有两个观点：

1. 比起 Target来，Endpoint更像一个请求对象；Target是通过枚举来描述的一组请求，而 Endpoint就是一个实实在在的请求对象；(废话)
2. 通过 Endpoint来隔离业务代码与 Request，毕竟这是 Moya的目标

如果有不同观点，还请告诉我。

重复上面一句话：我们可以自定义转换方法，来执行 Target到 Endpoint的映射操作。不过还有个问题，有些代码（比如headers的设置）即可以放在 Target里面，也可以放在 Endpoint里面。个人观点是能放在 Target里面的就放在 Target里，这样不需要自已去定义 EndpointClosure。

Endpoint类还有一些方法来便捷创建 Endpoint，可以参考一下。

到这一步，我们得到的数据是一个 Endpoint对象，有了这个对象，我们就可以来创建 Request了。

Request

和 Target->Endpoint的映射一样，Endpoint->Request的映射也有一个类似的属性：requestClosure属性。

public typealias RequestClosure = (Endpoint, @escaping RequestResultClosure) -> Void

open let requestClosure: RequestClosure
复制代码

同样也可以自定义闭包传递给 MoyaProvider的构造器，但通常不建议这么做。因为这样会让业务代码直接触达 Request，有违 Moya的目标。通常我们直接用默认的转换方法就行。默认映射方法的实现在 MoyaProvider+Defaults.swift文件中，如下：

public final class func defaultRequestMapping(for endpoint: Endpoint, closure: RequestResultClosure) {
    do {
        let urlRequest = try endpoint.urlRequest()
        closure(.success(urlRequest))
    } 
        
    ......
}
复制代码

看代码会发现实际的转换是由 Endpoint类的 urlRequest方法来完成的，如下：

public func urlRequest() throws -> URLRequest {
    guard let requestURL = Foundation.URL(string: url) else {
        throw MoyaError.requestMapping(url)
    }

    var request = URLRequest(url: requestURL)
    request.httpMethod = method.rawValue
    request.allHTTPHeaderFields = httpHeaderFields

    switch task {
    case .requestPlain, .uploadFile, .uploadMultipart, .downloadDestination:
        return request
    case .requestData(let data):
        request.httpBody = data
        return request
        
    ......
}
复制代码

这个方法创建了一个 URLRequest对象，看代码都能理解。

返回到 defaultRequestMapping()方法中，可以看到生成的 urlRequest被附在一个 Result枚举中，并传给 defaultRequestMapping的第二个参数： RequestResultClosure。这步我们暂时到这。

到此我们的 URLRequest对象就构建完成了，实际上我们会发现 URLRequest包含的信息并不大，但已经足够了，可以发起请求了。

发起请求

我们回到 RequestResultClosure中，也就是 requestNormal()方法的 performNetworking闭包中。在这个闭包里，就开始了发起请求的旅程。我们简单看一下流程：

 

 

基本上就三个步骤：

1. performRequest()：在这个方法中，将请求根据 task的类型分流；
2. sendRequest()、uploadFile()等四方法：这几个方法主要是创建对应的请求对象，如 DataRequest、UploadRequest
3. sendAlamofireRequest()：各类请求最后会汇聚到这个方法中，完成发起请求操作；

func sendAlamofireRequest<T>(_ alamoRequest: T, target: Target, callbackQueue: DispatchQueue?, progress progressCompletion: Moya.ProgressBlock?, completion: @escaping Moya.Completion) -> CancellableToken where T: Requestable, T: Request {
    ......

    progressAlamoRequest = progressAlamoRequest.response(callbackQueue: callbackQueue, completionHandler: completionHandler)
    progressAlamoRequest.resume()

	......
}
复制代码

到此为止，请求部分就基本结束了。

有一个小问题可以注意下：一个 Target最后一直被传递到 sendAlamofireRequest方法中，比 Endpoint的使用周期还长。呵呵。

等等，还有件事

为什么 Target的使用周期比 Endpoint还长呢？看代码，在 sendAlamofireRequest()方法中有这么一段：

let plugins = self.plugins
plugins.forEach { $0.willSend(alamoRequest, target: target) }
复制代码

也就是说 Target需要用在 plugin的方法中。Plugin，即插件，是 Moya提供了一种特别实用的机制，可以被用来编辑请求、响应及完成副作用的。Moya提供了几个默认的插件，同样我们也可以自定义插件。所有的插件都需要实现 PluginType协议，看看它的定义：

public extension PluginType {
    func prepare(_ request: URLRequest, target: TargetType) -> URLRequest { return request }
    func willSend(_ request: RequestType, target: TargetType) { }
    func didReceive(_ result: Result<Moya.Response, MoyaError>, target: TargetType) { }
    func process(_ result: Result<Moya.Response, MoyaError>, target: TargetType) -> Result<Moya.Response, MoyaError> { return result }
}
复制代码

实际上就是在整个数据流四个位置插入一些操作，这些操作可以对数据进行修改，也可以是一些没有副作用（例如日志）的操作。实际上 prepare操作是在 RequestResultClosure中就执行了。后面两个方法都是在响应阶段插入的操作。在此不描述了。

总结

这篇文章主要是从数据的流向来看了看 Moya的请求构建过程。我们避开了各种产生错误的分支以及用于测试插桩的代码，这些有兴趣可以参考代码的具体实现。

最后盗图一张，你就会发现一图胜千言，我上面讲的以及后面一篇文章讲的全是废话。

 

 

下一篇我们会从数据流的后半段 -- 响应处理-- 来继续看看 Moya的实现，敬请关注。

参考

1. 官方文档 https://github.com/Moya/Moya/blob/master/docs/README.md
2. Moya的设计之道 https://github.com/LeoMobileDeveloper/Blogs/blob/master/Swift/AnaylizeMoya.md

追踪一下 Moya 的数据流向，来看看它的基本实现。

作者：知识小集
链接：https://juejin.im/post/5ac2cf34f265da23a1421483
来源：掘金
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。