以前、通信部分の書き方を調べていたときに、

👉 【Swift】URLSession.shared.dataTask() をうまく使いこなせない 

古い API の公での dis がワロエタ。

👉 Use async/await with URLSession - WWDC21 - Videos - Apple Developer 

先人を敬えよ。

でも分かりやすくなって非常に良い。

 

🧑🏻‍💻 新しいAPIの使い分け

新しい API として以下が上げられている。

URLSession.shared.data() 
URLSession.shared.download()
URLSession.shared.upload()
URLSession.shared.bytes()

ドキュメントを見ながら、引数と戻り値がわかりやすように並べてみる。

func data(
    for request: URLRequest,
    delegate: (any URLSessionTaskDelegate)? = nil
) async throws -> (Data, URLResponse)

func data(
    from url: URL,
    delegate: (any URLSessionTaskDelegate)? = nil
) async throws -> (Data, URLResponse)

func download(
    for request: URLRequest,
    delegate: (any URLSessionTaskDelegate)? = nil
) async throws -> (URL, URLResponse)

func download(
    from url: URL,
    delegate: (any URLSessionTaskDelegate)? = nil
) async throws -> (URL, URLResponse)

func download(
    resumeFrom resumeData: Data,
    delegate: (any URLSessionTaskDelegate)? = nil
) async throws -> (URL, URLResponse)

func upload(
    for request: URLRequest,
    from bodyData: Data,
    delegate: (any URLSessionTaskDelegate)? = nil
) async throws -> (Data, URLResponse)

func upload(
    for request: URLRequest,
    fromFile fileURL: URL,
    delegate: (any URLSessionTaskDelegate)? = nil
) async throws -> (Data, URLResponse)

func bytes(
    for request: URLRequest,
    delegate: (any URLSessionTaskDelegate)? = nil
) async throws -> (URLSession.AsyncBytes, URLResponse)

func bytes(
    from url: URL,
    delegate: (any URLSessionTaskDelegate)? = nil
) async throws -> (URLSession.AsyncBytes, URLResponse)

なんとなく見えてきます。

 

🧑🏻‍💻 使い分けの基準

使い分けの基準としては、

「受け取りたいデータ形式」

ですね。

受け取ってからの利用するデータ形式が、

テキスト → .data()

ファイル → .download()

バイトバッファー → .bytes()

となります。

あとは、その他として

ファイルを送りたい → .upload()

となります。

リクエスト後のレスポンスは、すべてにある戻り値 URLResponse を使って

urlresponse as? HTTPURLResponse

のようにダウンキャストして、レスポンスコードなどを確認します。

 

🧑🏻‍💻 URL か URLRequest か

それぞれのメソッドに引数には、URL か URLRequest があります。

これらの使い分けとしては、

リクエストメソッド・ヘッダーのカスタムが

必要でない → URL

必要 → URLRequest

というかんじでしょうか。

リクエストヘッダーのカスタムは以下のような感じで書けるようです。

var request = URLRequest(url: url)
request.httpMethod = "POST"
request.setValue("application/json", forHTTPHeaderField: "Accept")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.setValue("Bearer 123456ABC", forHTTPHeaderField: "Authorization")
request.httpBody = try! JSONEncoder().encode(User(name: "John", age: 15))

let (data, response) = try await session.data(for: request)
print((response as! HTTPURLResponse).statusCode)
print(String(data: data, encoding: .utf8)!)

 

🧑🏻‍💻 まとめ

「リクエストヘッダーを常に意識しながら、JSONを受け取る。」

という感じの以下が最も使える基本的なメソッドとなるように思います。

func data(
    for request: URLRequest,
    delegate: (any URLSessionTaskDelegate)? = nil
) async throws -> (Data, URLResponse)

このメソッドだけで、

リクエストメソッドとヘッダー次第で、

ほとんどできるのではないかと思ったりもする。

👉 【Swift】ファイルやディレクトリのパスが長すぎていやだ – URL.shortPath() 

最後に、便利な無料確認サービスをどうぞ。

👉 httpbin.org 

関連ワード:  iOS・iPhone・mac・macOS・Swift・今さら聞けない・初心者