์˜ˆ์™ธ ๋ฐœ์ƒ ์‹œ์—๋„ JSON ์‘๋‹ต ๋ณด๋‚ด๊ธฐ

ResponseEntity๋ฅผ ์‚ฌ์šฉํ•ด์„œ ์‘๋‹ต์„ ๋ณด๋‚ด๋ฉด ๋œ๋‹ค.

public ResponseEntity<String> errorPage500Api() {
	String result = "error";
	return new ResponseEntity(result, HttpStatus.BAD_REQUEST.value());
}

ResponseEntity๋ฅผ ์‚ฌ์šฉํ•ด์„œ ์‘๋‹ตํ•˜๊ธฐ ๋•Œ๋ฌธ์„ธ ๋ฉ”์‹œ์ง€ ์ปจ๋ฒ„ํ„ฐ๊ฐ€ ๋™์ž‘ํ•˜๋ฉด์„œ ํด๋ผ์ด์–ธํŠธ์— JSON์ด ๋ฐ˜ํ™˜๋œ๋‹ค.


์Šคํ”„๋ง๋ถ€ํŠธ ์˜ˆ์™ธ ์ฒ˜๋ฆฌ

BasicErrorController

BasicErrorController์€ ์Šคํ”„๋ง๋ถ€ํŠธ์—์„œ ๊ธฐ๋ณธ์œผ๋กœ ์˜ค๋ฅ˜๋ฅผ ์ฒ˜๋ฆฌํ•ด์ฃผ๋Š” ์ปจํŠธ๋กค๋Ÿฌ์ด๋‹ค. ๋”ฐ๋กœ ๋“ฑ๋กํ•œ ๊ฒƒ์ด ์—†๋‹ค๋ฉด ์Šคํ”„๋ง๋ถ€ํŠธ๋Š” ์˜ˆ์™ธ๊ฐ€ ์ปจํŠธ๋กค๋Ÿฌ ๋ฐ–์œผ๋กœ ์˜ˆ์™ธ๊ฐ€ ๋˜์ ธ์ง„ ๊ฒฝ์šฐ /error๋ฅผ ํ˜ธ์ถœํ•œ๋‹ค. ๊ทธ๋ฆฌ๊ณ  /error๋Š” BasicErrorController๋กœ ๋งคํ•‘๋˜์–ด ์•„๋ž˜ ๋ฉ”์„œ๋“œ๋ฅผ ํ˜ธ์ถœํ•œ๋‹ค.

@RequestMapping(produces = MediaType.TEXT_HTML_VALUE)
public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) {}
 
@RequestMapping
public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {}
  • errorHtml : produces=MediaType.TEXT_HTML_VALUE ์œผ๋กœ ๋งคํ•‘๋˜์–ด, ํด๋ผ์ด์–ธํŠธ ์š”์ฒญ์˜ Accept ํ—ค๋” ๊ฐ’์ด text/html์ธ ๊ฒฝ์šฐ ํ˜ธ์ถœํ•˜์—ฌ ์—๋Ÿฌ view๋ฅผ ์ œ๊ณตํ•œ๋‹ค.
  • error : ๊ทธ ์™ธ์˜ ๊ฒฝ์šฐ ํ˜ธ์ถœ๋˜๋ฉฐ ResponseEntity๋กœ HTTP Body์— JSON ๋ฐ์ดํ„ฐ๋ฅผ ๋ฐ˜ํ™˜ํ•œ๋‹ค.

error ๋ฐœ์ƒ ์‹œ ์Šคํ”„๋ง๋ถ€ํŠธ๊ฐ€ ResponeEntity body์— ๋„ฃ์–ด์ฃผ๋Š” ์ •๋ณด๋Š” ๋‹ค์Œ๊ณผ ๊ฐ™๋‹ค

  • timestamp : ๋ฐœ์ƒ ์‹œ๊ฐ
  • path : ํด๋ผ์ด์–ธํŠธ ์š”์ฒญ ๊ฒฝ๋กœ
  • status : ์—๋Ÿฌ ์ƒํƒœ
  • message : ์—๋Ÿฌ ๋ฉ”์„ธ์ง€
  • error : ์—๋Ÿฌ ์ฝ”๋“œ
  • exception : ๋ฐœ์ƒํ•œ ์˜ˆ์™ธ
  • errors : ๋ฐœ์ƒํ•œ ์—๋Ÿฌ
  • trace : ์˜ˆ์™ธ trace

application.properties์—์„œ ๋‹ค์Œ๊ณผ ๊ฐ™์ด ์‘๋‹ต์— ์ •๋ณด๋ฅผ ๋‹ด์„์ง€ ๋ง์ง€ ์„ ํƒํ•  ์ˆ˜ ์žˆ๋‹ค.

  • server.error.include-exception
  • server.error.include-message
  • server.error.include-stacktrace
  • server.error.include-binding-errors

BasicErrorController์€ HTML ์—๋Ÿฌ ํŽ˜์ด์ง€์ง€๋ฅผ ์ œ๊ณตํ•  ๋•Œ๋Š” ๋งค์šฐ ํŽธ๋ฆฌํ•˜๋‹ค. ํ•˜์ง€๋งŒ API ์˜ค๋ฅ˜๋ฅผ ๋‚ด๋ณด๋‚ผ ๋•Œ๋Š” ์ปจํŠธ๋กค๋Ÿฌ๋งˆ๋‹ค ๋‹ค๋ฅธ ์˜ค๋ฅ˜ ์ฒ˜๋ฆฌ ๋ฐฉ๋ฒ•์— ๋Œ€์‘ํ•˜๊ธฐ๊ฐ€ ์–ด๋ ต๋‹ค. ๋”ฐ๋ผ์„œ API ์˜ค๋ฅ˜๋ฅผ ์ฒ˜๋ฆฌํ•  ๋•Œ๋Š” @ExceptionHandler๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ๊ฒƒ์ด ์ข‹๋‹ค.


HandlerExceptionResolver

์Šคํ”„๋ง MVC๋Š” ์ปจํŠธ๋กค๋Ÿฌ ๋ฐ–์œผ๋กœ ์˜ˆ์™ธ๊ฐ€ ๋˜์ ธ์ง„ ๊ฒฝ์šฐ, ์ด ์˜ˆ์™ธ๋ฅผ ์žก๊ณ  ์ฒ˜๋ฆฌํ•˜๋Š” HandlerExceptionResolver๋ฅผ ์ œ๊ณตํ•ด์ค€๋‹ค.

image-20221103143127595

์ด๋•Œ HandlerExceptionResolver๋Š” ์˜ˆ์™ธ๋ฅผ ํ•ด๊ฒฐํ•ด๋„ postHandle()์€ ํ˜ธ์ถœ๋˜์ง€ ์•Š๋Š”๋‹ค.

HandlerExceptionResolver ์ธํ„ฐํŽ˜์ด์Šค

public interface HandlerExceptionResolver {
	ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response,
		Object handler, Exception ex);
}
  • resolveException์ด ModelAndView๋ฅผ ๋ฐ˜ํ™˜ํ•˜๋Š” ์ด์œ ๋Š” Exception์„ ์ฒ˜๋ฆฌํ•ด์„œ ์ •์ƒ ํ๋ฆ„์ฒ˜๋Ÿผ ๋ณ€๊ฒฝํ•˜๋Š” ๊ฒƒ์ด ๋ชฉ์ ์ด๊ธฐ ๋•Œ๋ฌธ์ด๋‹ค.

HandlerExceptionResolver ๊ตฌํ˜„

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

resolveException ๋ฐ˜ํ™˜ ๊ฐ’์— ๋”ฐ๋ฅธ ๋™์ž‘๋ฐฉ์‹

  • ๋นˆ ModelAndVIew : new ModelAndView()๋ฅผ ๋ฐ˜ํ™˜ํ•˜๋Š” ๊ฒฝ์šฐ. ๋ทฐ๋ฅผ ๋ Œ๋”๋งํ•˜์ง€ ์•Š๊ณ , ์ •์ƒ ํ๋ฆ„์œผ๋กœ ์„œ๋ธ”๋ฆฟ์ด ๋ฆฌํ„ด๋œ๋‹ค. ์ฆ‰, API ์˜ค๋ฅ˜ ์ฒ˜๋ฆฌ๋ฅผ ํ•  ๋•Œ ์‚ฌ์šฉํ•œ๋‹ค.
  • ModelAndVIew ์ง€์ • : ModelAndVIew์— View, Model ๋“ฑ์˜ ์ •๋ณด๋ฅผ ์ง€์ •ํ•ด์„œ ๋ฐ˜ํ™˜ํ•˜๋ฉด ๋ทฐ๋ฅผ ๋ Œ๋”๋งํ•œ๋‹ค.
  • null : ๋‹ค์Œ ExceptionResolver๋ฅผ ์ฐพ์•„์„œ ์‹คํ–‰ํ•œ๋‹ค. ๋‹ค์Œ์ด ์—†์œผ๋ฉด ์˜ˆ์™ธ์ฒ˜๋ฆฌ๊ฐ€ ์•ˆ๋˜๊ณ  ๊ธฐ์กด์— ๋ฐœ์ƒํ•œ ์˜ˆ์™ธ๋ฅผ ์„œ๋ธ”๋ฆฟ ๋ฐ–์œผ๋กœ ๋˜์ง„๋‹ค.

ExceptionResolver ํ™œ์šฉ

  • ์˜ˆ์™ธ ์ƒํƒœ ์ฝ”๋“œ ๋ณ€ํ™˜
    • ์˜ˆ์™ธ๋ฅผ response.sendError() ํ˜ธ์ถœ๋กœ ๋ณ€๊ฒฝํ•ด์„œ ์„œ๋ธ”๋ฆฟ์—์„œ ์ƒํƒœ์ฝ”๋“œ์— ๋”ฐ๋ฅธ ์˜ค๋ฅ˜๋ฅผ ์ฒ˜๋ฆฌํ•˜๋„๋ก ์œ„์ž„
    • ์ดํ›„ WAS๋Š” ์„œ๋ธ”๋ฆฟ ์˜ค๋ฅ˜ ํŽ˜์ด์ง€๋ฅผ ์ฐพ์•„์„œ ๋‚ด๋ถ€ ํ˜ธ์ถœ.
  • ๋ทฐ ํ…œํ”Œ๋ฆฟ ์ฒ˜๋ฆฌ
    • ModelAndView์— ๊ฐ’์„ ์ฑ„์›Œ์„œ ์˜ˆ์™ธ์— ๋”ฐ๋ฅธ ์ƒˆ๋กœ์šด ์˜ค๋ฅ˜ํ™”๋ฉด ๋ทฐ ๋ Œ๋”๋งํ•ด์„œ ๊ณ ๊ฐ์—๊ฒŒ ์ œ๊ณต
  • API ์‘๋‹ต์ฒ˜๋ฆฌ
    • response.getWriter().println() ์ฒ˜๋Ÿผ HTTP์‘๋‹ต ๋ฐ”๋””์— ์ง์ ‘ ๋ฐ์ดํ„ฐ๋ฅผ ๋„ฃ์–ด์ฃผ๋Š” ๊ฒƒ๋„ ๊ฐ€๋Šฅ. ์—ฌ๊ธฐ์— JSON์œผ๋กœ ์‘๋‹ตํ•˜๋ฉด API ์‘๋‹ต ์ฒ˜๋ฆฌ๋ฅผ ํ•  ์ˆ˜ ์žˆ๋‹ค.

ExceptionResolver ๋“ฑ๋ก

  • WebMvcConfigurer์˜ extendHandlerExceptionResolvers๋ฅผ ํ†ตํ•ด ๋‹ค์Œ๊ณผ ๊ฐ™์ด ๋“ฑ๋กํ•˜๋ฉด ๋œ๋‹ค.
@Override
public void extendHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
	resolvers.add(new MyHandlerExceptionResolver());
}
  • configureHandlerExceptionResolvers ๋กœ๋„ ๋“ฑ๋ก์ด ๋˜์ง€๋งŒ, ์Šคํ”„๋ง์ด ๊ธฐ๋ณธ์œผ๋กœ ๋“ฑ๋กํ•˜๋Š” ExceptionResolver๊ฐ€ ์ œ๊ฑฐ๋˜๋ฏ€๋กœ ์ฃผ์˜ํ•œ๋‹ค. extendHandlerExceptionResolvers๋Š” ํ™•์žฅ.

์Šคํ”„๋ง์ด ์ œ๊ณตํ•˜๋Š” ExceptionResolver

์Šคํ”„๋ง ๋ถ€ํŠธ๊ฐ€ ๊ธฐ๋ณธ์œผ๋กœ ์ œ๊ณตํ•˜๋Š” ExceptionResolver์™€ ์šฐ์„ ์ˆœ์œ„๋Š” ๋‹ค์Œ๊ณผ ๊ฐ™๋‹ค.(HandlerExceptionResolverComposite์— ๋‹ค์Œ๊ณผ ๊ฐ™์ด ๋“ฑ๋ก)

  1. ExceptionHandlerExceptionResolver
    • @ExceptionHandler๋ฅผ ์ฒ˜๋ฆฌํ•œ๋‹ค.
  2. ResponseStatusExceptionResolver
    • HTTP ์ƒํƒœ ์ฝ”๋“œ๋ฅผ ์ง€์ •ํ•ด์ค€๋‹ค.
  3. DefaultHandlerExceptionResolver
    • ์Šคํ”„๋ง ๋‚ด๋ถ€ ๊ธฐ๋ณธ ์˜ˆ์™ธ๋ฅผ ์ฒ˜๋ฆฌํ•œ๋‹ค.

ExceptionHandlerExceptionResolver

@ExceptionHandler ์• ๋…ธํ…Œ์ด์…˜์„ ์‚ฌ์šฉํ•œ ์˜ˆ์™ธ์ฒ˜๋ฆฌ ๋ฐฉ๋ฒ•.

์ปจํŠธ๋กค๋Ÿฌ ์•ˆ์—์„œ @ExceptionHandler ์™€ ์ฒ˜๋ฆฌํ•˜๊ณ  ์‹ถ์€ ์˜ˆ์™ธ๋ฅผ ์„ ์–ธํ•ด์ฃผ๋ฉด ๋œ๋‹ค.

@RestController
public class ApiExceptionV2Controller
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(IllegalArgumentException.class)
    public ErrorResult illegalExHandle(IllegalArgumentException e) {
        return new ErrorResult("BAD", e.getMessage());	//  @ResponseBody ์ ์šฉ๋จ
    }
 
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ExceptionHandler
    public ResponseEntity<ErrorResult> exHandle(Exception e) {
      ErrorResult errorResult = new ErrorResult("EX", "๋‚ด๋ถ€ ์˜ค๋ฅ˜");
      return new ResponseEntity<>(errorResult, HttpStatus.BAD_REQUEST);
    }
  	...
}
 

์˜ˆ์™ธ๊ฐ€ ๋ฐœ์ƒํ•˜๋ฉด ์ปจํŠธ๋กค๋Ÿฌ ์•ˆ์˜ @ExceptionHandler ์• ๋…ธํ…Œ์ด์…˜์ด ๋ถ™์€ ๋ฉ”์„œ๋“œ๋ฅผ ํ™•์ธํ•˜๊ณ  ์˜ˆ์™ธ๋ฅผ ์ฒ˜๋ฆฌํ•œ๋‹ค. ์ง€์ •ํ•œ ์˜ˆ์™ธ์™€ ๊ทธ ์˜ˆ์™ธ์˜ ์ž์‹ ํด๋ž˜์Šค๋Š” ๋ชจ๋‘ ์žก์„ ์ˆ˜ ์žˆ๋‹ค.

๋ถ€๋ชจ์˜ ์ž์‹ ์˜ˆ์™ธ๊ฐ€ ๋ชจ๋‘ ๋“ฑ๋ก๋˜์–ด์žˆ์„ ๋•Œ๋Š”, ์ž์‹ ์˜ˆ์™ธ ์ฒ˜๋ฆฌ๊ฐ€ ๋จผ์ € ํ˜ธ์ถœ๋œ๋‹ค.

๋‹ค์Œ๊ณผ ๊ฐ™์ด ๋‹ค์–‘ํ•œ ์˜ˆ์™ธ๋ฅผ ํ•œ๋ฒˆ์— ๋“ฑ๋กํ•  ์ˆ˜๋„ ์žˆ๋‹ค.

@ExceptionHandler({AException.class, BException.class})

๋‹ค์Œ๊ณผ ๊ฐ™์ด ์ƒ๋žตํ•  ๊ฒฝ์šฐ์—๋Š” ๋ฉ”์„œ๋“œ ํŒŒ๋ผ๋ฏธํ„ฐ์˜ ์˜ˆ์™ธ๋กœ ์ง€์ •๋œ๋‹ค.

@ExceptionHandler
public ResponseEntity<ErrorResult> userExHandle(UserException e) {}

ResponseStatusExceptionResolver

์˜ˆ์™ธ์— ๋”ฐ๋ผ์„œ HTTP ์ƒํƒœ ์ฝ”๋“œ๋ฅผ ์ง€์ •ํ•ด์ฃผ๋Š” ์—ญํ• ์„ ํ•œ๋‹ค. ๋‹ค์Œ ๋‘ ๊ฐ€์ง€ ๊ฒฝ์šฐ๋ฅผ ์ฒ˜๋ฆฌํ•œ๋‹ค.

  • @ResponseStatus๊ฐ€ ๋‹ฌ๋ ค์žˆ๋Š” ์˜ˆ์™ธ
  • ResponseStatusException ์˜ˆ์™ธ

@ResponseStatus๊ฐ€ ๋‹ฌ๋ ค์žˆ๋Š” ์˜ˆ์™ธ

๋‹ค์Œ๊ณผ ๊ฐ™์ด ์˜ˆ์™ธ์— @ResponseStatus ์• ๋…ธํ…Œ์ด์…˜์„ ์ ์šฉํ•˜๋ฉด HTTP ์ƒํƒœ์ฝ”๋“œ๋ฅผ ๋ณ€๊ฒฝํ•ด์ค€๋‹ค.

@ResponseStatus(code = HttpStatus.NOT_FOUND, reason = "์ฐพ์„ ์ˆ˜ ์—†์Œ")
public class NotFoundException extends RuntimeException {
}

NotFoundException ์ปค์Šคํ…€ ์˜ˆ์™ธ๊ฐ€ ์ปจํŠธ๋กค๋Ÿฌ ๋ฐ–์œผ๋กœ ๋„˜์–ด๊ฐ€๋ฉด ResponseStatusExceptionResolver๊ฐ€ ํ•ด๋‹น ์• ๋…ธํ…Œ์ด์…˜์„ ํ™•์ธํ•ด์„œ ์˜ค๋ฅ˜ ์ฝ”๋“œ๋ฅผ 404๋กœ ๋ณ€๊ฒฝํ•˜๊ณ  ๋ฉ”์‹œ์ง€๋ฅผ ๋‹ด๋Š”๋‹ค.

reason์—๋Š” MessageSource๋ฅผ ์ฐพ๋Š” ๊ธฐ๋Šฅ๋„ ์ œ๊ณตํ•œ๋‹ค.

@ResponseStatus(code = HttpStatus.NOT_FOUND, reason = "error.notfound")
# messages.properties
error.notfound=์ฐพ์„ ์ˆ˜ ์—†์Šต๋‹ˆ๋‹ค.

ResponseStatusException

@ResponseStatus๋Š” ๊ฐœ๋ฐœ์ž๊ฐ€ ์ง์ ‘ ๋ณ€๊ฒฝํ•  ์ˆ˜ ์—†๋Š” ์˜ˆ์™ธ์—๋Š” ์ ์šฉํ•  ์ˆ˜ ์—†๋‹ค. ์ด๋•Œ๋Š” ResponseStatusException๋ฅผ ์‚ฌ์šฉํ•˜๋ฉด ๋œ๋‹ค.`

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

DefaultHandlerExceptionResolver

์Šคํ”„๋ง ๋‚ด๋ถ€์—์„œ ๋ฐœ์ƒํ•˜๋Š” ์Šคํ”„๋ง ์˜ˆ์™ธ๋ฅผ ํ•ด๊ฒฐํ•œ๋‹ค.

  • ex) ํŒŒ๋ผ๋ฏธํ„ฐ ๋ฐ”์ธ๋”ฉ ์‹คํŒจ์‹œ ๋ฐœ์ƒํ•˜๋Š” TypeMismatchException ์˜ˆ์™ธ๋ฅผ ์ฒ˜๋ฆฌํ•˜์—ฌ 400์œผ๋กœ ์‘๋‹ต

@ControllerAdvice

@ExceptionHandler๋ฅผ ์ปจํŠธ๋กค๋Ÿฌ ์•ˆ์—์„œ ์‚ฌ์šฉํ•˜์—ฌ ์˜ˆ์™ธ๋ฅผ ์žก์„ ์ˆ˜ ์žˆ์ง€๋งŒ, ์ปจํŠธ๋กค๋Ÿฌ ๋‚ด์˜ ์ •์ƒ ์ฝ”๋“œ์™€ ์˜ˆ์™ธ ์ฒ˜๋ฆฌ ์ฝ”๋“œ๊ฐ€ ์„ž์—ฌ์žˆ๋‹ค. ์ด๋ฅผ ๋ถ„๋ฆฌํ•˜๊ธฐ ์œ„ํ•ด์„  @ControllerAdvice ๋˜๋Š” @RestControllerAdvice๋ฅผ ์‚ฌ์šฉํ•˜๋ฉด ๋‘˜์„ ๋ถ„๋ฆฌํ•  ์ˆ˜ ์žˆ๋‹ค.

@RestControllerAdvice
public class ExControllerAdvice {
      @ResponseStatus(HttpStatus.BAD_REQUEST)
      @ExceptionHandler(IllegalArgumentException.class)
      public ErrorResult illegalExHandle(IllegalArgumentException e) {
          return new ErrorResult("BAD", e.getMessage());
      }
      ...
}
 

@ControllerAdvice๋Š” ๋Œ€์ƒ์œผ๋กœ ์ง€์ •ํ•œ ์—ฌ๋Ÿฌ ์ปจํŠธ๋กค๋Ÿฌ์— @ExceptionHandler, @InitBinder ๊ธฐ๋Šฅ์„ ๋ถ€์—ฌํ•ด์ฃผ๋Š” ์—ญํ• ์„ ํ•œ๋‹ค. ๋Œ€์ƒ์„ ์ง€์ •ํ•˜์ง€ ์•Š์œผ๋ฉด ๋ชจ๋“  ์ปจํŠธ๋กค๋Ÿฌ์— ์ ์šฉํ•œ๋‹ค.

@ControllerAdvice(annotations = RestController.class)
public class ExampleAdvice1 {}
 
 
// Target all Controllers within specific packages
@ControllerAdvice("org.example.controllers")
public class ExampleAdvice2 {}
 
// Target all Controllers assignable to specific classes
@ControllerAdvice(assignableTypes = {ControllerInterface.class, AbstractController.class})
public class ExampleAdvice3 {}

@RestControllerAdvice๋Š” @ControllerAdvice์™€ ๊ฐ™์€ ์—ญํ• ์„ ํ•˜๋ฉฐ, ๋‚ด๋ถ€์˜ ๋ฉ”์„œ๋“œ์— @ResponseBody ์• ๋…ธํ…Œ์ด์…˜์„ ์ถ”๊ฐ€์‹œ์ผœ์ค€๋‹ค.


@ExceptionHandler, @ControllerAdvice ์›๋ฆฌ

@ControllerAdvice์—์„œ Interceptor์—์„œ ๋‚ ์•„์˜จ ์—๋Ÿฌ๋„ ์žก๋Š” ๊ฒƒ์„ ๋ณด๊ณ  ์›๋ฆฌ๊ฐ€ ์‹ ๊ฒฝ ์“ฐ์—ฌ DispatcherServlet์˜ doDispatch() ๋ฉ”์„œ๋“œ ์ฝ”๋“œ๋ฅผ ์‚ดํŽด๋ดค๋‹ค.

protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
  ...
  try {
    ...
      try {
        ...
        // Determine handler for the current request.
        mappedHandler = getHandler(processedRequest);
 
        // Determine handler adapter for the current request.
        HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());
        
        ...
          
        if (!mappedHandler.applyPreHandle(processedRequest, response)) {
          return;
        }
 
        // Actually invoke the handler.
        mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
        
        ...
          
        mappedHandler.applyPostHandle(processedRequest, response, mv);
      }
      catch (Exception ex) {
        dispatchException = ex;
      }
      catch (Throwable err) {
        dispatchException = new NestedServletException("Handler dispatch failed", err);
      }
      processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
    }
  	...
}
  • ํ•ธ๋“ค๋Ÿฌ(์ปจํŠธ๋กค๋Ÿฌ)์™€ ์ธํ„ฐ์…‰ํ„ฐ๋ฅผ ์‹คํ–‰ ์ค‘ ์˜ˆ์™ธ๊ฐ€ ๋ฐœ์ƒํ•˜๋ฉด dispatchException์— ์˜ˆ์™ธ๋ฅผ ์ €์žฅํ•˜๊ณ , processDispatchResult๋กœ ๋„˜๊ฒจ์ค€๋‹ค.
  • ์œ„ ์ฝ”๋“œ์—๋Š” ๋‚˜์˜ค์ง€ ์•Š์ง€๋งŒ, processDispatchResult์—์„œ๋Š” ์˜ˆ์™ธ๊ฐ€ ์žˆ๊ณ , ModelAndViewDefiningException์ด ์•„๋‹Œ ๊ฒฝ์šฐ processHandlerException๋ฅผ ํ˜ธ์ถœํ•œ๋‹ค.
    • ModelAndViewDefiningException์€ ์˜ˆ์™ธ ํŽ˜์ด์ง€๋ฅผ ๋ณด์—ฌ์ฃผ๋„๋กํ•˜๋Š” ์˜ˆ์™ธ
  • processHandlerException์—์„œ๋Š” DispatcherServlet์— ๋“ฑ๋ก๋œ HandlerExceptionResolver ์„ ํ•˜๋‚˜์”ฉ ์ˆ˜ํ–‰ํ•œ๋‹ค.
  • HandlerExceptionResolver์€ ์œ„์—๋„ ๋‚˜์™€์žˆ์ง€๋งŒ ๋””ํดํŠธ๋กœ ๋‹ค์Œ ์„ธ๊ฐ€์ง€๊ฐ€ ๋“ฑ๋ก๋œ๋‹ค.
    • ExceptionHandlerExceptionResolver
    • ResponseStatusExceptionResolver
    • DefaultHandlerExceptionResolver
  • ์„ธ ๊ฐ€์ง€ Resolver ์ค‘ ExceptionHandlerExceptionResolver๊ฐ€ ExceptionHandler๋ฅผ ์‹คํ–‰ํ•œ๋‹ค.
  • @ControllerAdvice๋กœ ExceptionHandler๋ฅผ ๋“ฑ๋กํ•˜๋ฉด, ๋””ํดํŠธ๋กœ ๋ชจ๋“  ์ปจํŠธ๋กค๋Ÿฌ์— ๋“ฑ๋ก๋œ๋‹ค. ๋”ฐ๋ผ์„œ interceptor์—์„œ ๋‚ ๋ฆฐ ์˜ˆ์™ธ๋„ ๋ฐ›์„ ์ˆ˜ ์žˆ๋Š” ๊ฒƒ์ด๋‹ค.
  • ์„œ๋ธ”๋ฆฟ ํ•„ํ„ฐ์˜ ๊ฒฝ์šฐ๋Š” ๋””์ŠคํŒจ์ฒ˜ ์„œ๋ธ”๋ฆฟ ์ด์ „์— ์ˆ˜ํ–‰๋˜๊ธฐ์—, ExceptionHandler๋กœ ๋ฐ›์ง€ ์•Š๋Š”๋‹ค.

More..

  • DispathcerServlet์˜ ์ฝ”๋“œ๋ฅผ ๋ณด๋ฉด ์ปจํŠธ๋กค๋Ÿฌ ์•ˆ์—์„œ ์„ ์–ธํ•œ @ExceptionHandler ๋ฉ”์„œ๋“œ๋„ ์ธํ„ฐ์…‰ํ„ฐ์—์„œ ๋‚ ๋ฆฐ ์˜ˆ์™ธ๋ฅผ ๋ฐ›์„ ์ˆ˜ ์žˆ๋Š” ๊ฑธ๋กœ ๋ณด์ธ๋‹ค.
    • ๊ทธ๋ฆฌ๊ณ  ์‹ค์ œ๋กœ ์‹คํ—˜์„ ํ•ด๋ณด๋‹ˆ ์ธํ„ฐ์…‰ํ„ฐ์˜ preHandle์—์„œ ๋‚ ๋ฆฐ ์˜ˆ์™ธ๋ฅผ ์ปจํŠธ๋กค๋Ÿฌ์—์„œ ์„ ์–ธํ•œ @ExceptionHandler์—์„œ ์ฒ˜๋ฆฌํ•˜์˜€๋‹ค.
  • ์ธํ„ฐ์…‰ํ„ฐ์˜ afterCompletion ์€ processDispatchResult์—์„œ ์‹คํ–‰๋˜๋Š”๋ฐ ๋”ฐ๋ผ์„œ afterCompletion์—์„œ ์˜ˆ์™ธ๋ฅผ ๋‚ ๋ ค๋„ @ControllerAdvise์™€ @ExceptionHandler๋Š” ๋ฐ›์ง€ ๋ชปํ•œ๋‹ค.
    • ์‹คํ—˜ ๊ฒฐ๊ณผ, ์‹ค์ œ๋กœ ExceptionHandler์—์„œ๋Š” ์ฒ˜๋ฆฌํ•˜์ง€ ๋ชปํ•˜์˜€์ง€๋งŒ ์‘๋‹ต์€ ์ œ๋Œ€๋กœ ์™”๋‹ค. ๋Œ€์‹  ์ฝ˜์†”์— ์˜ค๋ฅ˜๊ฐ€ ๊ธฐ๋ก๋˜์—ˆ๋‹ค. afterCompletion์—์„œ ๋ฐœ์ƒํ•œ ์˜ˆ์™ธ๋Š” ์Šคํ”„๋ง ๋‚ด์—์„œ ์ฒ˜๋ฆฌํ•˜๋Š” ๊ฒƒ์ด๋‹ค.
  • processHandlerException์—์„œ ์˜ˆ์™ธ ์ฒ˜๋ฆฌ ์ดํ›„์—๋„ afterCompletion์€ ์‹คํ–‰๋œ๋‹ค.

์ •๋ฆฌ

HTML ์—๋Ÿฌ ํ™”๋ฉด์„ ๋ณด์—ฌ์ค˜์•ผํ•˜๋Š” ๊ฒฝ์šฐ

  • BasicErrorController ์‚ฌ์šฉ

API ์—๋Ÿฌ ์‘๋‹ต์„ ๋ณด๋‚ด์•ผํ•˜๋Š” ๊ฒฝ์šฐ

  • ExceptionHandlerExceptionResolver (@ExceptionHandler) ์‚ฌ์šฉ
  • @ControllerAdvise๋Š” ์˜ˆ์™ธ์ฒ˜๋ฆฌ ์ฝ”๋“œ์™€ ์ •์ƒ์ฝ”๋“œ๋ฅผ ๋ถ„๋ฆฌ์‹œํ‚ค๊ณ ์ž ํ•  ๋•Œ ์‚ฌ์šฉ

์ถœ์ฒ˜