깃허브에 정리했던 Spring boot를 이용한 공부들을 정리했다.
github:https://github.com/kimseokjin0324/springmvc
앞으로 로그를 사용할 것이기 때문에 로그에 대해서 간단히 실습
운영 시스템에서는 System.out.println() 같은 시스템 콘솔을 사용해서 필요한 정보를 출력하지 않고 별도의 로깅 라이브러리를 사용해서 로그를 출력한다.
지금은 최소한의 사용 방법만 알아봄
스프링 부트 라이브러리를 사용하면 스프링 부트 로깅 라이브러리(spring-boot-starter-logging)가 함께 포함된다.
스프링 부트 로깅 라이브러리는 기본으로 다음 로깅 라이브러리를 사용한다
로그 라이브러리는 Logback,Log4J, Log4J2 등등 수 많은 라이브러리가 있는데, 그것을 통합해서 인터페이스로 제공하는 것이 바로 SLF4J 라이브러리다.
SLF4J는 인터페이스이고 그 구현체로 Logback 같은 로그 라이브러리를 선택하면 됨
실무에서는 스프링 부트가 기본으로 제공하는 Logback을 대부분 사용한다.
application.properties에
#전체 로그 레벨 설정(기본 info)
logging.level.root=info
#hello.springmvc 패키지와 그 하위 로그 레벨 설정
logging.level.hello.springmvc=debug
회원 관리를 HTTP API 로 만든다고 생각하고 매핑을 어떻게 하는지 알아보기
(실제 데이터가 넘어가는 부분은 생략하고 URL 매핑만)
애노테이션 기반의 스프링 컨트롤러는 다양한 파라미터를 지원한다.
이번에는 HTTP 헤더 정보를 조회하는 방법을 알아볼려고함
org.springframework.http.HttpMethod
@RequestHeader MultiValueMap<String,String> headerMap
MultiValueMap
MultiValueMap<String, String> map = new LinkedMultiValueMap();
map.add("keyA", "value1");
map.add("keyA", "value2");
//[value1,value2]
List values = map.get("keyA");
다음 코드를 자동으로 생성해서 로그를 선언해준다. 개발자는 편리하게 log라고 사용하면된다.
private static final org.slf4j.Logger log =
org.slf4j.LoggerFactory.getLogger(RequestHeaderController.class);
서블릿에서 학습했던 HTTP 요청 데이터를 조회하는 방법을 다시 떠올려봄. 그리고 서블릿으로 학습했던 내용을 스프링이 얼마나 깔끔하고 효율적으로 바꾸어주는지 알아보자
HTTP 요청 메세지를 통해 클라이언트에서 서버로 데이터를 전달하는 방법을 알아보자
HttpServletRequest의 request.getParameter()를 사용하면 다음 두가지 요청 파라미터를 조회할 수 있다.
예시
http://localhost:8080/request-param?username=hello&age=20
예시
POST /request-param....
content-type: application/x-www-form-urlencoded
username=hello&age=20
GET 쿼리 파라미터 전송 방식이든 ,POST HTML Form 전송 방식이든 둘다 형식이 같으므로 구분없이 조회할 수 있다.
이것을 간단히 요청 파라미터(request parameter) 조회라 한다.
여기서는 단순히 HttpServletRequest가 제공하는 방식으로 요청 파라미터를 조회했다.
http://localhost:8080/request-param-v1?username=hello&age=20
스프링이 제공하는 @RequestParam을 사용하면 요청 파라미터를 매우 편리하게 사용할 수 있다.
@RequestParam의 name(value) 속성이 파라미터 이름으로 사용
HTTP 파라미터 이름이 변수 이름과 같으면 @RequestParam(name="xx") 생략 가능
String , int , Integer 등의 단순 타입이면 @RequestParam 도 생략 가능
주의!- 파라미터 이름만 사용
/request-param?username=
파라미터 이름만 있고 값이 없는 경우 -> 빈문자로 통과
주의!- 기본형(primitive)에 null 입력
null 을 int에 입력하는 것은 불가능(500 예외 발생)
따라서 null 을 받을 수 있는 Integer로 변경하거나, 또는 다음에 나오는 defaultValue 사용
파라미터에 값이 없는 경우 defaultValue를 사용하면 기본 값을 적용할 수 있다.
이미 기본 값이 있기 때문에 required는 의미가 없다.
defualtValue는 빈 문자의 경우에도 설정한 기본 값이 적용된다.
/request-param?username=
파라미터를 Map, MultiValueMap 으로 조회할 수 있다.
실제 개발을 하면 요청 파라미터를 받아서 필요한 객체를 만들고 그 객체에 값을 넣어주어야함, 보통 다음과 같은 코드를 작성함
@RequestParam String username;
@RequestParam int age;
HelloData data = new HelloData();
data.setUsername(username);
data.setAge(age);
스프링은 이 과정을 완전히 자동화 해주는 @ModelAttribute 기능을 제공함
먼저 요청 파라미터를 바인딩 받은 객체를 만들어 줌
스프링 MVC는 @ModelAttribute가 있으면 다음을 실행함
객체에 getUsername(), setUsername() 메서드가 있으면, 이 객체는 username이라는 프로퍼티를 가지고 있다.
username 프로퍼티의 값을 변경하면 setUsername() 이 호출되고, 조회하면 getUsername()이 호출된다.
class HelloData {
getUsername();
setUsername();
}@ModelAttribute 생략 - modelAttributeV2
@ModelAttribute는 생략할 수 있다.
그런데 @RequestParam도 생략할 수 있으니 혼란이 발생할 수있다.
스프링이 해당 생략시 다음과 같은 규칙을 적용한다.
요청 파라미터와 다르게, HTTP 메세지 바디를 통해 데이터가 직접 데이터가 넘어오는 경우는 @RequestParam,@ModelAttribute를 사용할 수 없다.(물론 HTML Form 형식으로 전달되는 경우는 요청 파라미터로 인정된다.)
스프링 MVC는 다음 파라미터를 지원한다.
스프링 MVC는 다음 파라미터를 지원한다.
@RequestBody를 사용하면 HTTP 메세지 바디 정보를 편리하게 조회할 수 있다. 참고로 헤더 정보가 필요하다면 HttpEntity를 사용하거나 @RequestHeader를 사용하면 된다.
이렇게 메세지 바디를 직접 조회하는 기능은 요청 파라미터를 조회하는 @RequestParam, @ModelAttribute와는 전혀 관계가 없다.
@ResponseBody를 사용하면 응답 결과를 HTTP 메세지 바디에 직접 담아서 전달할 수 있다. 물론 이 경우에도 view를 사용하지 않는다.
HTTP API에서 주로 사용하는 JSON 데이터 형식을 조회해볼것임(기존 서블릿에서 사용했던 방식과 비슷하게 시작)
문자로 변환하고 다시 json으로 변환하는 과정이 불편하다. @ModelAttribute처럼 한번에 객체로 변환할 수는 없을까?
@ResponseBody
응답의 경우에도 @ResponseBody를 사용하면 해당 객체를 HTTP 메세지 바디에 직접 넣어줄 수 있다.
물론 이 경우에도 HttpEntity를 사용해도 된다.
응답 데이터는 이미 앞에서 일부 다룬 내용들이지만, 응답 부분에 초첨을 맞추어서 정리
스프링(서버)에서 응답 데이터를 만드는 방법은 크게 3가지
스프링 부트는 클래스패스의 다음 디렉토리에 있는 정적 리소스를 제공한다.
/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
@ResponseBody 가 없으면 response/hello로 뷰 리졸버가 실행되어서 뷰를 찾고 ,렌더링함.
@ResponseBody가 있으면 뷰 리졸버를 실행하지 않고,HTTP메세지 바디에 직접 response/hello라는 문자가 입력됨
여기서 뷰의 논리 이름인 response/hello를 반환하면 다음 경로의 뷰 템플릿이 렌더링 되는것을 확인할 수있다.
@ResponseBody , HttpEntity 를 사용하면, 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에
직접 응답 데이터를 출력할 수 있다
HTTP API를 제공하는 경우에는 HTML이 아니라 데이터를 전달해야 하므로,HTTP 메세지 바디에 JSON 같은 형식으로 데이터를 실어 보낸다.
HTTP 요청에서 응답까지 대부분 다루었으므로 정리를 함
참고
HTML이나 뷰 템플릿을 사용해도 HTTP 응답 메세지 바디에 HTML데이터가 담겨서 전달됨. 여기서 설명하는 내용은 정적 리소스나 뷰 템플릿을 거치지 않고, 직접 HTTP 응답 메세지를 전달하는 경우를 말함
서블릿을 직접 다룰 때 처럼
HttpServletResponse 객체를 통해서 HTTP 메세지 바디에 직접 ok응답 메세지를 전달함
response.getWriter().writer("ok");
ResponseEntity 엔티티는 HttpEntity를 상속 받았는데, HttpEntity는 HTTP 메세지의 헤더, 바디 정보를 가지고 있다.
ResponseEntity는 여기에 더해서 HTTP 응답 코드를 설정할 수 있다.
HttpStatus.CREATED로 변경하면 201응답이 나가는 것을 확인할 수 있다.
@ResponseBody를 사용하면 view를 사용하지 않고, HTTP 메세지 컨버터를 통해서 HTTP 메세지를 직접 입력할 수 있다.
ResponseEntity도 동일한 방식으로 동작한다.
ResponseEntity를 반환함. HTTP 메세지 컨버터를 통해서 JSON 형식으로 변환되어 반환된다.
ResponseEntity는 HTTP 응답 코드를 설정할 수 있는데, @ResponseBody를 사용하면 이런것을 설정하기 까다롭다.
@ResponseStatus(HttpStatus.OK) 애노테이션을 사용하면 응답 코드도 설정할 수 있다.
물론 애노테이션이기 때문에 응답 코드를 동적으로 변경할 수는 없다. 프로그램 조건에 따라서 동적으로변경하려면 ResponseEntity 를 사용하면 된다
@Controller 대신에 @RestController 애노테이션을 사용하면, 해당 컨트롤러에 모두 @ResponseBody가 적용되는 효과가 있다. 따라서 뷰 템플릿을 사용하는 것이 아니라, HTTP 메세지 바디에 직접 데이터를 입력한다. 이름 그대로 REST API(HTTP API)를 만들 때 사용하는 컨트롤러이다.
참고로 @ResponseBody는 클래스 레벨에 두면 전체에 메서드에 적용되는데, @RestController 에노테이션 안에 @ResponseBody가 적용되어 있다.
뷰 템플릿으로 HTML을 생성해서 응답하는 것이 아니라, HTTP API 처럼 JSON 데이터를 HTTP 메세지 바디에서 직접 읽거나 쓰는 경우 HTTP 메세지 컨버터를 사용하면 편리하다.
HTTP 메세지 컨버터는 HTTP요청,HTTP 응답 둘 다 사용된다.
0= ByteArrayHttpMessageConverter
1= StringHttpMessageConverter
2= MappingJackson2HttpMessageConverter
스프링 부트는 다양한 메세지 컨버터를 제공하는데, 대상 클래스 타입과 미디어 타입 둘을 체크해서 사용여부를 결정한다.
만약 만족하지 않으면 다음 메세지 컨버터로 우선순위가 넘어간다.
##요청 매핑 핸들러 어뎁터 구조
다음 그림에서는 HTTP 메시지 컨버터는 보이지않음
모든 비밀은 애노테이션 기반 컨트롤러, @RequestMapping을 처리하는 핸들러 어댑터인 RequestMappingHandlerAdapter(요청 매핑 헨들러 어뎁터)에 있다.
생각해보면, 애노테이션 기반의 컨트롤러는 매우 다양한 파라미터를 사용할 수 있었다.
HttpServletRequest, Model은 물론이고, @RequestParam, @ModelAttribute같은 애노테이션 그리고 @RequestBody, HttpEntity 같은 HTTP 메시지를 처리하는 부분까지 매우 큰 유연함을 보여줌
이렇게 파라미터를 유연하게 처리할 수 있는 이유가 ArgumentResolver 덕분이다.
애노테이션 기반 컨트롤러를 처리하는 RequestMappingHandlerAdaptor는 바로 이 ArgumentResolver를 호출해서 컨트롤러(핸들러)가 필요로 하는 다양한 파라미터의 값(객체)을 생성한다.
그리고 이렇게 파리미터의 값이 모두 준비되면 컨트롤러를 호출하면서 값을 넘겨준다.
스프링은 30개가 넘는 ArgumentResolver를 기본으로 제공함
정확히는 HandlerMethodArgumentResolver인데 줄여서 ArgumentResolver라고 부른다.
ArgumentResolver의 supportsParameter()를 호출해서 해당 파라미터를 지원하는지 체크하고 지원하면 resolveArgument()를 호출해서 실제 객체를 생성. 그리고 이렇게 생성된 객체가 컨트롤러 호출시 넘어가는 것이다.
HandlerMethodArgumentResolver인데 줄여서 ArgumentResolver라고 부른다.
ArgumentResolver와 비슷함, 이것은 응답 값을 변환하고 처리함
컨트롤러에서 String으로 뷰 이름을 반환해도, 동작하는 이유가 바로 ReturnValueHandler 덕분이다.
스프링은 10여개가 넘는 ReturnValueHandler 를 지원한다.
예) ModelAndView , @ResponseBody , HttpEntity , String
HTTP 메시지 컨버터를 사용하는 @RequestBody도 컨틀러라가 필요로 하는 파라미터의 값에 사용된다.
@ResponseBody의 경우 컨트롤러의 반환 값을 이용한다.
요청의 경우 @RequestBody 를 처리하는 ArgumentResolver 가 있고, HttpEntity 를 처리하는ArgumentResolver 가 있다.
이 ArgumentResolver 들이 HTTP 메시지 컨버터를 사용해서 필요한객체를 생성하는 것이다.
응답의 경우 @ResponseBody 와 HttpEntity 를 처리하는 ReturnValueHandler 가 있다.
그리고여기에서 HTTP 메시지 컨버터를 호출해서 응답 결과를 만든다.
스프링 MVC는 @RequestBody @ResponseBody 가 있으면 RequestResponseBodyMethodProcessor (ArgumentResolver)
HttpEntity 가 있으면 HttpEntityMethodProcessor (ArgumentResolver)를 사용한다.
스프링은 다음을 모두 인터페이스로 제공한다. 따라서 필요하면 언제든지 기능을 확장할 수 있다.
수정에 필요한 정보를 조회하고, 수정용 폼 뷰를 호출한다.
정적 HTML을 뷰 템플릿(templates)영역으로 복사하고 수정함
상품 수정은 상품 등록과 전체 프로세스가 유사함
상품 수정은 마지막에 뷰 템플릿을 호출하는 대신에 상품 상세 화면으로 이동하도록 리다이렉트를 호출한다.
addItemV1~ addItemV4 에는 심각한 문제가 있음
상품을 등록 완료하고 웹 브라우저의 새로고침 버튼을 클릭하면 같은상품이 아이디만 다르고 계속 중복 등록이 된다.
웹브라우저의 새로고침은 마지막에 서버에 전송한 데이터를 다시 전송함
상품 등록 폼에서 데이터를 입력하고 저장하면 POST /add + 상품 데이터를 서버로 전송함
이 상태에서 새로 고침을 또하면 마지막에 전송한 POST /add + 상품 데이터를 서버로 다시 전송함
그래서 내용은 같고 ID만 다른 상품데이터가 계속 쌓이게 된다.
웹 브라우저의 새로 고침은 마지막에 전송한 데이터를 다시 전송함
새로 고침 문제를 해결하려면 상품 저장 후에 뷰 템플릿으로 이동하는 것이 아니라, 상품 상세 화면으로 리다이렉트를 호출하면 된다.
웹 브라우저는 리다이렉트의 영향으로 상품 저장 후에 실제 상품 상세 화면으로 다시 이동한다. 따라서 마지막에 호출한 내용이 상품 상세 화면인 GET /items/{id}가 되는것이다.
RedirectAttributes를 사용하면 URL 인코딩도 해주고,pathVarible, 쿼리파라미터까지 처리해준다.
뷰 템플릿에 메시지를 추가하고 실행해보면 저장완료!라는 메시지가 나오는 것을 확인할 수 있다. 물론 상품 목록에서 상품 상세로 이동한 경우에는 해당 메시지가 출력되지않는다.