2. 程式人生 > IOS開發 >如何更深入使用Moya

如何更深入使用Moya

阿新 • • 發佈：2019-12-25

Moya 簡介

Moya是一套基於Alamofire的網路抽象層框架。

個人認為Alamofire是基於URLSession上，如何更方便的呼叫請求，而Moya則是基於Alamofire上，通過抽象 URLs 和 parameter等等，更好的管理API。

Moya

基本模板

Moya在對於API的封裝是基於enum，通過對於列舉不同端點的不同用法，生成請求。

enum GitHub {
    case zen
    case userProfile(String)
}

extension GitHub: TargetType {
    var baseURL: URL { return URL
 
(string: "https://api.github.com")! }
    var path: String {
        switch self {
        case .zen:
            return "/zen"
        case .userProfile(let name):
            return "/users/\(name)"
        }
    }

    var method: Moya.Method {
        return .get
    }

    var task: Task {
        return
 
 .requestPlain
    }

    var sampleData: Data {
        switch self {
        case .zen:
            return "Half measures are as bad as nothing at all.".data(using: String.Encoding.utf8)!
        case .userProfile(let name):
            return "{\"login\": \"\(name)\",\"id\": 100}".data(using: String
 
.Encoding.utf8)!
        }
    }

    var validationType: ValidationType {
        return .successAndRedirectCodes
    }

    var headers: [String: String]? {
        return nil
    }
}

複製程式碼

通過列舉繼承TargetType，新增細節實現。

var provider = MoyaProvider<GitHub>()
provider.request(target) { response in
    if case .failure(let error) = response {
        receivedError = error
    }
}
複製程式碼

最後生成根據TargetType生成provider進行請求。

到此就是Moya的基本實現。因為過於基本，不再贅述。

Codable

Codable協議是蘋果提供解析資料的協議，在不使用第三方庫，如ObjectMapper,SwiftyJson的情況下，將伺服器返回的JSON資料轉為model。

下面是一個簡單的Codable示例：

struct Demo: Codable {
    var name: String
    var age: Int
}

func decode() {
    let jsonString =  "{\"name\":\"zhangsan\",\"age\":15}" // 模擬JSON資料
    let decoder = JSONDecoder()
    let data = jsonString.data(using: .utf8)!
    let model = try! decoder.decode(Demo.self,from: data)
    print(model) // Demo(name: "zhangsan",age: 15)
}
複製程式碼

在Moya的Response中已經封裝好了對應的處理

 DemoProvider.provider.request(.zen) { (result) in
    switch result {
    case .success(let response):
        if let model = try? response.map(Demo.self) {
            success(model)
        }
    case .failure(let error):
        break
   }
}
複製程式碼

如果資料是在JSON的好幾個層級中，也可以通過設定keypath獲取：

{
    data: {
        name: "test",age: 15
    }
}

try? response.map(Demo.self,atKeyPath: "data")

複製程式碼

要注意的是這裡函式還有一個引數叫做failsOnEmptyData，預設設定為true，如果返回的資料為空，會判定會解析失敗。

EndPoint

EndPoint是Moya的半個內部資料結構，由所用的TargetType生成，它最終被用來生成網路請求。 每個EndPoint 都儲存了下面的資料:

/// A string representation of the URL for the request.
public let url: String

/// A closure responsible for returning an `EndpointSampleResponse`. (單元測試)
public let sampleResponseClosure: SampleResponseClosure

/// The HTTP method for the request.
public let method: Moya.Method

/// The `Task` for the request.
public let task: Task

/// The HTTP header fields for the request.
public let httpHeaderFields: [String: String]?
複製程式碼

在Provider生成時，可以傳入endpointClosure，自定義TargetType到Endpoint的方式。

預設的實現方式：

final class func defaultEndpointMapping(for target: Target) -> Endpoint {
    return Endpoint(
        url: URL(target: target).absoluteString,sampleResponseClosure: { .networkResponse(200,target.sampleData) },method: target.method,task: target.task,httpHeaderFields: target.headers
    )
}
複製程式碼

在這裡可以重新定義Endpoint的生成方式,比如：

// 將所有生成Endpoint改為get方式請求
let endpointClosure = { (target: MyTarget) -> Endpoint in
    let url = URL(target: target).absoluteString
    return Endpoint(url: url,sampleResponseClosure: {.networkResponse(200,target.sampleData)},method: .get,task: target.task)
}
複製程式碼

或者對已經生成的Endpoint修改：

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

注意：如果直接對已經初始化的Endpoint修改，只能修改task以及新增header。

Request

在生成Endpoint之後，會從Endpoint再轉為URLRequst進行使用。

Moya的預設實現：

RequestResultClosure = (Result<URLRequest,MoyaError>) -> Void

final class func defaultRequestMapping(for endpoint: Endpoint,closure: RequestResultClosure) {
    do {
     let urlRequest = try endpoint.urlRequest()
        closure(.success(urlRequest))
    } catch MoyaError.requestMapping(let url) {
        closure(.failure(MoyaError.requestMapping(url)))
    } catch MoyaError.parameterEncoding(let error) {
        closure(.failure(MoyaError.parameterEncoding(error)))
    } catch {
        closure(.failure(MoyaError.underlying(error,nil)))
    }
}


 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
......
複製程式碼

因為內部已經實現如何生成Request，大多情況不需要修改urlRequest，而是重新定義requestClosure,對已經生成好的request進行修改，下面是直接修改request的快取策略，以及錯誤處理:

let requestClosure = { (endpoint: Endpoint,done: MoyaProvider.RequestResultClosure) in
    do {
        var request = try endpoint.urlRequest()
        request.cachePolicy = .reloadIgnoringCacheData
        done(.success(request))
    } catch {
        done(.failure(MoyaError.underlying(error)))
    }

}
複製程式碼

stubClosure

stubClosure實現：

 /// Do not stub.
final class func neverStub(_: Target) -> Moya.StubBehavior {
    return .never
}

/// Return a response immediately.
final class func immediatelyStub(_: Target) -> Moya.StubBehavior {
    return .immediate
}

/// Return a response after a delay.
final class func delayedStub(_ seconds: TimeInterval) -> (Target) -> Moya.StubBehavior {
    return { _ in return .delayed(seconds: seconds) }
}
複製程式碼

Moya的預設實現是neverStub，當使用immediatelyStub或者是delayedStub，請求網路時就不會走真實的資料，而是返回Target中SimpleData的資料，一般用於測試API返回資料的處理。

delayedStub相對於immediatelyStub指定了延遲時長，單位是秒。

callbackQueue

可以指定網路請求返回之後的callback執行緒。預設所有的請求將會被Alamofire放入background執行緒中,callbac將會在主執行緒中呼叫。

Manager

public typealias Manager = Alamofire.SessionManager

final class func defaultAlamofireManager() -> Manager {
    let configuration = URLSessionConfiguration.default
    configuration.httpAdditionalHeaders = Manager.defaultHTTPHeaders

    let manager = Manager(configuration: configuration)
    manager.startRequestsImmediately = false
    return manager
}
複製程式碼

Moya中使用的Manager其實就是Alamofire的Manager。

可以設定Timeout,快取策略等等

let manager: SessionManager = {
    let configuration = defaultURLSessionConfiguration
    configuration.requestCachePolicy = .reloadIgnoringLocalCacheData
    configuration.timeoutIntervalForRequest = 20
    let trustPolicyManager = ServerTrustPolicyManager(policies:
        [
            "www.baidu.com": ServerTrustPolicy.disableEvaluation
        ]
    )
    let manager = SessionManager(configuration: configuration,serverTrustPolicyManager: trustPolicyManager)
    return manager
}()
複製程式碼

Plugins

plugins是遵守了PluginType的外掛，一個provider可以方多個Plugin。

PluginType:

public protocol PluginType {
    /// 在傳送request之前，還有機會對request修改
    func prepare(_ request: URLRequest,target: TargetType) -> URLRequest

    /// 傳送之前呼叫
    func willSend(_ request: RequestType,target: TargetType)

    /// 接受Response之後，在觸發callback之前
    func didReceive(_ result: Result<Moya.Response,MoyaError>,target: TargetType)

    /// 在呼叫Callback之前，還能修改result
    func process(_ result: Result<Moya.Response,target: TargetType) -> Result<Moya.Response,MoyaError>
}

public extension PluginType {
    func prepare(_ request: URLRequest,target: TargetType) -> URLRequest { return request }
    func willSend(_ request: RequestType,target: TargetType) { }
    func didReceive(_ result: Result<Moya.Response,target: TargetType) { }
    func process(_ result: Result<Moya.Response,MoyaError> { return result }
}
複製程式碼

在Plugin中可以做很多事情

  • 記錄網路請求
  • 處理隱藏或者顯示網路activity progress
  • 對request進行更多的處理

比如：

struct TestPlugin: PluginType {
    //  對request進行更多的處理
    func prepare(_ request: URLRequest,target: TargetType) -> URLRequest {
        var request = request
        if target is GitHub {
            request.timeoutInterval = 5
        }
        return request
    }
    
    // 記錄網路請求
    func willSend(_ request: RequestType,target: TargetType) {
        print("start")
        print(request.request?.url ?? "")
    }
    
    // 記錄網路請求
    func didReceive(_ result: Result<Response,target: TargetType) {
        print("end")
        switch result {
        case .success(let response):
            print("end success")
            print(response.request?.url ?? "")
        case .failure(let error):
            print("end failure")
            print(error)
        }
    }
    
    // 對返回的result進行修改
    func process(_ result: Result<Response,target: TargetType) -> Result<Response,MoyaError> {
        if case let .failure(error) = result {
            return .failure(MoyaError.underlying(error,nil))
        }
        return result
    }
}
複製程式碼

Moya也對Logger，activity等提供了預設實現的Plugin，更多細節就不詳細說明了。

trackInflights

原始碼看了半天還是看不明白，希望懂的朋友能告訴我是怎麼用的。

MultiTarget

一般場景下，是一個targetType對應一個Provider

let githubProvider = MoyaProvider<GitHub>(stubClosure: MoyaProvider.immediatelyStub,trackInflights: true)
let demoProvider = MoyaProvider<Demo>(stubClosure: MoyaProvider.immediatelyStub,trackInflights: true)
複製程式碼

但是如果像讓這個Provider更通用，可以寫為：

let commonProvider = MoyaProvider<MultiTarget>()
複製程式碼

呼叫的時候指定TargetType即可：

commonProvider.request(MultiTarget(GitHub.zen)) { result in
    ...
}
複製程式碼

流程

補一張網上找到的流程圖

流程圖

相關推薦

如何更深入使用Moya

Moya 簡介 Moya是一套基於Alamofire的網路抽象層框架。 個人認為Alamofire是基於URLSession上，如何更方便的呼叫請求，而Moya則是基於Alamofire上，通過抽象 URLs 和 parameter等等，更好的管理API。

微軟 Win11 全新設計版檔案資源管理器更深入整合 OneDrive 網盤

4 月 13 日訊息，據 Windows Latest 報道，Windows 11 的檔案資源管理器和微軟 OneDrive 是目前受歡迎的兩個工具，科技巨頭認為這兩個功能如果一起使用，可能更具有生產力。微軟一直在採取措施，改善 OneDrive 與各

Redis SDS 深入一點，看到更多！

1、什麼是SDS? Redis 自定的字串儲存結構，關於redis，你需要了解的幾點！中我們對此有過簡要說明。

應該沒人比我更細了吧：帶你深入剖析Redis分散式鎖！

什麼是分散式鎖 說到Redis，我們第一想到的功能就是可以快取資料，除此之外，Redis因為單程序、效能高的特點，它還經常被用於做分散式鎖。

深入理解iOS開發中的鎖

摘要 本文的目的不是介紹 iOS 中各種鎖如何使用，一方面筆者沒有大量的實戰經驗，另一方面這樣的文章相當多，比如 iOS中保證執行緒安全的幾種方式與效能對比、iOS 常見知識點（三）：Lock。本文也不會詳細介紹鎖的具

Flutter如何更便捷的json轉model

0x1 前言 作為剛開始接觸flutter的iOS開發，json轉模型這部分一直是我非常頭疼的地方。現在網上能找到的方案一般有兩種

KVC 深入學習和探究

直入主題，開頭先介紹下本篇學習和探究方向，首先搞清楚成員變數、例項變數、屬性的定義，以便KVC賦值取值時能夠輕鬆區分；其次深入探究KVC取值原理、賦值原理；再次通過對YYmodel原始碼的分析，深入理解KVC；最後再

更貼合hooks的狀態管理--hox

前言 在之前的React Hooks：初探·實踐提到過hooks更符合React程式設計模型，其中custom hooks更是讓人眼前一亮，只能說用過的都說香，但是一直沒找到貼合hooks的狀態管理，雖然hooks的設計挺多來自於redux，但是red

為什麼 Vue 更符合這個時代的大勢所趨？

不久前，尤雨溪釋出了 Vue 3.0 Beta 版本。 釋出之後我們對社群裡的前端開發者做了一次調查溝通，大家普遍認為 Vue 已經具備了商業專案開發的必備條件，如語法精煉、優雅而簡潔、程式碼的可讀性高、成熟的元件模組化

深入理解 AQS 之 Condition 原始碼

前言 很久之前分享過ReetrantLock的實現深入剖析ReentrantLock公平鎖與非公平鎖原始碼實現，而今再回頭去看，對AQS也有了更深刻準確的理解，隨即更新了下之前的文章。今天分享利用AQS實現的另一個重要的JUC工具類Con

Python 命令列之旅：深入 click 之增強功能

作者：HelloGitHub-Prodesire 涉及的示例程式碼和歷史文章，已同步更新到 HelloGitHub-Team 倉庫

深入理解 Java 虛擬機器器：Java 記憶體區域透徹分析

前言 Java是目前使用者最多、使用範圍最廣的軟體開發技術，Java 的技術體系主要由支撐Java程式執行的虛擬機器器。為各開發領域提供介面支援的Java API， Java程式語言及許許多多的第三方Java框架( 如Spring和Struts等

SpringMVC原始碼深入解析

感悟 通過前面SpringAOP原始碼深度解析，SpringIOC原始碼深度解析加上本文的SpringMVC的原始碼閱讀，我從中收穫很多，學習了各種設計模式，各種抽象思想，以及各種底層原理，比如動態代理，反射等等，雖然前前前後後

深入理解-CPU核心數與執行緒池併發執行緒數關係

那是一個風和日麗的下午！ 面試官微微一笑，對我說：“小夥子，合理配置執行緒池你是如何考慮的？”

基於Moya、RxSwift和ObjectMapper實現REST API請求

在Android開發中有非常強大的 Retrofit 請求，結合RxJava可以非常方便實現 RESTful API 網路請求。在 iOS開發中也有非常強大的網路請求庫 Moya ，Moya是一個基於 Alamofire 開發的,輕量級的Swift網路層。Moya的可擴充

通過 深入對比 Arrays 和 Slices 學習GO

通過 深入對比 Arrays 和 Slices 學習GO 陣列定義 package main import ( \"fmt\" ) func main() { var arr [3]int//int 陣列，長度為3 ，並且初始值都為0

JDK13新特性，讓開發效率更快一步

JDK13到今天已經發布快2個月了，之前有零零散散的試過一些新的特性，但卻沒有整體的整理一下。想到作為Java開發，連使用的JDK(Java Developerment Kit)有什麼特性都不清楚，實在是有些不應該，想要進階為更有價值的J

深入理解Java虛擬機器器鎖優化&逃逸分析技術

引言 HotSpot虛擬機器器團隊在1.5 -> 1.6版本演進中，進行了大量的鎖優化技術，相應的jdk6併發包也推出了很多併發容器&API，所以JDK6是高效併發大放異彩的一個關鍵版本。本文主要介紹一下java虛擬機器器中對於

Python 命令列之旅：深入 click 之引數篇

作者：HelloGitHub-Prodesire 文中涉及的示例程式碼，已同步更新到 HelloGitHub-Team 倉庫

深入瞭解Netty【五】執行緒模型

引言 不同的執行緒模型對程式的效能有很大的影響，Netty是建立在Reactor模型的基礎上，要搞清Netty的執行緒模型，需要了解一目前常見執行緒模型的一些概念。