Swiftの関数の戻り値の指定の仕方

Question

Cloud Firestoreから取得した数値を用いて計算（割り算）したいです。
その際に多分returnや戻り値の指定などあると思うのですがよくわからないです。。
現状下記のシンプルなコードで関数内では 10とprintされるのですが呼び出した先では10が表示されず計算できません。

詳しい方いましたらよろしくお願いします。

func getDocuments(){
        let db = Firestore.firestore()
        db.collection("aaa").document("bbb").collection("ccc").getDocuments() { (querySnapshot, err) in
            if let err = err {
                print("Error getting documents: (err)")
            } else {
                for document in querySnapshot!.documents {
                    if let count = querySnapshot?.documents.count{
                        
                        self.aNumber = Double(count) // 10
                        self.amountNumber.text = "(count)" // 20  
                        print(self.aNumber) // 10
                    }
                }
            }
        }
    }

...
override func viewDidLoad() {
        super.viewDidLoad()
         
        getDocuments()

        // division & to String
        self.doneRateNumber.text = "(round( amountNumber / aNumber * 100))"
...
}

Answer 1

Cloud Firestore はいじったことがありませんが、ネットワークなどの非同期処理一般に言えることは

       db.collection("aaa").document("bbb").collection("ccc").getDocuments() { (querySnapshot, err) in

上記の文のクロージャは、非同期で処理されています。

つまり、

    // (1)
    getDocuments()

    // (2)
    // division & to String
    self.doneRateNumber.text = "(round( amountNumber / aNumber * 100))"

とした場合、(1) で処理を実行しても、(2) に到達する前に処理が完了している保証はありません。

言い方を変えれば、 クロージャで処理しているamountNumber（クロージャ内部だとself.amountNumber）に値が代入される前に (2) に到達することが十分にあり得るということです。

したがって、ラベルに値を反映させる処理もクロージャ内部に記述するか、あるいはgetDocuments()が処理完了後のクロージャなどを引数として取るようなメソッドとし、内部で渡されたクロージャの処理を任意のタイミングで行う、という方針を取ることとなります。

かなり抽象的なコードですが、たとえばこのような感じになるかと思います。

// ここでは引数を1つ取り、戻り値を持たないクロージャを仮定。もちろん必要に応じて引数の個数や型を変更する
func getDocuments(completion: @escaping (String) -> () ){
    // クロージャに渡したいデータ
    let data = "done"
    
    // 遅延の処理の代わりに DispatchQueue を使って1秒後に処理を行なっている。
    DispatchQueue.main.asyncAfter(deadline: .now() + 1.0 ){
        // クロージャに処理を行わせる
        completion(data)
    }
    
    // 実際には次のようなパターンを採用する（これ以外もあり得る）
    
    // (1)UI部品の更新を行わない場合
    // completion(data)
    
    // (2) クロージャ でUI部品の更新を行う（可能性がある）場合にはメインキューに入れて処理を行う
    // DispatchQueue.main.async {
    //    completion(data)
    //}
    
}

getDocuments() { data in
    // クロージャで処理したデータは data に入ってくる。
    
    // 実際にはラベルの更新などを行う
    // label.text = text
    print(data)
}

詳細が分からないので間違っている可能性もありますが、実際のコードに反映させるならこのような感じとなります。

func getDocuments(completion: @escaping (Int) -> () ){
    let db = Firestore.firestore()
    db.collection("aaa").document("bbb").collection("ccc").getDocuments() { (querySnapshot, err) in
        if let err = err {
            print("Error getting documents: (err)")
        } else {
            for document in querySnapshot!.documents {
                if let count = querySnapshot?.documents.count {
                    DispatchQueue.main.async {
                        completion(count)
                    }
                }
            }
        }
    }
}

...
    
override func viewDidLoad() {
    super.viewDidLoad()
    
    getDocuments() { count in
        self.aNumber = Double(count)
        self.amountNumber.text = "(count)" // 20
        print(self.aNumber)
    }
}

##2020年9月1日追記

1引数のクロージャには、下記のように他にもいくつかの書き方がありますので、わかりやすい方法を使っていただければと思います。

getDocuments { data in
    print(data)
}

getDocuments(completion: { data in
    print(data)
})

Comments

[sunglass]

コメントありがとうございます！
override func viewDidLoad() {...}内でこういう書き方もあるんですね。
指摘されている『到達する前に処理が完了している保証はありません。 』はその通りだと思いました。。

ちょっと全体のコードを見直して実装してみます。

[TsukubaDepot]

もしかしたら、クロージャの書式が viewDidLoad() 特有の書き方のような誤解を招いたかもしれません。
引数のないクロージャの書式の一つなのですが、見方によっては関数を定義しているようにも見える（実際は func キーワードがないので違う）ので、その点について追記しました。

[sunglass]

（ありがとうございます！勘違いしてました、、）