[ 스프링 웹 MVC ] - 스프링 MVC - 기본 기능

로깅

@Slf4j

• 롬복을 활용해서 로그를 사용할 수 있게 해줌

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

  로그 종류

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

로그 레벨

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

#전체 로그 레벨 설정(기본 info) 
logging.level.root=info
#hello.springmvc 패키지와 그 하위 로그 레벨 설정 
logging.level.hello.springmvc=debug

로그의 장점

• 쓰레드, 클래스 정보등을 같이 볼 수 있다.

• 파일이나 네트워크 등, 로그를 별도의 위치에 남길 수 있다.

• 성능이 더 좋아서 실무에서는 전부 로그를 사용

  @RestController

  @Controller은 반환값이 String이면 해당하는 뷰를 찾아서 반환
  @RestController은 메세지 바디에 직접 입력

  요청 매핑

  @RequestMapping("/hello-basic")

• /hello-basic URL 호출이 오면 이 메서드가 실행되도록 매핑한다

• {"/hello-basic", "/hello-go"} - 동시 매핑이 가능하다

  @GetMapping(value = "/mapping-get-v2")

• 메서드를 결합해서 매핑 가능

  @PathVariable

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

• PathVariable를 통해 매칭되는 부분을 받아 올 수 있다.
• @PathVariable 의 이름과 파라미터 이름이 같으면 생략할 수 있다.

HTTP 요청

요청 파라미터

request.getParameter()

• HttpServletRequest가 제공하는 방식

@RequestParam

• Spring이 제공하는 방식
• 파라미터 이름으로 바인딩
• HTTP 파라미터 이름이 변수 이름과 같으면 @RequestParam(name="xx") 생략 가능
• String , int , Integer 등의 단순 타입이면 @RequestParam 도 생략 가능

public String requestParamV3(
          @RequestParam String username,
          @RequestParam int age) {
      log.info("username={}, age={}", username, age);
      return "ok";
}

• @RequestParam(required = false) - 필수값 해제
• 파라미터에 값이 없는 경우 defaultValue 를 사용하면 기본 값을 적용할 수 있다.
• @RequestParam(required = false, defaultValue = "-1")
• 파라미터를 Map, MultiValueMap으로 조회할 수 있다.

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

@ModelAttribute

• 개발을 하면 요청 파라미터를 받아 필요한 객체를 만들고 그 객체에 값을 넣어줘야 한다. @ModelAttribute를 사용하면 그 과정을 간편하게 해준다.

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

• HelloData 객체를 생성
• 요청 파라미터의 이름으로 HelloData 객체의 프로퍼티를 찾는다. 그리고 해당 프로퍼티의 setter를 호출해서 파라미터의 값을 입력(바인딩) 한다.
• ex) 파라미터 이름이 username이면 setUsername() 호출
• @ModelAttribute도 생략이 가능하나 혼란스러울 수 있어 권장하지 않는다.

요청 메세지

단순 텍스트

• 메세지 바디를 통해 데이터가 넘어오는 경우
• HTTP API에서 주로 사용, JSON, XML, TEXT
• InputStream 을 사용해서 직접 읽을 수 있다.
• InputStream(Reader): HTTP 요청 메시지 바디의 내용을 직접 조회
• OutputStream(Writer): HTTP 응답 메시지의 바디에 직접 결과 출력

HttpEntity

 @PostMapping("/request-body-string-v3")
  public HttpEntity<String> requestBodyStringV3(HttpEntity<String> httpEntity) {
      String messageBody = httpEntity.getBody();
      log.info("messageBody={}", messageBody);
      return new HttpEntity<>("ok");
  }

• HttpEntity: HTTP header, body 정보를 편리하게 조회
• 메세지 바디를 직접 조회 가능하고 응답도 가능
• RequestEntity : HttpEntity를 상속받아 HttpMethod, url 정보가 추가
• ResponseEntity : HTTP 상태코드 설정 가능

RequestBody

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

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

JSON

서블릿

• HTTP 메시지 바디에서 데이터를 읽어와서, 문자로 변환
• 문자로 된 데이터를 objectMapper을 사용해서 객체로 변환

스프링

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

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

• HttpEntity , @RequestBody 를 사용하면 HTTP 메시지 컨버터가 HTTP 메시지 바디의 내용을 우리가 원하는 문자나 객체 등으로 변환
• @ResponseBody를 사용하면 응답에 객체 상태로 보내 줄 수 있음

• JSON 요청 -> HTTP 메시지 컨버터 -> 객체 - @RequestBody 요청
• 객체 -> HTTP 메시지 컨버터 -> JSON 응답 - @ResponseBody 응답

HTTP 응답

정적 리소스, 뷰 템플릿

정적 리소스

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

  기본 경로 : src/main/resources/static

뷰 템플릿

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

  기본 경로 : src/main/resources/templates

뷰 템플릿을 호출하는 컨트롤러

@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 로 뷰 리졸버가 실행되어서 뷰를 찾고, 렌더링
• void를 반환해도 작동하지만 추천하지 않음

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

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

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

• ResponseStatus(HttpStatus.OK) 애노테이션을 사용하면 응답 코드도 설정
• 프로그램 조건에 따라서 동적으로 변경하려면 ResponseEntity 를 사용
• @Controller 대신에 @RestController 애노테이션을 사용하면, 해당 컨트롤러에 모두 @ResponseBody 가 적용
• Rest API(HTTP API)를 만들 때 @RestController을 사용한다.

HTTP 메세지 컨버터

메세지 컨버터

• @ResponseBody를 사용하면 viewResolver 대신에 HttpMessageConverter 가 동작한다.
• HTTP API처럼 JSON 데이터를 HTTP 메시지
  바디에서 직접 읽거나 쓰는 경우 HTTP 메시지 컨버터를 사용

HTTP 요청 데이터 읽기

• HTTP 요청이 오고, 컨트롤러에서 @RequestBody , HttpEntity 파라미터를 사용
• 메시지 컨버터가 메시지를 읽을 수 있는지 확인하기 위해 canRead() 를 호출
• 대상 클래스 타입을 지원하는가.
• HTTP 요청의 Content-Type 미디어 타입을 지원하는가.
• canRead() 조건을 만족하면 read() 를 호출해서 객체 생성하고, 반환

HTTP 응답 데이터 생성

• 컨트롤러에서 @ResponseBody , HttpEntity 로 값이 반환된다.
• 메시지 컨버터가 메시지를 쓸 수 있는지 확인하기 위해 canWrite() 를 호출한다.
• 대상 클래스 타입을 지원하는가.
• HTTP 요청의 Accept 미디어 타입을 지원하는가.
• canWrite() 조건을 만족하면 write() 를 호출해서 HTTP 응답 메시지 바디에 데이터를 생성한다.

요청 매핑 핸들러 구조

ArgumentResolver

• RequestMappingHandlerAdaptor 는 ArgumentResolver 를 호출해서 컨트롤러(핸들러)가 필요로 하는 다양한 파라미터의 값(객체)을 생성
• ArgumentResolver 의 supportsParameter() 를 호출해서 해당 파라미터를 지원하는지 체크
• 지원하면 resolveArgument() 를 호출해서 실제 객체를 생성
• 객체를 컨트롤러 호출시 넘김

ReturnValueHandler

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

HTTP 메세지 컨버터 위치

• ArgumentResolver가 HTTP 메시지 컨버터를 사용해서 필요한 객체를 생성한다.
• ReturnValueHandler가 HTTP 메시지 컨버터를 호출해서 응답 결과를 만든다.