iOS ) URLSession 알아보기

오늘은 제가 최근에 얼렁뚱땅 쓰게 된 URLSession을 공부해보는 시간을 가져보도록 하겠습니다 !

세미나 때 Alamofire 배우고.. 합동 세미나에서는 Moya 하고.. 앱잼에서는 어쩌다 URLSession을 하게 되었더니 대혼란 🌀

서버통신 너 대체 뭔데.. 

 

이대로는 안되겠다 싶어서 URLSession, Alamofire, Moya 순으로 다시 개념 부터 실전까지 .. 공부해보려고 합니다 :) 

일단 제가 가장 최근에 URLSession을 사용하여 프로젝트를 했는데 그냥.. 아무 것도 모르고 후루룩 써버렸네요... 

 

---

URLSession 

iOS 앱에서 서버와 통신하기 위해 애플은 URLSession이라는 API를 제공하고 있습니다. 

iOS 앱 통신에서 유명한 라이브러리인 Alamofire의 기반이 되는 API로 서버와의 데이터 교류를 위해서는 필수적으로 알아야하는 API !

 

URLSession의 Request와 Response

- URLSession은 다른 HTTP 통신과 마찬가지로 Request와 Response를 기본 구조로 가짐

 

✨Request

- URL 객체를 통해 직접 통신하는 형태

- URLRequest 객체를 만들어서 옵션을 설정하여 통신하는 형태

 

✨Response

- 설정된 Task의 Completion Handler 형태로 response를 받기

- URLSessionDelgate를 통해 지정된 메소드를 호출하는 형태

 

일반적으로 간단한 response를 작성할 때에는 Completion Handler를 사용하지만, 앱이 background 상태로 들어갈 때에도 파일 다운로드를 지원하도록 설정하거나, 인증과 캐싱을 default 옵션으로 사용하지 않는 상황과 같은 경우에는 Delegate 패턴을 사용해야 합니다.

---

개발자 문서를 참고 하여 추가 설명 !

URLSession  은 특정한 URL를 이용하여 데이터를 다운로드하고 업로드  하기 위한 API를 제공합니다. 

관련 Delgegate는 URLSessionDelegate 와 URLSessionTaskDelegate 가 있습니다.

이 Delegate들을 활용하여 인증을 지원하거나 redirection, task끝남 같은 이벤트를 받을 수 있다고 합니다. 

 

session을 configure하기 위해서 URLSessionConfiguration 를 사용합니다. configuration을 통해 cache와 cookie를 어떻게 사용할지, 통신망에 connection을 허용할지 등을 설정할 수 있다고 합니다. 

URLSession의 이니셜라이저에도 configuration이 꼭 들어가있는 것을 볼 수 있습니다. 

 

이렇게 설명을 적어봐도 잘 모르겠네요 하하 . 일단 더 알아봅시다.. 

---

URLSession의 기본 진행 순서

1. Session configuration을 결정하고, Session을 생성
2. 통신할 URL과 Request 객체를 설정
3. 사용할 Task를 결정하고, 그에 맞는 Completion Handler나 Delegate 메소드들을 작성
4. 해당 Task를 실행
5. Task 완료 후 Completion Handler가 실행

 

아니 그래서 configuration..? task...? 너네 뭔데... ㅜㅜㅜㅜㅜㅜㅜ 

 

---

1. URLSessionConfiguration

- URLSession을 생성하기 위해서 필요한 요소

- Configuration을 생성할 때는 URLSession 정책에 따라서 default, ephemeral, background 세 가지 형태로 생성

 

1. Default Session: 기본적인 Session으로 디스크 기반 캐싱을 지원합니다.
2. Ephemeral Session: 어떠한 데이터도 저장하지 않는 형태의 세션입니다. 쿠키나 캐시를 저장하지 않는 정책을 가져갈 때  (ex. Safari의 개인정보보호 모드)
3. Background Session: 앱이 종료된 이후에도 통신이 이뤄지는 것을 지원하는 세션입니다. 앱이 백그라운드에 있는 상황에서 컨텐츠 다운로드, 업로드를 할 때 사용 

 

2. URLSessionTask

- Task 객체는 일반적으로 Session 객체가 서버로 요청을 보낸 후, 응답을 받을 때 URL 기반의 내용들을 받는(retrieve) 역할을 합니다. 3가지 종류의 Task가 지원됩니다. 

 

1. Data Task - HTTP의 각종 메서드를 이용해 서버로부터 응답 데이터를 받아서 Data 객체를 가져오는 작업을 수행(Response 데이터를 메모리 상에서 처리)
2. Download Task - 서버로부터 데이터를 다운로드 받아서 파일의 형태로 저장하는 작업을 수행. 백그라운드 다운로드 지원 (서버에서 응답으로 준 데이터를 파일에 저장해주는 task)
3. Upload Task - 애플리케이션에서 웹 서버로 Data 객체 또는 파일 데이터를 업로드하는 작업을 수행 (데이터를 request body에 넣어서 서버에 업로드하는 task)

JSON, XML, HTML 데이터 등 단순한 데이터의 전송에는 주로 데이터 작업을 사용하며, 용량이 큰 파일의 경우 애플리케이션이 백그라운드 상태인 경우에도 전달할 수 있도록 업로드(다운로드) 작업을 주로 사용합니다.

 

 

- URLSessionTask를 이해하는데 도움이 되었던 예시를 잠시 가져와보자면 .. 

 

예를 들어, URLSession을 웹 브라우저라고 생각하면 그 안에 여러 탭들이 있을 거 아니에여 ?? 티스토리.. 네이버.. 등등 여러 사이트들 ? 

그런 웹 사이트 데이터를 요청하고 로드하는 탭을 URLSessionTask라고 생각하면 됩니다 ! 

그러면 하나의 URLSession에는 여러 URLSessionTask가 다른 웹 사이트로 요청을 보낼 수 있겠죵 !

 

- 그리고 URLSession 네트워킹 순서를 더 간단하게 축약하자면.. 

 

1. URL 만들기
2. URLSession 만들기 
3. URLSession 인스턴스에게 task 주기
4. task 시작하기  task.resume()

 

---

 

이제 한번 코드를 봐보도록 할게요 ! 

 

1단계 : URL 만들기 

2단계 : URLSession 만들기 

func getData() {
        if let url = URL(string: APIConstants.sampleURL) {
            let session = URLSession(configuration: .default)
        }
    }

- APIConstants라는 파일에 sampleURL 로 url 주소를 넣어두었습니다! 

- default session을 생성

 

 

3단계 : URLSession 인스턴스에게 Task 주기 !!

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

 URLSession 안에 들어있는 dataTask라는 메서드를 자세히 살펴보면 ...

- 지정된 URL의 내용을 검색하는 작업을 만든 다음, 완료시 클로저 호출 ( comletionHandler )

- completionHandler로 escaping closure 가 들어있음 . (기본적으로 내부에서 비동기처리 )

- 클로저 앞에 escaping 이 있으면, 함수의 작업이 완료된 후에 클로저가 호출됩니다. 

 

func getData() {
    if let url = URL(string: APIConstants.sampleURL) {
        let session = URLSession(configuration: .default)

        let task = session.dataTask(with: url) { data, response, error in
            
            // error가 존재하면 종료
            guard error == nil else { return }

            // status 코드가 200번대여야 성공적인 네트워크라 판단
            let successsRange = 200..<300
            guard let statusCode = (response as? HTTPURLResponse)?.statusCode,
                  successsRange.contains(statusCode) else { return }
                  
            guard let resultData = data else { return }
            
        }
        task.resume()
    }
}

- completionHandler로 받아온 data, response, error들을 각각 받아서 처리해주면됩니다 ! 

- 3가지 모두 옵셔널 형태이기 때문에 바인딩이 필요합니다

 

작업을 만든 후에는 resume() 메서드를 호출하여 시작합니다 !

 

< 정리 >

 

매개변수 

1. request 

- URL : URL 요청 객체 

2. completionHandler : 로드 요청이 완료되면 호출할 클로저 

- data: 서버에서 반환된 데이터

- response: HTTP 헤더 및 상태 코드와 같은 응답 메타 데이터를 제공하는 객체 

- error : 요청이 실패한 이유 

+++ 3가지 전부 optional 형태 ! 

 

리턴 값 : 새 세션 데이터 task

 

 

 

4단계 : 받은 데이터 확인 !

func getData() {
    if let url = URL(string: APIConstants.sampleURL) {
        let session = URLSession(configuration: .default)

        let task = session.dataTask(with: url) { data, response, error in
        	
            // error가 존재하면 종료
            guard error == nil else { return }

            // status 코드가 200번대여야 성공적인 네트워크라 판단
            let successsRange = 200..<300
            guard let statusCode = (response as? HTTPURLResponse)?.statusCode,
                  successsRange.contains(statusCode) else { return }
                  
            guard let JSONData = data else { return }
            
            let dataString = String(data: JSONData, encoding: .utf8)
            print(dataString!)
            

        }
        task.resume()
    }
}

- data를 받아 스트링형식으로 잘 들어왔는지 확인 이후 JSON객체 디코드 과정을 진행하였습니다 ! 

 

5단계 : 받은 데이터를 디코딩하기 + 프로퍼티에 저장 후, reload 

do {
    let decodeData = try decoder.decode(Category.self, from: JSONData)
    self.cateogories = decodeData

    DispatchQueue.main.async {
        self.tableview.reloadData()
    }
} catch {
    // 디코딩 에러
    print(error)

- data를 받아서 디코딩하는 과정에서 디코딩 에러 핸들링을 해주었습니다.

- 정상적으로 디코딩 된 데이터를 받았을 경우, 뷰컨에서 만든 프로퍼티에 저장을 해줍니다

- DispatchQueue를 사용하여 테이블 뷰를 reload 해줍니다. 

 

 

++ 추가 ) 

하지만 우리는 보통 URLSession을 만들어쓰기보다는, shared를 주로 사용합니다. 

URLSession은 shared라는 변수를 통해 싱글톤 객체를 제공합니다. 그래서 우리는 편하게 URLSession의 함수들을 사용할 수 있었죠!

shared를 쓰면 편하지만 제한이 있습니다. 

shared session은 delegate도 없고, 커스터마이징된 configuration도 없기때문에 당연히 제한이 있습니다.

 

shared를 사용할땐  아래처럼 session을 따로 만들지 않고, 바로 shared 변수를 통해 접근합니다 ! 

let task = URLSession.shared.dataTask(with: url) {
...
}

 

 

 

 

 

 

 

iOS URLSession 이해하기

 

+ 예제 코드 : 유튜브 Smile Han 님의 박스오피스 앱 만들기 강좌를 참고하였습니다.