[7/5 TIL] SPRING MVC(WebApplicationContext, REST(ful) API)

🍃프로그래머스 백엔드 데브코스 4기 교육과정을 듣고 정리한 글입니다.🍃

WebApplicationContext

• Spring Framework에서 제공하는 웹 애플리케이션을 위한 ApplicationContext의 구현체
• 웹 애플리케이션 환경에서 Spring의 IoC 컨테이너와 DI(Dependency Injection) 기능을 제공
• 웹 애플리케이션에 필요한 빈(Bean)들을 생성하고 관리
• 웹 실행시, ContextLoaderListener가 웹 애플리케이션 컨텍스트를 생성하고, 이를 ServletContext에 저장
• ContextLoaderListener를 통해 자동으로 생성된 웹 애플리케이션 컨텍스트를 편의상 servlet applicationContext라고 함

ServletContext

그림 출처

• 여러 서블릿의 공유가 가능한 정보를 담고 있는 일종의 객체
• Dispatcher Servlet을 포함한 여러 서블릿에서 접근하여 공용 자원처럼 사용됨
• 각 서블릿은 필요에 따라 WebApplicationContext에서 필요한 빈(Bean)들을 가져와 사용

ContextLoaderListener

• 웹 애플리케이션 컨텍스트를 생성하고 초기화하는 역할을 담당
• ContextLoaderListener는 웹 애플리케이션 컨텍스트를 생성하고, 이를 servlet applicationContext에 저장
• ContextLoaderListener를 통해 수동으로 생성된 웹 애플리케이션 컨텍스트를 편의상 root applicationContext라고 함

동작 방식

그림 출처

• Dispatcher Servlet은 여러개 만들어질 수 있고, 컨트롤러는 해당 Dispatcher Servlet에 매핑 됨
• Dispatcher Servlet이 사용하는 컨트롤러는 웹 실행시, 자동으로 만들어지는 servlet applicationContext에 등록된 빈들
• 서비스와 DAO영역은 웹 실행시, 수동으로 만들어지는 root applicationContext에 등록된 빈들
• 위와 같이 계층 별로 나눌수도 있고, 하나의 IOC 컨테이너(웹 애플리케이션 컨텍스트)에 모든 빈들을 등록할 수 있음

REST(ful) API

REST 아키텍쳐 스타일을 따르는 API

Rest 아키텍쳐 스타일

• 클라이언트-서버 (client-server)
  • 사용자 인터페이스에 대한 관심을 데이터 저장에 대한 관심으로부터 분리함으로써 클라이언트의 이식성과 서버의 규모 확장성을 개선
• 스테이트리스 (stateless)
  • 클라이언트 서버의 통신에 상태가 없음
  • 모든 요청에는 필요한 모든 정보를 담고 있어 가시성이 좋고 요청 실패시 복원이 쉽기 때문에 신뢰성이 좋음
  • 상태를 저장할 필요가 없어 규모확장성이 개선
• 캐시 (cache)
  • 캐시가 가능해야 하고, HTTP가 가진 캐싱 기능이 적용 가능
  • HTTP 프로토콜 표준에서 사용하는 Last-Modified태그나 E-Tag를 이용하면 캐싱 구현이 가능
• 균일한 인터페이스 (uniform interface)
  • URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일
• 계층화된 시스템 (layered system)
  • REST 서버는 다중 계층으로 구성될 수 있음
  • 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용 가능

REST 아키텍쳐 스타일 Level

그림 출처

Level 3까지 적용하면, REST 아키텍쳐 스타일에 가장 근접하게 API를 만들었다고 봄

• Level 0
  • 가장 하위의 레벨
  • HTTP를 통해 리소스를 전달했다라는 의의
  • REST는 아님
• Level 1
  • Resources 추가
  • 리소스의 상태를 반영하고 있는 정보이고 representation data와 representation metadata로 구성
    그림 출처
• Level 2
  • HTTP 메서드 도입
• Level 3
  • HATEOAS
  • 클라이언트가 응답 받은 리소스를 갖고 무엇을 할 수 있는지 응답 메세지에 알려줌
    그림 출처

API 설계

GET /members/delete/1	//사용 x
DELETE /members/1		//사용 o
GET /members/show/1		//사용 x
GET /members/1			//사용 o
POST /task/1/run		//사용 o

• URI는 정보의 자원을 표현해야 하고, 리소스명은 동사보다 명사를 사용
• 자원에 대한 행위는 동사 대신 HTTP Method로 표현
• 슬래시 구분자(/)는 계층 관계를 나타내는 데 사용
• URI 마지막 문자로 슬래시(/) 포함 안함
• 가독성을 높이기 위해 하이폰(-) 사용 가능
• CRUD가 아닌, 특정 행위를 표현하려면 URI의 마지막에 동사 표현

스프링에서 REST API 사용

• @RequestBody: 전달받은 요청 메세지를 원하는 형태로 변환

@PostMapping("/users")
public ResponseEntity<User> createUser(@RequestBody User user) {
    // 클라이언트에서 전송한 JSON 또는 XML 데이터를 User 객체로 변환하여 받음
    // User 객체를 이용해 필요한 비즈니스 로직 수행
    // ...

    // 생성된 User 객체를 HTTP 응답의 본문으로 반환
    return ResponseEntity.ok(user);
}

---

• @ResponseBody: 정의한 모델 클래스를 ResponseBody 형태로 변환

@GetMapping("/users/{id}")
@ResponseBody
public User getUser(@PathVariable Long id) {
    // id에 해당하는 User 객체를 데이터베이스에서 조회
    // ...

    // 조회된 User 객체를 HTTP 응답의 본문으로 반환하여 클라이언트에게 전송
    return user;
}

---

• @RestController: 클래스의 모든 메서드에 @ResponseBody 적용

@RestController // @Controller + @ResponseBody
public class UserController {

    @PostMapping("/users")
    public ResponseEntity<User> createUser(@RequestBody User user) {
        // ...
    }

    @GetMapping("/users/{id}")
    public User getUser(@PathVariable Long id) {
        // ...
    }
}

HTTP 메시지 컨버터

그림 출처

• Spring MVC에서 HTTP 요청과 응답의 본문(body)을 자바 객체와 HTTP 메시지 형식(JSON, XML, TEXT 등) 간에 변환해주는 기능을 수행
• 클라이언트가 JSON 형식으로 요청을 보내면 HTTP 메시지 컨버터는 JSON 데이터를 자바 객체로 변환
• 서버가 JSON 형식으로 응답을 보내면 자바 객체를 JSON으로 변환하여 전송
• 클라이언트 요청의 Content-Type 헤더와 서버 응답의 Accept 헤더를 기반으로 적절한 메시지 컨버터를 선택
• Spring MVC는 다양한 형식을 처리하는 여러 개의 HTTP 메시지 컨버터를 지원하며, 우선순위 부여 가능

Http Client 도구

• Intellij HTTP Client
• Postman