class funcを利用してAPI取得用のメソッドを共通化したい

Question

質問失礼します。

アプリ内の複数箇所で同じAPIを使用する為、API検索用の値を引数にして
取得した値をエンティティクラスとして返すclass funcをUtilクラスに作成したいです。

下記の様にコードを記載して挙動を確認したのですが、
APIから情報を取得するクロージャーの中身がいつ発動されるか分からず、
値が必要な画面遷移前までに値を取得出来ずにいます。
（現状では画面遷移前のprintの後にクロージャー内のprintが表示される為、順序が逆になってしまいます）

これはどの様にコードを修正すれば解消する事ができるのでしょうか。
どなたかご教授いただけますと嬉しいです。
よろしくお願い致します。

コントローラークラス

//写真を撮影した後
    func imagePickerController(_ picker: UIImagePickerController, didFinishPickingMediaWithInfo info: [UIImagePickerController.InfoKey : Any]) {
        //インスタンスを用意しておく
        var dataList = DataList()
        
        if let pickedImage = info[.editedImage] as? UIImage {
            
            //イメージをbase64にエンコードする
                       let imageData = pickedImage.pngData()! as NSData
                     let imageString = imageData.base64EncodedString(options: .lineLength64Characters)
 
           //imageStringを引数として渡して、DataList型として値を受け取りたい           
            dataList = Util.returnData(image:imageString)

        }
                    print(dataList.data1)←値が空欄になってしまう
        
        //画面遷移する
        picker.dismiss(animated: true, completion: nil)
    }
}

エンティティクラス

class DataList {

    var data1 = ""
    var data2 = ""
    var data3 = ""

//値を設定する時だけ引数を渡してインスタンスを生成したい
    init(data1:String, data2:String, data3:String){

        self. data1 = data1
        self. data2 = data2
        self. data3 = data3
    }

//インスタンスの準備用
    init(){
    }
}

Utilクラス

class Util{
    
   class func returnData(image:String) -> DataList {
                //インスタンスを用意しておく
        var dataList = DataList()
 
       //JSONデータを取得する	
        session.dataTask(with: request) { (data, response, error) in
                if error == nil, let data = data, let response = response {
                
                let jsonData = try! JSONSerialization.jsonObject(with: data, options: JSONSerialization.ReadingOptions.allowFragments) as? [String: [String:Any]]
                
                if let data =  jsonData?["hits"] {
                    
                    let data1 = data["data1"] as! String
                    let data2 = data["data2"] as! String
                    let data3 = data["data3"] as! String
	//取得した値を格納する
                    dataList = DataList(data1,data2,data3)

                print(dataList.data1)←ここでは値を正常に取得出来る
                }
            } else {
                // API通信失敗
                print(error as Any)
            }
        }.resume()

print(dataList.data1)←ここでは値が空になってしまう

        return dataList
    }
}

＊コントローラークラスのAPIメソッド呼び出し箇所を修正＊

//写真を撮影した後
    func imagePickerController(_ picker: UIImagePickerController, didFinishPickingMediaWithInfo info: [UIImagePickerController.InfoKey : Any]) {
        
        if let pickedImage = info[.editedImage] as? UIImage {
            
            //イメージをbase64にエンコードする
                       let imageData = pickedImage.pngData()! as NSData
                     let imageString = imageData.base64EncodedString(options: .lineLength64Characters)
 
           var dataList = Util.returnData(image:imageString, completion: {
                      result in
                                        print(result.data1)←値が表示されない
                //商品リストへ遷移する
                      picker.dismiss(animated: true, completion: nil)←画面遷移しない
                  })
}

＊UtilクラスのAPI呼び出し箇所の修正＊

class Util{
    
   class func returnData(image:String), completion: @escaping (DataList) -> Void) {
                //インスタンスを用意しておく
        var dataList = DataList()
 
       //JSONデータを取得する	
        session.dataTask(with: request) { (data, response, error) in
                if error == nil, let data = data, let response = response {
                
                let jsonData = try! JSONSerialization.jsonObject(with: data, options: JSONSerialization.ReadingOptions.allowFragments) as? [String: [String:Any]]
                
                if let data =  jsonData?["hits"] {
                    
                    let data1 = data["data1"] as! String
                    let data2 = data["data2"] as! String
                    let data3 = data["data3"] as! String
	//取得した値を格納する
                    dataList = DataList(data1,data2,data3)
                }
            } else {
                // API通信失敗
                print(error as Any)
            }
        }.resume()
    }
}

Comments

[hoshi-takanori]

非同期なので値がいつ取得できるかは分かりません。値が取得できるまでは値が必要な画面に遷移しないようにするか、値がまだ取得できてなかったら「取得中です」と表示するなどの対応が必要になります。

[Ka_ya_]

hoshi-takanoriさん、ご回答ありがとうございます。
非同期の事をキチンと理解出来ていなかったので、
この機会にご回答いただいた内容を元にしっかり勉強しようと思います＾＾

Answer 1

クロージャの中の処理は非同期処理になっています。

クロージャ外部のprintはすぐに表示されますが、クロージャ内部の処理はデータを受信、もしくは受信失敗したときまで処理されませんから、そのタイミングでprintされます。

では、どのように解決すればいいかというと、一般的には処理完了時に実行するクロージャを別途渡して、そこで処理を行わせることになります。

つまり、return で値を返すのではなく、独自の処理を行うクロージャを引数として渡してあげて、それをデータ受診後に処理することで値を受け取る処理を行う必要があります。

Alamofireを使った例ですが、大まかな流れは同じです。
過去の回答が下記のリンクにありますので、一度ご覧になってご検討ください。

• Swift で TextField に取得してきた文字列を入れたい

Comments

[Ka_ya_]

TsukubaDepotさん、ご回答ありがとうございます。

クロージャーの処理がおかしかったのですね…！！
分かりやすく説明していただきありがとうございます＾＾

記載していただいたリンクを参考に修正したコードを質問内容に追記したのですが、
resultを受け取るクロージャーの中身が起動しないようで、
画面遷移をする事が出来ませんでした。

せっかく丁寧に記載のある回答を教えていただいたのに申し訳ないのですが、
よろしければどこがおかしいのか教えていただけますととても助かります。
たびたびお手数をおかけしますが、よろしくお願い致します。

[TsukubaDepot]

class func returnData(image:String), completion: @escaping (DataList) -> Void) {

ここで指定した completion を実行する部分が無いみたいです（ちなみに、Stringのあとの閉じるカッコが不要です）。
dataList = DataList(data1,data2,data3)
completion(dataList)
という具合に引数で指定したクロージャを実行する部分が必要になるのでご確認ください。

ところで、追記されたコードなどをXcodeに貼り付けても、カッコの位置などがおかしくエラーになる場合があります。
こちらとしても問題点を正確にご指摘したいので、コードはコピーアンドペーストして貼り付けるなど、実際に動くような形で転載していただけると助かります。

[TsukubaDepot]

ちなみに、引数として与えるクロージャ内部で pickerView のように UI部品を操作するメソッドを呼び出していますが、それらのメソッドはメインスレッドで呼び出すことが推奨されているため、
dataList = DataList(data1,data2,data3)
DispatchQueue.main.async {
completion(dataList)
}
のように、クロージャの呼び出しをメインスレッドで行うようにする必要があります。

[Ka_ya_]

TsukubaDepotさん、親切にご回答いただきありがとうございます。
せっかくお時間を割いて教えて下さっているのに、
コードに不備がありお手数をおかけして本当に申し訳ありません。
以後記載方法に気をつけようと思います。

お陰様で、コードを修正したところ無事動くようになりました＾＾
勉強不足でメインスレッドなどを意識した事がなかったのですが、
クロージャがマルチスレッドというものになるのですね…！！
新しい知識が知れて、とても勉強になりました。

いつも色々と丁寧に教えて下さり、本当にありがとうございます。