김영한 님의 '스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술'을 듣고 적은 글입니다.
운영 시스템에서는 System.out.println() 같은 시스템 콘솔을 사용해 필요한 정보를 출력하지 않고 별도의 로깅 라이브러리를 사용해 로그를 출력한다.
세상엔 수많은 로그 라이브러리 존재한다. 이걸 인터페이스로 제공한 것이 SLF4J 라이브러리다. 쉽게 이야기해서 SLF4J는 인터페이스이고, 그 구현체로 Logback같은 로그 라이브러리를 선택하면된다. 실무에선 스프링 부트가 기본적으로 제공하는 Logback을 대부분 사용한다.
private Logger log = LoggerFactory.getLogger(getClass());
private static final Logger log = LoggerFactory.getLogger(Xxx.class)
@Slf4j : 롬복 사용 가능
로그 예시를 보여주기 위해 새로운 클래스 파일 하나를 만들어보겠다.
package hello.springmvc.basic;
import lombok.extern.slf4j.Slf4j;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@Slf4j //주석대신 애노테이션만 넣으면 롬복이 알아서 해줌 !!
@RestController
// return값을 http 메시지에 콱 박아버림 @Controller로 적으면 뷰 이름이 반환되서 ViewResolver 과정 필요.
// RestAPI의 rest 맞음
public class LogTestController {
//private final Logger log = LoggerFactory.getLogger(getClass()); //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";
}
}
@Controller는 반환값이 String 이면 뷰 이름으로 인식되기에 뷰를 찾고 뷰가 랜더링된다. @RestController는 반환 값으로 뷰를 찾는 것이 아닌, HTTP 메시지 바디에 바로 입력한다. 따라서 실행 결과로 ok 메시지를 받을 수 있다.
로그 LEVEL : TRACE > DEBUG > INFO > WARN > ERROR
우리는 출력되는 로그 레벨을 설정할 수 있는데 개발 서버는 debug를 출력하고 운영 서버는 info를 출력하는게 적합하다.
#전체 로그 레벨 설정(기본 info)
logging.level.root=info
#hello.springmvc 패키지와 그 하위 로그 레벨 설정
logging.level.hello.springmvc=debug
log.debug("data="+data)는 잘못된 방법이다. "data="+data가 실제 진행이 되어버리기에 결과적으로 문자 더하기 연산이 발생한다.
그래서 log.debug("data={}", data)가 올바른 사용 방법이다.
/**
* method 특정 HTTP 메서드 요청만 허용
* GET, HEAD, POST, PUT, PATCH, DELETE
*/
@RequestMapping(value = "/mapping-get-v1", method = RequestMethod.GET)
public String mappingGetV1() {
log.info("mappingGetV1");
return "ok";
}
만약 여기에 POST을 하게되면 MVC는 HTTP 405 상태코드를 반환한다.
여기서 HTTP 메서드를 축약한 애노테이션을 사용하면 더 편리하고 직관적이다.
/**
* 편리한 축약 애노테이션 (코드보기)
* @GetMapping
* @PostMapping
* @PutMapping
* @DeleteMapping
* @PatchMapping
*/
@GetMapping(value = "/mapping-get-v2")
public String mappingGetV2() {
log.info("mapping-get-v2");
return "ok";
}
/**
* 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는 리소스 경로에 식별자를 넣는 스타일을 선호한다.
@RequestMapping은 URL 경로를 템플릿화 할 수 있는데, @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";
}
@PathVariable의 이름과 파라미터 이름이 같으면 생략가능하다.
/**
* 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 415(Unsupported Media Type) 상태 코드를 반환한다.
/**
* Accept 헤더 기반 Media Type
* produces = "text/html"
* produces = "!text/html"
* produces = "text/*"
* produces = "*\/*"
*/
@PostMapping(value = "/mapping-produce", produces = "text/html")
public String mappingProduces() {
log.info("mappingProduces");
return "ok";
}
만약 맞지 않으면 HTTP 406 상태코드(Not Acceptable)을 반환한다.
package hello.springmvc.basic.request;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import lombok.extern.slf4j.Slf4j;
import org.springframework.cglib.core.Local;
import org.springframework.http.HttpMethod;
import org.springframework.util.MultiValueMap;
import org.springframework.web.bind.annotation.CookieValue;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.Locale;
@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, //헤더 중에 host란 헤더는 필수임. host만 받음
@CookieValue(value = "myCookie", required = false) String cookie//value는 쿠키 이름이 됨. true가 기본 값
){
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 메서드를 조회해서 반환 (GET, POST 등)Locale : Locale 정보 조회. (ko_KR)@RequestHeader MultiValueMap<String, String> headerMap : 모든 HTTP 헤더를 MultiValueMap 형식으로 조회. MultiValueMap은 하나의 키에 여러값을 받을 수 있음. @RequestHeader("host") String host : 특정 HTTP 헤더 조회. 이 경우에는 헤더 값 중 호스트 값만 출력해줌.@CookieValue(value = "myCookie", required = false) String cookie : 특정 쿠키를 조회함. value는 쿠키의 이름이 됨. required는 true가 디폴트 값이고, false는 없어도 된단 의미임. @Slf4j : 이 애노테이션을 통해 바로 로그 사용 가능.map과 유사한데, 하나의 키에 여러 값을 받을 수 있다. HTTP 헤더, 쿼리 파라미터와 같이 하나의키에 여러 값을 받을 때 사용한다.
HTTP 요청 메시지를 통해 클라이언트에서 서버로 데이터를 전달하는 방법은 세가지이다.
GET - 쿼리 파라미터
ex) /url?username=hello&age=20
메시지 바디없이, URL의 쿼리 파라미터에 데이터 포함해서 전달
POST - HTML Form
content-type : application/x-www-form-urlencoded
메시지 바디에 쿼리 파라미터 형식으로 전달
HTTP message body에 데이터를 직접 담아서 요청
HTTP API에서 주로 사용.(JSON, XML, TEXT)
데이터 형식은 주로 JSON 사용
HttpServletRequest의 request.getParameter()을 사용하면 다음 두가지 요청 파라미터를 조회할 수 있다.
GET 쿼리 파라미터 전송 방식이든, POST HTML Form 전송 방식이든 둘다 형식이 같으므로 구분없이 조회할 수 있음. 이것을 간단히 요청 파라미터 조회라고 함.
그리고 유의해야 할 점, jar를 사용하면 webapp경로를 사용할 수 없다. resources > static 경로는 자동 공개된다. 그렇기에 우리는 이 경로를 사용하면 된다!!
스프링이 제공하는 @RequestParam을 사용하면 요청 파라미터를 매우 편리하게 사용할 수 있다.
@ResponseBody : View 조회를 무시하고, HTTP 메시지 바디에 직접 해당 내용 입력
@RequestParam : 파라미터 이름으로 바인딩.
@RequestParam의 name(value) 속성이 파라미터 이름으로 사용.
HTTP 파라미터 이름이 변수 이름과 같으면 @RequestParam(name=xxx)를 생략할 수 있다.
String, int Integer 등의 단순 타입이면 @RequstParam도 생략 가능하다. 이때 스프링 MVC는 내부에서 required = false을 적용한다.
/**
* @RequestParam.required
* /request-param-required -> username이 없으므로 예외
*
* 주의!
* /request-param-required?username= -> 빈문자로 통과
*
* 주의!
* /request-param-required
* int age -> null을 int에 입력하는 것은 불가능, 따라서 Integer 변경해야 함(또는 다음에 나오는
defaultValue 사용)
*/
@ResponseBody
@RequestMapping("/request-param-required")
public String requestParamRequired(@RequestParam(required = false) String username,
@RequestParam(required = false) int age){
log.info("username = {}, age = {}", username, age);
return "ok";
}
컨트롤러이면서 리턴값이 String이면 ViewResolver를 찾게 된다. 이때 리턴 값을 바로 출력화면에 그대로 찍고 싶으면 클래스 위에 @RestController를 적거나 메서드 위에 @ResponseBody에 적으면 된다.
@RequestParam.required : 파라미터 필수 여부. 기본값은 true/request-param 요청 : username이 없으므로 오류 발생주의
/request-param?username= : 파라미터 이름만 있고 값이 없는 경우에는 빈문자(" ")로 통과된다.defaultValue를 사용하면 된다. @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 기능을 제공한다.
먼저 요청 파라미터를 바인딩받을 수 있는 객체를 만들어야 한다.
package hello.springmvc.basic;
import lombok.Data;
@Data
public class HelloData {
private String username;
private int age;
}
롬복의 @Data를 @Getter, @Setter, @ToString, @EqualsAndHashCode, @RequiredArgsConstructor를 자동으로 적용해준다.
@ResponseBody
@RequestMapping("/model-attribute-v1")
public String modelAttributeV1(@ModelAttribute HelloData helloData) {
log.info("username = {}, age = {}", helloData.getUsername(), helloData.getAge());
log.info("helloData = {}", helloData); //HelloData의 @Data 애노테이션 안에 @ToString으로 인해 보기 좋게 출력됨.
return "ok";
}
스프링MVC는 @ModelAttribute가 있으면 HelloData객체를 생성한다.
요청파라미터 이름으로 HelloData 객체의 프로퍼티(설정자, 접근자)를 찾는다.
해당 프로퍼티의 setter를 호출해 파라미터 값을 입력(바인딩)한다.
ex) username -> getUsername() 메서드 호출
이때 숫자가 들어가야할 곳에 문자를 넣게되면 BindException이 발생한다. 이런 바인딩 오류는 검증 부분에서 다룬다.
그리고 @ModelAttribute는 생략가능하다. 하지만 @ReqestParam도 생략가능하기에 혼란이 발생할 수 있다. 그래서 스프링은 생략시 다음과 같은 규칙을 적용한다.
@RequestParam@ModelAttribute객체에 getUsername(), setUsername() 메서드가 있으면, 이 객체는 username이라는 프로퍼티를 가지고 있다. username의 프로퍼티 값을 변경하면 setUsername()이 호출되고, 조회하면 getUsername()이 호출된다.
HTTP message body에 데이터를 직접 담아서 요청
요청 파라미터와 다르게, HTTP 메시지 바디를 통해 데이터가 직접 넘어오는 경우 @RequestParam, @ModelAttribute를 사용할 수 없다.
HTTP 메시지 바디 데이터를 InputStream을 사용해 직접 읽을 수 있다. 서블릿에서 읽어오는 방식과 동일하다.
/**
* {"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 helloData = objectMapper.readValue(messageBody, HelloData.class);
log.info("username = {}, age = {}", helloData.getUsername(), helloData.getAge());
response.getWriter().write("ok");
}
}
이때 이 코드에서 서블릿 객체로 매개변수를 받지 않고 InputStream, Writer 객체를 매개변수로 받으면 된다.
@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");
}
하지만 스프링 MVC는 더욱 편리한 기능을 지원한다. 바로 HttpEntity를 지원한다.
/**
* 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();
log.info("messageBody={}", messageBody);
return new HttpEntity<>("ok");
}
HttpEntity는 응답에도 사용할 수 있다. 메시지 바디 정보에 직접 반환가능하고 헤더 정보 포함도 가능하다. 하지만 뷰 조회는 안된다.
/**
* @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";
}
@RequestBody를 사용하면 HTTP 메시지 바디 정보를 편리하게 조회할 수 있다. 이렇게 메시지 바디를 직접 조회하는 기능은 요청 파라미터를 조회하는 @RequestParam @ModelAttribute와는 전혀 관계없다.
@RequestParam, @ModelAttribute@RequestBodyJSON은 HTTP API 방식에 많이 사용된다.
JSON 데이터를 읽어들이기 위해서는
private ObjectMapper objectMapper = new ObjectMapper();
위의 코드가 필요하다. Jackson 라이브러리인 ObjectMapper를 사용해 자바 객체로 변환해준다.
/**
* @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";
}
@RequestBody를 사용해 HTTP 메시지에서 데이터를 꺼내고 messageBody 저장한다. 문자로 된 JSON 데이터인 messageBody를 objectMapper를 통해 자바 객체로 변환한다.
문자로 변환하고 다시 json으로 변환하는 과정이 불편하기에 더 편리한 방법은 없을까?
/**
* @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";
}
HttpEntity, @RequestBody를 사용하면 HTTP 메시지 컨버터가 HTTP 메시지 바디 내용을 우리가 원하는 문자나 객체 등으로 변환해준다. HTTP 메시지 컨버터는 문자 뿐만 아니라 JSON도 객체로 변환해준다.
@RequestBody는 생략할 수 없다. 이 애노테이션을 생략하면 @ModelAttribute가 적용되어 버린다. 이렇게 되면 HTTP 메시지 바디가 아니라 요청 파라미터를 처리하게 된다.
/**
* @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) {
log.info("username={}, age={}", data.getUsername(), data.getAge());
return data;
}
@ResponseBody의 해당 객체를 http 메시지 바디에 직접 넣어줄 수 있다.
@RequestBody 요청 : JSON 요청 -> HTTP 메시지 컨버터 -> 객체@ResponseBody 응답 : 객체 -> HTTP 메시지 컨버터 -> JSON 응답스프링에서 응답 데이터를 만드는 방법은 크게 3가지 이다.
스프링 부트는 클래스 겨로의 다음 디렉토리에 있는 정적 리소스를 제공한다.
/static, /public, /resources, /META-INF/resources
src/main/resources는 리소스를 보관하는 곳이고, 또 클래스 경로의 시작 경로이다. 따라서 src/main/resources/static 경로에 넣어두면 스프링 부트가 정적 리소스로 서비스를 제공한다.
뷰 템플릿을 거쳐 HTML이 생성되고, 뷰가 응답을 만들어 전달한다. 일반적으로 HTML을 동적으로 생성하는 용도로 사용하지만 다른 것들도 가능하다.
스프링 부트는 src/main/resources/templates 경로를 제공한다.
@ResponseBody가 없으면 뷰 리졸버가 실행되어 뷰를 찾고 렌더링한다. @ResponseBody가 있으면 뷰 리졸버를 사용하지 않고, HTTP 메시지 바디에 직접 문자가 입력된다.
ex) 리턴 값이 response/hello 일 때, 애노테이션이 존재하면 문자 그대로 출력되고, 애노테이션이 없으면 templates/response/hello/html이 렌더링된다.
@Controller를 사용하고, HttpServletResponse, OutputStream(Writer) 같은 HTTP 메시지 바디를 처리하는 파라미터가 없으면 요청 URL을 참고해 논리 뷰 이름으로 사용한다.
@ResponseBody, httpEntity를 사용하면 뷰 템플릿을 사용하는 것이 아닌 HTTP 메시지 바디에 직접 응답 데이터를 출력할 수 있다.
뷰 템플릿으로 HTML을 생성해서 응답하는 것이 아닌, HTTP API 처럼 JSON 데이터를 HTTP 메시지 바디에 직접 읽거나 쓰는 경우 HTTP 메시지 컨버터를 사용하면 편리하다.

**@ResponseBody를 사용
viewResolver 대신 HttpMessageConverter 동작StringHttpMessageConverter, 기본 객체 처리는 MappingJackson2HttpMessageConverter HTTP 메시지 컨버터는 HTTP 요청과 응답 둘다 사용된다.
canRead(), canWrite() : 메시지 컨버터가 해당 클래스, 미디어 타입 지원하는지 체크read(), write() : 메시지 컨버터를 통해 메시지 읽고 쓰는 기능
byte[] 데이터를 처리한다.
클래스 타입 : byte[] , 미디어 타입 : */*
String 문자로 데이터를 처리한다
클래스 타입 : String, 미디어 타입 : */*
application/json
클래스 타입 : 객체 또는 HashMap, 미디어 타입 : application/json
@RequestBody, HttpEntity 파라미터를 사용한다. canRead()를 호출한다.canRead() 조건을 만족하면 read()를 호출해 객체 생성하고 반환한다.@ResponseBody, HttpEntity 값이 반환된다.canWrite()를 호출한다.canWrite() 조건을 만족하면 write() 호출해서 HTTP 응답 메시지 바디에 데이터를 생성한다.
핸들러 어댑터에서 컨버터와 관련된 일이 벌어지고 있다. 이 모든 것은 @RequestMapping을 처리하는 핸들러 어댑터인 ReqestMappingHandlerAdapter에 있다.

애노테이션 기반의 컨트롤러는 매우 다양한 파라미터를 사용할 수 있다. HttpServletRequest, Model, HTTP 메시지를 처리하는 부분까지 매우 큰 유연함을 보여 주었다. 이 모든건 ArgumentResolver 덕분이다.
ArgumentResolver는 각각 맞는 데이터 타입으로 생성해준다. 파라미터 값이 모두 준비되면 컨트롤러를 호출하면서 값으로 넘겨준다. ArugmentResolver는 인터페이스로 존재한다. (확장 유리)

ArgumentResolver들은 그냥 사용되는게 아닌 HTTP 메시지 컨버터를 이용해 필요한 객체 생성한다. HTTP 메시지 컨버터는 루프로 돌리면서 처리한다. ReturnValueHandler들도 HTTP 메시지 컨버터를 호출한다. (write()로 호출. 값을 써야하기에)