스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 25

Spring 정리 2022. 5. 26. 21:51

인프런 강의 38일차.

 - 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 1 (김영한 강사님)

 - 서블릿, JSP, MVC 패턴

 - 서블릿으로 1차 구현

   -> 서블릿으로 구현했을 때 불편한 점 개선을 위해 JSP로 2차 구현

   -> JSP로도 불편한 점을 개선하기 위해 MVC 패턴으로 3차 구현

 - 스프링 프로젝트 시작

   -> 스프링 기본기능 이해

   -> 스프링 MVC 웹페이지 만들기

 

4. 스프링 MVC - 기본 기능

 4.12 HTTP 메시지 컨버터

  > 뷰 템플릿으로 HTML을 생성해서 응답하는 것이 아니라, HTTP API처럼 JSON 데이터를 HTTP 메시지 바디에서 직접 읽거나 쓰는 경우 HTTP 메시지 컨버터를 사용하면 편리하다.

  * HTTP 메시지 컨버터를 설명하기 전에 잠깐 과거로 돌아가서 스프링 입문 강의에서 설명했던 내용을 살펴보자

ResponseBody 사용원리

   - HTTP의 BODY에 문자 내용을 직접 반환

   - viewResolver 대신에 HttpMessageConverter 가 동작

   - 기본 문자처리: StringHttpMessageConverter

   - 기본 객체처리: MappingJackson2HttpMessageConverter 

   - byte 처리 등등 기타 여러 HttpMessageConverter가 기본으로 등록되어 있음

 

  * 응답의 경우 클라이언트의 HTTP Accept 해더와 서버의 컨트롤러 반환 타입 정보 둘을 조합해서 HttpMessageConverter 가 선택된다.

 

  * 스프링 MVC는 다음의 경우에 HTTP 메시지 컨버터를 적용한다.

   - HTTP 요청: @RequestBody , HttpEntity(RequestEntity) ,

   - HTTP 응답: @ResponseBody , HttpEntity(ResponseEntity) ,

 

  > HTTP 메시지 컨버터 인터페이스

   - org.springframework.http.converter.HttpMessageConverter

   - JsonConverter, StringConverter 등 다양한 타입을 처리해야하므로 인터페이스로 되어있음

   - HTTP 메시지 컨버터는 HTTP 요청, HTTP 응답 둘 다 사용된다.

   - canRead() , canWrite() : 메시지 컨버터가 해당 클래스, 미디어타입을 지원하는지 체크

   - read() , write() : 메시지 컨버터를 통해서 메시지를 읽고 쓰는 기능

 

  * 스프링 부트 기본 메시지 컨버터

   - 0 = ByteArrayHttpMessageConverter

   - 1 = StringHttpMessageConverter

   - 2 = MappingJackson2HttpMessageConverter

   - 스프링 부트는 다양한 메시지 컨버터를 제공하는데, 대상 클래스 타입과 미디어 타입(컨텐츠타입) 둘을 체크해서 사용여부를 결정한다. 만약 만족하지 않으면 다음 메시지 컨버터로 우선순위가 넘어간다

 

 * 주요 컨버터 3가지

 > 1 = ByteArrayHttpMessageConverter : byte[] 데이터를 처리한다.

  - 클래스 타입: byte[] , 미디어타입: */* 

  - 요청 예) '@RequestBody byte[] data'

  - 응답 예) '@ResponseBody return byte[]',  쓰기 미디어타입 'application/octet-stream'

 > 2 = StringHttpMessageConverter : String 문자로 데이터를 처리한다

  - 클래스 타입: String , 미디어타입: */*

  - 요청 예) '@RequestBody String data'

  - 응답 예) '@ResponseBody return "ok" ', 쓰기 미디어타입 'text/plain'

 > 3 = MappingJackson2HttpMessageConverter : application/json

  - 클래스 타입: 객체 또는 HashMap , 미디어타입 application/json 관련

  - 요청 예) '@RequestBody HelloData data'

  - 응답 예) '@ResponseBody return helloData', 쓰기 미디어타입 'application/json 관련'

 

/**
 * 동작 컨버터 체크
 * 1. 클래스 체크 : Stirng -> 0순위인 byte 컨버터는 대상이 아니므로 false, 1순위인 String 컨버터가 true
 * 2. 미디어타입 체크 : application/json -> String 컨버터는 */* 미디어타입을 허용하므로 true
 * 최종 결과 : StringHttpMessageConverter가 동작함
 */
 
content-type: application/json
@RequestMapping
void hello(@RequetsBody String data) {}

 

/**
 * 동작 컨버터 체크
 * 1. 클래스 체크 : HelloData -> 0순위인 byte 컨버터는 대상이 아니므로 false, 1순위인 String 컨버터도 false, 2순위인 Jackson 컨버터(객체 또는 해쉬맵)는 true
 * 2. 미디어타입 체크 : application/json -> Jackson 컨버터는 application/json 미디어타입을 허용하므로 true
 * 최종 결과 : MappingJackson2HttpMessageConverter 동작
 */

content-type: application/json
@RequestMapping
void hello(@RequetsBody HelloData data) {}

 

 

/**
 * 동작 컨버터 체크
 * 1. 클래스 체크 : HelloData -> 0순위인 byte 컨버터는 대상이 아니므로 false, 1순위인 String 컨버터도 false, 2순위인 Jackson 컨버터(객체 또는 해쉬맵)는 true
 * 2. 미디어타입 체크 : application/json -> Jackson 컨버터는 application/json 미디어타입을 허용하므로 false
 * 최종 결과 : 어떠한 컨버터도 동작하지 않는다.
 */

content-type: text/html
@RequestMapping
void hello(@RequetsBody HelloData data) {}

 

 

 * HTTP 요청 데이터 읽기

  > HTTP 요청이 오고, 컨트롤러에서 @RequestBody , HttpEntity 파라미터를 사용한다.

  > 메시지 컨버터가 메시지를 읽을 수 있는지 확인하기 위해 canRead() 를 호출한다.

   - 대상 클래스 타입을 지원하는가 (예. @RequestBody 의 대상 클래스 : byte[] , String , HelloData )

   - HTTP 요청의 Content-Type 미디어 타입을 지원하는가. (예. text/plain , application/json , */* )

  > canRead() 조건을 만족하면 read() 를 호출해서 객체 생성하고, 반환한다

 

 * HTTP 응답 데이터 생성

  > 컨트롤러에서 @ResponseBody , HttpEntity 로 값이 반환된다

  > 메시지 컨버터가 메시지를 쓸 수 있는지 확인하기 위해 canWrite() 를 호출한다.

   - 대상 클래스 타입을 지원하는가 (예. return의 대상 클래스 : byte[] , String , HelloData ) 

   - HTTP 요청의 Accept 미디어 타입을 지원하는가. (더 정확히는 @RequestMapping 의 produces ) (예. text/plain , application/json , */* )

  > canWrite() 조건을 만족하면 write() 를 호출해서 HTTP 응답 메시지 바디에 데이터를 생성한다.

 

 4.13 요청 매핑 헨들러 어뎁터 구조

  > 그렇다면 대체 HTTP 메시지 컨버터는 스프링 MVC 어디쯤에서 사용되는 것일까?

SpringMVC 구조

  * 모든 비밀은 애노테이션 기반의 컨트롤러, 그러니까 @RequestMapping 을 처리하는 핸들러 어댑터인 RequestMappingHandlerAdapter (요청 매핑 헨들러 어뎁터)에 있다

 

RequestMappingHandlerAdapter 동작 방식

 * ArgumentResolver

  > 애노테이션 기반의 컨트롤러는 매우 다양한 파라미터를 사용할 수 있었다.

  > HttpServletRequest , Model 은 물론이고, @RequestParam , @ModelAttribute 같은 애노테이션 그리고 @RequestBody , HttpEntity 같은 HTTP 메시지를 처리하는 부분까지 매우 큰 유연함을 보여주었다.

  > 이렇게 파라미터를 유연하게 처리할 수 있는 이유가 바로 ArgumentResolver 덕분이다.

  > 애노테이션 기반 컨트롤러를 처리하는 RequestMappingHandlerAdaptor 는 바로 이 ArgumentResolver 를 호출해서 컨트롤러(핸들러)가 필요로 하는 다양한 파라미터의 값(객체)을 생성한다.

  > 그리고 이렇게 파리미터의 값이 모두 준비되면 컨트롤러를 호출하면서 값을 넘겨준다

  > 스프링은 30개가 넘는 ArgumentResolver 를 기본으로 제공한다.

  > 정확히는 HandlerMethodArgumentResolver 인데 줄여서 ArgumentResolver 라고 부른다.

 

public interface HandlerMethodArgumentResolver {
    boolean supportsParameter(MethodParameter parameter);
    @Nullable
    Object resolveArgument(MethodParameter parameter, @Nullable
            ModelAndViewContainer mavContainer,
                           NativeWebRequest webRequest, @Nullable WebDataBinderFactory
                                   binderFactory) throws Exception;
}

  - 동작방식 : ArgumentResolver 의 supportsParameter() 를 호출해서 해당 파라미터를 지원하는지 체크하고, 지원하면 resolveArgument() 를 호출해서 실제 객체를 생성한다. 그리고 이렇게 생성된 객체가 컨트롤러 호출시 넘어가는 것이다

 

  > ReturnValueHandler : HandlerMethodReturnValueHandler 를 줄여서 ReturnValueHandle 라 부른다

  > ArgumentResolver 와 비슷한데, 이것은 응답 값을 변환하고 처리한다

  > 컨트롤러에서 String으로 뷰 이름을 반환해도, 동작하는 이유가 바로 ReturnValueHandler 덕분이다. 

  > 스프링은 10여개가 넘는 ReturnValueHandler 를 지원한다. (ModelAndView, @ResponseBody, HttpEntity, String)

 

스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 24

Spring 정리 2022. 5. 22. 18:43

인프런 강의 38일차.

 - 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 1 (김영한 강사님)

 - 서블릿, JSP, MVC 패턴

 - 서블릿으로 1차 구현

   -> 서블릿으로 구현했을 때 불편한 점 개선을 위해 JSP로 2차 구현

   -> JSP로도 불편한 점을 개선하기 위해 MVC 패턴으로 3차 구현

 - 스프링 프로젝트 시작

   -> 스프링 기본기능 이해

   -> 스프링 MVC 웹페이지 만들기

 

4. 스프링 MVC - 기본 기능

 4.8 HTTP 요청 메시지 - 단순 텍스트

  > HTTP message body에 데이터를 직접 담아서 요청

   - 요청 파라미터와 다르게, HTTP 메시지 바디를 통해 데이터가 직접 데이터가 넘어오는 경우는 @RequestParam , @ModelAttribute 를 사용할 수 없다.

   - 물론 HTML Form 형식으로 전달되는 경우는 요청 파라미터로 인정된다.

package hello.springmvc.basic.request;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.util.StreamUtils;
import org.springframework.web.bind.annotation.PostMapping;

import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.nio.charset.StandardCharsets;

@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");
    }
}

   - RequestBodyStringController.java

   - HTTP 메시지 바디의 데이터를 InputStream 을 사용해서 직접 읽을 수 있다.

   - Postman을 사용해서 테스트 해보자 : POST, http://localhost:8080/request-body-string-v1, Body : row, Text 선택

 

/**
 * InputStream(Reader): HTTP 요청 메시지 바디의 내용을 직접 조회
 * OutputStream(Writer): HTTP 응답 메시지의 바디에 직접 결과 출력
 */
@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");
}

   - requestBodyStringV2 (Input, Output 스트림, Reader)

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

   - InputStream(Reader) : HTTP 요청 메시지 바디의 내용을 직접 조회

   - OutputStream(Writer) : HTTP 응답 메시지의 바디에 직접 결과 출력

 

/**
 * HttpEntity: HTTP header, body 정보를 편라하게 조회
 * - 메시지 바디 정보를 직접 조회(@RequestParam X, @ModelAttribute X)
 * - HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
 *
 * 응답에서도 HttpEntity 사용 가능
 * - 메시지 바디 정보 직접 반환(view 조회X)
 * - HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
 */
@PostMapping("/request-body-string-v3")
public HttpEntity<String> requestBodyStringV3(HttpEntity<String> httpEntity) {
    String messageBody = httpEntity.getBody();  //inputStream으로부터 읽어오는 로직 및 Writer를 간단하게 적용 가능하다. (Converter가 동작함)
    log.info("messageBody={}", messageBody);
    return new HttpEntity<>("ok");
}

   - requestBodyStringV3 (HttpEntity)

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

   - HttpEntity : HTTP header, body 정보를 편리하게 조회 (메시지 바디 정보를 직접 조회)

   - 파라미터, 리턴타입을 HttpEntity로 선언해야한다.

   - 요청 파라미터를 조회하는 기능과 관계 없음

   - @RequestParam X, @ModelAttribute X

   - HttpEntity는 응답에도 사용 가능

   - 메시지 바디 정보 직접 반환

   - 헤더 정보 포함 가능, view 조회X

 

  * HttpEntity 를 상속받은 다음 객체들도 같은 기능을 제공한다.

   - RequestEntity : HttpMethod, url 정보가 추가, 요청에서 사용

   - ResponseEntity : HTTP 상태 코드 설정 가능, 응답에서 사용

   - return new ResponseEntity("Hello World", responseHeaders, HttpStatus.CREATED)

  > 스프링MVC 내부에서 HTTP 메시지 바디를 읽어서 문자나 객체로 변환해서 전달해주는데, 이때 HTTP 메시지 컨버터( HttpMessageConverter )라는 기능을 사용한다.

 

/**
 * @RequestBody
 * - 메시지 바디 정보를 직접 조회(@RequestParam X, @ModelAttribute X)
 * - HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
 *
 * @ResponseBody
 * - 메시지 바디 정보 직접 반환(view 조회X)
 * - HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
 */
@ResponseBody
@PostMapping("/request-body-string-v4")
public String requestBodyStringV4(@RequestBody String messageBody) {
    log.info("messageBody={}", messageBody);
    return "ok";
}

   - requestBodyStringV4 (@RequestBody)

   - @RequestBody 를 사용하면 HTTP 메시지 바디 정보를 편리하게 조회할 수 있다.

   - 헤더 정보가 필요하다면 HttpEntity 를 사용하거나 @RequestHeader 를 사용하면 된다.

   - 이렇게 메시지 바디를 직접 조회하는 기능은 요청 파라미터를 조회하는 @RequestParam , @ModelAttribute 와는 전혀 관계가 없다.

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

   - RequestBodyStringController.java에서 수동으로 파싱, 형변환 하던 작업을 스프링에서 자동으로 해준다(Converter)

 

  * 요청 파라미터 vs HTTP 메시지 바디

   - 요청 파라미터를 조회하는 기능: @RequestParam , @ModelAttribute

   - HTTP 메시지 바디를 직접 조회하는 기능: @RequestBody

 

 4.9 HTTP 요청 메시지 - JSON

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

package hello.springmvc.basic.request;
import com.fasterxml.jackson.databind.ObjectMapper;
import hello.springmvc.basic.HelloData;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.util.StreamUtils;
import org.springframework.web.bind.annotation.PostMapping;
import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
/**
 * {"username":"hello", "age":20}
 * content-type: application/json
 */
@Slf4j
@Controller
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 data = objectMapper.readValue(messageBody, HelloData.class);
        log.info("username={}, age={}", data.getUsername(), data.getAge());
        response.getWriter().write("ok");
    }
}

   - RequestBodyJsonController.requestBodyJsonV1

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

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

   - Postman으로 테스트 : POST, http://localhost:8080/request-body-json-v1 raw, JSON, content-type: application/json {"username":"hello", "age":20}

 

/**
 * @RequestBody
 * HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
 *
 * @ResponseBody
 * - 모든 메서드에 @ResponseBody 적용
 * - 메시지 바디 정보 직접 반환(view 조회X)
 * - HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
 */
@ResponseBody
@PostMapping("/request-body-json-v2")
public String requestBodyJsonV2(@RequestBody String messageBody) throws IOException {
    HelloData data = objectMapper.readValue(messageBody, HelloData.class);
    log.info("username={}, age={}", data.getUsername(), data.getAge());
    
    return "ok";
}

   - requestBodyJsonV2 (@RequestBody 문자 변환)

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

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

   - 문자로 변환하고 다시 json으로 변환하는 과정... @ModelAttribute처럼 한번에 객체로 변환할 수는 없을까?

 

/**
 * @RequestBody 생략 불가능(@ModelAttribute 가 적용되어 버림)
 * HttpMessageConverter 사용 -> MappingJackson2HttpMessageConverter (contenttype: application/json)
 *
 */
@ResponseBody
@PostMapping("/request-body-json-v3")
public String requestBodyJsonV3(@RequestBody HelloData data) {
    log.info("username={}, age={}", data.getUsername(), data.getAge());
    return "ok";
}

   - requestBodyJsonV3 (@RequestBody 객체 변환)

   - @RequestBody 객체 파라미터 : @RequestBody HelloData data 사용 시 @RequestBody에 직접 만든 객체를 지정할 수 있다.

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

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

   - 리턴타입을 String으로 지정하였음.

 

 * @RequestBody는 생략 불가능하다.

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

   - String , int , Integer 같은 단순 타입 = @RequestParam

   - 나머지 = @ModelAttribute (argument resolver 로 지정해둔 타입 외)

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

   - HelloData data -> @ModelAttribute HelloData data

   - 즉 생략하면 HTTP 메시지 바디가 아니라 ModelAttribute를 사용해 요청 파라미터를 처리하게 된다.

 

  * HTTP 요청시에 content-type이 application/json으로 되어있어야 JSON을 처리할 수 있는 HTTP 메시지 컨버터가 실행된다.

 

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

   - requestBodyJsonV4 (HttpEntity)

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

 

/**
 * @RequestBody 생략 불가능(@ModelAttribute 가 적용되어 버림)
 * HttpMessageConverter 사용 -> MappingJackson2HttpMessageConverter (contenttype: application/json)
 *
 * @ResponseBody 적용
 * - 메시지 바디 정보 직접 반환(view 조회X)
 * - HttpMessageConverter 사용 -> MappingJackson2HttpMessageConverter 적용
(Accept: application/json)
 */
@ResponseBody
@PostMapping("/request-body-json-v5")
public HelloData requestBodyJsonV5(@RequestBody HelloData data) {
    //@RequestBody-HttpMessageConverter가 MappingJackson2HttpMessageConverter를 적용함으로써 helloData를 바로 사용 가능하다
    //@RequestBody는 아래 코드를 처리해준다.
    //HelloData data = objectMapper.readValue(messageBody, HelloData.class);
    log.info("username={}, age={}", data.getUsername(), data.getAge());
    return data;
}

   - requestBodyJsonV5

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

   - 리턴타입을 HelloData로 지정할 시 컨버터가 변환한 json 메시지가 Http 응답 메시지에 박혀서 리턴된다. (즉 응답도 json으로 리턴된다)

 

  * @RequestBody 요청

   - JSON 요청 -> HTTP 메시지 컨버터 -> 객체

  * @ResponseBody 응답

   - 객체 -> HTTP 메시지 컨버터 -> JSON 응답

 

 4.10 HTTP 응답 - 정적 리소스, 뷰 템플릿

  > 응답 부분에 초점을 맞추어서 정리해보자. 스프링(서버)에서 응답 데이터를 만드는 방법은 크게 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>

   - hello.html

 

package hello.springmvc.basic.response;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

@Controller
public class ResponseViewController {

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

   - ResponseViewController (뷰 템플릿을 호출하는 컨트롤러)

 

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

   - String을 반환하는 경우 : View or HTTP 메시지

   - @ResponseBody 가 없으면 response/hello 로 뷰 리졸버가 실행되어서 뷰를 찾고, 렌더링 한다.

   - @ResponseBody 가 있으면 뷰 리졸버를 실행하지 않고, HTTP 메시지 바디에 직접 response/hello 라는 문자가 입력된다.

   - 여기서는 뷰의 논리 이름인 response/hello 를 반환하면 다음 경로의 뷰 템플릿이 렌더링 되는 것을 확인할 수 있다.

   - 실행 : templates/response/hello.html

 

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

   - Void를 반환하는 경우

   - @Controller 를 사용하고, HttpServletResponse , OutputStream(Writer) 같은 HTTP 메시지 바디를 처리하는 파라미터가 없으면 요청 URL을 참고해서 논리 뷰 이름으로 사용 요청

   - URL : /response/hello

   - 실행 : templates/response/hello.html

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

 

   > HTTP 메시지

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

 

#스프링 부트가 자동으로 ThymeleafViewResolver 와 필요한 스프링 빈들을 등록한다. 그리고 다음 설정도 사용한다. 이 설정은 기본 값 이기 때문에 변경이 필요할 때만 설정하면 된다.
spring.thymeleaf.prefix=classpath:/templates/
spring.thymeleaf.suffix=.html

    - application.propertie에 thymeleaf에서 사용할 prefix, suffix 디폴트값 설정이 가능하다

 

 4.11 HTTP 응답 - HTTP API, 메시지 바디에 직접 입력

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

   - HTML이나 뷰 템플릿을 사용해도 HTTP 응답 메시지 바디에 HTML 데이터가 담겨서 전달된다. 여기서 설명하는 내용은 정적 리소스나 뷰 템플릿을 거치지 않고, 직접 HTTP 응답 메시지를 전달하는 경우를 말한다

 

package hello.springmvc.basic.response;
import hello.springmvc.basic.HelloData;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@Slf4j
@Controller
//@ResponseBody       //클래스레벨에 ResponseBody 설정하게되면 클래스 내 메소드에서 선언해주지 않아도 됨
//@RestController : @RestController는 @Controller + @ResponseBody의 역할을 한다.
public class ResponseBodyController {

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

    - ResponseBodyController.responseBodyV1

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

    - response.getWriter().write("ok")

 

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

    - responseBodyV2

    - ResponseEntity 엔티티는 HttpEntity 를 상속 받았는데, HttpEntity는 HTTP 메시지의 헤더, 바디 정보를 가지고 있다.

    - ResponseEntity 는 여기에 더해서 HTTP 응답 코드를 설정할 수 있다.

    - HttpStatus.CREATED 로 변경하면 201 응답이 나가는 것을 확인할 수 있다.

 

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

    - responseBodyV3

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

 

@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);
}

    - responseBodyJsonV1

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

 

@ResponseStatus(HttpStatus.OK)      //return new ResponseEntity<>(helloData, HttpStatus.OK); 것 처럼 HTTP 응답코드 세팅 가능
@ResponseBody
@GetMapping("/response-body-json-v2")
public HelloData responseBodyJsonV2() {
    HelloData helloData = new HelloData();
    helloData.setUsername("userA");
    helloData.setAge(20);
    return helloData;
}

    - responseBodyJsonV2

    - responseBodyJsonV1에서 사용하는 것처럼 ResponseEntity 는 HTTP 응답 코드를 설정할 수 있는데, @ResponseBody 를 사용하면 이런 것을 설정하기 까다롭다.

    - @ResponseStatus(HttpStatus.OK) 애노테이션을 사용하면 응답 코드도 설정할 수 있다.

    - 물론 애노테이션이기 때문에 응답 코드를 동적으로 변경할 수는 없다.

    - 프로그램 조건에 따라서 동적으로 변경하려면 ResponseEntity 를 사용하면 된다

 

  * @RestController

    - @Controller 대신에 @RestController 애노테이션을 사용하면, 해당 컨트롤러에 모두 @ResponseBody 가 적용되는 효과가 있다. (@RestController는 @Controller + @ResponseBody의 역할을 하는 애노테이션이다)

    - 따라서 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에 직접 데이터를 입력한다.

    - 이름 그대로 Rest API(HTTP API)를 만들 때 사용하는 컨트롤러이다.

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

 

 

스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 23

Spring 정리 2022. 5. 22. 16:11

인프런 강의 37일차.

 - 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 1 (김영한 강사님)

 - 서블릿, JSP, MVC 패턴

 - 서블릿으로 1차 구현

   -> 서블릿으로 구현했을 때 불편한 점 개선을 위해 JSP로 2차 구현

   -> JSP로도 불편한 점을 개선하기 위해 MVC 패턴으로 3차 구현

 - 스프링 프로젝트 시작

   -> 스프링 기본기능 이해

   -> 스프링 MVC 웹페이지 만들기

 

4. 스프링 MVC - 기본 기능

 4.5 HTTP 요청 파라미터 - 쿼리 파라미터, HTML Form

  > HTTP 요청 데이터 조회 - 개요

   - 서블릿에서 학습했던 HTTP 요청 데이터를 조회 하는 방법을 다시 떠올려보자.

   - 그리고 서블릿으로 학습했던 내용을 스프링이 얼마나 깔끔하고 효율적으로 바꾸어주는지 알아보자.

   - HTTP 요청 메시지를 통해 클라이언트에서 서버로 데이터를 전달하는 방법을 알아보자.

 

  > 클라이언트에서 서버로 요청 데이터를 전달할 때는 주로 다음 3가지 방법을 사용한다

   - GET - 쿼리 파라미터

      /url?username=hello&age=20

      메시지 바디 없이, URL의 쿼리 파라미터에 데이터를 포함해서 전달

      예) 검색, 필터, 페이징등에서 많이 사용하는 방식

   - POST - HTML Form

      content-type: application/x-www-form-urlencoded

      메시지 바디에 쿼리 파리미터 형식으로 전달 username=hello&age=20

      예) 회원 가입, 상품 주문, HTML Form 사용

   - HTTP message body에 데이터를 직접 담아서 요청

      HTTP API에서 주로 사용, JSON, XML, TEXT

      데이터 형식은 주로 JSON 사용

      POST, PUT, PATCH

 

  > 스프링으로 요청 파라미터를 조회하는 방법

package hello.springmvc.basic.request;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@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");
    }
}

  - hello.springmvc.basic.request.RequestParamController.java

  - HTTP get/post 호출 처리

 

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<form action="/request-param-v1" method="post">
    username: <input type="text" name="username" />
    age: <input type="text" name="age" />
    <button type="submit">전송</button>
</form>
</body>
</html>

  - resources/static/basic/hello-form.html

  - HTTP post 호출을 하기 위한 샘플 html

  - Jar 를 사용하면 webapp 경로를 사용할 수 없다. 이제부터 정적 리소스도 클래스 경로에 함께 포함해야 한다.

 

 4.6 HTTP 요청 파라미터 - @RequestParam

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

/**
 * @RequestParam 사용
 * - 파라미터 이름으로 바인딩
 * @ResponseBody 추가
 * - View 조회를 무시하고, HTTP message body에 직접 해당 내용 입력
 */
@ResponseBody
@RequestMapping("/request-param-v2")
public String requestParamV2(
        @RequestParam("username") String memberName,
        @RequestParam("age") int memberAge) {
    log.info("username={}, age={}", memberName, memberAge);
    return "ok";            //String 반환일 경우 ViewResolver를 호출하는 것이지만 ResponseBody Annotation을 추가함으로써 REST API 호출로 변경할 수 있다.
}

  - requestParamV2

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

  - @ResponseBody : View 조회를 무시하고, HTTP message body에 직접 해당 내용 입력

  - @RequestParam의 name(value) 속성이 파라미터 이름으로 사용된다.

  - @RequestParam("username") String memberName -> request.getParameter("username")

/**
 * @RequestParam 사용
 * HTTP 파라미터 이름이 변수 이름과 같으면 @RequestParam(name="xx") 생략 가능
 */
@ResponseBody
@RequestMapping("/request-param-v3")
public String requestParamV3(
        @RequestParam String username,
        @RequestParam int age) {
    log.info("username={}, age={}", username, age);
    return "ok";
}

  - requestParamV3

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

/**
 * @RequestParam 사용
 * String, int 등의 단순 타입이면 @RequestParam 도 생략 가능
 */
@ResponseBody
@RequestMapping("/request-param-v4")
public String requestParamV4(String username, int age) {
    log.info("username={}, age={}", username, age);
    return "ok";
}

  - requestParamV4

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

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

  - @RequestParam을 생략하지 않음으로써 명확하게 요청 파리미터에서 데이터를 읽는 다는 것을 표현하기도 한다.

/**
 * @RequestParam.required
 * /request-param -> username이 없으므로 예외
 *
 * 주의!
 * /request-param?username= -> 빈문자로 통과
 *
 * 주의!
 * /request-param
 * int age -> null을 int에 입력하는 것은 불가능, 따라서 Integer 변경해야 함(또는 다음에 나오는
defaultValue 사용)
 */
@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";
}

  - requestParamRequired (파라미터 필수 여부)

  - @RequestParam.required : 파라미터 필수 여부. 기본값이 파라미터 필수( true )이다.

  - /request-param 요청 : username 이 없으므로 400 예외가 발생한다.

  - 파라미터 이름만 사용 : /request-param?username= 파라미터 이름만 있고 값이 없는 경우 빈문자로 통과

  - 기본형(primitive)에 null 입력 : /request-param 요청 @RequestParam(required = false) int age

  - null 을 int 에 입력하는 것은 불가능(500 예외 발생). null 을 받을 수 있는 Integer 로 변경 혹은 defaultValue 사용

/**
 * @RequestParam
 * - defaultValue 사용
 *
 * 참고: defaultValue는 빈 문자의 경우에도 적용
 * /request-param?username=
 */
@ResponseBody
@RequestMapping("/request-param-default")
public String requestParamDefault(
        @RequestParam(required = true, defaultValue = "guest") String username,
        @RequestParam(required = false, defaultValue = "-1") int age) {
    log.info("username={}, age={}", username, age);
    return "ok";
}

  - requestParamDefault (기본 값 적용)

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

  - defaultValue 는 빈 문자의 경우에도 설정한 기본 값이 적용된다. (e.g. /request-param?username=)

/**
 * @RequestParam Map, MultiValueMap
 * Map(key=value)
 * MultiValueMap(key=[value1, value2, ...] ex) (key=userIds, value=[id1, id2])
 */
@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";
}

  - requestParamMap (파라미터를 Map으로 조회하기)

  - 파라미터를 Map, MultiValueMap으로 조회할 수 있다

  - @RequestParam Map : Map(key=value)

  - @RequestParam MultiValueMap : MultiValueMap(key=[value1, value2, ...] ex) (key=userIds, value=[id1, id2])

  - 파라미터의 값이 1개가 확실하다면 Map 을 사용해도 되지만, 그렇지 않다면 MultiValueMap 을 사용하자.

 

 4.7 HTTP 요청 파라미터 - @ModelAttribute

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

@RequestParam String username;
@RequestParam int age;
HelloData data = new HelloData();
data.setUsername(username);
data.setAge(age);

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

package hello.springmvc.basic;
import lombok.Data;

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

  - @Data Annotation의 역할 : 롬복에서 제공해주는 @Data의 경우 @Getter , @Setter , @ToString , @EqualsAndHashCode , @RequiredArgsConstructor 를 자동으로 적용해준다.

/**
 * @ModelAttribute 사용
 * 참고: model.addAttribute(helloData) 코드도 함께 자동 적용됨, 뒤에 model을 설명할 때
자세히 설명
 */
@ResponseBody
@RequestMapping("/model-attribute-v1")
public String modelAttributeV1(@RequestParam String username, @RequestParam int age) {
    HelloData helloData = new HelloData();
    helloData.setUsername(username);
    helloData.setAge(age);
    log.info("username={}, age={}", helloData.getUsername(),
            helloData.getAge());
    log.info("hellodata={}", helloData);        //객체를 log에 찍을 경우 @Data에서 ToString으로 변환해준다.
    return "ok";
}

@ResponseBody
@RequestMapping("/model-attribute-v1")
public String modelAttributeV1(@ModelAttribute HelloData helloData) {
    //@ModelAttribute HelloData helloData의 경우 @RequestParam String username, @RequestParam int age와 동일한 역할을 한다.
    log.info("username={}, age={}", helloData.getUsername(),
            helloData.getAge());
    return "ok";
}

  - @ModelAttribute 적용

  - HelloData 객체가 생성되고, 요청 파라미터의 값도 모두 들어가 있다

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

  - HelloData 객체를 생성한다 -> 요청 파라미터의 이름으로 HelloData 객체의 프로퍼티를 찾는다 -> 해당 프로퍼티의 setter를 호출해서 파라미터의 값을 입력(바인딩) 한다.

  - 예) 파라미터 이름이 username 이면 setUsername() 메서드를 찾아서 호출하면서 값을 입력한다

 

  > 프로퍼티
  - 객체에 getUsername() , setUsername() 메서드가 있으면, 이 객체는 username 이라는 프로퍼티를 가지고 있다.

  - username 프로퍼티의 값을 변경하면 setUsername() 이 호출되고, 조회하면 getUsername() 이 호출된다

class HelloData {
 getUsername();
 setUsername();
}

  > 바인딩 오류

  - age=abc 처럼 숫자가 들어가야 할 곳에 문자를 넣으면 BindException 이 발생한다. 

 

/**
 * @ModelAttribute 생략 가능
 * String, int 같은 단순 타입 = @RequestParam
 * argument resolver 로 지정해둔 타입 외 = @ModelAttribute
 */
@ResponseBody
@RequestMapping("/model-attribute-v2")
public String modelAttributeV2(HelloData helloData) {
    log.info("username={}, age={}", helloData.getUsername(),
            helloData.getAge());
    return "ok";
}

  - @ModelAttribute 생략

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

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

  - String , int , Integer 같은 단순 타입 = @RequestParam

  - 나머지 = @ModelAttribute (argument resolver 로 지정해둔 타입 외)