Swift Moya网络层框架的学习笔记

什么是Moya?

对于iOS的开发人员来说,一般我们的网络请求是使用Alamofire来抽象的访问URLSession,为了更好的管理网络请求,一般的做法就是封装一个网络抽象层。但是一般的专有网络框架会出现一下问题:

编写新项目很困难

维护现有的项目很困难

编写单元测试很困难 

比如我刚开始使用swift的网络框架的时候,因为公司的接口是多人开发的没有太好的规范,所以写出来的接口五花八门,我就需要根据不同的人的接口写出不一样的网络请求,这样就让网络请求的工具类看起来特别的乱,项目维护起来也特别的难。在项目上线之后,我就一直想要解决这个问题,查看了很多资料,找到了Moya.

Moya的基本思想是,他提供给我们一个网络抽象层,他充分的封装且实际调用了Alamofire,他是用一份方式来抽象URL和parameters

Moya的一些特色功能是:

对正确的API端口访问进行编译时的检查

使用关联的枚举定义不同的端点,这样维护和查找使用的时候更加的清晰

把test stub作为一等公民,所以单元测试超级简单

利于Swift 编译器来防止与配置网络请求相关的运行时错误 .

为网络请求提供 Swift风格API/抽象.

提供一个API,它可以非常容易来代理(stub)网络请求.

提供一个基本的响应解析,同时也为其他库公开定制点来提供帮助.

为API提供 (可选的) RxSwift / ReactiveSwift 扩展.

通过为自定义行为提供周到且易于使用的扩展的点来避免有漏洞的抽象。

赞同明确定义的行为胜过默认实现

上述来自Moya!!!

通俗的自我理解就是,你不需要自己在去封装网络层来管理Alamofire,你只需要使用Moya一个高效的网络层,让他来管理网络请求。


图片来源于Moya

基本用法

使用Moya其实还是比较简单的。

第一步:为你所用的API目标创建一个enum,这个enum用来在target编译的时候提供实现的具体细节,在这里可以看到请求所需要的参数,这个enum必须遵循TargetType类型,在同一文件中通过扩展实现。


定义接口

第二步:通过扩展遵循TargetType类型,实现方法。


实现方法

这样TargetType协议保证每个enum的值被转化成一个完整的requst,每个requst被分割成baseURL和Path,定义了请求方式,已经参数和参数编码的test

这样就已经为基本的API网络层添加了基本的信息。默认的情况下,Moya回将给定的部分合并成一个完整的请求。

第三步发送请求:


发送网络请求

原理介绍

Moya的通过Provider这个类来完成所以网络的请求以及响应。在这里从发起请求和响应处理2方面说一下

Provider的初始化方法

public init(endpointClosure: @escaping EndpointClosure = MoyaProvider.defaultEndpointMapping,

            requestClosure: @escaping RequestClosure = MoyaProvider.defaultRequestMapping,

            stubClosure: @escaping StubClosure = MoyaProvider.neverStub,

            manager: Manager = MoyaProvider.defaultAlamofireManager(),

            plugins: [PluginType] = [],

            trackInflights: Bool = false) {

  //...

}

初始化的时候的几个参数:

endpointClosure 作用是把TargetType转换成EndPoint,EndPoint是Moya网络请求的一个中间态。

requestClosure 作用是把Endpoint转换成URLRequest

stubClosure 是用来桩测试的,也就是模拟服务端假数据,这里先不管。

manager,实际请求的Alamofire的SessionManager

plugins, 插件

trackInflights,是否要跟踪重复网络请求

如何这些使用默认的,有一个简单的方法。

Request的实现

Moya中请求是Provider管理者,通过如图方式进行转换的。


转换方式

Providers 映射 Targets 成 Endpoints, 然后映射 Endpoints 到实际的网络请求。

Endpoints

endPoint是Moya的半个内部结构,它最终被用来生成网络请求。endpoint存储了网络请求的相关数据。

url.

HTTP 方法 (GET, POST, etc).

HTTP 请求头.

Task 用来区别 upload, download 和 request.

sample response (为单元测试).


我们可以根据实际需要自定义endpoint闭包来转换,并且在初始化的时候传递给endpointClosure.

例如:


从Target到EndPoint

这种就是在创建一个单元测试中返回一个非200HTTP状态的测试Provider,或者您需要改变task, method, url, headers 或者 sampleResponse。 比如, 我们可能希望将应用程序名称设置到HTTP头字段中,从而用于服务器端分析。您可以为部分或者所有的endpoint提供附加参数。 

假设 MyTarget 除了实际执行身份验证的值之外,其他的所有值都需要有一个身份证令牌,我们可以构造一个类似如下面的 endpointClosure 。


Request 映射

紧接着在某一时刻,Endpoint 必须被转化成 URLRequest 从而给到 Alamofire。 这就是 requestClosure 参数的作用.

requestClosure有默认的参数,是可选的。这个闭包接受一个EndPoint实例对象并负责包代表EndPoint的requst作为RequestResultClosure闭包。这个闭包在实际的编辑请求对象是非常有用。比如:

1、禁用所以请求的cookie

2、输出网络请求的log日志


实际应用

响应(ReSponse)


Moya并没有对Response进行特殊处理,仅仅是把Alamofire层面返回的数据封装成Moya.Response,然后再调用convertResponseToResult进一步封装成Result类型交给上层。

不过Moya提供了几种转换方法:

mapImage()尝试把响应数据转化为UIImage实例 如果不成功将产生一个错误。

mapJSON()尝试把响应数据映射成一个JSON对象,如果不成功将产生一个错误。

mapString()把响应数据转化成一个字符串,如果不成功将产生一个错误。

mapString(atKeyPath:)尝试把响应数据的key Path映射成一个字符串,如果不成功将产生一个错误。

我们可以直接拿到数据进行处理。


数据处理


在这里盗取一张图大家可以看看。流程画的很好。


图片出自https://github.com/LeoMobileDeveloper/Blogs/blob/master/Swift/AnaylizeMoya.md

Moya插件

moya有一个特别好用的插件Plugin,他可以让你在网络请求的的时候用来编辑请求,响应以及完成副作用。

moya提供了4中插件有需要的自己看看。

AccessTokenPlugin OAuth的Token验证

CredentialsPlugin 证书

NetworkActivityPlugin 网络请求状态

NetworkLoggerPlugin 网络日志

附上一个我写的Moya和objectMapper封装的demo。

https://github.com/nanaLxs/LearnSwiftDemo  地址传送带:Moya+objectMapperdemo

大家互相学习了。

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

推荐阅读更多精彩内容

  • 文章摘自Moya官方文档 Targets Moya的使用始于定义一个target——典型的是定义一个符合Targe...
    Jt_Self阅读 16,146评论 0 27
  • 原文地址:https://github.com/Moya/Moya/tree/master/docs参考文章:ht...
    狂奔的兔子阅读 3,331评论 0 53
  • -------2024.05.11 update---- 最近换了新的公司,公司的项目比较新兼容的版本也比较高,使...
    liaoworkinn阅读 12,682评论 43 92
  • 题目:在智慧社区商超管理系统中,通常有多种不同角色的人员使用该系统,超市里面有各种各样不同的商品,商品都有不同的供...
    oh模棱两可阅读 154评论 1 0
  • 想你,想你了,你是怎样的精灵,不经意闯进我的生命,你是怎样的随意,游走在我的心里,让我为了你忽喜忽悲,坎特心情。想...
    yzwjjx阅读 138评论 0 0