API 예외처리

이동건 (불꽃냥펀치)·2025년 2월 9일
부트캠프 이후스프링부트
0

HTML같은 경우는 오류페이지만 있으면 대부분의 문제를 해결할 수 있다. 그런데 오류페이지는 단순히 화면을 보여주고 끝이지만 API는 각 상황에 맞는 오류 응답 스펙을 정하고 JSON으로 데이터를 내려줘야한다.

 public class WebServerCustomizer implements
 WebServerFactoryCustomizer<ConfigurableWebServerFactory> {
     @Override
     public void customize(ConfigurableWebServerFactory factory) {
         ErrorPage errorPage404 = new ErrorPage(HttpStatus.NOT_FOUND, "/error-
 page/404");
         ErrorPage errorPage500 = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR,
 "/error-page/500");
         ErrorPage errorPageEx = new ErrorPage(RuntimeException.class, "/error-
 page/500");
         factory.addErrorPages(errorPage404, errorPage500, errorPageEx);
     }
}
@Slf4j
 @RestController
 public class ApiExceptionController {
     @GetMapping("/api/members/{id}")
     public MemberDto getMember(@PathVariable("id") String id) {
		if (id.equals("ex")) {
			throw new RuntimeException("잘못된 사용자");
			}
         return new MemberDto(id, "hello " + id);
     }
      @Data
     @AllArgsConstructor
     static class MemberDto {
         private String memberId;
         private String name;
     }
}

단순히 회원을 조회하는 기능을 하나 만들었다. 예외 테스트를 위해 URL에 전달된 ID의 값이 ex이면 예외가 발생하도록했다. 하지만 이 상황에서 ID가 ex로 전달되더라도 미리 만들어둔 오류 HTML이 반환된다.
이것은 기대하는 바가 아니며 우리는 JSON이 반환되기를 기대했다.

API 응답 추가

 @RequestMapping(value = "/error-page/500", produces =MediaType.APPLICATION_JSON_VALUE)
 public ResponseEntity<Map<String, Object>> errorPage500Api(HttpServletRequest
 request, HttpServletResponse response) {
     log.info("API errorPage 500");
     Map<String, Object> result = new HashMap<>();
     Exception ex = (Exception) request.getAttribute(ERROR_EXCEPTION);
     result.put("status", request.getAttribute(ERROR_STATUS_CODE));
     result.put("message", ex.getMessage());
     Integer statusCode = (Integer)
 request.getAttribute(RequestDispatcher.ERROR_STATUS_CODE);
     return new ResponseEntity(result, HttpStatus.valueOf(statusCode));
 }

produces = MediaType.APPLICATION_JSON_VALUE은 클라이언트가 요청하는 HTTP Header의 Accept의 값이 application/json일때 해당 메서드가 호출된다는 것이다. 결국 클라이언트가 받고 싶은 미디어 타입이 json이면 이 컨트롤러의 메서드가 호출된다.

컨트롤러에서 사용한 상수값

 public static final String ERROR_EXCEPTION = "jakarta.servlet.error.exception";
 public static final String ERROR_EXCEPTION_TYPE ="jakarta.servlet.error.exception_type";
 public static final String ERROR_MESSAGE = "jakarta.servlet.error.message";
  public static final String ERROR_REQUEST_URI ="jakarta.servlet.error.request_uri";
 public static final String ERROR_SERVLET_NAME = "jakarta.servlet.error.servlet_name";
 public static final String ERROR_STATUS_CODE ="jakarta.servlet.error.status_code";



API 예외처리 _ 스프링 부트 기본 오류 처리

BasicErrorController

 @RequestMapping(produces = MediaType.TEXT_HTML_VALUE)
 public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) {}
 @RequestMapping
 public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {}

/error 동일한 경로를 처리하는 errorHtml(),error() 두 메서드를 확인 할 수 있다.

  • errorHtml(): produces = MediaType.TEXT_HTML_VALUE로 클라이언트 요청의 Accept 헤더 값이 text/html인 경우에는 errorHtml()을 호출해서 view를 제공
  • error(): 그외 경우에는 호출되고 responseEntity로 HTTP Body에 JSON 데이터를 반환



API 예외처리_ HandlerExceptionResolver 시작

예외가 발생해서 서블릿을 넘어 Was까지 예외가 전달되면 HTTP 상태코드가 500으로 처리된다. 발생하는 예외에 따라서 400,404 등등 다른 상태코드로 처리하고 싶다.

ApiExceptionController

 @GetMapping("/api/members/{id}")
 public MemberDto getMember(@PathVariable("id") String id) {
	if (id.equals("ex")) {
		throw new RuntimeException("잘못된 사용자");
     }
     if (id.equals("bad")) {
		throw new IllegalArgumentException("잘못된 입력 값"); 
     }
     return new MemberDto(id, "hello " + id);
 }

http://localhost:8080/api/members/bad 라고 호출하면 IllegalArgumentException 이 발생하도록 했다.

HandlerExceptionResolver

스프링 MVC는 컨트롤러 밖으로 예외가 던져진 경우 예외를 해결하고, 동작을 새로 정의할 수 있는 방법을 제공한다. 컨트롤러 밖으로 던져진 예외를 해결하고 동작방식을 변경하고 싶은면 HandlerExceptionResolver를 사용하면 된다.

HandlerExceptionResolver - 인터페이스

public interface HandlerExceptionResolver {
   ModelAndView resolveException(
      HttpServletRequest request, HttpServletResponse response,
    Object handler, Exception ex);
}

MyHandlerExceptionResolver

@Slf4j
 public class MyHandlerExceptionResolver implements HandlerExceptionResolver {
	@Override
     public ModelAndView resolveException(HttpServletRequest request,
 HttpServletResponse response, Object handler, Exception ex) {
         try {
             if (ex instanceof IllegalArgumentException) {
                 log.info("IllegalArgumentException resolver to 400");
                 response.sendError(HttpServletResponse.SC_BAD_REQUEST,ex.getMessage());
                 return new ModelAndView();
             }
         } catch (IOException e) {
             log.error("resolver ex", e);
		}
         return null;
     }
}

  • ExceptionResolver가 MocelAndView를 반환하는 이유는 마치 try.catch를 하듯이 Exception을 처리해서 정상 흐름처럼 변경하는 것이 목적이다.

  • 여기서는 IllegalArgumentException이 발새앟면 response.sendError(400)을 호출해서 HTTP 상태코드 400으로 지정하고 빈 ModelAndView를 반환한다.

  • 빈 ModelAndView: new ModelAndView()처럼 빈 ModelAndView를 반환하면 뷰를 렌더링하지 않고 정상 흐름으로 서블릿이 리턴된다.

  • ModelAndView 지정: ModelAndView에 view,Model등의 정ㅈ보를 지정해서 반환하면 뷰를 렌더링한다.

  • null: null을 반환하면 다음 ExceptionResolver를 찾아서 실행한다. 만약 처리할 수 있는 ExceptionResolver가 없으면 예외 처리가 안되고 기존에 발생한 예외를 서블릿 밖으로 던진다.

ExceptionResolver 활용

  • 예외 상태 코드 변환
    • 예외를 response.sendError(xxx) 호출로 변경해서 상태 코드에 따른 오류를 처리하도록 위임
    • 이후 WAS는 서블릿 오류 페이지를 찾아서 내부 호출, 예를 들어서 스프링 부트가 기본으로 설정한 /error가 호출됨
  • 뷰 템플릿 처리
    • ModelAndView에 값을 채워서 예외에 따른 새로운 오류 화면 뷰 렌더링해서 고객에게 제공
  • API 응답처리
    • response.getWriter().println("hello) 처럼 HTTP 응답 바디에 직접 데이터를 넣어주는 것도 가능하다. 여기에 JSON으로 응답하면 API 응답처리를 할 수 있다.



API 예외 처리 - HandlerExceptionResolver 활용

사용자 정의 예외 UserException

public class UserException extends RuntimeException {
     public UserException() {
         super();
	}
     public UserException(String message) {
         super(message);
	}
     public UserException(String message, Throwable cause) {
         super(message, cause);
	}
     public UserException(Throwable cause) {
         super(cause);
	}
    
    protected UserException(String message, Throwable cause, boolean
 enableSuppression, boolean writableStackTrace) {
         super(message, cause, enableSuppression, writableStackTrace);
     }
}

Controller에 오류 추가

 @GetMapping("/api/members/{id}")
     public MemberDto getMember(@PathVariable("id") String id) {
		if (id.equals("ex")) {
			throw new RuntimeException("잘못된 사용자");
         }
         if (id.equals("bad")) {
			throw new IllegalArgumentException("잘못된 입력 값"); }
		if (id.equals("user-ex")) {
			throw new UserException("사용자 오류");
		}
         return new MemberDto(id, "hello " + id);
  }

http://localhost:8080/api/members/user-ex 호출시 UserException 이 발생하도록 해두었다.

UserHandlerExceptionResolver

@Slf4j
 public class UserHandlerExceptionResolver implements HandlerExceptionResolver {
     private final ObjectMapper objectMapper = new ObjectMapper();
	@Override
     public ModelAndView resolveException(HttpServletRequest request,
 HttpServletResponse response, Object handler, Exception ex) {
         try {
             if (ex instanceof UserException) {
                 log.info("UserException resolver to 400");
                 String acceptHeader = request.getHeader("accept");
                 response.setStatus(HttpServletResponse.SC_BAD_REQUEST);
                 if ("application/json".equals(acceptHeader)) {
                     Map<String, Object> errorResult = new HashMap<>();
                     errorResult.put("ex", ex.getClass());
                     errorResult.put("message", ex.getMessage());
                     String result =objectMapper.writeValueAsString(errorResult);
                     response.setContentType("application/json");
                     response.setCharacterEncoding("utf-8");
                     response.getWriter().write(result);
                     return new ModelAndView();
                 } else {
                     //TEXT/HTML
                     return new ModelAndView("error/400");
                 }
             }
         } catch (IOException e) {
             log.error("resolver ex", e);
         }
         return null;
     }
}

HTTP 요청 해더의 ACCEPT 값이 application/json 이면 JSON으로 오류를 내려주고, 그 외 경우에는 error/ 500에 있는 HTML 오류 페이지를 보여준다.

WebConfig에 UserHandlerExceptionResolver 추가

 @Override
 public void extendHandlerExceptionResolvers(List<HandlerExceptionResolver>
 resolvers) {
     resolvers.add(new MyHandlerExceptionResolver());
     resolvers.add(new UserHandlerExceptionResolver());
 }



API 예외처리 _ 스프링이 제공하는 ExceptionResolver

스프링 부트가 기본으로 제공하는 ExceptionResolver

    1. ExceptionHandlerExceptionResolver
    1. ResponseStatusExceptionResolver
    1. DefaultHandlerExceptionResolver

ResponseStatusExceptionResolver

ResponseStatusExceptionResolver는 예외에 따라서 HTTP 상태 코드를 지정해주는 역할을 한다.

다음 두가지 경우를 처리

  • @ResponseStatus가 달린 예외
  • ResponseStatusException예외
@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "잘못된 요청 오류") 
public class BadRequestException extends RuntimeException {
}

  • BadRequestException예외가 컨트롤러 밖으로 넘어사면 ResponseStatusExceptionResolver 예외가 해당 애노테이션을 확인해서 오류 코드를 HttpStatus.BAD_REQUEST(400)으로 변경하고 메시지도 담는다.

  • ResponseStatusExceptionResolver 코드를 확인해보면 결국 response.sendError(statusCode, resolvedReason) 를 호출하는 것을 확인할 수 있다.

  • sendError(400) 를 호출했기 때문에 WAS에서 다시 오류 페이지( /error )를 내부 요청한다.

메시지 기능
reason을 MessageSource에서 찾는 기능도 제공한다. reason="error.bad"

@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "error.bad") 
public class BadRequestException extends RuntimeException {
}

messages.properties

error.bad=잘못된 요청 오류입니다. 메시지 사용

responseStatusException
@ResponseStatus는 개발자가 직접 변경할 수 없는 예외에는 적용할 수 없다. 추가로 애노테이션을 사용하기 때문에 조건에 따라 동적으로 변경하는 것도 어렵다. 이때는 respnseStatusException 예외를 사용하면 된다

 @GetMapping("/api/response-status-ex2")
 public String responseStatusEx2() {
     throw new ResponseStatusException(HttpStatus.NOT_FOUND, "error.bad", new 
     IllegalArgumentException());
}

API 예외 처리 - 스프링이 제공하는 ExceptionResolver2

DefaultHandlerExceptionResolver는 스프링 내부에서 발생하는 스프링 예외를 해결한다.
대표적으로 파라미터 바인딩 시점에 타입이 맞지 않으면 내부에서 TypeMismatchException 이 발생하는데, 이 경 우 예외가 발생했기 때문에 그냥 두면 서블릿 컨테이너까지 오류가 올라가고, 결과적으로 500 오류가 발생한다. 그런데 파라미터 바인딩은 대부분 클라이언트가 HTTP 요청 정보를 잘못 호출해서 발생하는 문제이다. HTTP 에서는 이런 경우 HTTP 상태 코드 400을 사용하도록 되어 있다.
DefaultHandlerExceptionResolver 는 이것을 500 오류가 아니라 HTTP 상태 코드 400 오류로 변경한다. 스프링 내부 오류를 어떻게 처리할지 수 많은 내용이 정의되어 있다.


API 예외 처리 - @ExceptionHandler

 @Data
 @AllArgsConstructor
 public class ErrorResult {
     private String code;
     private String message;
 }
@Slf4j
 @RestController
 public class ApiExceptionV2Controller {
     @ResponseStatus(HttpStatus.BAD_REQUEST)
     @ExceptionHandler(IllegalArgumentException.class)
     public ErrorResult illegalExHandle(IllegalArgumentException e) {
         log.error("[exceptionHandle] ex", e);
         return new ErrorResult("BAD", e.getMessage());
     }
     
     @ExceptionHandler
     public ResponseEntity<ErrorResult> userExHandle(UserException e) {
         log.error("[exceptionHandle] ex", e);
         ErrorResult errorResult = new ErrorResult("USER-EX", e.getMessage());
         return new ResponseEntity<>(errorResult, HttpStatus.BAD_REQUEST);
     }
	
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
	@ExceptionHandler
	public ErrorResult exHandle(Exception e) {
    	log.error("[exceptionHandle] ex", e);
		return new ErrorResult("EX", "내부 오류"); 
    }
    
	@GetMapping("/api2/members/{id}")
	public MemberDto getMember(@PathVariable("id") String id) {
		if (id.equals("ex")) {
			throw new RuntimeException("잘못된 사용자");
   		 }
   		 if (id.equals("bad")) {
			throw new IllegalArgumentException("잘못된 입력 값"); 
        }
		if (id.equals("user-ex")) {
			throw new UserException("사용자 오류");
		}
    return new MemberDto(id, "hello " + id);
	}
    
	@Data
	@AllArgsConstructor
	static class MemberDto {
    	private String memberId;
    	private String name;
	}
}

@ExceptionHandler 예외 처리 방법
@ExceptionHandler 애노테이션을 선언하고, 해당 컨트롤러에서 처리하고 싶은 예외를 지정해주면 된다. 해당 컨
트롤러에서 예외가 발생하면 이 메서드가 호출된다. 참고로 지정한 예외 또는 그 예외의 자식 클래스는 모두 잡을 수 있 다.

@ExceptionHandler(IllegalArgumentException.class)
 public ErrorResult illegalExHandle(IllegalArgumentException e) {
      log.error("[exceptionHandle] ex", e);
     return new ErrorResult("BAD", e.getMessage());
 }







출처: https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-2/dashboard

profile
이동건 (불꽃냥펀치)
자바를 사랑합니다
이전 포스트

예외처리와 오류 페이지

다음 포스트

스프링 타입 컨버터

0개의 댓글

관련 채용 정보