SPRING-101-Spring Web MVC : Exception Handler - JAVA

오류 발생시 브라우저에 오류 메세지 발생하면
브라우저 상에서 오류 페이지가 뜨는데,
별로임... ^^
나만으 어? 딱 그런 오류 페이지도 하나 만들어서 보여주면
사용자도, 나도 좋지 않겠어?

그럼 오류를 처리하고, jsp페이지를 하나 만들어서 오류 발생하면 그 페이지로 이동되는
예외처리 핸들러를 만들어보자


Java ver

 

 

 

 

 

 

 

 

 

 

 

프로젝트 생성

Project Explorer에서 빈공간에 우클릭하면 Dynamic Web Project 만들 수 있다!
여기까진 할 수 있잖아

 

방금 만든 그 프로젝트를 Maven Project로 만들어주자!

혹시 다시 Maven 제거하고 싶다면, 위의 그림처럼 Disabled Maven Nature 해주믄 되니꽈

아! 메이븐 설정하고 프로젝트에 오류뜨면 그냥 alt+F5로 마무리해주십시다

 

Maven 기본설정 해보자!

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <!-- pom모델버전 -->
  <modelVersion>4.0.0</modelVersion>
  <!-- 프로젝트 생성하는 조직의 고유 아이디 like 도메인 이름 -->
  <groupId>Ex01JavaSetting</groupId>
  <!-- Maven 프로젝트 식별하는 아이디 like 프로젝트명 -->
  <artifactId>Ex01JavaSetting</artifactId>
  <!-- 프로젝트 현재 버전 -->
  <version>0.0.1-SNAPSHOT</version>
  <!-- 어떤 형태로 프로젝트를 패키징할 지 결정 -->
  <packaging>war</packaging>
  
  <!-- 소스의 디렉토리 구조, 빌드 산출물 디렉토리 구조, 빌드시 사용할 플러긴 정보 관리 -->
  <build>
  	<!-- sourceDirectory : 자바 소스 코드를 관리하는 디렉토리 -->
  	<sourceDirectory>src/main/java</sourceDirectory>
  
	<!-- Maven제공 기능은 플러긴 기반으로 작동 따라서 설정 필요 -->  
    <plugins>
    
	  <!-- 컴파일 플러그인 설정 -->
      <plugin>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.8.1</version>
        <configuration>
        	<!-- 16>14변경 -->
          <release>14</release>
        </configuration>
      </plugin>
      
      <!-- 배포 패키징 플러긴 설정 -->
      <plugin>
        <artifactId>maven-war-plugin</artifactId>
        <version>3.2.3</version>
        <!-- configuration 추가 -->
        <configuration>
        	<!-- 배포할 위치 directory -->
        	<warSourceDirectory>src</warSourceDirectory>
        </configuration>
      </plugin>
    </plugins>
  </build>
  
  <!-- 라이브러리 버전관리 : properties -->
  <properties>
  	<javax.servlet-version>4.0.1</javax.servlet-version>
  	<javax.servlet.jsp-version>2.3.3</javax.servlet.jsp-version>
  	<javax.servlet.jsp.jstl-version>1.2</javax.servlet.jsp.jstl-version>
  	<org.springframework>5.2.2.RELEASE</org.springframework>
  </properties>
  
  <!-- 라이브러리 셋팅 : dependencies 프로그램과 의존관계인 라이브러리 관리 -->
  <dependencies>
  
  	<!-- servlet-api 라이브러리 적용 위한 설정 -->
	<dependency>
	    <groupId>javax.servlet</groupId>
	    <artifactId>javax.servlet-api</artifactId>
	    <!-- 버전관리는 properties에서 하기 때문에 변수처럼 사용하기 -->
	    <version>${javax.servlet-version}</version>
	    <scope>provided</scope>
	</dependency>
	
  	<!-- javax.servlet.jsp-api 라이브러리 적용 위한 설정 -->
	<dependency>
	    <groupId>javax.servlet.jsp</groupId>
	    <artifactId>javax.servlet.jsp-api</artifactId>
	    <!-- 버전관리는 properties에서 하기 때문에 변수처럼 사용하기 -->
	    <version>${javax.servlet.jsp-version}</version>
	    <scope>provided</scope>
	</dependency>

	<!-- javax.servlet/jstl 라이브러리 적용 위한 설정 -->
	<dependency>
	    <groupId>javax.servlet</groupId>
	    <artifactId>jstl</artifactId>
	    <!-- 버전관리는 properties에서 하기 때문에 변수처럼 사용하기 -->
	    <version>${javax.servlet.jsp.jstl-version}</version>
	</dependency>
	
	<!-- spring-webmvc 라이브러리 적용 위한 설정 -->
	<dependency>
	    <groupId>org.springframework</groupId>
	    <artifactId>spring-webmvc</artifactId>
	    <!-- 버전관리는 properties에서 하기 때문에 변수처럼 사용하기 -->
	    <version>${org.springframework}</version>
	</dependency>
	
    
	<!-- resource 어노테이션 안먹혀서 추가함.. 요상하군... -->
	<dependency>
	    <groupId>javax.annotation</groupId>
	    <artifactId>javax.annotation-api</artifactId>
	    <version>1.3.2</version>
  	</dependency>
	
  </dependencies>
</project>

@Resource가 안먹혀서 dependency 추가함..

 

 

Spring MVC Java 기본설정

일단 Spring MVC를 어떻게 구현할지 구조부터 대충 살펴보면,
전에 JSP MVC 패턴때 BeansConfigClass 만들어서 bean을 정의해주었지
그 역할을 이젠 SpringConfigClass라는 이름으로 변경해 Java버전으로 해볼게!

import javax.servlet.Filter;

import org.springframework.web.filter.CharacterEncodingFilter;
import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;

public class SpringConfigClass extends AbstractAnnotationConfigDispatcherServletInitializer {

	//AbstractAnnotationConfigDispatcherServletInitializer의 메소드 전부 override
	
	//프로젝트에서 사용할 bean정의 클래스 지정
	@Override
	protected Class<?>[] getRootConfigClasses() {
		// TODO Auto-generated method stub
		//return 추가
		return new Class[] {RootAppContext.class};
	}

	//Spring MVC 프로젝트 설정 위한 configuration 클래스 지정
	@Override
	protected Class<?>[] getServletConfigClasses() {
		// TODO Auto-generated method stub
		return new Class[] {ServletAppContext.class};
	}

	//DispatcherServlet에 매핑할 요청 주소 세팅
	//DispatcherServlet : 클라이언트 요청을 맨 처음 받는 위치로 공통작업 후 세부 작업은 담당 컨트롤러로 전달하는 역할
	@Override
	protected String[] getServletMappings() {
		// TODO Auto-generated method stub
		return new String[] {"/"};
	}
	
	//얘는 안따라와서 따로 추가해줌
	//request.setCharacterEncoding("UTF-8") 한 번만 설정하기
	@Override
	protected Filter[] getServletFilters() {
		// TODO Auto-generated method stub
		CharacterEncodingFilter encodingFilter = new CharacterEncodingFilter();
		encodingFilter.setEncoding("UTF-8");
		return new Filter[] {encodingFilter};
	}
	
}

AbstractAnnotationConfigDispatcherServletInitializer를 상속받아서 그 내부 메서드를 override 받았어.
맨 마지막 filter 메서드는 안따라오더라고?
걍 내가 불렀어 filter적고 ctrl+space하믄 뜰겨

보면 먼저 bean 뭐 쓸지 getRoot~()메서드에서 정의해주고,
getServletConfigClasses()메서드에서 Configuration을 지정해준다
getServletMapping()메서드는 말그대로 매핑 역할을 하는데, 위에서 적었다시피 클라이언트 요청 받으면
그 요청에 해당하는 컨트롤러 쪽으로 보내주는 것이 바로 매핑!
맨 마지막 filter 메서드는 우리 맨~날 스크립틀릿으로 또는 컨트롤러에서 request.set~("UTF-8") 적어줬잖아?
그걸 저기다가 딱 한 번, 두 번도 아니고 한 번만 적어주면 페이지마다 적은 효과를 주는거지

 

 

이제 getRootConfigClass 메서드에서 정의될 bean 클래스 RootAppContext를 한 번 만들어보자

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.context.annotation.SessionScope;

import kr.co.goodee39.vo.DataVO1;
import kr.co.goodee39.vo.DataVO2;

//Spring MVC 프로젝트에서 사용할 bean 정의하는 클래스
@Configuration
public class RootAppContext {

}

간단하지? @Configuration 이라고 어노테이션 달아준 클래스가 전부야
물론 필요하게 되면 클래스 내부에 필드니, 생성자니, 메서드니 들어가겠지만 지금은 틀만 잡고 있는거니까 요대로 둘게

 

 

 

이번엔 getServletConfigClass 메서드에서 Spring MVC 설정을 해줄 Configuration 클래스를 정의해보자

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.ViewResolverRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

//Spring MVC 프로젝트 설정 클래스
@Configuration

//@Controller 셋팅된 크래스를 Controller로 등록
@EnableWebMvc

//스캔할 패키지 저장
@ComponentScan("kr.co.goodee39.controller")
public class ServletAppContext implements WebMvcConfigurer {
	
	//Controller의 메서드가 반환하는 jsp의 이름 앞뒤에 경로(/WEB-INF/views), 확장자(.jsp) 추가하는 설정
	//configureViewResolvers
	@Override
	public void configureViewResolvers(ViewResolverRegistry registry) {
		// TODO Auto-generated method stub
		WebMvcConfigurer.super.configureViewResolvers(registry);
		registry.jsp("/WEB-INF/views/", ".jsp");
	}
	
	//정적 파일(img, video, audio, etc) 경로 매핑
	//addResourceHandlers
	@Override
	public void addResourceHandlers(ResourceHandlerRegistry registry) {
		// TODO Auto-generated method stub
		WebMvcConfigurer.super.addResourceHandlers(registry);
		registry.addResourceHandler("/**").addResourceLocations("/resources/");
	}
}

좀 낯설긴한데, servlet이라는 단어는 주구장창 봐왔잖아?
한 페이지 이동 할 때마다 servlet 추가추가추가 하던 그런 날이 끝났다 이거임..
여기서 한 큐에 설정이 가능해

일단 이 클래스가 Configuration할 클래스임을 어노테이션으로 명명하고,
@EnableWebMvc를 통해 이따가 @Controller 역할을 할 클래스를 진짜 controller로서 역할 할 수 있게 만들어줘
@ComponentScan으로 경로 설정해주면 그 내부 클래스 중 @Component설정된 클래스를 찾게될건데,
사실 이번에는 @Component로 등록된 클래스는 없어ㅎㅎㅎ

그리고나서 WebMvcConfigurer 상속받아준 후에 RootConfigClass와 마찬가지로 내부 메서드를 모두 상속 받아줘

configViewResolvers(ViewResolverResistry registry)라는 메서드는 이따가 @Controller에서 어떤 페이지로 갈 수 있게끔
jsp의 이름을 반환할텐데, 그 앞전 경로를 설정해주고, jsp파일임을 명시하는 확장자 설정이 가능해

addResourceHandelers(ResourceHandlerRegistry registry) 메서드는 정적인 파일, 예를들면 이미지, 영상, 음성 등등
어딘가에 딱 넣어두고, 불러와지기만 하는 변함없는 파일이잖아?
그 경로를 설정할 수 있는데, 여기서 보면 느끼겠지만 경로가 하나뿐이잖아..
하나의 경로밖에 못써..
뭐 하나의 경로 안에 폴더를 또 만들면 쓸 수 있겠지?
아 여기서 사실 addResourceHandler("/**")는 아직 어떤 역할인건지 잘 모르겠어.. 찾아보자 더 ㅎㅎㅎㅎ

 

자 여기까지가 기초다 기초...
사실 아직 100% 이해된건 아니야.
이렇다니까 일단 받아들인거고, 계속 따라쳐보고, 구글링 해보면서 내것으로 만들고 또 발전도 시켜봐야지!

 

 

Controller 클래스 만들기

아까 위에서 Spring MVC를 설정하게 해주는 클래스 하나가 있었잖아?
그 클래스 내부에 @EnableWebMvc라는 어노테이션이 있었는데
이건 @Controller로 지정된 클래스가 정말 controller로서의 역할을 할 수 있게끔 해주는 어노테이션이였어.
그럼 이제 @Controller를 달고있을 클래스를 만들어보자
따지고보면 JSP에서 Servlet역할의 일부를 담당하는 것이라고도 생각할 수 있지 않나? 싶네

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@Controller
public class HomeController {
	
	//ServletAppContext에서 설정한 configureViewResolvers()메소드 통해서 
	///WEB-INF/views/index.jsp로 변환됨
	@RequestMapping(value="/", method=RequestMethod.GET)
	public String home() {
		return "index";
		
	}
}

별건 없어
그냥 무슨 역할하는지 보자고!

위에서 계속 언급했듯 이 클래스는 controller의 역할을 할 클래스이므로 어노테이션으로 이름표 달아주고,
메소드를 하나 만드는데, 이 메소드는 무어냐
첫 페이지 역할, 그러니까 home 역할을 할 페이지를 설정하는 메서드야
그래서 이름도 home이야 후후
value는 우리 JSP MVC 패턴에서 servlet만들면 맨 상단에 

@WebServlet("/블라블라")하는 공간이 있어 (ㄴㅇㄹ는 무시혀~ 걍 쓴거임)
저 블라블라는 보통 servlet이름이 들어가는데, 파일을 실행시켜서 이동한다거나 하면
url에 저기 작성된 이름이 뒤에 뜨더라고?
근데 이걸 /만 남기고 지워주면?!
그냥 RequestDispatcher rdp = request.getRequestDispatcher("");에서 설정한 jsp파일이 home으로 떠부러
servlet이라는 위치가 jsp파일 앞전에 안붙기 때문이지!
그거랑 같은 이치야 value = "/"는

아무턴, return "문자열";은 이따가 만들 home이 될 jsp파일 이름을 넣어준거야
이 controller가 실행되면 index라는 홈이름이 전달되겠지 어디로?
아까 위에서 @EnableWebMvc로 지금 이 클래스에 Controller의 자격을 준 servletAppContext 클래스로!

그리고는 configureViewResolvers(ViewResolverRegistry registry) 메소드를 만나 
/WEB-INF/views/index.jsp로 변신!
그리고 index.jsp에 이미지가 있다면 addResourceHandlers(ResourceHandlerRegistry registry) 메서드 통해서
src 앞에 /resources/가 콱 붙어주겠지~ 

 

 

 

 

 

 

 

HomeController에서 설정한 첫 페이지가 되어줄 index.jsp를 만들자

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Insert title here</title>
</head>
<body>
<!-- 예외처리 -->
	<h1>SPRING MVC 예외처리</h1>
	<br />
	<a href="test1">Test1</a><br />
	<a href="test2">Test2</a><br />
</body>
</html>

이동시에 일부러 에러 발생할 메소드를 정의해두었음!
따로 예외처리하지 않은 상황에서는 404에러 화면같이 하얗고, 하늘색이고~ 뭐 블라블라 적힌 내용이 나오겠지?

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

error페이지 만들기

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Insert title here</title>
</head>
<body>
<!-- 예외처리 -->
	<h1>SPRING MVC 예외처리</h1>
	<br />
	<h1>ArrayIndexOutOfBoundsExceptiond 발생! 주어진 배열의 갯수를 초과합니다!</h1>

</body>
</html>

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Insert title here</title>
</head>
<body>
<!-- 예외처리 -->
	<h1>SPRING MVC 예외처리</h1>
	<br />
	<h1>NullPointerException 발생! </h1>

</body>
</html>

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Insert title here</title>
</head>
<body>
<!-- 예외처리 -->
	<h1>SPRING MVC 예외처리</h1>
	<br />
	<h1>rException 발생! </h1>

</body>
</html>

에러는 총 3가지 해볼꾸
하나는 ArrayIndexOutOfBoundsExceptiond, 또 하나는 NullPointerException, 마지막으로 Exception

 

 

 

 

 

 

 

 

 

 

 

에러 발생하지 않는다면 정상적으로 이동될 페이지도 구색 맞추기 위해 만들기

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Insert title here</title>
</head>
<body>
<!-- 예외처리 -->
	<h1>SPRING MVC 예외처리</h1>
	<br />
	<h1>Test1</h1>
	<h3>arr1 : ${arr1}</h3>
</body>
</html>

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Insert title here</title>
</head>
<body>
<!-- 예외처리 -->
	<h1>SPRING MVC 예외처리</h1>
	<br />
	<h1>Test2</h1>
	<h3>list : ${list}</h3>
</body>
</html>

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Controller 만들기

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class TestController {

	@GetMapping("/test1")
	public String test1(Model model) {
		
		int[] arr1 = {10, 20, 30};
		//정상수행됨
		//model.addAttribute("arr1", arr1[0]);
		
		//일부러 오류 발생시키기
		model.addAttribute("arr1", arr1[10]);
		//ArrayIndexOutOfBoundsException 예외 등장~
		
		return "test1";
	}
	
	//ArrayIndexOutOfBoundsException에러 발생시 이동할 페이지 설정
	@ExceptionHandler(ArrayIndexOutOfBoundsException.class)
	public String exceptionArr() {
		return "error1";
	}
}

이 컨트롤러는 test1에 대한 컨트롤러이고, 지역에러처리로 한 번 만들어 보았다!
일단 arr1는 0, 1, 2만 있는데, 10이라는 인덱스를 추가해서 ArrayIndexOutOfBoundException을 유도했으
에러 발생하면 상단에서 만든 error1페이지로 이동시킬꺼여

 

 

 

 

import java.util.ArrayList;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class SecondController {

	@GetMapping("/test2")
	public String test2() {
			ArrayList<String> list = null;
			list.add("문자열");
		
		
		return "test2";
	}
	
	//현재 controller내에서는 ExceptionHandler를 만들지 않았다.
	//GlobalExceptionHandler에서 정의해 사용함
}

이 컨트롤러는 test2에 대한 메소드만 있어
즉, 에러처리가 없는거지
얘는 GlobalExceptionHandler를 생성해서 처리해볼라구!

 

 

 

 

 

 

GlobalExceptionHandler만들기

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

//전역으로 예외처리 핸들러를 만들어서 설정하면 controller에 직접 선언하지 않아도 사용가능하다
//RuntimeException을 상속받아서 @ExceptionHandler 설정하면 가능함
//클래스명의 밑줄은 ID를 default값으로 주어야 하는데 주지 않아서 라고함
//주지 않아도 구동은 잘 됨
@ControllerAdvice
public class GlobalExceptionHandler extends RuntimeException {

	//오직 NullPointerException에 대한 예외처리
	@ExceptionHandler(NullPointerException.class)
	public String handleException() {
		
		return "error2";
	}
	
	//모~든 에러에 대해 error3으로 보내는 예외처리
	@ExceptionHandler(Exception.class)
	public String handlerGlobalException() {
		return "error3";
	}
	
	//국소 예외처리과 전역 예외처리 둘 다 설정하면 뭐가 나올까?
	//Expception보다 특정Exception으로 정의한 것이 우선하기 때문에
	//특정Exception 예외처리 정의되었다면 그 예외처리를 따름
	//없다면 그 때 Exception 예외처리를 따름
}

전역으로 에러를 처리하기 위해 클래스 하나 파고, RuntimeException을 상속받아줘
그리고 이 클래스에 @ControllerAdvice 어노테이션을 달아주면 환상의 전역 Exception Handler 뚝딱

이제 그 아래 @ExceptionHandler 어노테이션과 (에러타입.class)로 정의해주면 해당 에러에 대한 처리를 담당하는 핸들러가 전역으로 적용되는거여
하나는 handlerException은 NullPointerException만을 담당하고,
handlerGlobalException은 전~~체 Exception을 담당할거야

근데 잠깐, 특정 예외 담당 핸들러와 전~체 에러 다 처리해주는 핸들러가 둘 다 존재하면
특정 예외 발생했을 때 어떤 핸들러가 작동할까?

미리 그냥 답을 얘기헌다
주석에도 있잖아

특정 예외처리 핸들러가 작동함!
특정되는 예외처리가 없을 때만 전~체 예외처리 담당 핸들러가 작동함!

 

 

 

 

 

 

 

 

 

home으로 만들었던 index페이지에서 진짜 이동 되는지 한 번 해보자!

Run on Server를 클릭해주쟈

 

결과