Skip to content

Latest commit

 

History

History
316 lines (237 loc) · 11.1 KB

README_zh.md

File metadata and controls

316 lines (237 loc) · 11.1 KB

NetworkArchitectureDemo

EN | 中文

Swift 实现的网络框架示例，基于 MVC 设计模式。🤖

使用 Moya + RxSwift + ObjectMapper + AwesomeCache 进行优雅的网络请求、解析并且缓存。

🤖 要求

  • iOS 8.0+
  • Xcode 9.0+
  • Swift 4.2

🎯 安装方法

安装

在 iOS, 你需要在 Podfile 中添加.

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
use_frameworks!

pod 'RxSwift', '~> 3.4.0'
pod 'Moya', '~> 8.0.3'
pod 'Moya/RxSwift', '~> 8.0.3'
pod 'ObjectMapper', '~> 2.2.5'
pod 'AwesomeCache', '~> 5.0'

🛠 配置

在Swift中我们发送网络请求一般都是使用一个第三方库 Alamofire ，设置好URL和parameter然后发送网络请求，就像下面这样：

let param = ["iid": iid]
let url = baseURL + articlePath

Alamofire.request(url, parameters: param).responseJSON { (response) in
      switch response.result {
      case .success(let value):
          ....
      case .failure(let error):
      }
}

这些代码一般都是写在项目的Service或者ViewModel文件中，随着项目的增大每一个Service文件或者ViewModel文件中就会有很多不同的网络请求，每一次网络请求都不免会写这样的代码，那么项目中的网络请求就会变得很乱。

那么这时候一般我们会在项目中添加一个网络请求层，来管理网络请求，一般会叫 APIManager 或者 NetworkModel ，但是这样子还是会有一点不好：

  • 这一层比较混乱，不好管理，混合了各种请求
  • 不好做单元测试

Moya 网络管理层

但是 Moya 是专业处理这些问题而生滴。Moya 有以下优点：

  • 定义了一个清晰的网络结构
  • 更加简单地进行网络单元测试

Moya是作用在Alamofire之上，让我们不再直接去使用Alamofire了，Moya也就可以看做我们的网络管理层，只不过他拥有更好更清晰的网络管理。可以看到下图，我们的APP直接操作Moya，让Moya去管理请求，不在跟Alamofire进行接触。

网络请求

我们要怎么使用Moya进行请求呢？很简单。(参考官方Demo)比如我们要查询github上一个人的userProfile和一个人的repository。大伙可以想一下，我们如果直接使用Alamfire怎么去请求的。然而我们看下Moya怎么做：

首先我们需要声明一个enum来对请求进行明确分类。

public enumGitHub{
    case userProfile(String)   //请求profile
    case userRepositories(String)              //请求repository
}

然后我们需要让这个enum实现一个协议TargetType，点进去可以看到TargetType定义了我们发送一个网络请求所需要的东西，什么baseURL，parameter，method等一些计算性属性，我们要做的就是去实现这些东西，当然有带默认值的我们可以不去实现。相信下面代码中的东西大家都能看的懂，下面定义了每一个请求所需要的基本数据。

extensionGitHub:TargetType{
    public var baseURL: URL { return URL(string: "https://api.github.com")! }
    public var path: String {
        switch self {
        case .userProfile(let name):
            return "/users/\(name.urlEscaped)"
        case .userRepositories(let name):
            return "/users/\(name.urlEscaped)/repos"
        }
    }
    public var method: Moya.Method {
        return .get
    }
    public var parameters: [String: Any]? {
        switch self {
        case .userRepositories(_):
            return ["sort": "pushed"]
        default:
            return nil
        }
    }
    public var parameterEncoding: ParameterEncoding {
        return URLEncoding.default
    }
    public var task: Task {
        return .request
    }
    public var validate: Bool {
        switch self {
            return false
        }
    }
    
    //这个就是做单元测试模拟的数据，必须要实现，只在单元测试文件中有作用
    public var sampleData: Data {  
        switch self {
        case .userProfile(let name):
                                return "[{\"name\": \"Repo Name\"}]".data(using: String.Encoding.utf8)!
        case .userRepositories(_):
                                return ....
        }
    }
}

当我们实现了这个这个enum，我们就相当于完成了一个网络请求所需要的一个 endpoint ，endpoint其实就是一个结构，包含了我们一个请求所需要的基本信息，比如url，parameter等。endpoint好了这时候我们就需要一个工具去发送这个请求。

Moya 本身提供了 RxSwift 扩展，可以无缝衔接 RxSwift 和 ReactiveCocoa ，于是打开方式变成了这样：

private let provider = RxMoyaProvider()
private var disposeBag = DisposeBag()

extension ItemAPI {
    static func getNewItems(completion: [Item] -> Void) {
        disposeBag = DisposeBag()
        provider
            .request(.GetItems())
            .subscribe(
                onNext: { items in
                    completion(items)
                }
            )
            .addDisposableTo(disposeBag)
    }
}

ObjectMapper 数据转模型层

ObjectMapper 是一个在 Swift 下数据转模型的非常好用，并且很 Swift 的一个框架。以前我们在写 OC 代码的时候用 MJExtension 转模型，到了 Swift 的时代赶紧将 ObjectMapper 使用起来吧。

ObjectMapper框架支持的数据结构类型:

  • Int
  • Bool
  • Double
  • Float
  • String
  • RawRepresentable(Enums)
  • Array
  • Dictionary<String, AnyObject>
  • Object<T: Mappable>
  • Array<T: Mappable>
  • Array<Array<T: Mappable>>
  • Set<T: Mappable>
  • Dictionary<String, T: Mappable>
  • Dictionary<String, Array<T: Mappable>>
  • Optionals of all the above //上述的可选类型
  • Implicitly Unwrapped Optionals of the above //上述的隐式解析可选类型

Awesome Cache 缓存层

Awesome Cache 是一个让人喜爱的本地磁盘缓存（使用 Swift 编写）。基于 NSCache 发挥最好的性能，而且支持单个对象的缓存期限。

do {
    let cache = try Cache<NSString>(name: "awesomeCache")
 
    cache["name"] = "Alex"
    let name = cache["name"]
    cache["name"] = nil
} catch _ {
    print("Something went wrong :(")
}

📝 深入学习

1.对于异步 Api 的选择？ requestOperation 的设计——NSOperation。

2.使用直接dispatch的致命缺陷：

  • 第一个就是无法cancel这个请求（实时可控） 方便设计cancel请求；
  • 第二个是占用了完整的一个线程（资源占用） 无论同时并发多少个请求，AFNetworking和ASI都是只有一个线程在等待的。

3.网络层设计的并发数量的考虑

  • 控制连接数，2G网络下一次只能维持一个链接，3G是2个，4G和wifi是不限。这个是对应协议的限制。如果超过这个限制发出的请求，就会报超时。
  • 带宽，下载数据是要流量的，如果同时并发了太多请求，每个连接都占用带宽，可能导致每个请求的时间均会延长
  • maxConcurrentOperationCount 不能太少，避免个别请求太慢而后面的任务不能启动

4.网络层设计的数据加密和防篡改

  • 免费的SSL证书，https
  • 参数进行签名，动态签名密钥
  • 特殊攻击：

<1>https中间人：AFNetworking中的AFURLConnectionOperationSSLPinningMode设置ssl钢钉。（原理就是把证书或者公钥 打包到bundle中，发送请求的时候会与请求过来的证书比较，因此避免中间人发放的伪造证书可能。）

<2>DNS防劫持：可以本地维护一个路由表，然后本地实现 NSURLProtocol 对host进行ip映射。

5.网络库设计的回调方式 要求：统一和方便

  • 1.是选择block回调方式，还是delegate, 还是target-action 兼容多种。
  • 2.success和fail分开回调还是同一个方法回调。

6.网络库设计的拦截器——AOP

  • 1.session过期后自动登录
  • 2.需要登录的接口进入登录

7.网络库设计的cancel处理

  • 单独cancel 谁启动，谁cancel，dealloc里面写cancel
  • 统一cancel 类似封装个方法在父类里面调用

8.网络库设计的缓存 缓存的方式：

  • 一种是客户端写缓存实现和缓存逻辑，
  • 二种是遵循HTTP协议的缓存。

<1>自建缓存的需求场景：

1、接口返回的数据很少变动，不希望做重复请求

2、网络慢或者服务器等异常状况容灾。

注意点：

  • 缓存时间的定义
  • 数据实时性
  • 数据加载速度
  • 必要性

<2>HTTP缓存 NSURLCache，数据缓存在本地sqlite里。在返回的 responseHeaders 中添加 cache-control 和 Expires 来告诉前端是否可以缓存（设置cachePolicy）和缓存时间等。

原理：请求Header加字段-判断是否有更新，是否用缓存。 ETag是比较hash， Last-Modified是比较最后更改时间。

9.网络库设计的拓展性

  • SPDY、HTTP/2或TCP长连接-随时随地的推活动
  • 国际化-Accept-Language 字段

帮助文献：

RxSwift 链式语法库 https://github.com/ReactiveX/RxSwift

Moya 网络管理库 https://github.com/Moya/Moya

ObjectMapper 数据转模型库 https://github.com/Hearst-DD/ObjectMapper

AwesomeCache 数据缓存库 https://github.com/aschuch/AwesomeCache

IOS应用架构思考一（网络层） https://blog.cnbluebox.com/blog/2015/05/07/architecture-ios-1/

⚖ 协议

MIT License

Copyright (c) 2017 ReverseScale

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

😬 联系