RxCocoaNetworking

这是基于 RxCocoa 构建的一个极轻量级的网络框架，专为使用 RxTest 进行测试和仿照 Moya 设计。

• 要求
• 使用说明
• 安装
• 贡献
• 许可

尽管 Moya 是基于 Alamofire 构建的，并提供了一个具有 Observable 签名的 Rx 扩展，而 RxCocoaNetworking 是基于 RxCocoa 构建的，RxCocoa 已经为 NSURLSession 提供了 Observable 签名的扩展。如果您喜欢以下优点，那么 RxCocoaNetworking 是为您定做的：

• ✅您喜欢 Moya 保持网络层干净、易于阅读和可测试的特点；
• ✅Alamofire+Moya 的功能超出了您的需求；
• ✅您的项目已经依赖于 RxCocoa。

...且以下条件会额外加分：

• ✅您希望使用 RxTest 对 delayed 抽象进行测试；
• ✅您不喜欢在生产目标中实现 sampleData；
• ✅您认为您可以使用更少的代码来编写您使用的简单 API。

注意，这绝对不能替代 Alamofire+Moya 的全部功能。例如，您可能会错过一些只有当 RxCocoaNetworking 保持非常轻量时才会支持的功能，例如：

• ❌成功响应除了 Data 之外的其他任何内容；
• ❌文件上传；
• ❌插件（拦截器）。

...在这种情况下，使用 Alamofire+Moya 会更好。

这个框架是由于嵌入式在 RxCocoa 中的网络请求处理以及 Swift 4.1 的条件遵从（请参阅 ReactiveURLSessionProtocol）才得以实现的。

要求

• 📱iOS 9.0+ / Mac OS X 10.11+ / tvOS 10.0+ / watchOS 3.0+
• 🛠Xcode 9.3+
• ✈️Swift 4.1+
• ⚠️RxCocoa
• 🔥无需使用 Alamofire

用法

如果你已经熟悉 Moya，那么好消息是 RxCocoaNetworking （有意）具有非常相似的架构！你所需要做的就是创建一个表示你的 API 的结构 —— 推荐使用 enum，然后让它实现其中一个 TargetType 协议。对你的 API 的请求由一个 Provider 管理并指定为你的具体的 TargetType。

无论你是否熟悉 Moya，其他好消息是你可以参考 ExampleAPI 及其 规范。

enum ExampleAPI {
  // Endpoints as cases:
  case rate(movieID: String, rating: Float)
  case reviews(movieID: String, page: Int)
}

extension ExampleAPI: ProductionTargetType {
  // Your API's base URL is usually what determines an API enum.
  var baseURL: URL { return URL(string: "...")! }
  
  var path: String {
    switch self {
    case .rate(let movieID, _):
      return "/movie/\(movieID)/rating"
    case .reviews(let movieID, _):
      return "/movie/\(movieID)/reviews"
    }
  }
  
  var task: Task {
    // Specify GET/POST/etc., body and query parameters:
    switch self {
    case .rate(_, let rating):
      return Task(method: .post, dictionaryBody: ["value": rating])
    case .reviews(_, let page):
      return Task(parameters: parameters)
    }
  }
  
  var headers: [String : String]? { return nil }
}

extension ExampleAPI: TargetType {
  var sampleData: Data {
    ...
  }
}

常规网络请求（无模拟）

let provider = Provider<ExampleAPI>()

默认的 Provider 参数通常是你生产代码中会用到的。

即时的网络响应模拟

let provider = Provider<ExampleAPI>(stubBehavior: .immediate(stub: .default))

stub: .default 意味着将使用你的 API 的 sampleData。其他 Stub 类型允许你指定不同的响应。

注意：如果你实现了 ProductionTargetType，则无法使用 stub: .default，因为该协议不要求 sampleData。👌你可以始终在测试目标中单独实现 TargetType，例如。

RxTest 可测试的延迟响应模拟

let testScheduler = TestScheduler(initialClock: 0)
let provider = Provider<ExampleAPI>(stubBehavior: .delayed(time: 3,
                                                           stub: .error(SomeError.anError)),
                                    scheduler: testScheduler)

订阅发生 3 个虚拟时间单位后发出 error。

安装

依赖管理器

$ gem install cocoapods

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '9.0'

pod 'RxCocoaNetworking', '~> 0.2.2'

$ pod install

$ brew update
$ brew install carthage

github "gobetti/RxCocoaNetworking" ~> 0.2.2

// swift-tools-version:4.1
import PackageDescription

let package = Package(
    name: "HelloRxCocoaNetworking",
    dependencies: [
        .package(url: "https://github.com/gobetti/RxCocoaNetworking.git", .upToNextMajor(from: "0.2.2"))
    ],
    targets: [
        .target(name: "HelloRxCocoaNetworking", dependencies: ["RxCocoaNetworking"])
    ]
)

手动

如果您不想使用上述任一的依赖管理器，您可以将 RxCocoaNetworking 手动集成到项目中。

$ git init

$ git submodule add https://github.com/gobetti/RxCocoaNetworking.git
$ git submodule update --init --recursive

参与贡献

欢迎参与问题和拉取请求！

一旦你克隆了项目，在构建之前你需要做的所有事就是安装 Carthage 依赖项。

$ carthage bootstrap

然后为了成功运行单元测试，你需要后台运行 wiremock 脚本。

$ ./script/wiremock.sh

作者

Marcelo Gobetti @mwgobetti

许可证

RxCocoaNetworking 在 MIT 许可证下发布。有关详细信息，请参阅 LICENSE。