[ Swift ] 네트워크 통신 - JSON, API, REST API

네트워크

간단하게 말하자면, 둘 이상의 컴퓨터가 연결되고 소통하는 것

핸드폰과 서버와의 통신도 네트워크 통신이다. 

 

 

✅ JSON(JavaScript Object Notaion)

네트워크에서 데이터를 주고 받기 위해서는 데이터를 표현하는 정해진 형식을 지켜 교환하는 것이 좋다. 

서버와 클라이언트가 가장 많이 사용하는 데이터 형식이 JSON 형식이다. 

JSON은 key-value 형태를 가진다.

[
    {
        "name": "Jihyeon",
        "phoneNumber": "010-1111-2222"
    },
    {
        "name": "Swift",
        "phoneNumber": "010-3333-4444"
    },
    {
        "name": "Apple",
        "phoneNumber": "010-5555-6666"
    }
]

 

 

✅ API(Application Programming Interface)

프로그램을 개발할 때 필요한 기능을 제공해주는 창구, 설명서, 도구이다. 

API를 통해 클라이언트가 API 서버에게 필요한 요청을 하면 API 서버는 API를 통해 응답을 한다. 

 

 

 

✅  Swift Codeable

• 인코딩 : 데이터 → 특정 형식으로 변환
• 디코딩 : 인코딩된 데이터 → 원본으로 변환

 

Swift의 Codeable 프로토콜을 채택하면 인코딩과 디코딩 모두 가능

서버와 통신하기 위해서 JSON 형식으로 인코딩을 많이 한다. 

 

 

🌟 JSON 형식의 데이터에서 Swift로 데이터를 디코딩해서 추출하는 과정 🌟

1. Codeable을 채택해 인코딩과 디코딩이 가능한 객체 생성

2. String으로 JSON 모양의 데이터 생성 

3. JSON 형식으로 바꾸기 :  jsonString으로 jsonData 생성 -> data(using: .utf8)

4. JSON 디코더(JSON -> 원본으로 변환) : JSONDecoder()

5. Codeable 디코딩 진행

 

import Foundation

struct PhoneBook: Codable { //Codable을 채택해 인코딩과 디코딩이 가능한 객체가 됨
    
    let name: String
    let phoneNumber: String
}

// string 으로 json 모양의 데이터를 생성.
let jsonString = """
[
    {
        "name": "Jihyeon",
        "phoneNumber": "010-1111-2222"
    },
    {
        "name": "Swift",
        "phoneNumber": "010-3333-4444"
    },
    {
        "name": "Apple",
        "phoneNumber": "010-5555-6666"
    }
]
"""

// jsonString 으로 jsonData 를 생성 -> JSON 형식으로 바뀜 
let jsonData = jsonString.data(using: .utf8)!

// Swift 가 제공하는 JSON 디코더.
let jsonDecoder = JSONDecoder()

// JSON -> Codable 디코딩 진행.
do {	
						//jsonDecoder로 [PhoneBook] 타입으로 jsonData을 디코딩 한다.
    let phoneBooks = try jsonDecoder.decode([PhoneBook].self, from: jsonData)
    for phoneBook in phoneBooks {
        print("name: \(phoneBook.name), phoneNumber: \(phoneBook.phoneNumber)")
    }
} catch {
    print("JSON 디코딩 실패")
}

 

 

 

✅ URL 기본 구조

URL(Uniform Resource Locator)은 자원의 위치를 나타내는 식별자다.

즉, 웹에서 자원이 어디에 있는지를 가리킨다. 

• URL (Uniform Resource Locators): 웹에서 특정 위치를 나타내는 주소.
• Protocol: http, https → 인터넷 통신 규약을 의미.
• Domain: 자원이 위치한 서버(컴퓨터)의 이름. 예를 들어 google, naver . url 의 정체성을 나타낸다.
• Port: 구체적으로 어떤 서버를 이용할지 번호로 결정. HTTP 의 경우 80. HTTPS 는 443.
• Path: 서버에서 제공하는 자원의 경로를 나타냄.
• Query: 자원에 대한 추가적인 매개변수를 전달하는 데 사용됨. 주로 key=value 형식으로 표현되며, 여러 개의 매개변수는 &로 구분.
• Fragment: 자원 내에서 특정 부분을 가리킬 때 사용.

 

 

✅ REST API(Representational State Transfer)

웹 기반의 네트워크 통신을 간단하고 일관성 있게 설계하기 위한 아키텍처 스타일이다.

REST는 자원을 URL로 식별하고, HTTP 메서드(POST, GET, PUT, DELETE)를 사용하여 자원을 처리한다.

JSON 또는 XML 형식으로 데이터를 주고받는 API

 

 

 

🌟 REST API의 주요 개념 🌟

 

1. 자원 (Resource)

URI(Uniform Resource Identifier, URI 안에 URL이 포함된 개념)로 식별되는 대상.

예를 들어, 사용자 정보는 /users라는 URI로 식별될 수 있다.

 

 

2. HTTP 메서드 : 서버가 파악하기 위한(통신하기 위한) 요청의 종류

• GET : 조회
  예) 인스타그램 게시글 보기 
• POST : 생성 -> 내가 준 데이터를 서버에 올려 두겠다는 요청
  예) 인스타그램 피드 올리기, 다른 사람의 게시물에 댓글 달기, 서비스 가입 
  
• PUT : 업데이트 -> 서버에서 가지고 있는 기존의 데이터를 수정하겠다는 요청 
  예) 인스타그램 피드 수정, 다른 사람의 게시물 좋아요, 나의 정보 수정
• DELETE : 삭제  -> 서버에 있는 데이터를 지우겠다는 요청
  예) 인스타그램 피드 삭제 

 

3. HTTP 상태 코드

클라이언트 요청에 대한 서버의 응답 상태를 나타냄.

• 200 OK: 성공
• 201 Created: 자원 생성 성공
• 400 Bad Request: 잘못된 요청
• 404 Not Found: 자원을 찾을 수 없음
• 500 Internal Server Error: 서버 오류

 

** URL을 가지고 네트워크 통신을 할 수 있게 하는 Swift 클래스가 URLSession.

 

---

🌟 GET(조회) 요청 예제 코드

import Foundation

// 1. 네트워크 요청을 보낼 URL을 생성
let url = URL(string: "https://jsonplaceholder.typicode.com/posts/1")!
// 2. URL을 기반으로 URLRequest 객체를 생성
var request = URLRequest(url: url)
// 3. URLRequest 객체에  HTTP 메서드를 GET으로 설정
request.httpMethod = "GET"

/* 4. URLSession의 기본 shared 인스턴스를 사용하여 URLSession을 생성
URLSession은 네트워크 작업을 관리하는 클래스로, 세션을 생성하고, 데이터를 주고받는 작업을 관리. 
URLSession.shared는 기본 세션 인스턴스로, 캐시, 쿠키, 인증서 등의 공통 구성을 갖춘 공유 세션을 제공한다. 
기본적으로 shared 인스턴스를 사용하여 간편하게 네트워크 작업을 수행할 수 있다.
*/
let session = URLSession.shared
// 5. URLSessionDataTask를 생성하여 GET 요청을 보내기(서버로부터 데이터를 가져오거나 서버에 데이터를 전송)
let task = session.dataTask(with: request) { data, response, error in
    // 6. 에러가 발생했는지 확인
    if let error = error {
        print("Error: \(error)")
        return
    }
    // 7. 서버로부터 데이터를 받았는지 확인
    guard let data = data else {
        print("No data")
        return
    }
    // 8. 받은 데이터를 JSON으로 파싱
    do {
        let json = try JSONSerialization.jsonObject(with: data, options: [])
        print("JSON Response: \(json)")
    } catch {
        print("Failed to parse JSON: \(error)")
    }
}
/* 9. 요청 시작
URLSessionDataTask나 URLSessionDownloadTask 등의 작업을 시작하는 메서드. 
네트워크 요청은 기본적으로 일시 중단된 상태로 생성되므로, resume()을 호출해 네트워크 작업 시작.
*/
task.resume()

 

응답 처리: URLSessionDataTask의 클로저 내부에서 응답을 처리한다.

• 에러 처리: 네트워크 요청 도중 발생한 오류를 처리.
• HTTP 응답 처리: 서버에서 받은 HTTP 응답 코드를 확인.
• 데이터 처리: 서버에서 받은 데이터를 처리. 예제에서는 JSON 데이터를 파싱하여 사용.

 

클로저 내부의 처리 방식

클로저 내부에서 받은 데이터는 해당 클로저 내부에서만 처리된다.

데이터를 UI에 업데이트하거나 다른 비동기 작업을 수행해야 할 경우,

클로저 외부에서 해당 데이터를 사용할 수 있도록 데이터를 처리하는 메서드나 콜백을 호출하는 방식으로 구현 가능.

 

 

📌 Swift에서는 가능하면 Codable 프로토콜을 사용하여 데이터를 디코딩하는 것이 권장되며,

JSONSerialization은 더 낮은 수준의 JSON 데이터 처리가 필요할 때 사용될 수 있다!!!!

 

 

🌟 POST(생성) 요청 예제 코드

import Foundation

// 1. POST 요청을 보낼 URL을 생성합니다.
let url = URL(string: "https://jsonplaceholder.typicode.com/posts")!
// 2. URL을 기반으로 URLRequest 객체를 생성합니다.
var request = URLRequest(url: url)
// 3. 요청의 HTTP 메서드를 POST로 설정합니다.
request.httpMethod = "POST"
// 4. 요청의 Content-Type을 설정해 요청 바디의 데이터 형식을 JSON으로 설정합니다.
request.setValue("application/json", forHTTPHeaderField: "Content-Type")

// 5. 요청 바디에 포함할 JSON 데이터를 딕셔너리로 생성합니다.
let parameters: [String: Any] = ["title": "foo", "body": "bar", "userId": 1]
// 6. 딕셔너리를 JSON 데이터로 변환하여 요청 바디에 설정합니다.
// 딕셔너리 객체를 JSON 데이터로 변환하여 요청 바디에 설정.
request.httpBody = try? JSONSerialization.data(withJSONObject: parameters, options: [])

// 7. URLSession의 shared 인스턴스를 사용하여 URLSession을 생성합니다.
let session = URLSession.shared
// 8. URLSessionDataTask를 생성하여 요청을 보냅니다.
let task = session.dataTask(with: request) { data, response, error in
    // 9. 에러가 발생했는지 확인합니다.
    if let error = error {
        print("Error: \(error)")
        return
    }
    // 10. 서버로부터 데이터를 받았는지 확인합니다.
    guard let data = data else {
        print("No data")
        return
    }
    // 11. 받은 데이터를 JSON으로 파싱합니다.
    do {
        let json = try JSONSerialization.jsonObject(with: data, options: [])
        print("JSON Response: \(json)")
    } catch {
        print("Failed to parse JSON: \(error)")
    }
}
// 12. 요청을 시작합니다.
task.resume()

 

 

 

코드를 보니 GET, POST가 헷갈린다..🫠

차이점에 대해 좀 더 정리해본다. 

 

GET 요청과 POST 요청은 HTTP 프로토콜에서 서버와 클라이언트 간의 데이터를 주고받는 두 가지 주요 방식이다. 

 

🌟 GET 요청

목적: 서버로부터 데이터를 가져오기 위해 사용된다.

특징:

• 데이터 요청: GET 요청은 서버로부터 데이터를 가져오는 데 사용. 서버에서 자원을 읽거나 조회할 때 사용.
• URL에 데이터 포함: 요청할 데이터는 URL의 쿼리 문자열에 포함한다. 
  예를 들어, 클라이언트는 사용자의 ID를 쿼리 파라미터로 포함시켜 서버에 요청 보낼 수 있다. 
  https://api.example.com/dposts?userId=1
  여기서 ?userId=1 부분이 쿼리 문자열로, 서버에 userId가 1인 사용자의 정보를 요청한다는 의미다. 
  서버는 이 쿼리 파라미터를 읽고 해당 사용자에 대한 정보를 검색한 후 결과를 클라이언트에 반환.
  서버는 요청을 처리하고, userId가 1인 사용자의 정보를 클라이언트에게 보낸다(응답).
• 캐싱: GET 요청은 캐시 가능하므로, 동일한 요청을 반복적으로 수행해도 네트워크 부담을 줄일 수 있다.
• 안전함: GET 요청은 서버 상태를 변경하지 않으므로 안전하다.
• idempotent: GET 요청을 여러 번 반복해도 동일한 결과를 반환합니다.

 

 

 

🌟 POST 요청

목적: 데이터를 서버에 저장하기 위해 사용된다.
예) 인스타그램 피드 올리기, 다른 사람의 게시물에 댓글 달기, 서비스 가입 

 

특징:

• 데이터 전송: POST 요청은 서버로 데이터를 전송하거나 제출할 때 사용. 
• 새로운 리소스를 생성하거나 서버의 상태를 변경할 때 사용한다.
• 바디에 데이터 포함: 요청 데이터는 HTTP 요청의 바디에 포함된다. 
• 일반적으로 JSON, XML, 또는 폼 데이터 형식으로 전송.
• 캐싱 안 됨: POST 요청은 일반적으로 캐시되지 않으므로, 항상 서버로 전달된다.
• 안전하지 않음: POST 요청은 서버의 상태를 변경하므로 안전하지 않다.
• idempotent 아님: 동일한 POST 요청을 여러 번 반복하면 여러 개의 리소스가 생성될 수 있다.