DispatchGroupを利用するwhile文の条件の設定の仕方

Question

前提・実現したいこと

SwiftUIを利用してアプリを開発しています。

DispatchGroupを利用するwhile文から取得する値を、同じwhile文をloopさせるかどうかの条件の値として利用したいです。

---

例えば、下記のコードに載せているメソッドを以下のように呼んだ場合：
makeGetCallDateOverSetTemp(start_date:"2020-11-01", set_temp:100)

• 1回目 loop -> totalTemp = 20 (2020-11-01の気温は20℃)
• 2回目 loop -> totalTemp = 50 (2020-11-02の気温は30℃)
• 3回目 loop -> totalTemp = 80 (2020-11-03の気温は30℃)
• 4回目 loop -> totalTemp = 105 (2020-11-04の気温は25℃)

5番目は、while文の条件としているtotalTempが、2番目の引数に渡した100を超えるため、loopが止まる

という動きにしたいです。

該当のソースコード

AppState.swift

@Published var weatherInfos:[WeatherInfos]?


func makeGetCallDateOverSetTemp(start_date:String, set_temp:Int){
    
    let start_date = self.dateFromString(string: start_date, format: "yyyy/MM/dd")
    var addDays = 0
    var totalTemp:Float = 0.0
    
    let group = DispatchGroup()
   
    // Set up the URL request
    while Float(set_temp) < totalTemp {
        
        let start_date = Calendar.current.date(byAdding: .day, value: addDays, to: start_date)
        let url_start_date = self.stringFromDate(date: start_date!, format: "yyyy-MM-dd")
        
        let endpoint: String = "https://sample.com/api/weather/?start_date=(url_start_date)"
        addDays += 1
        
        guard let url = URL(string: endpoint) else {
            print("Error: cannot create URL")
            continue
        }
        var urlRequest = URLRequest(url: url)
        urlRequest.addValue("token xxxxxxxxxxx", forHTTPHeaderField: "authorization")
        // set up the session
        let config = URLSessionConfiguration.default
        let session = URLSession(configuration: config)
        // make the request
        group.enter()
        let task = session.dataTask(with: urlRequest) {(data, response, error) in
            guard error == nil else {
                print("error calling GET")
                return
            }
            // make sure we got data
            guard let responseData = data else {
                print("Error: did not receive data")
                return
            }
            // check for any errors
            defer { group.leave()}
            // parse the result as JSON, since that's what the API provides
            DispatchQueue.main.async {
                do{
                    self.weatherInfos = try JSONDecoder().decode([WeatherInfos].self, from: responseData)
                    for info in self.weatherInfos!{
                        totalTemp += info.temp
                    }
                }catch{
                    print("Error: did not decode")
                    return
                }
            }
        }
        task.resume()
    }
    group.notify(queue: .main){
    print(url_start_date)
    }
}

func stringFromDate(date: Date, format: String) -> String {
    let formatter: DateFormatter = DateFormatter()
    formatter.calendar = Calendar(identifier: .gregorian)
    formatter.dateFormat = format
    return formatter.string(from: date)
}

func dateFromString(string: String, format: String) -> Date {
    let formatter: DateFormatter = DateFormatter()
    formatter.calendar = Calendar(identifier: .gregorian)
    formatter.dateFormat = format
    return formatter.date(from: string) ?? Date()
}

jsonModel.swift

struct WeatherInfos:Codable,Identifiable {
    var id: Int
    var temp: Float
}

---

追記

 func getTemperature(date: String) -> Double? {
        let semaphore = DispatchSemaphore(value: 0)
        
        let endpoint: String = "https://sample.com/api/weather_ave_day/?date=(date)"
        
        let url = URL(string: endpoint)
        
        var urlRequest = URLRequest(url: url!)
        urlRequest.addValue("token xxxxxxxxxxxxxxxxx", forHTTPHeaderField: "authorization")
        // set up the session
        let config = URLSessionConfiguration.default
        let session = URLSession(configuration: config)
        
        var temperature: Double = 0.0
        
        let task = session.dataTask(with: urlRequest) {(data, response, error) in
            guard error == nil else {
                print("error calling GET")
                return
            }
            // make sure we got data
            guard let responseData = data else {
                print("Error: did not receive data")
                return
            }
            DispatchQueue.main.async {
                do{
                    self.weatherInfos = try JSONDecoder().decode([WeatherInfos].self, from: responseData)
                    for info in self.weatherAveInfos!{
                        temperature += Double(info.ave_temp)
                    }
                    
                    print("weatherInfos:(self.weatherInfos as Any)") // 11.9
                }catch{
                    print("Error: did not decode")
                    return
                }
            }
            semaphore.signal()
        }
        task.resume()
        semaphore.wait()
        
        print("returnValue:(temperature as Any)") // 0.0
        return temperature
    }

メソッドの呼び出し

 Button(action: {
                appState.getTemperature(date: "2020-11-11")
                }
        ) {
           Text("取得")
          } 

実行結果

returnValue:0.0
weatherInfos:Optional([Sample.WeatherInfos(id: 6, temp: 11.9)])

補足情報（FW/ツールのバージョンなど）

Xcode:Version 12.0.1

Answer 1

いろいろなことを一つのメソッドでいっぺんにしない方がいいです。

僕なら同期的にある日時の気温を取得するメソッドを作りますね。
つまり、

func getTemperature(on: Date) -> Double? {
  let semaphore = DispatchSemaphore(value: 0)
  
  let session = // URLSessionの作成と設定
  
  var temperature: Double?
  
  let task = session.dataTask(with: urlRequest) {(data, response, error) in
    // いろいろ
    
    temperature = 気温
    
    semaphore.signal()
  }
  
  semaphore.wait()
  
  return temperature
}

こういうの。

そうするとループは単純に

var totalTemperature = Double(0)

while totalTemperature < limit {
   
   let date = //日付処理
   
   totalTemperature += getTemperature(on: date) ?? 0.0
   // ↑このエラー処理（nilの時の処理）はダメな見本です。
   // 実際はちゃんとしてください。
}

とするだけで済みます。

Comments

[tomaa]

回答していただきありがとうございます。回答を参考にしまずは、同期的に温度を取得するメソッドを作成しました（質問に追記として記載）。
しかし、私が修正したコードでは同期的に動かない状況です。
回答していただいた内容では、`task`が実行されていなかったので、それらしい場所で`task.resume()`をしています。
他に不備等ありますでしょうか？

[MasakiHori]

DispatchQueue.main.async を DispatchQueue.main.sync (同期実行）にしてください。

[tomaa]

DispatchQueue.main.sync (同期実行）で試してみました。
メソッドを呼ぶと、アプリが固まってしまします。エラー等は出ず、その後の動作は何もできなくなります。

[MasakiHori]

もしかしてこのメソッド（makeGetCallDateOverSetTemp）はメインスレッド上から呼び出してますか？
メインスレッド上でスレッドをブロックするのは全くよろしくないのでやめましょう。

このメソッドをDispatchQueue.global().asyncなどを用いて非同期に呼び出してください。
あるいはこのメソッド内での処理をDispatchQueue.global().asyncで行い即座に呼び出し元に処理を返してください。

[tomaa]

今は、動作の確認のため`getTemperature ()`を単体で動かしています。
期待通りの動作する事を確認した後に、`while`文の中で使用するつもりです。
質問に呼び出し元のコードを追記しました。
この場合も、メインスレッド上で呼び出している事になりますでしょうか？

[MasakiHori]

Target-Actionはすべてメインスレッド上で処理されます。
テストということでしたらgetTemperatureをラップする
func getTemperatureAsync(date: String) {
DispatchQueue.global().async { self.getTemperature(date: date) }
}
を作ってこちらをアクションに指定すれば動くと思われます。

[tomaa]

func getTemperatureAsync(date: String) {
DispatchQueue.global().async { self.getTemperature(date: date) }
}
の方法をとり、`getTemperature`の動作の確認がとれました。
その後、今回の目的である`while`文に使用しようとしましたが、こちらでも複数回の非同期処理（DispatchQueue.global().async）を行う必要があり（syncにするとアプリがクラッシュする）、totalTempがずっと0.0という条件となってしまいます。
回答欄にwhile文使用のコードを記載しましたが、修正できる方法はありますでしょうか？

[MasakiHori]

関数内の”すべて"の処理をDispatchQueue.global().async{} のクロージャ内に記述してください。
変なところだけ非同期にしないでください。

[MasakiHori]

非同期処理のゆるーいイメージとしては、与えられた処理を０秒後に実行されるタイマーにセットして処理を戻す、です。
タイマーを起動するためにも時間は必要ですので０秒後であってもすぐに処理が始まるわけではありません。
処理から戻った時点ではタイマーがまだ動いていないかもしれませんし、与えた処理が完了していないかもしれません。
つまり一般的にはasyncから処理が戻ってきた時点では与えた処理は終わっていません。
これを決して忘れないでください。

[tomaa]

関数内の”すべて"の処理をDispatchQueue.global().async{} のクロージャ内に記述し、期待どおりの動きとなりました。
長い時間、ご丁寧に教えていただきありがとうございました。
おかげで非同期処理の知識が深まり、DispatchSemaphoreの使い方を知る事ができました。
DispatchSemaphoreは非同期処理を同期的に行う場面で活用できそうです。

Answer 2

  func getTemperatureAsync(date: String) {
        
        var totalTemp:Double = 0.0
        
        while totalTemp < 100
        {
            DispatchQueue.global().async { //ここでasyncとするため非同期処理となる
                totalTemp += self.getTemperature(date: date)
            }
        }
    }