RxSwift - Swiftでのリアクティブプログラミング

(Reactive Programming in Swift)

Created at: 2015-04-08 05:25:17
Language: Swift
License: NOASSERTION

RxSwift ロゴ
ビルドステータス サポートされているプラットフォーム: iOS、macOS、tvOS、watchOS および Linux

Rx は、インターフェイスを介して表現される計算の一般的な抽象化であり、ストリームからの値やその他のイベントをブロードキャストおよびサブスクライブできます。

Observable<Element>
Observable

RxSwift は、リアクティブ拡張機能標準の Swift 固有の実装です

RxSwift アプリの UI が常に変化し、更新される価格の観察可能な例

このバージョンは、Rx の元の精神と命名規則に忠実であり続けることを目的としていますが、このプロジェクトは Rx API に真の Swift-first API を提供することも目的としています。

クロスプラットフォームのドキュメントは ReactiveX.io にあります。

他の Rx 実装と同様に、RxSwift の目的は、非同期操作とデータのストリームをオブジェクトの形で簡単に構成し、これらの非同期作業を変換および構成するための一連のメソッドを可能にすることです。

Observable

KVOオブザベーション、非同期操作、UIイベント、その他のデータストリームはすべて、シーケンスの抽象化の下で統合されています。これが、Rxがとてもシンプルでエレガントでパワフルな理由です。

私はここに来たので、私はしたい...

...分かる
...取り付ける
...ハックアラウンド
...相呼応する
...比べる
...構造を理解する

RxSwiftは、それが駆動する非同期作業と同じくらい構成的です。コアユニットはRxSwift自体ですが、UI作業、テストなどのために他の依存関係を追加することができます。

これは、次のようにして互いに依存する5つの別々のコンポーネントで構成されています。

┌──────────────┐    ┌──────────────┐
│   RxCocoa    ├────▶   RxRelay    │
└───────┬──────┘    └──────┬───────┘
        │                  │        
┌───────▼──────────────────▼───────┐
│             RxSwift              │
└───────▲──────────────────▲───────┘
        │                  │        
┌───────┴──────┐    ┌──────┴───────┐
│    RxTest    │    │  RxBlocking  │
└──────────────┘    └──────────────┘
  • RxSwift: The core of RxSwift, providing the Rx standard as (mostly) defined by ReactiveX. It has no other dependencies.
  • RxCocoa: Provides Cocoa-specific capabilities for general iOS/macOS/watchOS & tvOS app development, such as Shared Sequences, Traits, and much more. It depends on both
    RxSwift
    and
    RxRelay
    .
  • RxRelay: Provides
    PublishRelay
    ,
    BehaviorRelay
    and
    ReplayRelay
    , three simple wrappers around Subjects. It depends on
    RxSwift
    .
  • RxTest and RxBlocking: Provides testing capabilities for Rx-based systems. It depends on
    RxSwift
    .

Usage

Here's an example In Action
Define search for GitHub repositories ...
let searchResults = searchBar.rx.text.orEmpty
    .throttle(.milliseconds(300), scheduler: MainScheduler.instance)
    .distinctUntilChanged()
    .flatMapLatest { query -> Observable<[Repository]> in
        if query.isEmpty {
            return .just([])
        }
        return searchGitHub(query)
            .catchAndReturn([])
    }
    .observe(on: MainScheduler.instance)
... then bind the results to your tableview
searchResults
    .bind(to: tableView.rx.items(cellIdentifier: "Cell")) {
        (index, repository: Repository, cell) in
        cell.textLabel?.text = repository.name
        cell.detailTextLabel?.text = repository.url
    }
    .disposed(by: disposeBag)

Requirements

  • Xcode 12.x
  • Swift 5.x

For Xcode 11 and below, use RxSwift 5.x.

Installation

RxSwift doesn't contain any external dependencies.

These are currently the supported installation options:

Manual

Open Rx.xcworkspace, choose

RxExample
and hit run. This method will build everything and run the sample app

CocoaPods

# Podfile
use_frameworks!

target 'YOUR_TARGET_NAME' do
    pod 'RxSwift', '6.5.0'
    pod 'RxCocoa', '6.5.0'
end

# RxTest and RxBlocking make the most sense in the context of unit/integration tests
target 'YOUR_TESTING_TARGET' do
    pod 'RxBlocking', '6.5.0'
    pod 'RxTest', '6.5.0'
end

Replace

YOUR_TARGET_NAME
and then, in the
Podfile
directory, type:

$ pod install

XCFrameworks

Each release starting with RxSwift 6 includes

*.xcframework
framework binaries.

Simply drag the needed framework binaries to your Frameworks, Libraries, and Embedded Content section under your target's General tab.

Note: If you're using

RxCocoa
, be sure to also drag RxCocoaRuntime.xcframework before importing
RxCocoa
.

XCFrameworks instructions

Carthage

Add this to

Cartfile

github "ReactiveX/RxSwift" "6.5.0"
$ carthage update

Carthage as a Static Library

Carthage defaults to building RxSwift as a Dynamic Library.

If you wish to build RxSwift as a Static Library using Carthage you may use the script below to manually modify the framework type before building with Carthage:

carthage update RxSwift --platform iOS --no-build
sed -i -e 's/MACH_O_TYPE = mh_dylib/MACH_O_TYPE = staticlib/g' Carthage/Checkouts/RxSwift/Rx.xcodeproj/project.pbxproj
carthage build RxSwift --platform iOS

Swift Package Manager

Note: There is a critical cross-dependency bug affecting many projects including RxSwift in Swift Package Manager. We've filed a bug (SR-12303) in early 2020 but have no answer yet. Your mileage may vary. A partial workaround can be found here.

Create a

Package.swift
file.

// swift-tools-version:5.0

import PackageDescription

let package = Package(
  name: "RxTestProject",
  dependencies: [
    .package(url: "https://github.com/ReactiveX/RxSwift.git", .exact("6.5.0"))
  ],
  targets: [
    .target(name: "RxTestProject", dependencies: ["RxSwift", "RxCocoa"])
  ]
)
$ swift build

To build or test a module with RxTest dependency, set

TEST=1
.

$ TEST=1 swift test

Manually using git submodules

  • Add RxSwift as a submodule
$ git submodule add git@github.com:ReactiveX/RxSwift.git
  • Drag
    Rx.xcodeproj
    into Project Navigator
  • Go to
    Project > Targets > Build Phases > Link Binary With Libraries
    , click
    +
    and select
    RxSwift
    ,
    RxCocoa
    and
    RxRelay
    targets

References