[ Swift ] 네트워크 통신 - URLSession

URLSession은 Swift에서 서버와 소통하기 위해 제공되는 클래스.

URLSession을 사용하면 데이터 다운로드, 업로드, API 요청 등을 쉽게 수행할 수 있다.

URLSession은 네트워크 요청을 처리하고 응답을 받아오는 과정을 관리한다.

 

서드파티 라이브러리인 Alamorfire와 moya도 있다.  

 

 

---

✅ URLSession의 주요 구성 요소

 

🌟 1. URLSession

: 네트워크 요청을 수행하는 주요 객체

 

 

 

🌟 2. URLSessionConfiguration

: 세션을 구성하는 환경 설정을 의미하는 속성

 

- .default

기본 통신으로 디스크를 이용한 정보 저장을 하는 configuration

그냥 브라우저 띄울때

let defaultSession = URLSession(configuration: .defualt)

 

 

- .ephemeral

default 랑 비슷하지만, 쿠키나 인증서, 캐시 등을 저장하지 않을 때 사용

ex) 브라우저 시크릿 모드, Safari의 개인 정보보호 모드 

let ephemeralSession = URLSession(configuration: .ephemeral)

 

 

- .background

네트워크를 통해 파일 다운로드 받을때

ex) 앱이 백그라운드에 있을 때, 다운로드/업로드할 때 사용

let backgroundSession = URLSession(configuration: .background)

 

 

 

🌟 3. URLSessionTask

: 데이터 전송 작업

 

- URLSessionDataTask

서버에서 메모리로 데이터를 가져오거나 데이터를 서버로 보낼 때 사용.

서버에 짤고, 자주 요청되는 작업에 대해 사용된다. 

백그라운드에서는 지원❌

 

- URLSessionDownloadTask

데이터를 파일의 형태로 읽고 대용량 파일을 다운로드할 때 사용.

다운받은 파일을 임시 디렉토리에 저장해두고 다운로드에 성공했다면 디렉토리의 주소를 completion handler에 반환한다. 

이때 임시 파일을 completionHandler가 종료되기 전 다른 디렉토리에 옮겨줘야 데이터가 삭제가 안된다. 

백그라운드에서 지원

 

- URLSessionUploadTask

데이터를 서버로 업로드할 때 사용.

백그라운드에서 지원

 

- URLSessionWebSocketTask

TCP나 TLS를 통해 메시지를 주소 받을 때 사용

 

 

 

✅ URLSession의 사용 방법

1. URLSessionConfiguration 설정

기본 설정, 임시 설정, 백그라운드 설정 등 다양한 구성을 사용할 수 있다.

let defaultSession = URLSession(configuration: .default)

 

URLSessionConfigration 객체가 세션에 한번 설정 된 이후 수정은 무시가 되기 때문에,

새로운 URLSession 인스턴스를 사용해야 한다. 

 

또한, URLSession은 앱 전역에서 사용되기 때문에 shared라는 이름으로 싱글톤  세션도 가능하다. 

이 세션은 설정 객체를 가지고 있지 않아, configuration을 바꾸기 위해서는 추가 설정이 필요하다. 

싱글톤 객체를 사용할 경우 세션을 따로 생성할 필요가 없다.  

 

 

 

 

2. URLSession 인스턴스 생성

설정을 사용하여 URLSession 인스턴스를 생성한다.

 

 

3. URLRequest 객체 생성 

요청할 URL과 기타 요청 정보를 포함하는 URLRequest 객체를 생성 

• URL
  요청을 보낼 대상의 URL로, URL 객체를 통해 설정된다.

var request = URLRequest(url: URL(string: "https://example.com")!)

• HTTP Method
  요청의 유형을 나타내는 메서드로는 GET, POST, PUT, DELETE 등이 있다.

request.httpMethod = "GET"

• HTTP Headers
  요청에 대한 추가 정보를 제공하는 키-값 쌍이다. 예를 들어, Content-Type, Authorization, User-Agent 등이 있다.

request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.setValue("Bearer token", forHTTPHeaderField: "Authorization")

• HTTP Body
  주로 POST나 PUT 요청에서 사용되며, 서버로 전송할 데이터를 담고 있다. Data 객체로 설정된다.

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

• Cache Policy
  캐시된 응답 데이터를 사용할지 여부를 결정한다.
  기본값은 .useProtocolCachePolicy이며,
  다른 옵션으로는 .reloadIgnoringLocalCacheData, .returnCacheDataElseLoad, .returnCacheDataDontLoad 등이 있다.

request.cachePolicy = .reloadIgnoringLocalCacheData

• Timeout Interval
  요청이 시간 초과로 실패하기 전까지 대기하는 시간을 지정한다. 기본값은 60초.

request.timeoutInterval = 30.0  // 30초로 설정

• Network Service Type
  요청이 사용하는 네트워크 서비스 유형을 지정한다.
  기본값은 .default이며, 다른 옵션으로는 .background, .video, .voice, .responsiveData 등이 있다.

request.networkServiceType = .video

 

 

 

4. URLSessionDataTask 생성 및 실행

데이터 요청을 비동기로 수행하기 위해 URLSessionDataTask를 생성하고 실행한다.

URL 생성과 필요한 정보를 이제 요청하는 부분이다. 

URLSession에서 URL을 요청 후 dataTask에서 응답이 오면 코드 수행 

 

응답은 completion(closure)와 delegate 두 가지 방법이 있다. 

 

세션 내에서 진행되는 Task들은 공통된 Delegate 객체를 공유하고 있다. 

이 Delegate를 구현하면 통신과정에서 발생하는 권한 인증 실패, 서버로부터의 데이터 도착, 데이터 캐싱 등

다양한 이벤트에 대한 정보를 받을 수 있다. 

 

Delegate가 필요하지 않다면, Session을 생성할 때  인자로 nil을 전달한다. 

// URLSession 생성, delegate 인자로 nil을 전달
let session = URLSession(configuration: configuration, delegate: nil, delegateQueue: nil)

세션 객체는 Delegate를 앱이 종료되거나 세션이 끝날 때까지 강하게 참조한다. 

메모리 릭을 방지하기 위해 더이상 사용하지 않는 세션은 invalidateAndCancel() 메서드를 호출해 무효화한다. 

// 세션 무효화 및 취소
session.invalidateAndCancel()

 

 

 

---

✅ URLSession을 사용한 예제

간단한 GET 요청을 보내고 JSON 응답을 처리하는 예제

import UIKit

class ViewController: UIViewController {

    override func viewDidLoad() {
        super.viewDidLoad()
        fetchData()
    }
    
    // 서버 데이터를 불러오는 메서드 선언
    private func fetchData() {
        
        let defaultUrlSession = URLSession(configuration: .default)
        
        guard let url: URL = URL(string: "https://reqres.in/api/users/1") else {
            print("URL is not correct")
            return  //함수의 실행을 즉시 종료하고 함수가 Void를 반환
        }
        
        // URLRequest 인스턴스 설정
        var request: URLRequest = URLRequest(url: url)
        
        // 요청에 사용할 HTTP메서드 설정 - GET 메소드 사용
        request.httpMethod = "GET"
        
        // HTTP 헤더 설정 - json 데이터 형식임을 나타냄
        request.addValue("application/json", forHTTPHeaderField: "Content-Type")

        // URLSession 생성 (기본 default 세션)
        let session: URLSession = URLSession(configuration: .default)

        // dataTask - URLSession을 사용해 요청 수행 
        session.dataTask(with: request) { (data, response, error) in
		        // http 통신 response 에는 status code 가 함께오는데, 200번대가 성공을 의미.
            let successRange: Range = (200..<300)
            
            // 통신 성공
            guard let data, error == nil else { return }
            
            if let response: HTTPURLResponse = response as? HTTPURLResponse{
                print("status code: \(response.statusCode)")
                
                // 요청 성공 (StatusCode가 200번대)
                if successRange.contains(response.statusCode){
                    
                    // decode
                    guard let userInfo: ResponseData = try? JSONDecoder().decode(ResponseData.self, from: data) else { return }
                    print(userInfo)
                    
                } else { // 요청 실패 (Status code가 200대 아님)
                    print("요청 실패")
                }
            }
            
        }.resume() //작업 시작
    }
}

// 데이터 구조체 정의
struct UserData: Codable {
    let id: Int
    let email: String
    let firstName: String
    let lastName: String
    let avatar: URL
    
    // JSON 키와 구조체 프로퍼티 간의 매핑을 위해 CodingKeys 열거형 정의
    enum CodingKeys: String, CodingKey {
        case id
        case email
        case firstName = "first_name"
        case lastName = "last_name"
        case avatar
    }
}

// Support 구조체 정의
struct SupportData: Codable {
    let url: URL
    let text: String
}

// 최상위 구조체 정의
struct ResponseData: Codable {
    let data: UserData
    let support: SupportData
}

 

 

🌟 Codable 프로토콜을 준수하는 구조체에서 CodingKeys를 사용하는 이유?

Codable 프로토콜을 준수하는 구조체에서 CodingKeys를 사용하는 주된 이점은

JSON 데이터의 키와 Swift 구조체의 프로퍼티명이 다를 때, 이를 매핑해줄 수 있는 유연성을 제공한다.

주로 다음과 같은 경우에 활용된다. 

 

• 프로퍼티 명명 규칙이 다른 경우
  : JSON 데이터의 키가 snake_case 형식이거나 다른 명명 규칙을 따르는 경우,
  Swift의 camelCase 명명 규칙에 맞추기 위해 CodingKeys를 사용.
• 일부 데이터만 디코딩/인코딩
  : JSON에는 필요한 일부 데이터만 있을 경우, CodingKeys를 사용하여 필요한 데이터만 처리.
• 기본값 처리
  : JSON에 특정 키가 없을 때 기본값을 사용하도록 CodingKeys 설정.

 

 

 

🌟 URLSession의 .default과 .shared의 차이점?

- URLSession.shared
: 애플리케이션 내에서 기본적으로 제공되는 URLSession 인스턴스.

앱 전체에서 공유되며, 기본 구성을 사용하여 네트워크 요청을 처리한다.

대부분의 경우에서 사용할 수 있고, 추가적인 세부 설정이 필요하지 않을 때 사용.

 

- URLSession(configuration: .default)
: 개발자가 직접 구성을 설정하여 생성하는 URLSession 인스턴스.

기본 구성과는 다른 타임아웃, 캐시 정책 등의 옵션을 추가로 설정할 수 있다.

특정 요구사항에 맞춰 특정 타임아웃이나 캐시 정책 설정과 같은 세부적인 커스터마이징이 필요할 때 사용.

 

 

 

🌟 네트워크 요청을 보낼 때 주요 HTTP 헤더들의 종류와 역할

네트워크 요청 시 특정한 HTTP 헤더를 설정하면 서버와의 통신을 더욱 정교하게 제어할 수 있다.

 

• Content-Type
  : 요청 바디의 미디어 타입을 정의. 주로 JSON 데이터를 전송할 때 사용.
  예: Content-Type: application/json
• Accept
  : 클라이언트가 원하는 응답의 미디어 타입을 서버에 알림. 서버는 이를 참고하여 적절한 포맷으로 응답.
  예: Accept: application/json
• Authorization: 인증 정보를 서버에 전달하여 보안적인 접근을 제어. 주로 토큰 기반 인증에서 사용.
  예: Authorization: Bearer {token}
• User-Agent
  : 클라이언트 애플리케이션 정보를 서버에 제공하여, 서버가 요청을 받은 클라이언트 종류를 식별.
  예: User-Agent: MyApp/1.0 (iOS 14.5; iPhone 12)
• Cache-Control: 캐싱 동작을 설정. 클라이언트와 서버 간 캐싱 정책을 조정.
  예: Cache-Control: no-cache
• Cookie: 클라이언트가 서버에 보낸 쿠키를 포함하여 세션 관리 등.
  예: Cookie: sessionid=123456

 

 

🌟 HTTP요청의 헤더를 설정할 때 사용되는 URLRequest 객체에서 사용되는 메서드

• addValue(_:forHTTPHeaderField:)
  : 지정된 HTTP 헤더 필드에 값을 추가한다. 동일한 헤더 필드가 이미 존재하는 경우, 기존 값에 추가
• setValue(_:forHTTPHeaderField:)
  : 지정된 HTTP 헤더 필드에 새 값을 설정한다. 동일한 헤더 필드가 이미 존재하는 경우, 이전 값은 대체됨.
• allHTTPHeaderFields
  : 현재 설정된 모든 HTTP 헤더 필드를 가져오거나 설정.
• httpMethod
  : HTTP 요청 메서드(예: GET, POST 등)를 설정.
• httpBody
  : HTTP 요청의 본문 데이터를 설정.
• timeoutInterval
  : 네트워크 요청의 타임아웃 시간을 설정.

 

이들 메서드들을 적절히 활용하여 URLRequest 객체를 구성하면, 원하는 형태의 HTTP 요청을 보내고

필요한 헤더나 데이터를 포함할 수 있다.

 

 

 

 

🔗 Reference
https://jeonyeohun.tistory.com/357
https://jazz-the-it.tistory.com/19