この記事では、Combineフレームワークに焦点を当てて解説します。

Combineを使うと何ができるの？

Combineを使うことで、APIからデータを取得し、そのデータを効率的に処理・表示することができます。例えばニュースアプリや天気アプリにCombineを利用することができます。

Combineを使って天気アプリを作ってみた

こちらは実際に私がCombineを学習するにあたって作成してみたものになります。↓

コードはGitHubに公開してるのでよかったら使ってみてください。

Combineをさらっと復習

まずPublisherはデータを生成します。次にOperatorがそのデータをSubscriberが期待するデータの型に変換します。最後にSubscriberが最終的にそのデータを受け取って処理します。

天気アプリのCombine処理の流れ

天気アプリのWeatherFetcherクラスのfetchCities関数とfetchWeather関数についてご紹介します。
処理の流れは以下の通りで、どちらの関数でも同様の手順で進めています。

関数のセットアップ
Publisherの生成
Operatorsの設定
Subscriberの設定

今回紹介するコードの例では、PublisherはAPIから取得したデータを発行し、Operatorはそのデータをフィルタリングや変換を行いながら、Subscriberが必要とする形式に整えます。最後に、Subscriberは整えられたデータを受け取る流れになります。

WeatherFetcher

fetchCities全体のコード

まずはfetchCities関数内のコードを見てみましょう。

//Combineフレームワークのデータを取得するための部分
    func fetchCities() {
        // 1. 関数のセットアップ
        let urlString = "https://weather.tsukumijima.net/primary_area.xml"
        guard let url = URL(string: urlString) else { return }
        
        // 2. Publisherの生成
        URLSession.shared.dataTaskPublisher(for: url)
        
        // 3. Operatorsの設定
            .map { $0.data }
            .tryMap { data -> [(String, String, String)] in
                let parser = XMLParser(data: data)
                let delegate = WeatherXMLParserDelegate()
                parser.delegate = delegate
                if parser.parse() {
                    return delegate.cities
                } else {
                    throw URLError(.badServerResponse)
                }
            }
            .receive(on: DispatchQueue.main)
        
        // 4. Subscriberの設定
            .sink(receiveCompletion: { completion in
                if case .failure(let error) = completion {
                    print("Error: \(error)")
                }
            }, receiveValue: { [weak self] cities in
                self?.cities = cities
            })
            .store(in: &cancellables)

次にステップごとに上記のコードを解説していきます。

1. 関数のセットアップ

関数fetchCitiesを定義し、データを取得するためのURLを設定します。URLが正しくない場合、関数は何もせずに終了します。

let urlString = "https://weather.tsukumijima.net/primary_area.xml"
guard let url = URL(string: urlString) else { return }

2. Publisherの生成

URLSession.shared.dataTaskPublisher(for: url)を使って、指定したURLに対してHTTP GETリクエストを送信し、Publisherを生成します。このPublisherは、データとレスポンスを発行します。

URLSession.shared.dataTaskPublisher(for: url)

3. Operatorsの設定

Publisherに対して様々なOperatorsをチェーンさせてデータを処理します。

.map { $0.data }: レスポンスのdata部分のみを取り出します。この操作により、Publisherの型はDataになります。

.map { $0.data }

.tryMap { data -> [(String, String, String)] in: 取得したデータをXML形式からタプルの配列に変換します。XMLParserを使用してパースし、成功した場合はdelegate.citiesを返し、失敗した場合はエラーをスローします。

.tryMap { data -> [(String, String, String)] in
    let parser = XMLParser(data: data)
    let delegate = WeatherXMLParserDelegate()
    parser.delegate = delegate
    if parser.parse() {
        return delegate.cities
    } else {
        throw URLError(.badServerResponse)
    }
}

.receive(on: DispatchQueue.main): メインスレッドで処理を受け取るようにします。これにより、UIの更新がメインスレッドで行われます。

.receive(on: DispatchQueue.main)

4. Subscriberの設定

Publisherから発行されたデータを受け取るためのSubscriberを設定します。

.sink(receiveCompletion:receiveValue:): データの受信と完了ステータスの処理を行います。receiveCompletionクロージャでは、リクエストの完了ステータスを受け取り、成功か失敗かを判定します。receiveValueクロージャでは、受信した値を処理します。

swiftコードをコピーする
.sink(receiveCompletion: { completion in
    if case .failure(let error) = completion {
        print("Error: \(error)")
    }
}, receiveValue: { [weak self] cities in
    self?.cities = cities
})

.store(in: &cancellables): 購読をキャンセル可能なセットに保持し、メモリリークを防ぎます。

.store(in: &cancellables)

fetchWeather

fetchWeather全体のコード

 func fetchWeather(for cityId: String, cityName: String) {
        selectedCityName = cityName
        let urlString = "https://weather.tsukumijima.net/api/forecast/city/\(cityId)"
        guard let url = URL(string: urlString) else {
            weatherInfo = "Invalid URL"
            weatherIcon = ""
            return
        }
        
        URLSession.shared.dataTaskPublisher(for: url)
            .map { $0.data }
            .decode(type: WeatherResponse.self, decoder: JSONDecoder())
            .map { response in
                (response.title, response.description.bodyText, response.forecasts.first?.telop ?? "")
            }
            .replaceError(with: ("Failed to fetch weather information.", "", ""))
            .receive(on: DispatchQueue.main)
            .sink { [weak self] result in
                self?.weatherInfo = "\(result.1)"
                self?.weatherIcon = self?.iconForWeather(result.2) ?? ""
                self?.weatherIconColor = .white  // アイコンの色を設定
            }
            .store(in: &cancellables)
    }

1. 関数のセットアップ

selectedCityName = cityName
let urlString = "https://weather.tsukumijima.net/api/forecast/city/\(cityId)"
guard let url = URL(string: urlString) else {
    weatherInfo = "Invalid URL"
    weatherIcon = ""
    return
}

selectedCityNameに引数cityNameを設定。
cityIdを用いてURL文字列を作成し、そのURLが有効かをチェックします。無効な場合はエラーメッセージを設定して関数を終了します。

2. Publisherの生成

URLSession.shared.dataTaskPublisher(for: url)

URLSession.shared.dataTaskPublisher(for: url)は、指定されたURLに対してHTTPリクエストを送信し、レスポンスをPublisherとして発行します。

3. Operatorsの設定

.map { $0.data

map Operator:
- レスポンスからデータ部分（data）のみを抽出します。
- Publisherの出力が(data: Data, response: URLResponse)からDataに変換されます。

.decode(type: WeatherResponse.self, decoder: JSONDecod

decode Operator:
- 受信したデータをWeatherResponse型にデコードします。
- JSONデータをWeatherResponseというSwiftのデータモデルに変換します

.map { response in
    (response.title, response.description.bodyText, response.forecasts.first?.telop ?? "")

map Operator:
- デコードされたWeatherResponseをタプル(String, String, String)に変換します。
- タプルの内容はtitle、bodyText、telop（天気予報のテキスト）です。

.replaceError(with: ("Failed to fetch weather information.", "", ""))

replaceError Operator:

エラーが発生した場合に、指定した値("Failed to fetch weather information.", "", "")に置き換えます。

.receive(on: DispatchQueue.main)

receive(on:) Operator:
- メインスレッドで処理を受け取ります。UIの更新はメインスレッドで行う必要があるためです。

4. Subscriberの設定

.sink { [weak self] result in
    self?.weatherInfo = "\(result.1)"
    self?.weatherIcon = self?.iconForWeather(result.2) ?? ""
    self?.weatherIconColor = .white
}

sink Operator:
- 受信したデータを処理し、UIを更新します。
- receiveCompletionクロージャは省略されており、成功時とエラー時の処理が統一されています。
- receiveValueクロージャで受信した値を用いて、weatherInfo、weatherIcon、weatherIconColorを更新します。

参考

リンク