Skip to content

Latest commit

 

History

History
289 lines (209 loc) · 7.9 KB

About_URLSession.md

File metadata and controls

289 lines (209 loc) · 7.9 KB
Raw

NSObject - URLSession

Swift에서 데이터 통신을 하는 가장 기본적인 방법은 URL Session을 사용하는 방법이다.


데이터 요청을 하는 과정은 아래와 같다. - URL 구조체 생성 : 경로 생성 - URLSession 생성 : 브라우저를 켜는 행위 - dataTask : 작업을 정의 - resume : 시작 선언

위에 대한 결과로 서버에서 응답을 리턴하게 된다.

  • URLSession: URLSession은 웹 서버에 데이터를 전송하거나 데이터를 수신하는 네트워크 통신을 처리하는 객체.
  • URLRequest: URLRequest는 웹 서버에 보낼 요청의 정보를 제공하는 객체.



1. URL 구조체 생성

기본적으로 문자열로 이루어진 경로를 담은 변수는 말그대로 문자열일 뿐이다.
네트워크 통신을 하기위한 형태로 가공하기위해 해당 경로를 가지고 URL이라는 구조체로 변형한다.

URL을 생성할 때, 옵셔널 타입으로 리턴하는데
그 이유는 해당 문자열이 유효할 지 아닐지 모르기 때문이다.

let urlString = "https://www.naver.com"
guard let requestURL = URL(string: urlString) else { return }

2. URLSession 생성

웹페이지 하나 하나가 URLSession의 요청으로 생성되는 것처럼,
앱에서의 요청도 URLSession을 통해 이루어진다.

URLSession은 애플에서 미리 만들어둔 Foundation 프레임워크에 있는 객체다.
싱글통으로 구현되어있어, URLSession.shared 를 사용한다.

이 객체를 사용하여 HTTP GET, POST, PUT, DELETE 등의 네트워크 요청을 처리할 수 있다.

HTTP 요청을 사용하여 RESTful API를 호출하는 것이 가장 기본적인 방법이다.



3. dataTask

dataTask는 URLSession이 갖고 있는 메서드다.
이 메서드를 찾아보면 파라미터로 URL을 받는게 있고 URLRequest를 받는 메서드가 있다.


extension URLSession {
    open func dataTask(with request: URLRequest, completionHandler: @escaping @Sendable (Data?, URLResponse?, (any Error)?) -> Void) -> URLSessionDataTask

    open func dataTask(with url: URL, completionHandler: @escaping @Sendable (Data?, URLResponse?, (any Error)?) -> Void) -> URLSessionDataTask
}

만약 GET메서드로 단순히 URL만 가지고 조회를 요청할 거라면

  1. URL만 넣어서 사용하거나,
  2. URL을 담은 URLRequest를 만들어서 사용가능하다.

POST메서드의 경우 반드시 URLRequest를 생성해서 사용해야한다.

GET 요청으로 웹 API에 접근하는 예제.

let url = URL(string: "https://api.example.com/data")!
let task = URLSession.shared.dataTask(with: url) { (data, response, error) in
    if let data = data {
        let result = String(data: data, encoding: .utf8)
        print(result)
    }
}
task.resume()


// 혹은 request를 만드는 경우

let url = URL(string: "https://api.example.com/data")!

var request = URLRequest(url: url)

// HTTP 메서드 설정
request.httpMethod = "GET"

let task = URLSession.shared.dataTask(with: request) { (data, response, error) in
    if let data = data {
        let result = String(data: data, encoding: .utf8)
        print(result)
    }
}
task.resume()



POST 사용하기

POST 메서드를 사용하기 위해서는 URLRequest를 만들어야만 한다.

guard let url = URL(string: "https://www.example.com/post") else { return }
var request = URLRequest(url: url)
request.httpMethod = "POST"

let parameters = ["key": "value"]
let data = try! JSONSerialization.data(withJSONObject: parameters, options: [])
request.httpBody = data

let task = URLSession.shared.dataTask(with: request) { data, response, error in
    guard let data = data, error == nil else {
        print(error?.localizedDescription ?? "No data")
        return
    }

    let responseJSON = try? JSONSerialization.jsonObject(with: data, options: [])
    if let responseJSON = responseJSON as? [String: Any] {
        print(responseJSON)
    }
}

task.resume()



서버가 개발이 안된 경우

이럴 때에는 앱 입장에선 약속된 더미데이터를 만들어서 사용할 수 밖에 없다.

  • String형태로 먼저 더미데이터를 생성
  • 더미데이터를 JSONEncoding 하여 사용

해당 내용은 아래 글을 참고하자.

이제 여기서 들어오는 Response에 대한 처리를 위해서는 아래 글을 참고하자.



Alamofire

Alamofire는 iOS에서 HTTP 네트워크 통신을 다루는 라이브러리다. 아래는 Alamofire를 사용하여 GET 요청을 보내는 예제이다.

GET형식

import Alamofire

AF.request("https://api.example.com/data")
    .response { response in
        if let data = response.data {
            let result = String(data: data, encoding: .utf8)
            print(result)
        }
    }

또는

import Alamofire

AF.request("https://www.example.com/api/v1/data").responseJSON { response in
      if let data = response.data {
          print("Success: \(data)")
      } else {
          print("Error: \(String(describing: response.error))")
      }
  }



POST형식

여기에서 Post는 API가 반환하는 JSON 데이터를 매핑하는 Swift 구조체다.

import Alamofire

let parameters: [String: Any] = ["key": "value"]

AF.request("https://www.example.com/post", method: .post, parameters: parameters, encoding: JSONEncoding.default)
    .validate()
    .responseJSON { response in
        switch response.result {
        case .success(let value):
            print(value)
        case .failure(let error):
            print(error)
        }
    }



Alamofire의 6가지 response handler

    1. response
AF.request("https://api.example.com/data").response { response in
        if let data = response.data {
            let result = String(data: data, encoding: .utf8)
            print(result)
        }
    }
    1. reponseData
AF.request("https://www.example.com/api/v1/data").responseData { response in
    switch response.result {
        case .success(let data):
            print("Success: \(data)")
        case .failure(let error):
            print("Error: \(error)")
    }
}
    1. responseString
import Alamofire

AF.request("https://httpbin.org/get").responseString { response in
    switch response.result {
    case .success(let value):
        print(value)
    case .failure(let error):
        print(error)
    }
}
    1. responseJSON 상단 post부분 참조
    1. responseDecodable responseDecodable 메서드는 응답 데이터를 [Post] 타입으로 자동으로 디코딩하고, 결과가 성공하면 response.value에 값이 할당된다.
import Alamofire

AF.request("https://your-api.com/posts").responseDecodable(of: [Post].self) { (response) in
    if let posts = response.value {
        // do something with your decoded posts
    }
}



Validation

유효성검사는 요청에 대한 response를 하기 전에 .validate()를 호출함으로써 유효하지 않은 상태 코드나 MIME타입이 있는 경우 response하지 않도록 한다.

일반적인 사용 방법은 아래와 같고

AF.request(url)
  .validate()
  .response { response in 
     print(response)
}

상태 코드나 MIME 타입 조건을 넣는 방법은 다음과 같다.

AF.request(url)
  .validate(200..<300) // 200~300 사이 상태코드만 허용
  .validate(contentType:["application/json"]) // JSON 포맷만 허용
  .response { response in 
      print(response)
}

주석처럼 위 코드는 해당 URL에 대한 응답 처리를 상태코드가 200~300이면서 JSON 포맷일 때 응답처리를 한다.