WEB CS 기초 - section 4 HTTP 메서드(1)

* 해당 글은 멋사 부트캠프 CS 기초 추가강의 내용 정리글입니다.

https://bootcamp.likelion.net/school/kdt-backendj-21th

백엔드 부트캠프 21기: Java : 멋사 부트캠프

 

HTTP 메소드

가장 중요한 것은 리소스 식별을 기준으로 URI 를 설계해야 한다는 것이다.

여기서 리소스의 의미는 무엇일까?

•  회원을 등록하고 수정하고 조회하는게 리소스가 아니다.
•  회원 이라는 개념 자체가 바로 리소스다.

 

* 그렇다면 리소스를 어떻게 식별하는게 좋을까?

 회원을 등록하고, 수정하고, 조회하는 것을 모두 배제하자.

 회원이라는 리소스만 식별하면 된다. -> 회원 리소스를 URI 에 매핑한다.

리소스 식별, URI 계층 구조를 활용하여 다시 API URI 를 설계하면 다음과 같다.

•  회원 목록 조회 : /members
•  회원 조회 : /members/{id}
•  회원 등록 : /members/{id}
•  회원 수정 : /members/{id}
•  회원 삭제 : /members/{id}
•  참고 : 계층 구조상 상위를 컬렉션으로 보고 복수단어 사용을 권장한다.(member -> members)

그런데 위와 같이 설계된 URI 에서 각 id 를 통해 어떻게 API 들을 구분할 수 있을까?

 

또 한가지 중요한것은 리소스를 식별하는 것이다.

•  URI 는 리소스만 식별한다. 즉, 리소스의 행위를 식별하면 안된다.
•  리소스와 해당 리소스를 대상으로 하는 행위를 분리한다.
  • 리소스 : 회원
  • 행위 : 조회, 등록, 삭제, 변경
•  리소스는 명사, 행위는 동사(미네랄을 캐라) 이다.
•  그렇다면 행위(메소드) 는 어떻게 구분할까?

 

HTTP 메소드 : GET, POST

HTTP 메소드는 클라이언트가 서버에게 요청할 때 기대하는 행동이다.

주요 메소드는 다음과 같다.

•  GET : 리소스 조회
•  POST : 요청 데이터 처리, 주로 등록에 사용한다.
•  PUT : 클라이언트에서 서버에게 리소스를 보내는데, 보내주는 리소스로 대체하는 행동이다. (기존에 존재하던 리소스를 덮어씌운다.) 해당 리소스가 없으면 생성시킨다.
•  PATCH : 리소스 부분 변경
•  DELETE : 리소스 삭제

* GET

•  리소스를 조회하는 메소드이다.
•  서버에 전달하고 싶은 데이터는 query(쿼리 파라미터, 쿼리 스트링) 를 통해서 전달한다.
•  메시지 바디를 사용해서 데이터를 전달할 수 있지만, 지원하지 않는곳이 많아서 권장하지 않는다.
• GET 메소드를 통해 /members/100 과 같은 요청을 보낸 경우 해당 요청을 서버에서 받은 다음, 클라이언트가 조회한 데이터를 찾아서 JSON 과 같은 형태의 데이터로 만든다.
• 그렇게 만들어진 데이터를 다시 클라이언트 에게 전달해준다.

* POST

• 클라이언트에서 서버로 요청을 보낼때, 클라이언트 측에서 서버로 데이터를 전달한다.
• (메시지 바디를 통해 서버로 요청 데이터 전달) 그렇게 서버에서 데이터를 전달 받으면 서버는 해당 데이터를 처리해준다.
•  POST 메소드는 메시지 바디를 통해 들어온 데이터를 처리하는 모든 기능을 수행한다.
•  주로 전달된 데이터는 신규 리소스 등록, 프로세스 처리에 사용한다.
• POST 메소드를 통해 클라이언트에서 JSON 형태로 메시지 바디에 데이터를 실어서 서버로 요청을 보낸다. 
• 서버에서는 이 데이터를 받고 확인한 다음 서버상에 작성되어 있는 로직대로 기능을 수행한다.
• 서버측에서 처리가 완료되고 나면, HTTP 상태 코드와 함께(200 번대) 기존에 클라이언트에서 요청을 위해 보냈던 데이터를 메시지 바디에 함께 실어서 응답을 보내준다.

* 정리

리소스 URI 에 POST 요청이 오면, 요청 데이터를 어떻게 처리할 지 리소스마다 따로 정해야 한다. -> 따로 처리 방식이 정해진게 없다.

1. 새 리소스 생성(등록)

• 서버가 아직 식별하지 않은 새 리소스 생성

2. 요청 데이터 처리

•  단순히 데이터를 생성하거나, 변경하는 것을 넘어서 프로세스를 처리해야 하는 경우
•  예시 : 주문에서 결제완료 -> 배달 시작 -> 배달 완료 처럼 단순히 값 변경을 넘어 프로세스의 상태가 변경되는 경우
•  POST 의 결과로 새로운 리소스가 생성되지 않을 수도 있다.
•  예시 : POST /orders/{ordersId}/start-delivery (컨트롤 URI)

3. 다른 메소드로 처리하기 애매한 경우

•  예시 : JSON 으로 조회 데이터를 넘겨야 하는데, GET 메소드를 사용하기 어려운 경우
•  애매하면 POST 를 쓰자

HTTP 메소드 : PUT, PATCH, DELETE

* PUT

•  리소스를 대체할 때 쓰이는 메소드이다.
  • 리소스가 있으면 대체한다.
  • 리소스가 없으면 생성한다.
  • 쉽게 이야기해서, 리소스를 덮어버린다.
•  주의! 리소스를 완전히 대체해버린다.
• 예를 들어 클라이언트 측에서는 age 라는 데이터만 서버로 보냈는데, 서버에서는 username, age 총 두 가지 데이터가 있는 경우 이 데이터가 완전히 대체되어 버리기 때문에 서버측에서는 username 필드가 삭제되어 버린다.
•  중요! 클라이언트가 리소스를 식별한다 : POST 와의 큰 차이점으로 클라이언트가 리소스 위치를 알고 URI 를 지정할 수 있다.

정리하자면 PUT 은 데이터를 수정하는 것이 아니라 완전히 대체해버리는 것이다.

그렇다면 데이터를 부분적으로만 수정하려면 어떤 메소드를 사용하는 것이 좋을까?

 

* PATCH

•  리소스를 부분적으로만 변경한다.
•  PUT 과는 다르게 age 필드만 데이터로 보내면, 서버측에서 username 필드가 삭제되는 것이 아니라 정확하게 age 필드의 값만 변경된다.
•  혹여나 PATCH 를 지원하지 않는 서버상에서 작업을 해야 한다면 POST 를 쓰자.

 

* DELETE

•  리소스를 제거할 때 사용하는 메소드이다.

HTTP 메소드의 속성

•  안전(Safe Methods)
•  멱등(Idempotent Methods)
•  캐시 가능(Cacheable Methods)

* 안전(Safe Methods)

•  호출해도 리소스를 변경하지 않는다.(GET 과 같은 경우)
•  그래도 계속 호출해서 로그 같은게 쌓여서 장애가 발생하면?
•  안전은 해당 리소스만 고려한다. 위와 같은 장애까지는 고려하지 않는다.

 

* 멱등(Idempotent Methods)

•  f(f(x)) = f(x)
•  한 번 호출하든, 두 번 호출하든 100번 호출하든 결과가 똑같다.
•  멱등 메소드는 다음과 같다.
•  GET : 한 번 조회하든, 두 번 조회하든 같은 결과가 나온다.
•  PUT : 결과를 대체한다. 따라서 같은 요청을 여러번 해도 최종 결과는 같다.
•  DELETE : 결과를 삭제한다. 같은 요청을 여러번 해도 삭제된 결과는 똑같다.
•  POST : 멱등이 아니다! 두 번 호출하면 같은 결제가 중복해서 발생할 수 있다.

 

* 멱등의 활용?

•  자동 복구 메커니즘에서 활용 가능한 속성이다.
•  서버가 timeout 등으로 정상 응답을 못 주었을 때, 클라이언트가 같은 요청을 다시 해도 되는가에 대한 판단 근거가 된다.

 

그렇다면 아래와 같은 경우는 어떨까?

•  재요청 중간에 다른 곳에서 리소스를 변경해버리면 어떻게 될까?
•  사용자1 : GET -> username:A, age:20
•  사용자2 : POST -> username:A, age:30
•  사용자3 : GET -> username:A, age30 -> 사용자2의 영향으로 바뀐 데이터 조회
•  멱등은 외부 요인으로 중간에 리소스가 변경되는 것 까지는 고려하지 않는다.

 

* 캐시 가능(Cacheable Methos)

•  응답 결과 리소스를 캐시해서 사용해도 되는가?
•  GET, HEAD, POST, PATCH : 캐시 가능
•  실제로는 GET, HEAD 정도만 캐시로 사용한다.
•  POST, PATCH 는 본문 내용까지 캐시 키로 고려해야 하는데, 구현이 쉽지 않다.