[Spring MVC] 15. 스프링 MVC - 기본 기능

해당 글은 김영한님의 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 - 인프런 | 강의를 수강하고 정리한 게시글입니다.

스프링 MVC - 기본 기능

로깅

운영 시스템에서는 System.out.println() 같은 시스템 콘솔을 사용해서 필요한 정보를 출력하지 않고, 별도의 로깅 라이브러리를 사용해서 로그를 출력한다.

 

로깅 라이브러리
스프링 부트 라이브러리를 사용하면 스프링 부트 로깅 라이브러리( spring-boot-starter-logging )가 함께 포함된다.

• SLF4J - http://www.slf4j.org
• Logback - http://logback.qos.ch

로그 라이브러리는 수 많은 라이브러리가 있는데, 그것들을 통합해서 인터페이스로 제공하는 것이 SLF4J 라이브러리이다.

//@Slf4j
@RestController // 리턴하는 걸 뷰에 바로 반환됨.(html body에)
public class LogTestController {

    private final Logger log = LoggerFactory.getLogger(getClass());

    @RequestMapping("/log-test")
    public String logTest() {

        String name = "Spring";

        System.out.println("name = " + name);

        log.trace("trace log={}", name);
        log.debug("debug log={}", name);
        log.info(" info log={}", name);
        log.warn(" warn log={}", name);
        log.error("error log={}", name);


        return "ok";
    }
}

 

로그 사용법
log.debug("data={}", data)
문자 더하기 연산을 사용하면 안되고 위의 방식대로 사용한다. (문자 더하기를 하면 출력되지 않는 로그도 실행되서 낭비되기 때문에)

참고 : 위의 예시 코드 처럼 log를 LoggerFactory에서 받아서 사용해도 되지만, 클래스 레벨에 @Slf4j 에노테이션을 사용해서 바로 log라는 변수로 사용해도 된다.

 

로그 레벨 설정

#전체 로그 레벨 설정(기본 info)
#logging.level.root=debug

# hello.springmvc 패키지와 그 하위 로그 레벨 설정
logging.level.hello.springmvc=debug

• LEVEL: TRACE > DEBUG > INFO > WARN > ERROR
• 보통 개발 서버는 debug 출력
• 보통 운영 서버는 info 출력

요청 매핑

@RestController
public class MappingController {

    private Logger log = LoggerFactory.getLogger(getClass());

    @RequestMapping(value = "/hello-basic")
    public String helloBascie() {
        log.info("basic");
        return "ok";
    }
}

• @RestController : @Controller는 반환 값이 String이면 뷰 이름으로 인식되서 뷰를 찾고 뷰가 랜더링되지만, @RestController는 반환값으로 뷰를 찾는 것이 아니라 HTTP 메시지 바디에 바로 입력한다.
• @RequestMapping(“/hello-basic”) : /hello-basic URL 호출이 오면 해당 메서드가 실행되도록 매핑한다. 또한 이 애노테이션에 method 속성을 지정하지 않으면 모든 메서드를 허용하게 된다.
  • 다중 설정 가능 ex) {“/hello-basic”, “/hello-go”}

[HTTP 메서드 매핑]

/**
 * method 특정 HTTP 메서드 요청만 허용
 * GET, HEAD, POST, PUT, PATCH, DELETE
 */
@RequestMapping(value = "/mapping-get-v1", method = RequestMethod.GET)
public String mappingGetV1() {
    log.info("mappingGetV1");
    return "ok";
}

method 속성을 지정해줌으로서 해당 method 요청만 허용한다.
만약, 해당 URL에 다른 method 요청이오면 HTTP 405 Method Not Allowed 를 반환한다.

 

[HTTP 메서드 매핑 축약]

/**
 * 편리한 축약 애노테이션 (코드보기) * @GetMapping
 * @PostMapping
 * @PutMapping
 * @DeleteMapping
 * @PatchMapping
 */
@GetMapping(value = "/mapping-get-v2")
public String mappingGetV2() {
    log.info("mapping-get-v2");
    return "ok";
}

HTTP 메서드를 축약한 애노테이션을 사용하면 더 직관적이다. (@GetMapping 내부 구조를 보면 @RequestMapping에 method = RequestMethod.GET 이 추가되 있는걸 알 수 있다)

[PathVariable(경로 변수) 사용]

/**
 * PathVariable 사용
 * 변수명이 같으면 생략 가능
 * @PathVariable("userId") String userId -> @PathVariable userId
 * /mapping/userA
 */
@GetMapping("/mapping/{userId}")
public String mappingPath(@PathVariable("userId") String data) {
    log.info("mappingPath userId={}", data);
    return "ok";
}

/**
 * PathVariable 사용 다중
 */
@GetMapping("/mapping/users/{userId}/orders/{orderId}")
public String mappingPath(@PathVariable String userId, @PathVariable Long
        orderId) {
    log.info("mappingPath userId={}, orderId={}", userId, orderId);
    return "ok";
}

리소스 경로에 식별자를 넣는 경우( ex) /mapping/userA) @PathVariable 애노테이션을 사용하면 매칭 되는 부분을 편리하게 조회할 수 있다.

참고 : @PathVariable의 이름과 파라미터 이름이 같으면 생략 가능

[미디어 타입 조건 매핑 - HTTP 요청 Content-Type, consume]

/**
 * Content-Type 헤더 기반 추가 매핑 Media Type
 * consumes="application/json"
 * consumes="!application/json"
 * consumes="application/*"
 * consumes="*\/*"
 * MediaType.APPLICATION_JSON_VALUE
 */
@PostMapping(value = "/mapping-consume", consumes = "application/json")
public String mappingConsumes() {
    log.info("mappingConsumes");
    return "ok";
}

HTTP 요청의 Content-Type 헤더를 기반으로 미디어 타입으로 매핑한다.
만약 맞지 않으면 HTTP 415 Unsupported Media Type 을 반환한다.

예시)

consumes = “text/plain” consumes = {“text/plain”, “application/*”} consumes = MediaType.TEXT_PLAIN_VALUE

HTTP API 예시

회원 관리를 HTTP API로 만든다 생각하고 매핑을 어떻게 하는지 알아보자.
(실제 데이터가 넘어가는 부분은 생략하고 URL 매핑만)

 

[회원 관리 API]

• 회원 목록 조회 : GET /users
• 회원 등록 : POST /users
• 회원 조회 : GET /users/{userId}
• 회원 수정 : PATCH /users/{userId}
• 회원 삭제 : DELETE /users/{userId}

@RestController
@RequestMapping("/mapping/users")
public class MappingClassController {

    /**
     * 회원 목록 조회: GET        /users
     * 회원 등록:     POST      /users
     * 회원 조회:     GET       /users/{userId}
     * 회원수정:      PATCH     /users/{userId}
     * 회원 삭제:     DELETE    /users/{userId}
     */

    @GetMapping
    public String users() {
        return "get users";
    }

    @PostMapping
    public String addUser() {
        return "post user";
    }

    @GetMapping("/{userId}")
    public String findUser(@PathVariable String userId) {
        return "get userId=" + userId;
    }

    @PatchMapping("/{userId}")
    public String updateUser(@PathVariable String userId) {
        return "update userId=" + userId;
    }

    @DeleteMapping("/{userId}")
    public String deleteUser(@PathVariable String userId) {
        return "delete userId=" + userId;
    }

}

@RequestMapping(“/mapping/users”) : 클래스 레벨에 매핑 정보를 두면 메서드 레벨에서 해당 정보를 조합해서 사용한다.

HTTP 헤더 조회

애노테이션 기반의 스프링 컨트롤러는 다양한 파라미터를 지원한다.
이번에는 HTTP 헤더 정보를 조회하는 방법을 알아보자.

@Slf4j
@RestController
public class RequestHeaderController {

    @RequestMapping("/headers")
    public String headers(HttpServletRequest request,
                          HttpServletResponse response,
                          HttpMethod httpMethod,
                          Locale locale,
                          @RequestHeader MultiValueMap<String, String> headerMap,
                          @RequestHeader("host") String host,
                          @CookieValue(value = "myCookie", required = false) String cookie) {

        log.info("request={}", request);
        log.info("response={}", response);
        log.info("httpMethod={}", httpMethod);
        log.info("locale={}", locale);
        log.info("headerMap={}", headerMap);
        log.info("header host={}", host);
        log.info("myCookie={}", cookie);


        return "ok";
    }
}

• HttpMethod : HTTP 메서드를 조회한다.
• Locale : Locale 정보(국가 언어)를 조회한다. ex) ko_KR
• @RequestHeader MultiValueMap<String, String> headerMap : 모든 HTTP 헤더를 MutiValueMap 형식으로 조회한다.
• @RequestHeader(“host”) String host : 특정 HTTP 헤더를 조회한다.
• @CookieValue(value = “myCookie”, required = false) String cookie : 특정 쿠키를 조회한다.
  • 속성 (필수 값 여부 : required , 기본 값 : defaultValue)

참고 : MultiValueMap : Map과 유사한데, 하나의 키에 여러 값을 받을 수 있다.
HTTP header, HTTP 쿼리 파라미터와 같이 하나의 키에 여러 값을 받을 때 사용

HTTP 요청 파라미터

서블릿에서 학습했던 HTTP 요청 데이터를 조회 하는 방법을 생각해보고 스프링이 얼마나 깔끔하고 효율적으로 바꾸어주는지 알아보자.

참고 : [Spring MVC] 06. HTTP 요청 데이터 실습

GET 쿼리 파리미터 전송 방식이든, POST HTML Form 전송 방식이든 둘다 형식이 같으므로 구분없이 조회할 수 있다. (이것을 단순히 요청 파라미터 조회라 한다)

 

지금부터 스프링으로 요청 파라미터를 조회하는 방법을 단계적으로 알아보자.

@Slf4j
@Controller
public class RequestParamController {

    @RequestMapping("/request-param-v1")
    public void requestParamV1(HttpServletRequest request, HttpServletResponse response) throws IOException {
        String username = request.getParameter("username");
        int age = Integer.parseInt(request.getParameter("age"));

        log.info("username = {}, age={}", username, age);

        response.getWriter().write("ok");
    }
}

request.getParameter() : 여기서는 단순히 HttpServletRequest가 제공하는 방식으로 요청 파라미터를 조회했다.

위 코드를 확인하려면

• http://localhost:8080/request-param-v1?username=hello&age=20 (GET방식)
• HTML Form을 만들어서 확인해보면 된다.
  (둘다 결과는 같음)

[@RequestParam]

스프링이 제공하는 @RequestParam 을 사용하면 요청 파라미터를 매우 편리하게 사용할 수 있다.

 

[requestParamV2]

@ResponseBody
@RequestMapping("/request-param-v2")
public String requestParamV2(
        @RequestParam("username") String memberName,
        @RequestParam("age") int memberAge) {

    log.info("username = {}, age={}", memberName, memberAge);
    return "ok";
}

@ResponseBody : return 값을 View 조회가 아닌 HTTP message body에 직접 해당 내용을 입력한다. (RestController 원리)

@RequestParam : 파라미터 이름으로 바인딩

• @RequestParam(“username”) String memberName -> request.getParameter(“username”)

[requestParamV3]

@ResponseBody
@RequestMapping("/request-param-v3")
public String requestParamV3(
        @RequestParam String username,
        @RequestParam int age) {

    log.info("username = {}, age={}", username, age);
    return "ok";
}

HTTP 파라미터 이름이 변수 이름과 같으면 @RequestParam(name=“xx”) 생략 가능

 

[requestParamV4]

@ResponseBody
@RequestMapping("/request-param-v4")
public String requestParamV4(String username, int age) {
    log.info("username = {}, age={}", username, age);
    return "ok";
}

String, int, Integer 등의 단순 타입이면 @RequestParam 도 생략 가능

주의 : @RequestParam 애노테이션을 생략하면 스프링 MVC는 내부에서 required=false 를 적용한다.

참고 : 이렇게 애노테이션을 완전히 생략해도 되는데, 너무 없는 것도 읽는 쪽에서 안좋을 수 있으니 본인의 판단으로 적도록 하자.

 

[파라미터 필수 여부 - requestParamRequired]

ResponseBody
@RequestMapping("/request-param-required")
public String requestParamRequired(
        @RequestParam(required = true) String username,
        @RequestParam(required = false) Integer age) {
    log.info("username = {}, age={}", username, age);
    return "ok";
}

@RequestParam.required : 파라미터 필수 여부를 결정한다. (기본값은 true)

주의 : 파라미터 이름만 있고 값이 없는 경우 -> 빈문자로 통과
예시) /request-param?username=

주의 : 기본형(primitive)에 null 입력(값을 안주면 null)시 500 예외 발생 따라서 wrapper 클래스(Integer)를 사용하거나 defaultValue를 사용!
예시) @RequestParam(required = false) int age

[기본 값 적용 - requestParamDefault]

@ResponseBody
@RequestMapping("/request-param-default")
public String requestParamDefault(
        @RequestParam(defaultValue = "guest") String username,
        @RequestParam(defaultValue = "-1") int age) {
    log.info("username = {}, age={}", username, age);
    return "ok";
}

파라미터에 값이 없는 경우 defaultValue를 사용하면 기본 값을 적용할 수 있다.
(이미 기본 값이 있으면 required는 의미가 없다)

참고 : defaultValue 는 빈 문자의 경우에도 설정한 기본 값이 적용된다.

 

[파라미터를 Map으로 조회하기 - requestParamMap]

@ResponseBody
@RequestMapping("/request-param-map")
public String requestParamMap(@RequestParam Map<String, Object> paramMap) {
    log.info("username = {}, age={}", paramMap.get("username"), paramMap.get("age"));
    return "ok";
}

파라미터를 Map, MultiValueMap으로 조회할 수 있다.
파라미터의 값이 1개가 확실하다면 Map 을 사용해도 되지만, 그렇지 않다면 MultiValueMap 을 사용하자.

[@ModelAttribute]

실제 개발을 하면 요청 파라미터를 받아서 필요한 객체를 만들고 그 객체에 값을 넣어주어야 한다.
예시)

@RequestParam String username; 
@RequestParam int age;

HelloData data = new HelloData();
data.setUsername(username);
data.setAge(age);

스프링은 이 과정을 완전히 자동화해주는 @ModelAttribute 기능을 제공한다.

 

예시를 위해 요청 파라미터를 바인딩 받을 객체를 다음과 같이 만들어 주자.

 

[HelloData]

@Data
public class HelloData {
    private String username;
    private int age;
}

[modelAttributeV1]

@ResponseBody
@RequestMapping("/model-attribute-v1")
public String modelAttributeV1(@ModelAttribute HelloData helloData) {
    log.info("username = {}, age={}", helloData.getUsername(), helloData.getAge());
    log.info("helloData = {}", helloData);
    return "ok";
}

@ModelAttribute 애노테이션만 넣어주면 값을 넣어주지 않아도 자동으로 객체가 생성되고 요청 파라미터의 값도 모두 들어가있다.

스프링MVC는 @ModelAttribute 가 있으면 다음을 실행한다.

• HelloData 객체를 생성한다.
• 요청 파라미터의 이름으로 HelloData 객체의 프로퍼티를 찾는다. 그리고 해당 프로퍼티의 setter를 호출해서 파라미터의 값을 입력(바인딩) 한다.
  • 예) 파라미터 이름이 username 이면 setUsername() 메서드를 찾아서 호출하면서 값을 입력한다.

참고 : 프로퍼티
객체에 getUsername(), setUsername() 메서드가 있으면, 이 객체는 username이라는 프로퍼티를 갖고 있다.
username 프로퍼티의 값을 변경하면 setUsername()이 호출되고, 조회하면 getUsername()이 호출된다.

 

[modelAttributeV2]

@ResponseBody
@RequestMapping("/model-attribute-v2")
public String modelAttributeV2(HelloData helloData) {
    log.info("username = {}, age={}", helloData.getUsername(), helloData.getAge());
    log.info("helloData = {}", helloData);

    return "ok";
}

@ModelAttribute 는 생략할 수 있다.
그런데 @RequestParam 도 생략할 수 있으니 혼란이 발생할 수 있다.

스프링은 해당 생략시 다음과 같은 규칙을 적용한다.

• String , int , Integer 같은 단순 타입 = @RequestParam
• 나머지 = @ModelAttribute (argument resolver 로 지정해둔 타입 외)

HTTP 요청 메시지

HTTP message body에 데이터를 직접 담아서 요청하는 경우를 알아보자

• HTTP API에서 주로 사용 JSON, XML, TEXT
• 데이터 형식은 주로 JSON 사용
• POST, PUT, PATCH

요청 파라미터와 다르게 HTTP 메시지 바디를 통해 데이터가 넘어오면 @RequestParam, @ModelAttribute를 사용할 수 없다. (HTML Form 형식 제외)

참고 : Http message body

[단순 텍스트]

먼저 가장 단순한 텍스트 메시지를 HTTP 메시지 바디에 담아서 전송하고, 읽어보자
HTTP 메시지 바디의 데이터를 InputStream을 사용해서 직접 읽을 수 있다.

 

[RequestBodyStringController]

@Slf4j
@Controller
public class RequestBodyStringController {

    @PostMapping("/request-body-string-v1")
    public void requestBodyString(HttpServletRequest request, HttpServletResponse response) throws IOException {
        ServletInputStream inputStream = request.getInputStream();
        String messageBody = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);

        log.info("messageBody = {}", messageBody);

        response.getWriter().write("ok");
    }
}

request에서 inputStream을 받아서 UTF_8형식으로 String을 받아주면 된다.

테스트는 Postman에서 Body -> row, Text를 선택해서 해보자.

 

[requestBodyStringV2]

@PostMapping("/request-body-string-v2")
public void requestBodyStringV2(InputStream inputStream, Writer responseWriter) throws IOException {

    String messageBody = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);
    log.info("messageBody = {}", messageBody);
    responseWriter.write("ok");
}

V1에서는 HttpServletRequest와 HttpServletResponse를 사용하였지만 사용하는 기능은 inputStream과 Writer밖에 없었다.

스프링 MVC는 다음 파라미터를 지원한다.

• InputStream(Reader): HTTP 요청 메시지 바디의 내용을 직접 조회
• OutputStream(Writer): HTTP 응답 메시지의 바디에 직접 결과 출력

[requestBodyStringV3]

@PostMapping("/request-body-string-v3")
public HttpEntity<String> requestBodyStringV3(HttpEntity<String> httpEntity) throws IOException {

    String messageBody = httpEntity.getBody();
    log.info("messageBody = {}", messageBody);

    return new HttpEntity<>("ok");
}

V3에서 파라미터 2개를 받았지만, 스프링 MVC는 다음 파라미터를 지원한다.

• HttpEntity: HTTP header, body 정보를 편리하게 조회
  • 메시지 바디 정보를 직접 조회
  • 요청 파라미터를 조회하는 기능과 관계 없음
• HttpEntity는 응답에도 사용 가능
  • 메시지 바디 정보 직접 반환
  • 헤더 정보 포함 가능
  • view 조회 X

참고 : HttpEntity 를 상속받은 다음 객체들도 같은 기능을 제공한다.
RequestEntity : HttpMethod, url 정보가 추가, 요청에서 사용
ResponseEntity : HTTP 상태 코드 설정 가능, 응답에서 사용

 

[requestBodyStringV4]

@ResponseBody
@PostMapping("/request-body-string-v4")
public String requestBodyStringV4(@RequestBody String messageBody){

    log.info("messageBody = {}", messageBody);

    return "ok";
}

@RequestBody를 사용하면 HTTP 메시지 바디 정보를 편리하게 조회할 수 있다
헤더 정보가 필요하다면 HttpEntity 를 사용하거나 @RequestHeader 를 사용하면 된다.

@ResponseBody 를 사용하면 응답 결과를 HTTP 메시지 바디에 직접 담아서 전달할 수 있다. 물론 이 경우에도 view를 사용하지 않는다.

[JSON]

이번에는 HTTP API에서 주로 사용하는 JSON 데이터 형식을 조회해보자.

[RequestBodyJsonController]

public class RequestBodyJsonController {

    private ObjectMapper objectMapper = new ObjectMapper();

    @PostMapping("/request-body-json-v1")
    public void requestBodyJsonV1(HttpServletRequest request, HttpServletResponse response) throws IOException {
        ServletInputStream inputStream = request.getInputStream();
        String messageBody = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);

        log.info("messageBody = {}", messageBody);
        HelloData helloData = objectMapper.readValue(messageBody, HelloData.class);
        log.info("username = {}, age = {}", helloData.getUsername(), helloData.getAge());

        response.getWriter().write("ok");
    }
}

HttpServletRequest를 사용해서 직접 HTTP 메시지 바디에서 데이터를 읽어와서, 문자로 변환한다.

문자로 된 JSON 데이터를 Jackson 라이브러리인 objectMapper를 사용해서 자바 객체로 변환한다.

 

[requestBodyJsonV2]

@ResponseBody
@PostMapping("/request-body-json-v2")
public String requestBodyJsonV2(@RequestBody String messageBody) throws IOException {
    log.info("messageBody = {}", messageBody);
    HelloData helloData = objectMapper.readValue(messageBody, HelloData.class);
    log.info("username = {}, age = {}", helloData.getUsername(), helloData.getAge());

    return "ok";
}

이전에 사용했던 @RequestBody 를 사용해서 HTTP 메시지에서 데이터를 꺼내고 messageBody에 저장한다.

문자로 된 JSON 데이터인 messageBody 를 objectMapper 를 통해서 자바 객체로 변환한다.

 

[requestBodyJsonV3]

@ResponseBody
@PostMapping("/request-body-json-v3")
public String requestBodyJsonV3(@RequestBody HelloData helloData) {
    log.info("username = {}, age = {}", helloData.getUsername(), helloData.getAge());

    return "ok";
}

@RequestBody 객체 파라미터

• @RequestBody HelloData data
• @RequestBody 에 직접 만든 객체를 지정할 수 있다.

HttpEntity , @RequestBody 를 사용하면 HTTP 메시지 컨버터가 HTTP 메시지 바디의 내용을 우리가 원하는 문자나 객체 등으로 변환해준다.

 

HTTP 메시지 컨버터는 문자 뿐만 아니라 JSON도 객체로 변환해주는데, 우리가 방금 V2에서 했던 작업을 대신 처리해준다. (자세한 내용은 뒤에 HTTP 메시지 컨버터에서 다룬다)

 

@RequestBody는 생략 불가능

 

스프링은 @ModelAttribute, @RequestParam 해당 생략시 다음과 같은 규칙을 적용한다.

• String, int , Integer 같은 단순 타입 = @RequestParam
• 나머지 = @ModelAttribute (argument resolver 로 지정해둔 타입 외)

따라서 이 경우 HelloData에 @RequestBody를 생략하면 @ModelAttribute 가 적용되어버린다.
HelloData data -> @ModelAttribute HelloData data

따라서 생략하면 HTTP 메시지 바디가 아니라 요청 파라미터를 처리하게 된다.

주의 : HTTP 요청시에 content-type이 application/json인지 꼭 확인해야 한다. 그래야 JSON을 처리할 수 있는 HTTP 메시지 컨버터가 실행된다.

[requestBodyJsonV4]

@ResponseBody
@PostMapping("/request-body-json-v4")
public String requestBodyJsonV4(HttpEntity<HelloData> data) {
    HelloData helloData = data.getBody();
    log.info("username = {}, age = {}", helloData.getUsername(), helloData.getAge());

    return "ok";
}

앞서 배운 것과 같이 HttpEntity를 사용해도 된다.

 

[requestBodyJsonV5]

@ResponseBody
@PostMapping("/request-body-json-v5")
public HelloData requestBodyJsonV5(@RequestBody HelloData helloData) {
    log.info("username = {}, age = {}", helloData.getUsername(), helloData.getAge());
    return helloData;
}

@ResponseBody : 응답의 경우에도 @ResponseBody 를 사용하면 해당 객체를 HTTP 메시지 바디에 직접 넣어줄 수 있다. (물론 이 경우에도 HttpEntity 를 사용해도 된다)

응답

응답 데이터는 이미 앞에서 일부 다룬 내용들이지만, 응답 부분에 초점을 맞추어서 정리해보자.

스프링(서버)에서 응답 데이터를 만드는 방법은 크게 3가지이다.

• 정적 리소스
  • 예) 웹 브라우저에 정적인 HTML, css, js을 제공할 때는, 정적 리소스를 사용한다.
• 뷰 템플릿 사용
  • 예) 웹 브라우저에 동적인 HTML을 제공할 때는 뷰 템플릿을 사용한다.
• HTTP 메시지 사용
  • HTTP API를 제공하는 경우에는 HTML이 아니라 데이터를 전달해야 하므로, HTTP 메시지 바디에 JSON 같은 형식으로 데이터를 실어 보낸다.

[정적 리소스]

스프링 부트는 클래스패스의 다음 디렉토리에 있는 정적 리소스를 제공한다.
/static, /public, /resources, /META-INF/resources

 

src/main/resources 는 리소스를 보관하는 곳이고, 또 클래스패스의 시작 경로이다. 따라서 다음 디렉토리에 리소스를 넣어두면 스프링 부트가 정적 리소스로 서비스를 제공한다.

 

정적 리소스 경로
src/main/resources/static

 

다음 경로에 파일이 들어있으면
src/main/resources/static/basic/hello-form.html

 

웹 브라우저에서 다음과 같이 실행하면 된다.
http://localhost:8080/basic/hello-form.html

 

정적 리소스는 해당 파일을 변경 없이 그대로 서비스하는 것이다.

[뷰 템플릿]

뷰 템플릿을 거쳐서 HTML이 생성되고, 뷰가 응답을 만들어서 전달한다.
일반적으로 HTML을 동적으로 생성하는 용도로 사용하지만, 다른 것들도 가능하다.

 

스프링 부트는 기본 뷰 템플릿 경로를 제공한다.

 

뷰 템플릿 경로
src/main/resources/templates

 

뷰 템플릿 생성
src/main/resources/templates/response/hello.html

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<p th:text="${data}">empty</p>
</body>
</html>

 

[ResponseViewController]

@Controller
public class ResponseViewController {

    @RequestMapping("/response-view-v1")
    public ModelAndView responseViewV1() {
        ModelAndView mav = new ModelAndView("response/hello")
                .addObject("data", "hello!");

        return mav;
    }

    @RequestMapping("/response-view-v2")
    public String responseViewV2(Model model) {
        model.addAttribute("data", "hello!!");
        return "response/hello";
    }

    @RequestMapping("/response/hello")
    public void responseViewV3(Model model) {
        model.addAttribute("data", "hello!!");
    }
}

[String을 반환하는 경우 - View or HTTP 메시지]
@ResponseBody 가 없으면 response/hello 로 뷰 리졸버가 실행되어서 뷰를 찾고, 렌더링 한다.
@ResponseBody 가 있으면 뷰 리졸버를 실행하지 않고, HTTP 메시지 바디에 직접 response/hello 라는 문자가 입력된다.

 

[Void를 반환하는 경우에는]
@Controller 를 사용하고, HttpServletResponse , OutputStream(Writer) 같은 HTTP 메시지 바디를 처리하는 파라미터가 없으면 요청 URL을 참고해서 논리 뷰 이름으로 사용
요청 URL: /response/hello

참고 : 이 방식은 명시성이 너무 떨어지고 이렇게 딱 맞는 경우도 많이 없어서, 권장하지 않는다.

 

[HTTP 메시지]
@ResponseBody , HttpEntity 를 사용하면, 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에 직접 응답 데이터를 출력할 수 있다.

[HTTP API, 메시지 바디에 직접 입력]

HTTP API를 제공하는 경우에는 HTML이 아니라 데이터를 전달해야 하므로, HTTP 메시지 바디에 JSON 같은 형식으로 데이터를 실어 보낸다.

 

[ResponseBodyController]

@Slf4j
//@Controller
//@ResponseBody
@RestController
public class ResponseBodyController {

    @GetMapping("/response-body-string-v1")
    public void responseBodyV1(HttpServletResponse response) throws IOException {
        response.getWriter().write("ok");
    }

    @GetMapping("/response-body-string-v2")
    public ResponseEntity<String> responseBodyV2() {
        return new ResponseEntity<>("ok", HttpStatus.OK);
    }

//    @ResponseBody
    @GetMapping("/response-body-string-v3")
    public String responseBodyV3() {
        return "ok";
    }

    @GetMapping("/response-body-json-v1")
    public ResponseEntity<HelloData> responseBodyJsonV1() {
        HelloData helloData = new HelloData();
        helloData.setUsername("userA");
        helloData.setAge(20);

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

    @ResponseStatus(HttpStatus.OK)
//    @ResponseBody
    @GetMapping("/response-body-json-v2")
    public HelloData responseBodyJsonV2() {
        HelloData helloData = new HelloData();
        helloData.setUsername("userA");
        helloData.setAge(20);
        return helloData;
    }
}

[responseBodyV1]
서블릿을 직접 다룰 때 처럼 HttpServletResponse 객체를 통해서 HTTP 메시지 바디에 직접 ok 응답 메시지를 전달한다.

 

[responseBodyV2]
ResponseEntity 엔티티는 HttpEntity 를 상속 받았는데, HttpEntity는 HTTP 메시지의 헤더, 바디 정보를 가지고 있다.
ResponseEntity 는 여기에 더해서 HTTP 응답 코드를 설정할 수 있다.
(HttpStatus.CREATED 로 변경하면 201 응답이 나가는 것을 확인할 수 있다)

 

[responseBodyV3]
@ResponseBody 를 사용하면 view를 사용하지 않고, HTTP 메시지 컨버터를 통해서 HTTP 메시지를 직접 입력할 수 있다. ResponseEntity 도 동일한 방식으로 동작한다.

 

[responseBodyJsonV1]
ResponseEntity 를 반환한다. HTTP 메시지 컨버터를 통해서 JSON 형식으로 변환되어서 반환된다.

 

[responseBodyJsonV2]
ResponseEntity 는 HTTP 응답 코드를 설정할 수 있는데, @ResponseBody 를 사용하면 이런 것을 설정하기 까다롭다.
@ResponseStatus(HttpStatus.OK) 애노테이션을 사용하면 응답 코드도 설정할 수 있다.

참고 : 물론 애노테이션이기 때문에 응답 코드를 동적으로 변경할 수는 없다. 프로그램 조건에 따라서 동적으로 변경하려면 ResponseEntity 를 사용하면 된다.

@RestController
@Controller 대신에 @RestController 애노테이션을 사용하면, 해당 컨트롤러에 모두 @ResponseBody 가 적용되는 효과가 있다. 따라서 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에 직접 데이터를 입력한다. 이름 그대로 Rest API(HTTP API)를 만들 때 사용하는 컨트롤러이다.

참고 : @ResponseBody 는 클래스 레벨에 두면 전체에 메서드에 적용되는데, @RestController 에노테이션 안에 @ResponseBody 가 적용되어 있다.