[iOS] 공식문서로 공부하는 URLSession

Apple Developer Documentation

URLSession 

URLSession은 네트워크 통신과 관련된 작업들의 그룹을 관리하는 객체입니다. Foundation 프레임워크에 포함되어 있고 클래스입니다. 

 

Overview

URLSession은 URL을 통해 특정되는 엔드 포인트에 대해 데이터를 업로드하거나 다운로드 할 수 있도록 API를 제공하는 클래스입니다. URLSession을 통해서 앱이 실행되지 않아도, 혹은 Suspended 상태여도(헐 처음알았네요..) 백그라운드에서 다운로드를 진행할 수 있게 도와줍니다. URLSessionDelegate나 URLSessionTaskDelegate를 사용하면 권한이나 리다이렉션, 작업 완료에 대한 이벤트를 받을 수도 있어요. 

 

오버뷰에는 이런 노트가 적혀져 있는데요, 오버뷰를 마저 보고 노트에서 소개하는 문서를 잠깐 살펴볼게요.

간략하게 URLSession API는 다른 클래스들과 복잡하게 얽혀서 사용되기 때문에 래퍼런스 문서만 보면 잘 와닿지 않을 수도 있다고 하는데 좀 잘 적어주지..

 

아무튼 앱에서는 여러개의 URLSession 인스턴스를 만들 수 있고, 각 인스턴스들이 데이터 통신과 관련된 작업들을 그룹지어서 관리하고 있어요. 예를 들어서 웹 브라우저 앱을 구현한다면, 브라우저의 각 탭이나 창에 대해 세션을 하나씩 만들어줘야할 수도 있고, 사용자가 웹서핑을 하는데 사용하는 세션, 그리고 동시에 백그라운드에서 다운로드를 수행하는 세션으로도 나눌 수 있죠. 

 

URL Loading System

더 진행하기 전에 공식문서에서 읽어보라고 추천해준  URL Loading System부터 읽어볼게요. 

 

URL Loading System 역시 Foundation 프레임워크에 포함된 기능인데요, 표준 인터넷 프로토콜(HTTP를 말하는 것이겠죠?)을 통해 URL로 식별되는 서버와 통신을 가능하게 해준다고 소개하고 있어요. Loading은 비동기적으로 수행되고 덕분에 우리의 앱은 데이터를 주고받는 작업을 하면서도 계속 사용자와 상호작용할 수 있죠.

 

URLSession을 사용하면 하나 이상의 URLSessionTask 인스턴스를 만들 수 있고, 이 인스턴스가 통신을 통해 데이터를 받아 앱에 전달하는 역할을 하게됩니다. 만약 각 세션에 대한 자세한 설정을 지정하고 싶다면 URLSessionConfiguration 객체를 통해 설정을 만들 수 있고, 이 설정에서 캐시와 쿠키를 어떻게 사용할건지, 셀룰러 네트워크를 허용할 것인지 등 다양한 정보를 설정할 수 있어요. 

 

하나의 세션을 통해서 반드시 하나의 URLSessionTask만 만들 수 있는 것은 아니고 여러개의 Task를 생성하는 것도 가능합니다. 예를 들면 웹 브라우저에 두개의 세션을 두고 한 세션은 일반 모드일 때의 Task를 계속 생성하고, 사생활 보호모드일 때는 캐시를 남기지 않는 설정을 세션에 적용해 이 안에서 Task를 생성해 사용하게 할 수 있습니다.

 

URLSessionConfiguration에 대해서는 위 문서에 각 설정별로 상세하게 나와있는데요, 나중에 시간을 내서 한 번 읽어보아야겠습니다..!

 

Type of URL Sessions

한 세션에서 생성되는 Task들은 모두 세션의 설정을 공유하고 있어요. 위에서 언급한 셀룰러 뿐만 아니라 세션에 한번에 연결할 수 있는 호스트의 최대 수와 같은 설정들도 만들어줄 수 있죠. 

 

URLSession은 shared라는 이름으로 싱글톤 세션을 가지고 있는데요, 이 세션은 설정 객체를 가지고 있지 않습니다. 아주 기본적인 데이터 전송만을 지원하는 세션인거죠. 이 세션은 직접 세션을 만든는 것처럼 커스터마이징을 할 수는 없지만 제한적인 기능만을 사용한다면 유용하게 사용할 수 있습니다. 

 

만약 세션 인스턴스를 직접 만들고자한다면 세 종류의 설정을 가지고 만들 수 있습니다. 

 

1) 먼저 Default 세션인데요, shared 인스턴스처럼 아주 기본적인 기능만을 제공하지만 이번에는 직접 설정들을 줄 수 있다는 점에서 차이가 있습니다. Delegate를 설정할 수도 있어요.

 

2) 그 다음은 Ephemeral 세션입니다. 아까 사생활 보호 브라우저 모드를 말하면서 첨부한 사진에 나와있었는데요, shared 인스턴스처럼 기본적인 기능을 제공하지만, Ephemeral 세션은 캐시, 쿠키, 인증정보를 디스크에 남기지 않아요. 

 

3) 마지막으로 Background 세션인데요, 업로드나 다운로드를 앱이 실행중이 아니더라도 진행하고 싶다면 이 세션을 사용할 수 있습니다.

 

이 문서에 따르면 URLSessionConfiguration 객체가 세션에 한번 설정되고난 뒤에 통신 정책을 수정하고자 한다면, 기존 세션이 아니라 새로운 URLSession 인스턴스를 사용해야 해요. 한번 정해진 뒤에는 새로운 URLSessionConfiguration가 들어와도 무시됩니다.

 

Types of URL Session Tasks

URLSession은 작업들을 관리하는 세션 객체이고, 실제로 데이터를 받거나 올리는 작업은 Task 라는 단위로 이루어지고 있습니다. 각 세션 안에서는 Task 가 하는 일에 따라 여러 종류의 Task를 정의할 수 있습니다.

 

1) 먼저 Data Task 는 NSData 객체로 데이터를 올리고 내려받아요. Data task는 서버에 짧고, 자주 요청되는 작업에 대해 사용하게 됩니다(지금까지 이미지 다운로드를 Data Task로 해왔는데 반성하게 되네요..). 

 

2) Upload Task는 Data Task와 유사하지만 데이터를 전송하고 백그라운드에서 전송이 가능하게 합니다.

3) Download Task는 데이터를 파일의 형태로 읽고 앱이 실행되지 않을 때도 백그라운드에서 다운로드가 가능하도록 합니다(문서에는 downloads and uploads 라고 되어 있는데 URLSessionDownloadTask 문서에는 upload와 관련된 내용이 없네요.. 잘못적힌 것 같은데 알고 계시는 내용이 있다면 알려주세요!).

 

다른 태스크와는 다르게 Download Task는 다운로드 받은 파일을 임시 디렉토리에 저장해요. 그리고 다운로드가 성공하면 해당 디렉토리의 주소를 completion handler에 반환합니다.  이 임시 파일을 completionHandler가 종료되기 전에 반드시 다른 디렉토리로 이동시켜주어야 합니다. 그렇지 않으면 completion handler의 반환과 함께 데이터가 삭제됩니다.

 

4) 마지막으로 WebSocket Task는 TCP나 TLS를 통해 메시지를 주고받을 수 있게 합니다.

 

Session Delegate 사용하기

세션 내에서 진행되는 Task들은 모두 공통된 Delegate 객체를 공유하고 있습니다. 이 Delegate를 구현하면 통신과정에서 발생하는 여러 이벤트에 대한 정보를 받을 수 있습니다. 권한 인증에 실패하거나, 서버로부터 데이터가 도착하거나, 데이터가 캐싱이 가능할 때와 같은 이벤트에 대한 로직을 작성할 수 있죠.

 

만약 Delegate가 필요하지 않다면 Session을 생성할 때 인자로 nil을 전달하면 됩니다.

중요한 내용이 있는데요, 세션 객체는 delegate를 앱이 종료되거나 세션이 끝날 때까지 강하게 참조한다고 합니다. 따라서 세션이 종료되지 않으면 메모리 릭이 발생한다는 점을 알고 있어야 해요. delegate를 사용하는 세션은 사용을 더 이상 하지 않는다면 반드시 invalidate를 해주는 것이 중요하겠네요..!

 

URLSessionTaskDelegate를 채택해서 세션 내에서 발생하는 이벤트에 대한 메서드를 구현할 수 있고, 만약 특정한 태스크에 대해서 따로 동작을 지정하고 싶다면 URLSessionTask 객체의 delegate 프로퍼티에 대리자를 지정해줄 수도 있습니다. 

 

Asynchronicity and URL Sessions

대부분의 네트워크 API가 그런 것 처럼 URLSession의 API는 비동기적으로 동작합니다. URL Session은 데이터가 도착하면 어떤 메서드를 호출하는지에 따라서 세 가지 다른 방식으로 데이터를 전달하죠.

 

1) 만약 Swift를 사용하고 있다면, 메서드에 async 키워드를 함께 사용할 수 있습니다. 예를 들어 data(from:delegate:) 메서드로 데이터를 받아오고 download(from:delegate:)로 파일을 다운로드 받는다면, 메서드를 호출하는 지점에서 await 키워드를 사용해 모든 통신이 완료될 때까지 대기하도록 할 수 있습니다.

 

또 다른 방법으로는 bytes(from:delegate:) 메서드를 호출해서 데이터를 AsyncSequence 타입으로 받을 수도 있죠 이 방법을 사용한다면 for await-in 루프를 사용해서 앱이 전달받은 데이터를 순회할 수 있습니다.

 

갑자기 익숙치 않은 AsyncSequence 가 나와서 찾아봤는데요, [공식문서]

Sequence 프로토콜과 비슷하게 값을 순회할 수 있는데, 아직 완료되지 않은 값에 대해서는 기다리게 합니다.  

bytes 메서드의 정의를 보면 sequence of bytes로 데이터를 비동기적으로 전달한다고 되어있어요. 그래서 NSData로 완성된 데이터를 받는게 아니라 바이트 단위로 들어오는 데이터를 그대로 계속 전달하는 것이라고 볼 수 있을 것 같아요. 그래서 각 바이트들이 도착할 때까지 기다려야 하니까 for await in 을 사용하는 것이구요.

bytes 메서드의 문서 마지막에 이렇게 적혀있는 것을 보니 제가 생각한 방향이 맞는 것 같네요!

 

2) 다시 본론으로 돌아오면.. 스위프트나 Objective-C에서 비동기 처리를 위해 동일하게 사용할 수 있는 방법은 Completion Handler 클로저를 제공하는 방법이에요. 저희가 가장 많이 쓰는 방법이기도 하죠. 그리고 Delegate 메서드 중에서 작업이 완료되었을 때의 이벤트를 받을 수 있는

func urlSession(URLSession, task:URLSessionTask, didCompleteWithError: Error?) 메서드도 제공하고 있어요.

 

Protocol Support

URLSession은 기본적으로 data, file, ftp, http, https의 URL Scheme을 지원하고 있어요. 그리고 HTTP 중에서는 HTTP/1.1, HTTP/2, HTTP/3 프로토콜을 지원하고 있습니다. 

 

만약 네트워크 프로토콜을 직접 추가하고 싶다면 URLProtocol 을 상속해서 구현하는 것도 가능합니다.

 

혹시 HTTP 버전을 원하는대로 선택해서 요청을 보낼 수 있는지 궁금해서 찾아봤는데요, 공식적인 래퍼는 없지만 

https://developer.apple.com/forums/thread/94907

URLSession for HTTP/2 | Apple Developer Forums

이 스레드를 보면 서버에서 제공하는 프로토콜에 맞게 적용되는 것 같아요.

 

Foundation Copying Behavior

URLSession의 세션과 태스크는 모두 NSCopying 프로토콜을 채택하고 있어요. 따라서 어떤 세션이나 태스크 객체를 복사하게 되면 기존 객체가 그대로 반환됩니다. 하지만 Configuration 객체를 복사하게되면 새로운 객체를 반환해 기존 설정 객체에 영향을 주지 않고 수정할 수 있게됩니다.

 

Thread Safety

URL Session의 API는 Thread-Safe 합니다. 어떤 스레드에서든지 세션이나 태스크를 만들 수 있고 Completion Handler 를 제공했다면, 올바른 delegate queue에 자동으로 할당이 됩니다. 

 

delegate queue가 뭔지 모르겠어서 찾아봤는데요, 

카테고리가 이렇게 나와있어서 URLSession이 가지는 프로퍼티라는 것을 알 수 있었고,

정의는 이렇게 되어있었습니다. delegateQueue가 URLSession의 프로퍼티이니까 여기서 말하는 this object는 URLSession 객체를 말하는 것이겠죠? 그래서 일단 세션 하나당 delegate에 대한 작업이 쌓이는 큐가 있다고 생각했어요.

설명을 보니까 좀 더 명확해지네요. 어떤 세션에서 일어난 모든 delegate 메서드의 호출과 completion handler의 호출이 이 큐에 쌓여서 실행된다고 하네요. 그럼 아까 어떤 스레드이던지 "올바른 delegate queue에 자동으로 할당이 됩니다." 라는 말은 같은 스레드에 여러 delegate나 completion이 있어도 각 세션에 맞는 delegate queue에 할당된다고 볼 수 있을 것 같습니다.

 

근데 당연한거 아닌가..? 세션 당 큐 하나면.. 큐가 다른 스레드에 있을 수도 있다는 걸까요?? 의견이 있으시다면 알려주세요ㅠ

 

마무리

이렇게 해서 완전 이론과 문서 중심의 URLSession 공부하기가 마무리되었습니다! 사실 공식 문서에는 하위 문서로 백그라운드 다운로드나 delegate에 대한 더 자세한 이야기들이 있어서 나중에 시간을 내서 더 자세히 읽어봐야겠습니다.

 

사실 이 포스트는 URLSession은 어떤 스레드에서 돌아갈까? 라는 질문에서 시작했는데, 막상 그런내용은 없어서 자료를 더 찾아봤어요ㅋㅋ URLSession은 자동으로 백그라운드 스레드에 작업을 할당한다고 하네요.

 

생각해보니까 그래서 메인 스레드에서 URLSession 의 태스크를 시작하더라도 completion handler에서 UI 업데이트를 해주려면 DIspatchQueue.main.async로 메인 스레드를 지정해주었네요.. 역시 어중간하게 아는건 제대로 아는게 아니라는걸 오늘도 깨닫게 됩니다..