[Swift] Alamofire vs Moya & URLSession에 대하여

 

 

 

URLSession

The URLSession class and related classes provide an API for downloading data from and uploading data to endpoints indicated by URLs.
Your app can also use this API to perform background downloads when your app isn’t running or, in iOS, while your app is suspended. You can use the related URLSessionDelegate and URLSessionTaskDelegate to support authentication and receive events like redirection and task completion.

The URLSession API involves many different classes that work together in a fairly complex way which may not be obvious if you read the reference documentation by itself. Before using the API, read the overview in the URL Loading System topic. The articles in the Essentials, Uploading, and Downloading sections offer examples of performing common tasks with URLSession.

• URL Loading System: Interact with URLs and communicate with servers using standard Internet protocols.
•  The URL Loading System provides access to resources identified by URLs, using standard protocols like https or custom protocols you create. Loading is performed asynchronously, so your app can remain responsive and handle incoming data or errors as they arrive.
• You use a URLSession instance to create one or more URLSessionTask instances, which can fetch and return data to your app, download files, or upload data and files to remote locations. To configure a session, you use a URLSessionConfiguration object, which controls behavior like how to use caches and cookies, or whether to allow connections on a cellular network. 

Figure 1 : two sessions with these configurations can then create multiple tasks.

• Each session is associated with a delegate to receive periodic updates (or errors). The default delegate calls a completion handler block that you provide; if you choose to provide your own custom delegate, this block is not called.
• You can configure a session to run in the background, so that while the app is suspended, the system can download data on its behalf and wake up the app to deliver the results.
• You can use one session repeatedly to create tasks.
  For example, a web browser might have separate sessions for regular and private browsing use, where the private session doesn’t cache its data. 
  Figure 1 shows how two sessions with these configurations can then create multiple tasks.

 

• Essentials : Configure and create sessions(세션을 구성하고 생성), then use them to create tasks that interact with URLs.
• Fetching Website Data into Memory : Receive data directly into memory by creating a data task from a URL session.
• Analyzing HTTP Traffic with Instruments : Measure HTTP-based network performance and usage of your apps.
• class URLSession : An object that coordinates a group of related, network data transfer tasks.
• class URLSessionTask : A task, like downloading a specific resource, performed in a URL session.

 

• Requests and Responses (내가 서버에게 요청하고 응답을 받음)
• struct URLRequest : A URL load request that is independent of protocol or URL scheme. (내가 요청을 보낸다)
• class URLResponse : The metadata (데이터에 대한 데이터, 즉 정보) associated with the response to a URL load request, independent of protocol and URL scheme. (independent는 왜 자꾸 나온 걸까?)
• class HTTPURLResponse : The metadata associated with the response to an HTTP protocol URL load request.

 

• Uploading (내가 서버에 데이터를 보내는 것)
• Uploading Data to a Website : Post data from your app to servers.
• Uploading Streams of Data : Send a stream of data to a server.

 

• Downloading
• Downloading Files from Websites : Download files directly to the filesystem.
• Pausing and Resuming Downloads : Allow the user to resume a download without starting over.
• Downloading Files in the Background : Create tasks that download files while your app is inactive.

 

 

기본적인 URL Loading System을 알아보았다. 다시 URLSession으로 돌아와서 ... 

Your app creates one or more URLSession instances, each of which coordinates a group of related data-transfer tasks. For example, if you’re creating a web browser, your app might create one session per tab or window, or one session for interactive use and another for background downloads.
Within each session, your app adds a series of tasks, each of which represents a request for a specific URL (following HTTP redirects, if necessary).

 

Types of URL Sessions

The tasks within a given URL session share a common session configuration object, which defines connection behavior, like the maximum number of simultaneous connections to make to a single host, whether connections can use the cellular network, and so on.

URLSession has a singleton shared session (which doesn’t have a configuration object) for basic requests. It’s not as customizable as sessions you create, but it serves as a good starting point if you have very limited requirements. You access this session by calling the shared class method. (서버, manager 관련 코드에서 활용하는 싱글톤 패턴!) 
For other kinds of sessions, you create a URLSession with one of three kinds of configurations:

• A default session behaves much like the shared session, but lets you configure it.
  You can also assign a delegate to the default session to obtain data incrementally. (점진적으로)
• Ephemeral sessions are similar to shared sessions, but don’t write caches, cookies, or credentials to disk. (임시)
• Background sessions let you perform uploads and downloads of content in the background while your app isn’t running.

See Creating a Session Configuration Object in the URLSessionConfiguration class for details on creating each type of configuration. (이제 좀 이해가 되네)

• class var shared: URLSession : The shared singleton session object.

 

Types of URL Session Tasks

Within a session, you create tasks that optionally upload data to a server and then retrieve data from the server either as a file on disk or as one or more NSData objects in memory.
The URLSession API provides four types of tasks:

• Data tasks send and receive data usingNSDataobjects.
  Data tasks are intended for short, often interactive requests to a server.
• Upload tasks are similar to data tasks, but they also send data (often in the form of a file), and support background uploads while the app isn’t running.
• Download tasks retrieve data in the form of a file, and support background downloads and uploads while the app isn’t running.
• WebSocket tasks exchange messages over TCP and TLS, using the WebSocket protocol defined in RFC 6455. 웹소켓이 뭐지? 서버와 브라우저 사이에 양방향 소통이 가능하다고 한다. 하나의 TCP 접속에 전이중 통신 채널을 제공하는 컴퓨터 통신 프로토콜, 웹소켓 프로토콜은 2011년 IETF에 의해 RFC 6455로 표준화되었으며, 웹 IDL의 웹소켓 API는 W3C에 의해 표준화되고 있다. 웹소켓은 HTTP와 구별된다. CS 책 읽다가, 네트워크 파트에서 봤던 기억이 난다.

 

Using a Session Delegate

Tasks in a session also share a common delegate object. You implement this delegate to provide and obtain information when various events occur, including when:

• Authentication fails. (인증 실패)
• Data arrives from the server. (서버에서 데이터가 왔을 때!)
• Data becomes available for caching. (캐싱 -> 이전에 검색하거나 계산한 데이터를 효율적으로 재사용할 수 있다)

If you don’t need the features provided by a delegate, you can use this API without providing one by passing nil when you create a session. 

 

 

Important

The session object keeps a strong reference to the delegate until your app exits or explicitly invalidates the session.
If you don’t invalidate the session, your app leaks memory until the app terminates.

Each task you create with the session calls back to the session’s delegate, using the methods defined in URLSessionTaskDelegate.
You can also intercept these callbacks before they reach the session delegate by populating a separate delegate that’s specific to the task.

 

Asynchronicity and URL Sessions (비동기성)

Like most networking APIs, the URLSession API is highly asynchronous. It returns data to your app in one of three ways, depending on the methods you call:

• If you’re using Swift, you can use the methods marked with the asynckeyword to perform common tasks.
  For example, data(from:delegate:) fetches data, while download(from:delegate:)downloads files.
  Your call point uses the await keyword to suspend(유예 == 지연) running until the transfer completes.
  You can also use the bytes(from:delegate:) method to receive data as an AsyncSequence. With this approach, you use the for-await-in syntax to iterate over the data as your app receives it.
  The URL type also offers covenience methods to fetch bytes or lines from the shared URL session.
• In Swift or Objective-C, you can provide a completion handler block, which runs when the transfer completes.
• In Swift or Objective-C, you can receive callbacks to a delegate method as the transfer progresses and immediately after it completes.

In addition to delivering this information to delegates, the URLSession provides status and progress properties. Query these properties if you need to make programmatic decisions based on the current state of the task (with the caveat(경고) that its state can change at any time).

 

Protocol Support

The URLSession class natively supports the data, file, ftp, http, and https URL schemes, with transparent support for proxy servers and SOCKS gateways, as configured in the user’s system preferences.

URLSession supports the HTTP/1.1, HTTP/2, and HTTP/3 protocols.
HTTP/2 support, as described by RFC 7540, requires a server that supports Application-Layer Protocol Negotiation (ALPN).

You can also add support for your own custom networking protocols and URL schemes (for your app’s private use) by subclassing URLProtocol.

 

App Transport Security (ATS)

iOS 9.0 and macOS 10.11 and later use App Transport Security (ATS) for all HTTP connections made with URLSession. ATS requires that HTTP connections use HTTPS (RFC 2818). For more information, see NSAppTransportSecurity.

 

Foundation Copying Behavior

Session and task objects conform to the NSCopying protocol as follows:

• When your app copies a session or task object, you get the same object back.
• When your app copies a configuration object, you get a new copy you can independently modify.
• 이것도 copy by reference vs value 개념 같다. 구성은 독립(값만, 복사본), 세션과 태스크는 동일 객체 반환

 

Thread Safety (스레드 안전)

The URL session API is thread-safe.
You can freely create sessions and tasks in any thread context.
When your delegate methods call the provided completion handlers, the work is automatically scheduled on the correct delegate queue.

• 멀티 스레드 프로그래밍에서 일반적으로 어떤 함수나 변수, 혹은 객체가 여러 스레드로부터 동시에 접근이 이루어져도 프로그램의 실행에 문제가 없음을 의미
• 하나의 함수가 한 스레드에서 호출되어 실행중일 때, 다른 스레드가 그 함수를 호출해서 동시에 실행되더라도, 각 스레드에서의 함수의 수행 결과가 올바로 나오는 것으로 정의

 

• 스레드에 안전한 코드를 작성하는 방법
• Re-entrancy 
  어떤 함수가 한 스레드에 의해 호출되어 실행중일 때, 다른 스레드가 그 함수를 호출하더라도 그 결과가 각각에게 올바로 주어져야 한다. 스레드끼리 독립적으로 동작할 수 있도록 코드를 짜라는 것
• Thread-local-storage
  공유 자원의 사용을 최대한 줄여 각각의 스레드에서만 접근 가능한 저장소들을 사용함으로써 동시 접근을 막는다. 전역 변수 사용을 자제하라는 뜻
• Mutual exclusion
  공유 자원(전역 변수 등)을 꼭 사용해야 될 경우에는, 해당 자원의 접근을 세마포어 등의 락으로 통제
  예를 들면, Python에서의 threading.lock이 있다. threading.lock을 acquire하면 해당 스레드만 공유 데이터에 접근할 수 있고, lock을 release해야만 다른 스레드에서 공유 데이터에 접근할 수 있다
• Atomic operations
  공유 자원에 접근할 때 원자 연산을 이용하거나 원자적으로 정의된 접근 방법을 사용함 -> 상호 배제를 구현
  ex) a += b의 경우, 먼저 +연산을 한 뒤에 =연산을 하므로, 원자적이라고 보기 어렵다.

 

• 네 가지의 방법들 중에 thread-safe한 상황이 명백한 경우를 제외한다면, 보통은 Mutual exclusion(동기화 객체)를 사용하는 것이 가장 일반적이다. 이것을 구현하는 것이 가장 쉽기 때문 
• 실생활에서 이 mutual exclusion을 사용하는 예시는, GIL이 있다. GIL이란 Global Interpreter Lock의 줄임말로, Python 인터프리터가 한 스레드만 하나의 바이트코드를 실행시킬 수 있도록 해주는 Lock을 의미한다. 즉 하나의 스레드에만 모든 자원을 허락하고 그 이후에는 락을 걸어 다른 스레드가 접근할 수 없게 만드는 것이다.
• Python에서 GIL이 필요한 이유가, CPython의 메모리 관리 상태가 thread-safe하지 않기 때문
  즉, 이러한 스레드 안전의 해결책으로서 사용하는 것이 GIL이라는 것

 

 

 

apple 공식문서와 기타 자료들을 통하여 URLSession을 파악해보았다. 다음으로 Alamofire & Moya에 대하여 알아보자.

Alamofire

 

• Moya는 Alamofire 라이브러리를 한층 더 Wrapping하여 사용하기 편리하도록 한 라이브러리
• Wrapping은 사용의 편의성이라는 장점도 제공하지만, URLSession에 접근하기 어렵다는 한계가 있다
• 최근 이를 느끼고 한 계층 낮은 Alamofire 라이브러리를 사용할지, 아니면 순수 URLSession을 Module화하여 사용할 지 고민하다가, 그래도 조금은 Module화가 되어있는 Alamofire 라이브러리를 사용하는 것이 돌발 상황 대처에 좋을 것 같아 Alamofire를 사용하기로 결정
• 개인적으로 Moya의 사용에 익숙해져 있고, 체계적으로 기능이 분리되어 있는 라이브러리의 특성상 규모가 커질수록 유지보수에 장점이 있다는 점을 느꼈기에 Alamofire를 Moya처럼 만들어보기로 했습니다.

 

 

• Foundation Framework
• 파운데이션 프레임워크는 데이터 처리, 네트워크 처리, 파일 처리와 같은 필수 기능을 제공
• 파운데이션 프레임워크에서 제공하는 클래스는 이름 앞에 NS를 붙인다.
  ex) NSData, NSArray, NSURL은 파운데이션 프레임워크에서 제공하는 클래스
• 파운데이션 프레임워크를 사용할 때는 프로그램의 상단에 import 문을 입력합니다.
  • import Foundation

 

• Alamofire
• 파운데이션 프레임워크에서는 API를 호출하기 위해 URLRequest 객체를 만들어 사용했지만,
  Alamoifire는 더욱 간편하게 접근 할 수 있도록 함.
• Alamofire 는 비동기 기반으로 네트워크 응답을 처리
  응답 메시지를 reponse 메소드의 결과값으로 반환 받을 수 없다.
  서버에서 응답이 도착했을때 실행될 로직을 클로저 형태로 작성해, reponse 메소드에 넣어주어야 함 (콜백 함수)
• Alamofire 는 서버에서 응답이 도착하면 이를 클로저의 매개변수에 담아 호출한다.

 

 

 

 

✳️ 파운데이션 프레임워크를 이용하여 API 호출하기

• GET 방식으로 현재 시간 확인 API 호출하기
• POST 방식으로 에코 API 호출하기
• JSON 방식으로 에코 JSON API 호출하기

 

 

 

1) GET 방식으로 현재 시간 확인 API 호출하기

CurrentTime API 호출 형식

• Description : 서버로부터 현재 시간을 가져온다.
• URL : 
• Method : GET
• Request : 없음
• Response : 날짜 형태의 문자열(ex. 2020-09-04 13:29:46)
  • 값을 요청할 때 전달값(request, req)에는 아무 것도 포함하지 않아도 된다.

 

 

 

2) POST 방식으로 API 호출하기

클라이언트가 보낸 요청을 그대로 응답하는 Echo API 호출

개발 과정에서 서버와 클라이언트를 처음 연동할 때 서버가 잘 응답하는지 확인하기 위하여 사용

클라이언트의 요청내용을 JSON 형식으로 돌려주고, 거기에 더해 timestamp 와 처리 결과는 result 항목을 추가하여 응답한다.

 

Echo API 요청 형식

• Description : 클라이언트가 보낸 요청을 그대로 JSON 형식으로 변경하여 응답한다.
• URL : 
• Method : POST
• Content Type : x-www-form-urlencoded
• Request : 사용자 정의 형식
• Response : JSON 객체. 사용자의 요청 내용 그대로 / result: 성공시 SUCCESS, 실패시 FAIL / timestmp : 응답 시간을 YYYY-MM-dd HH:mm:ss 형태로 표현
  • GET 방식과 다르게 Content Type 이 있다. 서버에 값을 전송할 때 URL 인코딩된 폼 타입을 사용하겠다는 의미.
    보통 웹페이지의 form 에서 submit 눌렀을때 값이 전달되는 형식이 x-www-form-urlencoded 이다.

 

 

1. 전송할 값 준비
값을 POST 방식으로 전송하려면 http 통신 표준에 정의된 약속에 따라, key1=value1&key2=value2&... 와 같은 방식으로 작성해 주어야 한다. 이 값을 그대로 보내면 공백이나 문장부호, 한글 같은 문자는 전송과정에서 변형되어 버릴 수 있으므로 Data 객체로 변경할때 .utf8 인코딩을 적용해줘야 한다.

 

2. URL 객체 정의
API를 호출하는 과정의 대부분은 URL 객체를 생성하는 것으로 시작한다.

 

3. URLRequest 객체를 정의하고 요청 내용을 담는다.
생성된 URL 객체를 이용해서 URLRequest 객체를 만든다.
이 객체는 API를 호출할 때 필요한 요청 내용이 모두 포함되며, http 요청 메시지 구조를 구성하는 역할을 한다.

 

4. http 메시지의 헤더를 설정한다.
헤더는 실제 내용에는 포함되지 않으면서 전송하는 콘텐츠에 대한 형식이나 특성 등 메타 정보를 제공한다.
(메타데이터 - 데이터에 대한 데이터! 앞서 언급되었다.)
request.addValue(: forHTTPHeaderField: )와 request.setValue(: forHTTPHeaderField: ) 메소드를 통해 헤더를 추가
추가할 수 있는 헤더의 수에는 제한이 없으므로, 필요한 만큼 위 메소드를 반복적으로 사용하면 된다.
addValue 는 헤더에 값을 추가하는 것이고, setValue 는 기존값을 replace 하는 것이다.

Content-Length 를 설정한 이유는 다음과 같다.
서버에 전송되는 데이터는 문자열이 덩어리 단위로 끊어져서 전송되는 것이 아니라 스트림 형식으로 계속 이어져 전달되기 때문에, 서버는 http 메시지를 어디까지 끊어서 처리해야 할 지 결정할 수 있어야 한다. http 메시지 길이를 판별하기 위한 헤더.
Content-Length 헤더가 없어도 대부분의 서버는 http 메시지의 끝을 잘 판별하지만, 본문의 길이를 계산하여 넣어주는 것이 더 안전하다.
Data 객체 값의 길이는 count 속성을 통해 확인할 수 있고, 헤더에 추가할 때는 문자열 형식으로 변경해서 집어넣어야 한다.

 

5. URLSession 객체를 통해 전송 및 응답값 처리
URLRequest 객체를 전송하는데는 URLSession.shared.dataTask(with:) 구문이 사용된다. 인풋에 URLRequest 객체를 담고, 뒤에 이어질 트레일링 클로저에는 응답이 올때 처리될 로직이 들어간다.
응답값의 처리가 필요없는 요청이라면 트레일링 클로저를 생략하고 다음과 같이 간략히 적을 수 있다.

let task = URLSession.shared.dataTask(with: request)

http 통신은 비동기로 이루어지기 때문에, 응답값을 받아 처리할 내용을 클로저 형태로 미리 작성하여 인자값으로 넣어주어야 한다.
응답 클로저에는 응답 메시지 본문(Data 타입의 data), 응답 코드 및 메타정보가 저장된 응답정보(URLResponse 타입의 response), 오류정보(Error 타입의 error) 가 매개변수로 들어간다.
서버 통신에 문제가 생긴다면 세번째 매개변수에 Error 타입의 값이 대입된다. 따라서 응답 시 세번째 매개변수를 체크하면 통신이 제대로 수행되었는지를 확인할 수 있다.
Swift 에서 비동기로 실행되는 모든 구문은 서브 스레드에서 실행되고, UI 관련 구문은 메인 스레드에서 실행된다. 따라서 비동기로 수행되는 URLSession 핸들링은 서브스레드에서 실행된다.
그러나 서버 통신으로 얻은 결과물을 UI 에 반영시켜야 되기 때문에, 서브 스레드 대신 메인스레드에서 실행되게 만들어야 한다.
서브스레드 대신 메인스레드에서 실행되도록 DispatchQueue.main.async() 구문을 사용한다.
서버 통신으로 받아온 jsonObject를 NSDictionary 객체로 변환하고, 각각 값을 출력해서 텍스트에 집어넣으면 된다.

 

6. POST 전송
1~5까지, http 메시지 전달과 관련된 로직이 전부 작성 되었으면 task.resume()을 호출해서 서버에 메시지를 전달한다.

URL 객체를 만들고, URLSession 에 URL 객체를 담아 보내고, 응답을 파싱하여 원하는대로 사용하면 된다.

 

 

 

3) JSON 방식으로 API 호출하기

이번에는 Echo API 호출할때와 비슷하지만, Request 가 JSON 형식을 따르는 호출을 시도한다.

JSON 방식의 API 호출은 상용 서비스에서 많이 적용하는 방식이다.
전송할 값을 =와 &로 연결하는 대신 JSON 형식으로 구성하고, Content-Type 헤더를 application/json 으로 변경

 

 

 

 

 

 

Moya

• Moya에는 Alamofire 프레임워크가 내부적으로 포함되어 있다.
• Alamofire가 있지만 굳이 Moya프레임워크를 사용하는 이유
  
  • Alamofire를 사용하면, URL과 같은 것을 사용할 때 request에 넣어주어야 하며(Network Layer접근),
    템플릿이 갖추어 지지 않아서 재사용에 유리하지 않은 구조
  • Moya를 사용하면 Moya에서 Network layer를 템플릿화 해놓고, 사용하는 App에서는 request, response만 처리하면 됨
• Moya - Reactive Extensions : RxSwift 와 ReactiveSwift 에 대한 extensions 를 제공

 

 

 

Moya를 통해 정리된 네트워킹 흐름은 세가지 단점을 극복

• Makes it hard to write new apps ("where do I begin?")
• Makes it hard to maintain existing apps ("oh my god, this mess...")
• Makes it hard to write unit tests ("how do I do this again?")

Moya의 훌륭한 세가지 특징은

• Compile-time checking for correct API endpoint accesses.
• Lets you define a clear usage of different endpoints with associated enum values.
• Treats test stubs as first-class citizens so unit testing is super-easy.

 

Moya와 Alamofire의 차이

• Moya는 직접적인 네트워킹을 수행하지 않음 : 자체적 네트워킹을 수행하지 않음
• Alamofire는 직접적인 네트워킹을 수행함
• 즉, Moya는 Alamofire의 네트워킹 기능을 사용하고, Alamofire을 추상화하기 위한 수단

 

 

 

• URLSession
  • iOS 앱에서 서버와 통신하기 위해 Apple이 제공하는 네트워킹 API
  • 로우 레벨의 코드를 작성할 수 있고, 가장 기본적인 방법
  • Alamofire 의 기반이 되는 API
  • 특정 URL을 사용해서 데이터를 다운로드, 업로드하기 위한 API

• Alamofire
  • 네트워킹 오픈소스 라이브러리
  • URLSession 에 기반한 라이브러리
  • 코드의 간소화 및 가독성 측면에서 보다 성능이 개선되었다
  • 유지보수와 유닛 테스트가 힘들다는 단점이 있다

• Moya
  • 네트워킹 오픈소스 프레임워크
  • 추상화 된 정도 : URLSession < Alamofire < Moya
  • Network Layer를 템플릿화 : 재사용성을 높인다
  • 열거형 enum을 사용해서 안전하고 정돈된 방식의 캡슐화

 

 

• What I like about Moya is being able to have all the endpoints of a particular service in one enum and being able to configure everything there, with convenient switch statements.
• Using only Alamofire is a good solution as well, but in this case you have to provide some of the functionalities on top of that.

 

 

 

 

 

 

 

출처

• https://developer.apple.com/documentation/foundation/urlsession
• https://developer.apple.com/documentation/foundation/url_loading_system
• https://steadily-worked.tistory.com/577
• https://velog.io/@budlebee/iOS-파운데이션-프레임-워크를-이용한-API-호출
• https://velog.io/@budlebee/iOS-Alamofire-를-이용한-API-호출
• https://gyuios.tistory.com/68
• https://jazz-the-it.tistory.com/m/25
• https://ios-development.tistory.com/193
• https://ios-development.tistory.com/731
• https://lidium.tistory.com/37
• https://ronanociosoig.medium.com/goodbye-moya-alamofire-simplify-your-dependancies-cff5dd649e91
• https://ko.wikipedia.org/wiki/웹소켓
• https://velog.io/@heyksw/iOS-Moya-Alamofire-URLSession-비교
• https://www.gfrigerio.com/moya-and-alamofire/ (읽어보기 추천!)

Moya and Alamofire – Gualtiero Frigerio