[09] 스프링 MVC의 Controller 및 여러 예제 2

3-8. @DateTimeFormat

@InitBinder를 이용해서 날짜를 변환할 수도 있지만, 파라미터로 사용되는 인스턴스 변수에 @DateTimeFormat을 적용해도 변환이 가능하다. (둘중 하나를 사용.)

3-8-1. TodoDTO 클래스에 아래와 같은 코드를 추가한다.

package org.zerock.domain;

import java.util.Date;

import org.springframework.format.annotation.DateTimeFormat;
import org.springframework.ui.Model;

import lombok.Data;

@Data
public class TodoDTO {

	private String title;
	
	// if you using @InitBinder, you use only this(down) code.
	//private Date dueDate;
	
	// using @DateTimeFormat
	@DateTimeFormat(pattern = "yyyy-MM-dd")
	private Date dueDate;
}

4. Model 이라는 데이터 전달자

public String home(Model model) {
	model.addAttribute("serverTime", new java.util.Date());
	
	return "home";
}

메서드의 파라미터를 Model 타입으로 선언하게 되면 자동으로 스프링 MVC에서 Model 타입의 객체를 만들어 주기 때문에 개발자의 입장에서는 필요한 데이터를 담아주는 작업만으로 모든 작업이 완료된다. Model을 사용해야 하는 경우는 주로 Controller에 전달된 데이터를 이용해서 추가적인 데이터를 가져와야 하는 상황이다.

예를 들면,

리스트 페이지 번호를 파라미터로 전달받고, 실제 데이터를 View로 전달해야 하는 경우
파라미터들에 대한 처리 후 결과를 전달해야 하는 경우

4-1. @ModelAttibute 어노테이션

웹 페이지 구조는 Request에 전달된 데이터를 가지고 필요하다면 추가적인 데이터를 생성해서 화면으로 전달하는 방식으로 동작한다. Model의 경우는 파라미터로 전달된 데이터는 존재하지 않지만 화면에서 필요한 데이터를 전달하기 위해서 사용한다. 예를 들어 페이지 번호는 파라미터로 전달되지만, 결과 데이터를 전달하려면 Model에 담아서 전달한다.

스프링 MVC의 Controller는 기본적으로 Java Beans 규칙에 맞는 객체는 다시 화면으로 전달한다. 좁은 의미에서 Java Beans의 규칙은 단순히 생성자가 없거나 빈 생성자를 가져야 하며, getter/setter를 가진 클래스의 객체들을 의미한다. 앞의 예제에서 파라미터로 사용된 SampleDTO의 경우는 Java Bean의 규칙에 맞기 때문에 자동으로 다시 화면까지 전달된다. 전달될 때 클래스명의 앞글자는 소문자로 처리된다.

반면에 기본 자료형의 경우는 파라미터로 선언하더라도 기본적으로 화면까지 전달되지 않는다.

4-1-1. SampleController에 아래와 같은 코드를 추가한다.

	@GetMapping("/ex04")
	public String ex04(SampleDTO dto, int page) { 
		
		log.info("dot : " + dto);
		log.info("page : " + page);
		
		return "/sample/ex04";
	}

- ex04()는 SampleDTO 타입과 int 타입의 데이터를 파라미터로 사용한다.

4-1-2. 결과를 확인하기 위해서 '/WEB-INF/views' 폴더아래 sample 폴더를 생성하고 ex04.jps 파일을 생성한다.

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8">
<title>Insert title here</title>
</head>
<body>

<h2>SAMPLEDTO   ${sampleDTO }</h2>
<h2>PAGE  ${page }</h2>

</body>
</html>

4-1-3. 결과화면 - page는 나타나지 않은 것을 볼 수 있다.

4-2. @ModelAttribute 는 강제로 전달받은 파라미터를 Model에 담아서 전달하도록 할 때 필요한 어노테이션이다.

@ModelAttribute가 걸린 파라미터는 타입에 관계없이 무조건 Model에 담아서 전달되므로, 파라미터로 전달된 데이터를 다시 화면에서 사용해야 할 경우에 유용하게 사용된다.

4-2-1. SampleController 클래스에 아래와 같은 코드를 추가한다.

4-2-2. 페이지 까지 출력되는 것을 볼 수 있다.

4-3. RedirectAttributes

Model 타입과 더불어서 스프링 MVC가 자동으로 전달해 주는 타입 중에는 RedirectAttributes 타입이 존재한다. RedirectAttributes는 조금 특별하게도 일회성으로 데이터를 전달하는 용도로 사용된다.

(Sevlet에서는 response.sendRedirect()를 사용할 때와 동일.)

스프링 MVC를 이용하는 경우에는 다음과 같다.

rttr.addFlashAttribute("name", "AAA");
	rttr.addFlashAttribute("age", 10);
	
	return "redirect:/";

5. Controller의 리턴 타입

스프링 MVC의 구조가 기존의 상속과 인터페이스에서 어노테이션을 사용하는 방식으로 변한 이후에 가장 큰 변화 중 하나는 리턴 타입이 자유로워 졌다는 것이다.

Controller 메서드가 사용할 수 있는 리턴 타입은 다음과 같다.

String : jsp를 이용하는 경우에는 jsp 파일의 경로와 파일 이름을 나타내기 위해서 사용한다.
void : 호출하는 URL과 동일한 이름의 jsp를 의미한다.
VO, DTO 타입 : 주로 JSON 타입의 데이터를 만들어서 반환하는 용도로 사용한다.
ResponseEntity 타입 : response 할 때 Http 헤더 정보와 내용을 가공하는 용도로 사용한다.
Model, ModelAndView : Model로 데이터를 반환하거나 화면까지 같이 지정하는 경우에 사용한다. (최근X)
HttpHeaders : 응답에 내용 없이 Http 헤더 메시지만 전달하는 용도로 사용한다.

5-1. 객체 타입

Controller의 메서드 리턴 타입을 VO(Value Object)나 DTO(Data Transfer Object) 타입 등 복합적인 데이터가 들어간 객체 타입으로 지정할 수 있는데, 이 경우는 주로 JSON 데이터를 만들어 내는 용도로 사용한다.

5-1-1. jackson-databind 라이브러리를 pom.xml에 추가한다.

		<!--  https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind -->
		<dependency>
			<groupId>com.fasterxml.jackson.core</groupId>
			<artifactId>jackson-databind</artifactId>
			<version>2.9.4</version>
		</dependency>

5-1-2. SampleController에도 아래와 같은 메서드를 추가한다.

	@GetMapping("/ex06")
	public @ResponseBody SampleDTO ex06() {
		
		log.info("/ex06..................");
		
		SampleDTO dto = new SampleDTO();
		dto.setAge(10);
		dto.setName("홍길동");
		
		return dto;
	}

5-1-3. JSON 타입으로 객체를 변환시켜서 브라우저에 전달하게 된다.

* 기본설정이 visual studio로 되어있어서 브라우저로 연동시켰더니 열리지 않는다.........아깐 됐었는데..... 뭐지 아무튼 json 파일은 잘 만들어진다.

* 만약 jackson-databind 라이브러리가 포함되지 않았다면 500 에러가 뜨게 된다.

5-2. ResponseEntity 타입

Web을 다루다 보면 HTTP 프로토콜의 헤더를 다루는 경우도 종종 있다. 스프링 MVC의 사상은 HttpServletRequest나 HttpServletResponse를 직접 핸들링하지 않아도 이런 작업이 가능하도록 작성되었기 때문에 이러한 처리를 위해 ResponseEntity를 통해서 원하는 헤더 정보나 데이터를 전달 할 수 있다.

5-2-1. SampleController 클래스에 코드를 추가한다.

	@GetMapping("/ex07")
	public ResponseEntity<String> ex07(){
		
		log.info("/ex07..........................");
		
		// {"name" : "홍길동"}
		String msg = "{\"name\" : \"홍길동\"}";
		
		HttpHeaders header = new HttpHeaders();
		header.add("Content-Type", "application/json; charset=UTF-8");
		
		return new ResponseEntity<>(msg, header, HttpStatus.OK);
	}

ResponseEntity는 HttpHeaders 객체를 같이 전달할 수 있고, 이를 통해서 원하는 HTTP 헤더 메시지를 가공하는 것이 가능하다. ex07()의 경우 브라우저에는 JSON 타입이라는 헤더 메시지와 200 OK라는 상태코드를 전송한다.

5-3. 파일 업로드 처리

Controller의 많은 작업은 스프링 MVC를 통해서 처리하기 때문에 개발자는 자신이 해야 하는 역할에만 집중해서 코드를 작성할 수 있지만, 조금 신경 써야 하는 부분이 있다면 파일을 업로드하는 부분에 대한 처리일 것이다. 파일 업로드를 하기 위해서는 전달되는 파일 데이터를 분석해야 하는데, 이를 위해서 Servlet 3.0 전까지는 commons의 파일 업로드를 이용하거나 cos.jar 등을 이용해서 처리를 해왔다. Servlet 3.0 이후 (Tomcat 7.0)에는 기본적으로 업로드 되는 파일을 처리할 수 있는 기능이 추가되어 있으므로 더 이상 추가적인 라이브러리가 필요로 하지 않는다.

조금 아쉬운 점은 'Spring Legacy Project'로 생성되는 프로젝트의 경우 Servlet 2.5를 기준으로 생성되기 때문에 3.0 이후에 지원되는 설정을 사용하기 어렵다는 점이다. 3.0이상의 파일 업로드 방식은 후반부에 별도 파트에서 다루도록 하고 예제는 일반적으로 많이 사용하는 commons-fileupload를 이용하도록 하겠다.

5-3-1. pom.xml에 commons-fileupload 라이브러리를 추가한다.

		<dependency>
			<groupId>commons-fileupload</groupId>
			<artifactId>commons-fileupload</artifactId>
			<version>1.3.3</version>
		</dependency>

5-3-2. 라이브러리 추가 후 파일이 임시로 업로드될 폴더를 C드라이브 아래 upload/tmp 로 작성한다.

5-3-3. servlet-context.xml을 설정한다.

servlet-context.xml은 스프링 MVC의 특정한 객체를 설정해서 파일을 처리한다. 다른 객체를 설정하는 것과 달리 파일 업로드의 경우에는 반드시 id 속성의 값을 'multipartResolver'로 정확하게 지정해야 하므로 주의가 필요하다.

	<beans:bean id = "multipartResolver" class = "org.springframework.web.multipart.commons.CommonsMultipartResolver">
		<beans:property name = "defaultEncoding" value="utf-8"></beans:property>
		<!-- 1024 * 1024 * 10 bytes 10MB -->
		<beans:property name = "maxUploadSize" value = "104857560"></beans:property>
		<!-- 1024 * 1024 * 2 bytes 2MB -->
		<beans:property name = "maxUploadSizePerFile" value = "2097152"></beans:property>
		<beans:property name = "uploadTempDir" value = "file:/C:/upload/tmp"></beans:property>
		<beans:property name = "maxInMemorySize" value = "10485756"></beans:property>
	</beans:bean>

- maxUploadSize : 한 번의 Request로 전달될 수 있는 최대의 크기

- maxUploadSizePerFile : 하나의 파일 최대 크기

- maxInMemorySize : 메모리상에서 유지하는 최대의 크기

- uploadTempDir : 메모리 크기 이상의 데이터를 임시 파일의 형태로 보관함. 여기서 절대 경로를 이용하려면 URI 형태로 제공해야 하기 때문에 'file:/'로 시작

- defaultEncoding : 업로드 하는 파일의 이름이 한글일 경우 깨지는 문제를 처리

5-3-4. SampleController에서는 다음과 같이 get 방식으로 업로드할 화면을 처리한다.

	@GetMapping("/exUpload")
	public void exUpload() {
		log.info("/exUpload..........................");
	}

5-3-5. exUpload.jsp 파일을 작성한다.

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8">
<title>Insert title here</title>
</head>
<body>

<form action = "/sample/exUploadPost"  method="post"  enctype="multipart/form-data">
	<div>
	<input type = 'file' name = 'files'>
	</div>
	<div>
	<input type = 'file' name = 'files'>
	</div>
	<div>
	<input type = 'file' name = 'files'>
	</div>
	<div>
	<input type = 'file' name = 'files'>
	</div>
	<div>
	<input type = 'file' name = 'files'>
	</div>
	<div>
	<input type = 'submit'>
	</div>

</form>
</body>
</html>

5-3-4. 실행시키면 아래와 같다.

5-3-5. exUpload.jsp의 action 속성값은 '/sample/exUploadPost'로 작성되었으므로, 이에 맞는 메서드를 SampleController에 추가한다.

	@GetMapping("/exUploadPost")
	public void exUploadPost(ArrayList<MultipartFile> files) {
		
		files.forEach(file -> {
			log.info("------------------------------------");
			log.info("name" + file.getOriginalFilename());
			log.info("size:" + file.getSize());
		});
	}

스프링 MVC는 전달되는 파라미터가 동일한 이름으로 여러 개 존재하면 배열로 처리가 가능하므로 파라미터를 MultipartFile의 배열 타입으로 작성한다.

5-3-6. 2MB보다 작은 크기의 파일을 지정하여 업로드를 테스트 한다.

* 잘 저장되었다는 로그는 뜨는데 만들어준 exUploadPost의 로그가 안나온다... 무슨일?????????

jsp 파일안에 action 이름도 잘 확인해주고 GetMapping 이름도 잘 확인해 주었는데................................................................

차차 해결해보자 ㅠ

6. Controller의 Exception 처리

Controller를 작성할 때 예외 상황을 고려하면 처리해야 하는 작업이 엄청나게 늘어날 수 밖에 없다. 스프링 MVC에서는 이러한 작업을 다음과 같은 방식으로 처리할 수 있다.

@ExceptionHandler와 @ControllerAdvice를 이용한 처리
@ResponseEntity를 이용하는 예외 메세지 구성

6-1. @ControllerAdvice

@ControllerAdvice는 뒤에 배우게 되는 AOP(Aspect-Oriented-Programming)를 이용하는 방식이다. AOP에 대해서는 별도의 파트에서 설명하겠지만, 간단히 언급하자면 핵심적인 로직은 아니지만 프로그램에서 필요한 '공통적인 관심사는 분리'하자는 개념이다. Controller를 작성할 때, 메서드의 모든 예외사항을 전부 핸들링해야 한다면 중복적이고 많은 양의 코드를 작성해야 하지만, AOP 방식을 이용하면 공통적인 예외사항에 대해서는 별도로 @ControllerAdvice를 이용해서 분리하는 방식이다.

6-1-1. 프로젝트에 org.zerock.exception이라는 패키지를 생성하고, Common ExceptionAdvice 클래스를 생성한다.

package org.zerock.exception;

import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;

import lombok.extern.log4j.Log4j;

@ControllerAdvice
@Log4j
public class CommonExceptionAdvice {
	
	@ExceptionHandler(Exception.class)
	public String except(Exception ex, Model model) {
		
		log.error("Exception.............."+ex.getMessage());
		model.addAttribute("exception", ex);
		log.error(model);
		return "error_page";
	}
}

- @ControllerAdvice : 해당 객체가 스프링의 컨트롤러에서 발생하는 예외를 처리하는 존재임을 명시하는 용도로 사용

- @ExceptionHandler : 해당 메서드가 () 들어가는 예외 타입을 처리한다는 것을 의미. 속성으로는 Exception 클래스 타입을 지정할 수 있음. 위와 같은 경우 Exception.class를 지정하였으므로 모든 예외에 대한 처리가 except()만을 이용해서 처리할 수 있음.

만약 특정한 타입의 예외를 다루고 싶다면 Exception.class 대신에 구체적인 예외의 클래스를 지정해야 한다. JSP 화면에서도 구체적인 메시지를 보고 싶다면 Model을 이용해서 전달하는 것이 좋다.

org.zerock.exception 패키지는 servlet-context.xml에서 인식하지 않기 때문에 <component-scan>을 이용해서 해당 패키지의 내용을 조사하도록 해야 한다.

6-1-2. servlet-context.xml 일부를 추가한다.

6-1-3. CommonExceptionAdvice의 except()의 리턴값은 문자열이므로 JSP 파일의 경로가 된다. JSP는 error_page.jsp이므로 /WEB-INF/views 폴더 내에 작성해야 한다.

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8">
<title>Insert title here</title>
</head>
<body>

	<h4><c:out value="${exception.getMessage()}"></c:out></h4>
	
	<ul>
		<c:forEach items="${exception.getStackTrace() }" var="stack">
			<li><c:out value="${stack }"></c:out></li>
		</c:forEach>
	</ul>
	
</body>
</html>

6-1-4. 예외의 메시지가 정상적으로 출력되는지 보려면 고의로 파라미터 값의 변환에 문제있게 만들어야한다.

* 에러 페이지가 안뜨길래 오류 메세지를 찾아보았더니 error_page.jsp에 c:out 태그가 unkown이라고 떠있었다. 구글링 해본 결과 아래와 같은 코드를 추가해주어야 한다고...

<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>

* 추가하고도 error_page로 넘어가지 않아서 ControllerExceptionAdvice 클래스 안에 메소드의 리턴값을 "error_page" 에서 "sample/error_page"로 바꿔줬더니 에러페이지가 나타남!!

6-2. 404 에러 페이지

WAS의 구동 중 가장 흔한 에러와 관련된 HTTP 상태코드는 '404' 와 '500' 에러코드 이다. 500 메시지는 'Internal Server Error' 이므로 @ExceptionHandler를 이용해서 처리되지만, 잘못된 URL을 호출할 때 보이는 404 에러 메시지의 경우는 조금 다르게 처리하는 것이 좋다.

서블릿이나 JSP를 이용했던 개발 시에는 web.xml을 이용해서 별도의 에러 페이지를 지정할 수 있다. 에러 발생 시 추가적인 작업을 하기는 어렵기 때문에 스프링을 이용해서 404와 같이 WAS 내부에서 발생하는 에러를 처리하는 방식을 알아두는 것이 좋다.

6-2-1. 스프링 MVC의 모든 요청은 DispatcherServlet을 이용해서 처리되므로 404 에러도 같이 처리할 수 있도록 web.xml을 수정한다.

6-2-2. ControllerExceptionAdvice 클래스에도 코드를 추가한다

	@ExceptionHandler(NoHandlerFoundException.class)
	@ResponseStatus(HttpStatus.NOT_FOUND)
	public String handle404(NoHandlerFoundException ex) {
		return "sample/custom404";
	}

* 여기서 @ResponseStatus 부분에서 자꾸 에러가 나면서 자동 import도 안먹고 그랬는데

import org.springframework.http.HttpStatus;

위의 코드를 추가하니 에러가 사라졌다..!

'Spring > Spring' 카테고리의 다른 글

[11] 기본적인 웹 게시물 관리 - 영속/비즈니스 계층의 CRUD 구현 (0)	2019.12.18
[10] 기본적인 웹 게시물 관리 - 스프링 MVC 프로젝트의 기본 구성 (0)	2019.12.18
[08] 스프링 MVC의 Controller 및 여러 예제 (0)	2019.12.17
[07] 스프링 MVC의 기본 구조 및 예제 실습 (0)	2019.12.17
[06] Mybatis와 스프링 연동 (0)	2019.12.16

4. Model 이라는 데이터 전달자

5. Controller의 리턴 타입

6. Controller의 Exception 처리

'Spring > Spring' 카테고리의 다른 글

티스토리툴바