2023.06.05 Spring

2023. 6. 6. 11:47

스프링 인프런 김영한

43. 요청 매핑

요청이 왓을때 어떤 컨트롤러가 호출되어야하나?
단순 url뿐만 아니라 여러 요소가 적용이 된다.

43.1 기본 매핑

@RestController
public class MappingController {
    private Logger log = LoggerFactory.getLogger(getClass());

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

@RequestMapping("/hello-basic")
/hello-basic URL 호출이 오면 이 메소드가 실행되도록 매핑한다.
대부분의 속성을 배열[] 로 제공하므로 다중 설정이 가능하다.
{"/hello-basic", "/hello-go"}

둘다 허용 - 스프링 부트 3.0 이전
다음 두가지 요청은 다른 URL이지만 스프링은 다음 URL 요청들을 같은 요청으로 매핑한다.
매핑: /hello-basic
URL 요청: /hello-basic , /hello-basic/
다르지만 인정해주고 알아서 넣어준다.

HTTP 메소드
@RequestMapping 에 method 속성으로 HTTP 메소드를 지정하지 않으면 HTTP 메소드와 무관하게 호출된다.
모두 허용 GET, HEAD, POST, PUT, PATCH, DELETE

43.2 축약 어노테이션을 사용할 수 있다.

@GetMapping(value = "/mapping-get-v2")
public String mappingGetV2() {
    log.info("mapping-get-v2");
    return "ok";
}

43.3 PathVariable(경로 변수) 사용

PathVariable 사용
변수명이 같으면 생략 가능하다.
@PathVariable("userId") String userId -> @PathVariable userId
파라미터명이 경로 그자체가 된다.
경로/{파라미터}
최근에 정말 많이 사용되고 있다.

@GetMapping("/mapping/{userId}")
public String mappingPath(@PathVariable("userId") String data) {
    log.info("mappingPath userId={}", data);
    return "ok";
}

최근 HTTP API는 다음과 같이 리소스 경로에 식별자를 넣는 스타일을 선호한다.
/mapping/userA
/users/1

@RequestMapping은 URL 경로를 템플릿화 할 수 있는데
@PathVariable 을 사용하면 매칭 되는 부분을 편리하게 조회할 수 있다.

43.4 PathVariable 사용 - 다중

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

43.5 특정 파라미터 조건 매핑

잘사용하지 않는데 쿼리 파라미터를 조건 매핑할 수도 있다.
파라미터에 특정값이 있어야 호출을 할 수 있다.
params="mode",
params="!mode"
params="mode=debug"
params="mode!=debug" (! = )
params = {"mode=debug","data=good"}
이 외에도 다양한 조건을 추가할 수 있지만 자주 사용하지는 않는다고 한다.

@GetMapping(value = "/mapping-param", params = "mode=debug")
public String mappingParam() {
    log.info("mappingParam");
    return "ok";
}

43.6 특정 헤더 조건 매핑

특정 헤더를 조건으로 매핑 할 수 있다.
특정 헤더로 추가 매핑

headers="mode",
headers="!mode"
headers="mode=debug"
headers="mode!=debug" (! = )

이것또한 자주 사용할일은 없는데 쓸일이 잇을때 파보는게 좋다.

@GetMapping(value = "/mapping-header", headers = "mode=debug")
public String mappingHeader() {
    log.info("mappingHeader");
    return "ok";
}

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

이렇게 하면 더 부가적인 것을 설정할 수 있다.

html이면 이렇게 처리 json이면 이렇게 처리 등등을 지정할 수 있다.
소비하는 입장이니 소비하는 것을 지정해준다.

Content-Type 헤더 기반 추가 매핑 Media Type
consumes="application/json"
consumes="!application/json"
consumes="application/*"
consumes="*\/*"
MediaType.APPLICATION_JSON_VALUE

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

@PostMapping(value = "/mapping-consume", consumes = "application/json")
public String mappingConsumes() {
    log.info("mappingConsumes");
    return "ok";
}

43.8 미디어 타입 조건 매핑 - HTTP 요청 Accept, produce

생산하는 입장에서 미디어타입에 조건을 매핑하는 것이다.

Accept 헤더 기반 Media Type
produces = "text/html"
produces = "!text/html"
produces = "text/*"
produces = "*\/*"

HTTP 요청의 Accept 헤더를 기반으로 미디어 타입으로 매핑한다.
만약 맞지 않으면 HTTP 406 상태코드(Not Acceptable)을 반환한다.
예시)

produces = "text/plain"
produces = {"text/plain", "application/*"}
produces = MediaType.TEXT_PLAIN_VALUE
produces = "text/plain;charset=UTF-8"

@PostMapping(value = "/mapping-produce", produces = "text/html")
public String mappingProduces() {
    log.info("mappingProduces");
    return "ok";
}

44. 요청 매핑 - API 예시

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

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

같은 url이지만 메소드에 따라서 구분을 할 수 있다.
메소드에 따라서 행위를 구분할 수 있다.

@RestController
@RequestMapping("/mapping/users")
public class MappingClassController {
    @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;
    }
}

/mapping :는 강의의 다른 예제들과 구분하기 위해 사용했다.
@RequestMapping("/mapping/users")
클래스 레벨에 매핑 정보를 두면 메소드 레벨에서 해당 정보를 조합해서 사용한다.

리소스를 계층으로 식별하는 일이 많은데 사람이 인지하기도 쉽고 유지보수하기도 쉽다.

회원 목록 조회: GET /mapping/users
회원 등록: POST /mapping/users
회원 조회: GET /mapping/users/id1
회원 수정: PATCH /mapping/users/id1
회원 삭제: DELETE /mapping/users/id1
매핑 방법을 이해했으니, 이제부터 HTTP 요청이 보내는 데이터들을 스프링 MVC로 어떻게 조회하는지 알아보자.

45. HTTP 요청 - 기본, 헤더 조회

서블릿할때 헤더부터 조회햇엇다. 그걸떠올리면서 해보자.

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

스프링 어노테이션 기반은 인터페이스로 정형화된게 아니라 다 받을 수 있다.
서블릿 request respose locale httpmethod 등등을 다 받을 수 있다.

@RequestHeader어노테이션으로 특정 헤더나 여러 헤더들을 받을 수 있다.

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

HttpServletRequest

HttpServletResponse

HttpMethod
HTTP 메소드를 조회한다. org.springframework.http.HttpMethod

Locale
Locale 정보를 조회한다.

@RequestHeader MultiValueMap<String, String> headerMap
모든 HTTP 헤더를 MultiValueMap 형식으로 조회한다.

@RequestHeader("host") String host
특정 HTTP 헤더를 조회한다.
속성
필수 값 여부: required
기본 값 속성: defaultValue

@CookieValue(value = "myCookie", required = false) String cookie
특정 쿠키를 조회한다.
속성
필수 값 여부: required
기본 값: defaultValue

MultiValueMap
MAP과 유사한데 하나의 키에 여러 값을 받을 수 있다.
HTTP header HTTP 쿼리 파라미터와 같이 하나의 키에 여러 값을 받을 때 사용한다.
keyA=value1&keyA=value2

MultiValueMap<String, String> map = new LinkedMultiValueMap();
map.add("keyA", "value1");
map.add("keyA", "value2");
//[value1,value2]
List<String> values = map.get("keyA");

참고할점!!
@Controller 의 사용 가능한 파라미터 목록은 다음 공식 메뉴얼에서 확인할 수 있다.
https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-annarguments

@Controller 의 사용 가능한 응답 값 목록은 다음 공식 메뉴얼에서 확인할 수 있다.
https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-annreturn-type

있다는 것만 일단 이해하자.

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

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

서블릿에서 학습했던 HTTP 요청 데이터를 조회 하는 방법을 다시 떠올려보자.
그리고 서블릿으로 학습했던 내용을 스프링이 얼마나 깔끔하고 효율적으로 바꾸어주는지 알아보자.
HTTP 요청 메시지를 통해 클라이언트에서 서버로 데이터를 전달하는 방법을 알아보자.

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

46.1.1 GET - 쿼리 파라미터

/url?username=hello&age=20
메시지 바디 없이, URL의 쿼리 파라미터에 데이터를 포함해서 전달
예) 검색, 필터, 페이징등에서 많이 사용하는 방식

46.1.2 POST - HTML Form

content-type: application/x-www-form-urlencoded
메시지 바디에 쿼리 파리미터 형식으로 전달 username=hello&age=20
예) 회원 가입, 상품 주문, HTML Form 사용

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

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

HttpServletRequest 의 request.getParameter() 를 사용하면 다음 두가지 요청 파라미터를 조회할 수 있다.

GET, 쿼리 파라미터 전송
예시
http://localhost:8080/request-param?username=hello&age=20

POST, HTML Form 전송
예시
POST /request-param ...
content-type: application/x-www-form-urlencoded
username=hello&age=20

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

46.2 요청 파라미터(request parameter)조회

기존처럼 HttpServletRequest request, HttpServletResponse response을 파라미터로 받고
request.getParameter()메소드를 사용하는 것이다.

@Slf4j
@Controller
public class RequestParamController {
    /**
    * 반환 타입이 없으면서 이렇게 응답에 값을 직접 집어넣으면, view 조회X
    */
    @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");
    }
}

Post Form 실행
http://localhost:8080/basic/hello-form.html

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

47. HTTP 요청 파라미터 - @RequestParam

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

@ResponseBody
@RequestMapping("/request-param-v2")
public String requestParamV2(
        @RequestParam("username") String memberName,
        @RequestParam("age") int memberAge) {
    log.info("username={}, age={}", memberName, memberAge);
    return "ok";
}

@RequestParam의 name(value) 속성이 파라미터 이름으로 사용된다.
@RequestParam("username") String memberName
= request.getParameter("username")

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

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

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

주의할점
@RequestParam 어노테이션을 생략하면 스프링 MVC는 내부에서 required=false 를 적용한다.
required 옵션은 바로 다음에 설명한다.

참고할점
이렇게 어노테이션을 완전히 생략해도 되는데, 너무 없는 것도 약간 과하다는 주관적 생각이 있다.
@RequestParam이 있으면 명확하게 요청 파라미터에서 데이터를 읽는 다는 것을 알 수 있다.

강사님은 쓰는것을 권장한다.

47.2 파라미터 필수 여부 - 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";
}

스프링에서 값을 보내지 않으면 알아서 에러를 내준다.
필수이지만 null과 빈값은 다르다.

@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을 사용해야한다.

47.3 기본 값 적용 - requestParamDefault

파라미터에 값이 없는 경우 defaultValue를 사용하면 기본 값을 적용할 수 있다.
이미 기본 값이 있기 때문에 required는 의미가 없다.
defaultValue 는 빈 문자의 경우에도 설정한 기본 값이 적용된다.
/request-param-default?username=defaultValue

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

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

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

파라미터를 Map, MultiValueMap으로 조회할 수 있다.
@RequestParam Map, Map(key=value)
@RequestParam MultiValueMap
MultiValueMap(key=[value1, value2, ...] ex) (key=userIds, value=[id1, id2])
파라미터의 값이 1개가 확실하다면 Map 을 사용해도 되지만, 그렇지 않다면 MultiValueMap 을 사용하자.

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

48. HTTP 요청 파라미터 - @ModelAttribute

실제 개발을 하면 요청 파라미터를 받아서 필요한 객체를 만들고 그 객체에 값을 넣어주어야 한다.
보통 다음과 같이 코드를 작성할 것이다.

@RequestParam String username;
@RequestParam int age;

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

스프링은 이 과정을 완전히 자동화해주는 @ModelAttribute 기능을 제공한다.
다음 객체에 값을 집어 넣는다고 생각해보자.

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

48.1 @ModelAttribute 적용

모델에 담아서 보내는 model.addAttribute(helloData) 코드도 함께 자동 적용된다.

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

마치 마법처럼 HelloData 객체가 생성되고 요청 파라미터의 값도 모두 들어가 있다.

스프링MVC는 @ModelAttribute 가 있으면 다음을 실행한다.
1.HelloData 객체를 생성한다.
2.요청 파라미터의 이름으로 HelloData객체의 프로퍼티를 찾는다. 그리고 해당 프로퍼티의 setter를
3.호출해서 파라미터의 값을 입력(바인딩) 한다.
예) 파라미터 이름이 username 이면 setUsername() 메소드를 찾아서 호출하면서 값을 입력한다.

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

바인딩 오류
age=abc 처럼 숫자가 들어가야 할 곳에 문자를 넣으면 BindException 이 발생한다.
이런 바인딩 오류를 처리하는 방법은 검증 부분에서 다룬다

개발할때 정식흐름은 20~~30%이고 70~~80을 예외처리하는데 시간을 쓰게 된다고 한다.

@ModelAttribute를 생략할 수도 있다.

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

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

스프링은 해당 생략시 다음과 같은 규칙을 적용한다.
String , int , Integer 같은 단순 타입 = @RequestParam으로 이해한다.
나머지 = @ModelAttribute (argument resolver 로 지정해둔 타입 외)이해한다.

argument resolver는 HTTP~ response같은 것을 의미한다.
결론적으로 지정해둔게 아니라면 알아서 이해한다는 것이다.

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

서블릿에서 학습한 내용을 떠올려보자.
HTTP message body에 데이터를 직접 담아서 요청할 수 있다.
HTTP API에서 주로 사용, JSON, XML, TEXT

데이터 형식은 주로 JSON을 사용한다.
POST, PUT, PATCH

요청 파라미터와 다르게 HTTP 메시지 바디를 통해 데이터가 직접 넘어오는 경우는
@RequestParam과 @ModelAttribute를 사용할 수 없다.
물론 HTML Form 형식으로 전달되는 경우는 요청 파라미터로 인정된다.

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

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

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

49.2 Input, Output 스트림, Reader

스프링 MVC는 다음 파라미터를 지원한다.
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");
}

49.3 HttpEntity

HttpEntity: HTTP header, body 정보를 편리하게 조회
메시지 바디 정보를 직접 조회
요청 파라미터를 조회하는 기능과 관계 없다. @RequestParam X, @ModelAttribute X

HttpEntity는 응답에도 사용 가능하다.
메시지 바디 정보 직접 반환하고 헤더 정보 포함 가능하다.
view 조회X

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

RequestEntity
HttpMethod, url 정보가 추가, 요청에서 사용한다.

ResponseEntity
HTTP 상태 코드 설정 가능, 응답에서 사용한다.
return new ResponseEntity<String>("Hello World", responseHeaders, HttpStatus.CREATED)

ResponseEntity는 json을 반환할때 사용해보았었다.

참고할점
스프링MVC 내부에서 HTTP 메시지 바디를 읽어서 문자나 객체로 변환해서 전달해주는데
이때 HTTP 메시지 컨버터( HttpMessageConverter )라는 기능을 사용한다.
조금 뒤에 HTTP 메시지 컨버터에서 자세히 설명이 될 것이다.

49.4 @RequestBody

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

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

요청 파라미터 vs HTTP 메시지 바디
요청 파라미터를 조회하는 기능: @RequestParam , @ModelAttribute
HTTP 메시지 바디를 직접 조회하는 기능: @RequestBody

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

@ResponseBody
@PostMapping("/request-body-string-v4")
public String requestBodyStringV4(@RequestBody String messageBody) {
    log.info("messageBody={}", messageBody);
    return "ok";
}

50. HTTP 요청 메시지 - JSON

이번에는 HTTP API에서 주로 사용하는 JSON 데이터 형식을 조회해보자.
기존 서블릿에서 사용했던 방식과 비슷하게 시작해보자

HttpServletRequest를 사용해서 직접 HTTP 메시지 바디에서 데이터를 읽어와서, 문자로 변환한다.
문자로 된 JSON 데이터를 Jackson 라이브러리인 objectMapper 를 사용해서 자바 객체로 변환한다.

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

50.2 @RequestBody 문자 변환

이전에 학습했던 @RequestBody를 사용해서 HTTP 메시지에서 데이터를 꺼내고 messageBody에 저장한다.
문자로 된 JSON 데이터인 messageBody를 objectMapper 를 통해서 자바 객체로 변환한다.

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

50.3 @RequestBody 객체 변환

문자로 변환하고 다시 json으로 변환하는 과정이 불편해서
@ModelAttribute처럼 한번에 객체로 변환하는 방법이 있다.

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

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

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

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

@ModelAttribute 에서 학습한 내용을 떠올려보자.
스프링은 @ModelAttribute @RequestParam 과 같은 해당 어노테이션을 생략시 다음과 같은 규칙을 적용한다.

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

따라서 이 경우 HelloData에 @RequestBody 를 생략하면 @ModelAttribute 가 적용되어버린다.
따라서 생략하면 HTTP 메시지 바디가 아니라 요청 파라미터를 처리하게 된다.

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

50.4 HttpEntity

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

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

50.5 requestBodyJsonV5

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

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

@RequestBody 요청
JSON 요청 HTTP 메시지 컨버터 객체

@ResponseBody 응답
객체 HTTP 메시지 컨버터 JSON 응답

51. 응답 - 정적 리소스, 뷰 템플릿

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

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

정적 리소스
예) 웹 브라우저에 정적인 HTML, css, js를 제공할 때는, 정적 리소스를 사용한다.

뷰 템플릿 사용
예) 웹 브라우저에 동적인 HTML을 제공할 때는 뷰 템플릿을 사용한다.

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

51.1 정적 리소스

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

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

51.1.1 정적 리소스 경로

src/main/resources/static

다음 경로에 파일이 들어있으면

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

웹 브라우저에서 다음과 같이 실행하면 된다.

http://localhost:8080/basic/hello-form.html

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

51.2 뷰 템플릿

뷰 템플릿을 거쳐서 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>

이 뷰템플릿을 불러오는 방법은 여러가지가 있다.
ModelAndView과거버전 String으로 경로지정
void하면 생략할 수 있다.

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

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

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

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

51.2.2 Void를 반환하는 경우

@Controller 를 사용하고, HttpServletResponse , OutputStream(Writer) 같은 HTTP 메시지
바디를 처리하는 파라미터가 없으면 요청 URL을 참고해서 논리 뷰 이름으로 사용한다.
요청 URL: /response/hello
실행: templates/response/hello.html
참고로 이 방식은 명시성이 너무 떨어지고 이렇게 딱 맞는 경우도 많이 없어서 권장하지 않는다.

51.2.3 HTTP 메시지

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

Thymeleaf 스프링 부트 설정
다음 라이브러리를 추가하면 이미 추가되어있다.

build.gradle
`implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'`

스프링 부트가 자동으로 ThymeleafViewResolver 와 필요한 스프링 빈들을 등록한다.
그리고 다음 설정도 사용한다.
이 설정은 기본 값 이기 때문에 application.properties에가서 변경이 필요할 때만 설정하면 된다.

spring.thymeleaf.prefix=classpath:/templates/
spring.thymeleaf.suffix=.html

2023.06.05
@Slf4j이거 붙어잇던것을 이해못햇엇는데 이제 이해하게 되엇다.

@Slf4j
다음 코드를 자동으로 생성해서 로그를 선언해준다. 개발자는 편리하게 log 라고 사용하면 된다.
private static final org.slf4j.Logger log =
org.slf4j.LoggerFactory.getLogger(RequestHeaderController.class);

개발할때 정식흐름은 20~~30%이고 70~~80을 예외처리하는데 시간을 쓰게 된다고 한다.
예외처리하나도 안햇엇는데 조금은 적용해볼 필요가 있어보인다.

'기초단계 > SPRING' 카테고리의 다른 글

2023.06.09 Spring (0)	2023.06.22
2023.06.07 Spring (0)	2023.06.22
2023.06.03 Spring (0)	2023.06.06
2023.06.01 Spring (0)	2023.06.06
2023.05.30 Spring (0)	2023.05.31

발전하고 싶은 춘핑이