[Spring MVC] API 계층

🍃 Spring MVC

Spring에서 지원하는 모든 기능을 포함해서 Spring Framework 라고 한다.

 

Spring의 모듈 중에서는 웹 계층을 담당하는 몇 가지 모듈이 있는데, 그 중에서 서블릿(Servlet) API를 기반으로 클라이언트의 요청을 처리하는 모듈이 있다. 우리는 이것을 spring-webmvc 라고 한다. 이는 Spring Web MVC, Spring MVC, Spring MVC 프레임워크라고 불리고 있다.

 

간단히 정리하면 Spring MVC 는 다음과 같다.

 

✔️ Spring MVC 클라이언트 요청을 편리하게 처리해주는 프레임워크이다.

✔️ 우리가 만들게 될 샘플 애플리케이션은 Spring MVC가 제공해주는 기능을 이용해서 만든다.

 

 

서블릿(Servlet)이란?

- 클라이언트의 요청을 처리하도록 특정 규약에 맞춰 Java 코드로 작성하는 클래스 파일이다.

- 아파치 톰캣 (Apache Tomcat)은 서블릿들이 웹 애플리케이션으로 실행이 되도록 해주는 서블릿 컨테이너 (Servlet Container) 중 하나이다.

 

 

Model

 

Model은 Spring MVC에서 M에 해당한다.

 

Spring MVC 기반의 웹 애플리케이션이 클라이언트의 요청을 전달 받으면 요청 사항을 처리하기 위한 작업을 한다.

 

이렇게 처리한 작업의 결과 데이터를 클라이언트에게 응답으로 돌려줘야 하는데, 이 때 클라이언트에게 응답으로 돌려주는 작업의 처리 결과 데이터를 Model이라고 한다.

 

클라이언트에의 요청 사항을 구체적으로 처리하는 영역을 서비스 계층(Service Layer)이라고 하며,

실제로 요청 사항을 처리하기 위해 Java 코드로 구현한 것을 비즈니스 로직(Business Logic) 이라 한다. 

 

 

View

Model은 Spring MVC에서 V에 해당한다.

 

View는 Model 데이터를 이용해 웹 브라우저 같은 클라이언트 애플리케이션의 화면에 보이는 리소스(Resource)를 제공하는 역할을 한다.

 

Spring MVC 에는 다양한 View 기술이 포함되어 있는데 View의 형태는 다음과 같이 나눌 수 있다.

 

- HTML 페이지의 출력

- PDF, Excel 등의 문서 형태로 출력

- XML, JSON(JavaScript Object Natation) 등 특정 형식의 포맷으로의 변환

 

 

Controller

Model은 Spring MVC에서 C에 해당한다.

 

Controller는 클라이언트 측의 요청을 직접적으로 전달받는 엔드포인트(Endpoint)로써 Model 과 View 의 중간에서 상호 작용을 해주는 역할을 한다.

 

클라이언트 측의 요청을 전달 받아서 비즈니스 로직을 거친 후 Model  데이터가 만들어지면, 이 Model 데이터를 View로 전달하는 역할을 한다.

 

 

 

Spring MVC 동작 방식과 구성 요소

 

Spring MVC의 동작 방식 및 구성 요소

(1) 먼저 클라이언트가 요청을 전송하면 DispatcherServlet이라는 클래스에 요청이 전달된다.

 

(2) DispatcherServlet은 클라이언트의 요청을 처리할 Controller에 대한 검색을 HandlerMapping 인터페이스에게 요청한다.

 

(3) HandlerMapping은 클라이언트 요청과 매핑되는 핸들러 객체를 다시 DispatcherServlet에게 리턴해준다.

핸들러 객체는 해당 핸들러의 Handler 메서드 정보를 포함하고 있다.
Handler 메서드는 Controller 클래스 안에 구현된 요청 처리 메서드를 의미한다.

(4) 요청을 처리할 Controller 클래스를 찾았으니 이제는 실제로 클라이언트 요청을 처리할 Handler 메서드를 찾아서 호출해야 합니다. DispatcherServlet은 Handler 메서드를 직접 호출하지 않고, HandlerAdpater에게 Handler 메서드 호출을 위임한다.

(5) HandlerAdapter는 DispatcherServlet으로부터 전달받은 Controller 정보를 기반으로 해당 Controller의 Handler 메서드를 호출한다.

이제 전체 처리 흐름의 반환점을 돌았다. 이제부터는 반대로 되돌아가보자.

(6) Controller의 Handler 메서드는 비즈니스 로직 처리 후 리턴 받은 Model 데이터를 HandlerAdapter에게 전달한다.

(7) HandlerAdapter는 전달받은 Model 데이터와 View 정보를 다시 DispatcherServlet에게 전달한다.

(8) DispatcherServlet은 전달받은 View 정보를 다시 ViewResolver에게 전달해서 View 검색을 요청한다.

(9) ViewResolver는 View 정보에 해당하는 View를 찾아서 View를 다시 리턴해준다.

(10) DispatcherServlet은 ViewResolver로부터 전달받은 View 객체를 통해 Model 데이터를 넘겨주면서 클라이언트에게 전달할 응답 데이터 생성을 요청한다.

(11) View는 응답 데이터를 생성해서 다시 DispatcherServlet에게 전달한다.

(12) DispatcherServlet은 View로부터 전달받은 응답 데이터를 최종적으로 클라이언트에게 전달한다.

 

Front Controller Pattern

- DispatcherServlet이 애플리케이션의 가장 앞단에 배치되어 다른 구성요소들과 상호작용하면서 클라이언트의 요청을 처리하는 패턴

 

 

 

Controller 클래스 설계 및 구조 생성 

 

 

API 계층 (계층형 아키텍처)

 

API 계층은 클라이언트의 요청을 직접적으로 전달 받는 계층이다

 

Spring MVC 동작 방식과 구성 요소를 살펴보면 클라이언트 요청 흐름의 끝에는 Controller가 있다.

이곳이 바로 Spring MVC에서 클라이언트 요청의 최종 목적지가 된다.

 

 

커피 주문 애플리케이션을 만든다고 가정하고, 해당 애플리케이션의 Controller을 설계해보자.

먼저 애플리케이션의 기능 요구사항을 정리해보자.

 

 

주인이 커피 정보를 관리하는 기능
- 커피 정보 등록 기능
- 등록한 커피 정보 수정 기능
- 등록한 커피 정보 삭제 기능
- 등록한 커피 정보 조회 기능

고객이 커피 정보를 조회하는 기능
- 커피 정보 조회 기능

고객이 커피를 주문하는 기능
- 커피 주문 등록 기능
- 커피 주문 취소 기능
- 커피 주문 조회 기능

고객이 주문한 커피를 주인이 조회하는 기능
- 커피 주문 조회 기능
- 고객에게 전달 완료한 커피에 대한 주문 완료 처리 기능

 

 

커피 주문 애플리케이션에 필요한 리소스

REST API 기반의 애플리케이션에서는 일반적으로 애플리케이션이 제공해야 될 기능을 리소스(Resource, 자원)으로 분류한다.

따라서 아래와 같은 리소스가 필요한 것을 예상할 수 있다.

 

커피 주문 애플리케이션에 기본적으로 필요한 리소스

 

커피 주문 애플리케이션의 Controller 구조 작성

 

MemberController 구조 작성

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController   // (1)
@RequestMapping("/v1/members")   // (2)
public class MemberController {
}

✔️ (1) @RestController

- Spring MVC에서 특정 클래스에 해당 애노테이션이 추가되면, 해당 클래스가 REST API의 리소스를 처리하기 위해 API 엔드포인트로 동작함을 정의한다.

- @RestController 가 추가된 클래스는 애플리케이션 로딩 시, Spring Bean으로 등록한다.

 

✔️ (2) @RequestMapping

- 클라이언트의 요청과 클라이언트의 요청을 처리하는 핸들러 메서드 (Handler Method)를 매핑해주는 역할을 한다.

- 클래스 전체에 사용하는 공통의 URL(Base URL) 설정을 한다.

 

 

CoffeeController 구조 작성

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/v1/coffees")
public class CoffeeController {
}

 

 

OrderController 구조 작성

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/v1/orders")
public class OrderController {
}

 

 

핸들러 메서드 (Handler Method)

핸들러 메서드란 우리가 위에서 작성한 Controller 클래스에 클라이언트의 요청을 처리하는 메서드를 말한다.

위에서 구현한 각 Controller에 핸들러 메서드를 작성해보자.

 

 

MemberController 레거시 코드 

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

import java.util.HashMap;
import java.util.Map;

@RestController
@RequestMapping("/v1/members") // (1) produces 설정 제거됨
public class MemberController {
    @PostMapping
    public ResponseEntity postMember(@RequestParam("email") String email,
                                     @RequestParam("name") String name,
                                     @RequestParam("phone") String phone) {
        // (2) JSON 문자열 수작업을 Map 객체로 대체
        Map<String, String> map = new HashMap<>();
        map.put("email", email);
        map.put("name", name);
        map.put("phone", phone);

        // (3) 리턴 값을 ResponseEntity 객체로 변경
        return new ResponseEntity<>(map, HttpStatus.CREATED);
    }

    @GetMapping("/{member-id}")
    public ResponseEntity getMember(@PathVariable("member-id") long memberId) {
        System.out.println("# memberId: " + memberId);

        // not implementation

        // (4) 리턴 값을 ResponseEntity 객체로 변경
        return new ResponseEntity<>(HttpStatus.OK);
    }

    @GetMapping
    public ResponseEntity getMembers() {
        System.out.println("# get Members");

        // not implementation

        // (5) 리턴 값을 ResponseEntity 객체로 변경
        return new ResponseEntity<>(HttpStatus.OK);
    }
}

 

✔️ (2) 우리는 JSON 문자열을 수작업으로 작성할 필요 없이 Map 객체로 대체할 수 있다.

- Map<String, String>의 경우 key와 value가 모두 String 이어야 한다.

- key가 String이고, 다른 타입의 데이터를 map에 추가하기 위해서는 value 타입을 Object로 지정해야 한다.

 

✔️ (3) 리턴 값으로 JSON 문자열을 처리하던 부분이 ResponseEntity 객체를 리턴하는 것으로 바꿀 수 있다.

- return new ResponseEntity<>(map, HttpStatus.CREATED);

- 이는 객체를 생성하면서 생성자 파라미터로 응답 데이터(map)과 HTTP 응답 상태를 함께 전달하고 있다.

 

 

 

클라이언트와 서버의 관계

웹 브라우저와 웹 서버

웹 브라우저는 웹 서버가 응답으로 전달해주는 HTML 콘텐츠를 전달 받아, 브라우저 내에 보여준다.

여기서 서버 쪽 리소스를 이용하는 측이 클라이언트가 된다.

 

하지만 서버는 항상 클라이언트에게 리소스를 제공하는 것이 아닌, 서버도 다른 서버로부터 리소스를 제공받아야 하는 경우가 많다. 대표적으로 Frontend와 Backend의 관계를 살펴볼 수가 있다.

 

 

여기서 웹 브라우저의 입장에서는 Frontend의 리소스를 제공받으므로 클라이언트가 된다.

Frontend의 경우는 리소스를 제공하는 입장이기 때문에 서버가 맞지만, Frontend가 Backend의 동적인 데이터를 요청하게 되면, 이때는 Backend의 리소스를 이용하는클라이언트가 되는 것이다.

 

 

결론은 어떤 서버가 HTTP 통신을 통해 다른 서버의 리소스를 이용하게 되면, 그 때는 클라이언트의 역할을 한다는 것이다.

 

 

 

 

DTO(Data Transfer Object)란?

 

DTO는 엔터프라이즈 애플리케이션 아키텍처 패턴의 하나로, 애플리케이션 아키텍처 패턴의 하나클라이언트에서 서버 쪽으로 전송하는 요청 데이터를 전달받을 때, 서버에서 클라이언트 쪽으로 전송하는 응답 데이터를 전송하기 위한 용도로 사용된다.

 

우리가 DTO를 사용하는 이유는 다음과 같다.

- 클라이언트의 RequestBody를 하나의 객체로 모두 전달받을 수 있기 때문에 코드 자체가 간결해진다.

- RequsetBody의 데이터 유효성 검증이 단순해진다.

 

 

 

DTO 클래스 적용 전 MemberController 코드

@RestController
@RequestMapping("/v1/members")
public class MemberController {
    @PostMapping
    public ResponseEntity postMember(@RequestParam("email") String email,
                                     @RequestParam("name") String name,
                                     @RequestParam("phone") String phone) {
        Map<String, String> map = new HashMap<>();
        map.put("email", email);
        map.put("name", name);
        map.put("phone", phone);

        return new ResponseEntity<Map>(map, HttpStatus.CREATED);
    }

		...
		...
}

 

 

DTO 클래스 적용 후 MemberController 코드

@RestController
@RequestMapping("/v1/members")
public class MemberController {
    @PostMapping
    public ResponseEntity postMember(MemberDto memberDto) {
        return new ResponseEntity<MemberDto>(memberDto, HttpStatus.CREATED);
    }

		...
		...
}

 

유효성 검증 로직이 추가된 MemberDto 클래스

public class MemberDto {
    @Email
    private String email;
    private String name;
    private String phone;

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getPhone() {
        return phone;
    }

    public void setPhone(String phone) {
        this.phone = phone;
    }
}

 

- MemberDto 클래스에서 이메일에 대한 유효성 검증을 진행했다.

 

 

 

유효성 검증이 적용된 MemberController 코드

@RestController
@RequestMapping("/v1/members")
public class MemberController {
    @PostMapping
    public ResponseEntity postMember(@Valid MemberDto memberDto) {
        return new ResponseEntity<MemberDto>(memberDto, HttpStatus.CREATED);
    }

		...
		...
}

 

 

 

이제 본격적으로 Dto 클래스를 생성해보고, MemberController에 적용해보자.

 

 

회원 정보 등록에 사용되는 MemberPostDto 클래스

public class MemberPostDto {
    private String email;
    private String name;
    private String phone;

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getPhone() {
        return phone;
    }

    public void setPhone(String phone) {
        this.phone = phone;
    }
}

 

 

회원 정보 수정에 사용되는 MemberPatchDto 클래스

public class MemberPatchDto {
    private long memberId;
    private String name;
    private String phone;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getPhone() {
        return phone;
    }

    public void setPhone(String phone) {
        this.phone = phone;
    }

    public long getMemberId() {
        return memberId;
    }

    public void setMemberId(long memberId) {
        this.memberId = memberId;
    }
}

 

 

Dto가 적용된 MemberController

import com.codestates.member.MemberPatchDto;
import com.codestates.member.MemberPostDto;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/v1/members")
public class MemberController {
    // 회원 정보 등록
    @PostMapping
    public ResponseEntity postMember(@RequestBody MemberPostDto memberPostDto) {
        return new ResponseEntity<>(memberPostDto, HttpStatus.CREATED);
    }

    // 회원 정보 수정
    @PatchMapping("/{member-id}")
    public ResponseEntity patchMember(@PathVariable("member-id") long memberId,
                                      @RequestBody MemberPatchDto memberPatchDto) {
        memberPatchDto.setMemberId(memberId);
        memberPatchDto.setName("홍길동");

        // No need Business logic

        return new ResponseEntity<>(memberPatchDto, HttpStatus.OK);
    }

    // 한명의 회원 정보 조회
    @GetMapping("/{member-id}")
    public ResponseEntity getMember(@PathVariable("member-id") long memberId) {
        System.out.println("# memberId: " + memberId);

        // not implementation
        return new ResponseEntity<>(HttpStatus.OK);
    }

    // 모든 회원 정보 조회
    @GetMapping
    public ResponseEntity getMembers() {
        System.out.println("# get Members");

        // not implementation

        return new ResponseEntity<>(HttpStatus.OK);
    }

    // 회원 정보 삭제
    @DeleteMapping("/{member-id}")
    public ResponseEntity deleteMember(@PathVariable("member-id") long memberId) {
        // No need business logic

        return new ResponseEntity(HttpStatus.NO_CONTENT);
    }
}

 

 

 

✔️ @RequestBody 애너테이션

코드 3-32에서 MemberPostDto 클래스 앞에 붙은 @RequestBody 애너테이션은 JSON 형식의 Request Body를 MemberPostDto 클래스의 객체로 변환을 시켜주는 역할을 한다.

이 말의 의미는 클라이언트 쪽에서 전송하는 Request Body가 JSON 형식이어야 한다는 말과 같다.

만일 JSON 형식이 아닌 다른 형식의 데이터를 전송한다면, Spring 내부에서 ‘Unsupported Media Type’과 같은 에러 메시지를 포함한 응답을 전달한다.

 

 

✔️ @ResponseBody 애너테이션

@RequestBody의 역할이 클라이언트 쪽에서 전송한 JSON 형식의 Request Body를 DTO 클래스의 객체로 변환하는 것이라면, @ResponseBody는 JSON 형식의 Response Body를 클라이언트에게 전달하기 위해 DTO 클래스의 객체를 Response Body로 변환하는 역할을 한다.

여기서 @ResponseBody를 사용하는 곳이 없는 이유는 postMember(), patchMember() 핸들러 메서드의 리턴 값이 ResponseEntity 클래스의 객체이기 때문이다.

Spring MVC에서는 핸들러 메서드에 @ResponseBody 애너테이션이 붙거나 핸들러 메서드의 리턴 값이 ResponseEntity일 경우, 내부적으로 HttpMessageConverter가 동작하게 되어 응답 객체(여기서는 DTO 클래스의 객체)를 JSON 형식으로바꿔준다.

 

 

 

✔️ JSON 직렬화(Serialization)와 역직렬화(Deserialization)

클라이언트 쪽에서 JSON 형식의 데이터를 서버 쪽으로 전송하면 서버 쪽의 웹 애플리케이션은 전달받은 JSON 형식의 데이터를 DTO 같은 Java의 객체로 변환하는데 이를 역직렬화(Deserialization)이라고 한다.

반면에 서버 쪽에서 클라이언트에게 응답 데이터를 전송하기 위해서 DTO 같은 Java의 객체를 JSON 형식으로 변환하는 것을 직렬화(Serialization)라고 한다.

JSON 직렬화(Serialization): Java 객체 → JSON
JSON 역직렬화(Deserialization): JSON → Java 객체