MVCでAPI通信が完了してから変数に値を入れたいのですが

Question

前提・実現したいこと

現在位置情報から国土地理院のAPIを使って標高を取得するアプリを作成しています。
標高を取得する操作をControllerとModelに分けて実装しようとしたところうまくいきませんでした。

発生している問題・エラーメッセージ

標高の取得が完了する前にUIの更新をしてしまって、画面に標高の表示がうまく反映されない。

該当のソースコード

Controllerで位置情報を取得したら、ModelのgetElevationで標高を取得しています。
このAPIを使って取得した標高をViewにわたすことができずにいます。
常に0.0ｍが表示されてしまう状況です。

func locationManager(_ manager: CLLocationManager, didUpdateLocations locations: [CLLocation]) {        
        self.customView.elevation = customModel.getElevation(locations)
}

var elevationString: String = "0.0m" 
private var afterElevation:Double = 0.0
private var beforeElevation:Double = pow(10, 5)

func getElevation(_ Locations: [CLLocation]) -> String{
        
        self.locations = Locations
        
        guard let coordinate = Locations.first?.coordinate else {return elevationString}
        
        userLocation = CLLocationCoordinate2DMake(coordinate.latitude, coordinate.longitude)
        
        // 国土地理院のURL
        let baseUrl = "https://cyberjapandata2.gsi.go.jp/general/dem/scripts/getelevation.php?"
        // ロングタップ地点でクエリを設定する
        if let userLocation = userLocation {
            let lonUrl = "&lon=" + userLocation.longitude.description
            let latUrl = "&lat=" + userLocation.latitude.description
            // アウトプット形式をJSONに設定する
            let outtypeUrl = "&outtype=JSON"
            // URLとクエリを連結
            let listUrl = baseUrl + lonUrl + latUrl + outtypeUrl
            // URLを生成する
            guard let url = URL(string: listUrl) else { return elevationString}

            let task = URLSession.shared.dataTask(with: url) { (data, response, error) in
                if error != nil {
                    print(error!.localizedDescription)
                }
                guard let data = data else { return }
                // JSONを取得する
                if let json = try? JSONDecoder().decode(ElevationData.self, from: data) {
                    DispatchQueue.main.async {
                        // JSONから標高を取得する
                        self.afterElevation = json.elevation
                        self.measuringElevation()
                        self.elevationString = String(format: "%.2fm", self.gotElevation)
                        self.beforeElevation = self.afterElevation
                        print(#function, self.elevationString)
                    }
                } else {
                    self.afterElevation = 0.0

                }
            }
            task.resume()
        }
        return elevationString
}

func measuringElevation() {
        if afterElevation > beforeElevation {
            gotElevation += afterElevation - beforeElevation
        }
}

import Foundation

struct ElevationData: Codable{
    let elevation: Double
}

試したこと

非同期通信などを調べてみてものの、解決に至らなかったのでどうかよろしくおねがいします

Comments

[TsukubaDepot]

if let json = try? JSONDecoder().decode(ElevationData.self, from: data) {
以降、json に代入された値を直接使っている形跡がないのですが、高度はどのようにして計算しているのでしょうか。
self.measuringElevation()　からは json は見えないので、計算できていない気もしています。

[TsukubaDepot]

if let json = try? JSONDecoder().decode(ElevationData.self, from: data) {
この行以降、json という変数は直接扱われていませんが、得られた JSON はどのように加工しているのでしょうか。
self.measuringElevation()を読んでいるようですが、このメソッドから上記の json は見えないのではないかと思います。

[Raleigh]

すいませんご指摘ありがとうございます。
jsonの記述の
self.afterElevation = json.elevation
この部分が抜けいていました。

Answer 1

あるメソッドに引数として取られたクロージャからは、return を使ってメソッドの外側に値を返すことができないことはおそらくご存知かと思います。

一方、非同期処理を行うクロージャで得られたデータを処理させるためには、直接クロージャ外の変数を処理するよりも、データ取得完了、あるいはエラー発生時の処理を行うクロージャを渡せるようにして、そこで処理をさせるほうが確実かとおもます。

ということで、ご提示いただいたコードのgetElevation(_:)を次のようにしてみました。

getElevation(_ Locations: [CLLocation], completionHandler: @escaping (String?) -> Void, errorHandler: @escaping (Error?) -> Void )

completionHandler: で与えるクロージャは、引数として String?型が与えられます。処理内で正しい標高が得られなかった場合には "0.0" を返すようになっていましたが、実際は標高 0.0 m という場所もあるので、nil を返したほうが現実的と思います。

errorHandler:は、Error? 型が与えられます。こちらはエラーが起きたときの処理を記述します。

いただいた範囲で想像で記述し、コンパイルしていないためもしかしたらエラーが出る可能性もありますが、概ねこんな感じで使えるのではないでしょうか。

• Controller

　　　　model.getElevation(locations, completionHandler: { (elevationString) in
            DispatchQueue.main.async {
                // ここでは View Controller にラベルに表示しているが、他のクラスのプロパティに書き込む場合でも考え方は同じ
                //self.customView.elevation = elevationString
                self.altitudeLabel.text = elevationString ?? "取得できませんでした"
            }
        }, errorHandler:  { (error) in
            print(error?.localizedDescription ?? "エラー情報なし")
        })

• Model

func getElevation(_ locations: [CLLocation], completionHandler: @escaping (String?) -> Void, errorHandler: @escaping (Error?) -> Void ) {
        guard let coordinate = locations.first?.coordinate else {
            // 終了処理のクロージャに nil を渡す
            completionHandler(nil)
            return
        }
        
        let userLocation = CLLocationCoordinate2DMake(coordinate.latitude, coordinate.longitude)
        
        let baseUrl = "https://cyberjapandata2.gsi.go.jp/general/dem/scripts/getelevation.php?"
        
        let lonUrl = "&lon=" + userLocation.longitude.description
        let latUrl = "&lat=" + userLocation.latitude.description
        let outtypeUrl = "&outtype=JSON"
        
        let listUrl = baseUrl + lonUrl + latUrl + outtypeUrl
        print(listUrl)
        guard let url = URL(string: listUrl) else {
            // 終了処理のクロージャに nil を渡す
            completionHandler(nil)
            return
        }
        
        let task = URLSession.shared.dataTask(with: url) { (data, response, error) in
            if error != nil {
                // エラー処理のクロージャに error を渡す
                errorHandler(error)
                return
            }
            
            guard let data = data else {
                // 終了処理のクロージャに nil を渡す
                completionHandler(nil)
                return
            }
            
            // error を返せるように、do-try-catch で処理する
            do {
                let json = try JSONDecoder().decode(ElevationData.self, from: data)

                // 以下の処理は全体の文脈がわからないので、とりあえずコメントアウト
//                self.afterElevation = json.elevation
//                self.measuringElevation()
//                self.beforeElevation = self.afterElevation
                
                // JSON で得られた座標を直接処理
                self.gotElevation = json.elevation
                
                let elevationString = String(format: "%.2fm", self.gotElevation)

                completionHandler(elevationString)
            } catch {
                errorHandler(error)
            }
        }
        task.resume()
    }

##追記
今回の処理を簡素化したモデルです。
Playground でも実行できますので、よかったら試してみてください。

import UIKit

func delayFunc(completion: @escaping (String) -> ()) {
    DispatchQueue.main.asyncAfter(deadline: .now() + 1.0) {
        // 1秒後に実行されるコード
    
        // (1) に相当
        print("(1) 遅延処理クロージャの中の処理を開始")
        completion("クロージャへ渡す文字列")
    }
    // （2）に相当
    print("(2) クロージャ外の処理")
}

delayFunc(completion: { (message) in
    print("(3) 処理完了クロージャでの処理")
    print("渡された文字列は「(message)」")
})

クロージャだけでなく、引数の型と個数が合えば関数も渡せます。

import UIKit

func delayFunc(completion: @escaping (String) -> ()) {
    DispatchQueue.main.asyncAfter(deadline: .now() + 1.0) {
        // 1秒後に実行されるコード
    
        // (1) に相当
        print("(1) 遅延処理クロージャの中の処理を開始")
        completion("クロージャへ渡す文字列")
    }
    // （2）に相当
    print("(2) クロージャ外の処理")
}

func completionFunction(_ msg: String) {
    print("(4) 処理完了クロージャは関数でもいい")
    print("渡された文字列は「(msg)」")
}

delayFunc(completion: completionFunction)

Comments

[Raleigh]

MVCでコードを記述したかったので、getElevationとmeasuringElevationはModelのファイルにあるのですがどうしたらいいでしょうか？

[TsukubaDepot]

そういう意味だったんですね。失礼しました。
そうなると、Double? で json.elevation の結果を返すのではなく、ある程度処理したあと、最終結果だけ String? で返して、getElevation(locations, completionHandler:errorHandler:)では表示に専念させるほうがいいのかもしれません。

[TsukubaDepot]

ちょっときちんと試してみたいので、Struct ElevationData の定義もご質問に追記していただけないでしょうか（これがあれば多分こちらでも動くアプリが作れると思います）。

[Raleigh]

ややこしくてすいません。
追加しました。よろしくおねがいします。

[TsukubaDepot]

Model の中でどの程度隠蔽を行いたいのかわからなかった部分もありますが、こちらで試した感じだとこのような感じになるかと思います（要は、細かい計算まで済ませて、文字列だけ返すようにしただけ）。

回答内のコードは全般的に書き換えてあります。

こちらのテストでは、GPSの座標は使わずに、いくつか座標を適当に入れてみて、それを公表されている結果と合わせてみましたが、概ね妥当な値がでてきるようです。

[Raleigh]

できました！！！ありがとうございます。
自分自身なぜうまくいったのか理解が追いついていないので、これからもっと勉強しようと思います！
コードの添削のようなこともしていただいて、頭が上がりません。

ちなみに以下のようなアプリを作っていて、MVCで書くことに苦戦しているところです。
https://twitter.com/QINIx9fgWSEuyF4/status/1300783075383672838?s=20

[Raleigh]

最後になぜ自分のコードはelevationStringが思ったように更新されなかったか、理由を教えていただけると嬉しいです。

[TsukubaDepot]

すごく抽象的な書き方をしますが、
let task = URLSession.shared.dataTask(with: url) { (data, response, error) in
// （1）
}
// (2)

における、（1）（2）の両者において、この場合は（1）->（2）の順番に処理が行われるとは限らないためです。
ネットワークの通信状態によっては、（2）->（1）のこともあり得ますし、どんな低遅延であっても、処理量を考えれば（1）->（2）となることはないかと思います。
すると、（1）の部分である変数にデータを書き込んだとしても、（2）の部分（たとえば return )は通り過ぎており、意図した通り実行することができないわけです。

なので、（1）の部分で行わせたい処理を「クロージャ」の形で外部から渡し、任意のタイミングで処理するようにしています。

[TsukubaDepot]

簡単な例を追記しましたので、参考にしていただければとおもます。

アプリですが、面白そうですね。
とりあえず作ってみるのか、モデル化を突き詰めるのか、UIを極めるのか、選択も難しいと思いますが、目標があることはいいことだと思うので、成功するのを楽しみにしています。

[Raleigh]

少しわかったような気がします！
今までクロージャの存在だけは知っていたものの、今回始めてその使い所が理解できました。
とても親切に回答してくださってありがこうございました。すごく助かりましたm(_ _)m
アプリ開発大変ですががんばります。