ジオコーディングした緯度経度をグローバル変数に代入する方法。

Question

前提・実現したいこと

住所から緯度経度を出力し、グローバル変数に緯度経度を保存しようと考えています。
そこで、CLGeocoder().geocodeAddressStringを利用して緯度経度を出力しましたが
グローバル変数に緯度経度を代入することができません。

下記ソースコードの
viewDidLoad()内のprint("3",eventAddressCoordinate)にて
出力がnilではなく、緯度経度が入っている状態で出力する方法をご教授いだだけると幸いです。

また、よろしければ処理の順番が
ソースコードに記載された順番ではなく、
print("2",eventAddressCoordinate)
print("3",eventAddressCoordinate)
print("1",eventAddressCoordinate)
というように、前後する理由をご教授いただけると幸いです。

該当のソースコード

import UIKit
import MapKit

var eventAddressCoordinate:CLLocationCoordinate2D?

class ViewController: UIViewController {
    
    override func viewDidLoad() {
        super.viewDidLoad()
        geocode()
        print("3",eventAddressCoordinate)
    }
    
    func geocode(){
        let testKey:String? = "東京都千代田区千代田１−１"
        guard  let searchKey = testKey else { print("testKey = nil"); return }
        let geocoder = CLGeocoder()
        geocoder.geocodeAddressString(searchKey) { (placemarks, error) in
            guard let unwrapPlacemark = placemarks else { return }
            guard let firstPlacemark = unwrapPlacemark.first else { return }
            guard let location = firstPlacemark.location else { return }
            eventAddressCoordinate = location.coordinate
            print("1",eventAddressCoordinate)
        }
        print("2",eventAddressCoordinate)
    }

}

デバックエリアの内容

2 nil
3 nil
1 Optional(__C.CLLocationCoordinate2D(latitude: 35.6837221, longitude: 139.7535985))

Answer 1

        geocoder.geocodeAddressString(searchKey) { (placemarks, error) in

上記のメソッドは非同期に実行されるメソッドとなります。

• geocodeAddressString(_:completionHandler:)

Submits a forward-geocoding request using the specified string.

上記のリファレンスには

Discussion

This method submits the specified location data to the geocoding server asynchronously and returns.

と記述してありますので、指定した searckKey での検索は非同期に行われ、その処理結果が completionHandler で指定したクロージャに渡されるようになっています。

したがって、クロージャを渡したからと言ってそれが即時に実行されるわけではなく、サーバに住所を送り、ジオコーディングに成功（あるいは失敗）した時点でクロージャが実行される仕組みとなっています。

なので、実行結果が

2 nil
3 nil
1 Optional(__C.CLLocationCoordinate2D(latitude: 35.6837221, longitude: 139.7535985))

という具合になってしまっています。

求められた実行結果を元に、スコープ外の変数に対して何らかの処理を行いたいのであれば、その処理をさらにクロージャとして渡すようにするか、プロパティオブザーバの利用、あるいはオブザーバパターンなどの利用が必要となってきます。

以下はクロージャを渡す例となりますので、参考にしていただければと思います。
playground でも動くようになっています。

厳密にエラー処理を行なっているわけではありませんので、必要に応じてエラー処理を書き換えていただければと思います。

また、geocodeAddressStringに渡すクロージャはメインスレッドで実行されるようですので（リファレンスより）、geocode 内の DispatchQueue は必要ないかもしれません。

import UIKit
import MapKit

geocode { location, error in
    guard let location = location else {
        if let error = error {
            print(error.localizedDescription)
        } else {
            print("Unknown error.")
        }
        return
    }
    
    // 緯度軽度を表示
    print(location)

} errorHandler: {
    print("error")
}

func geocode(completionHandler: @escaping (CLLocationCoordinate2D? , Error?) -> (), errorHandler: @escaping () -> ()){
    let testKey:String? = "東京都千代田区千代田１−１"
    //let testKey:String? = "あり得ない住所"
    
    guard  let searchKey = testKey else {
        errorHandler()
        return
        
    }
    
    let geocoder = CLGeocoder()
    geocoder.geocodeAddressString(searchKey) { (placemarks, error) in
        guard let unwrapPlacemark = placemarks else {
            DispatchQueue.main.async {
                // エラーを返す
                completionHandler(nil, error)
            }
            return
        }
        
        // ジオコーディングが成功したら少なくとも住所は一つ入っていると想定されているので、
        // 強制アンラップしても問題ないかもしれない
        // 以下公式ドキュメントより
        // For most geocoding requests, this array should contain only one entry.
        let firstPlacemark = unwrapPlacemark.first!
        let location = firstPlacemark.location!
        
        DispatchQueue.main.async {
            // 取得した住所を返す
            completionHandler(location.coordinate, nil)
        }
    }
}