[Spring] API ExceptionHandler(API 예외 처리)

API 예외 처리 방법

---

API에서 예외 처리는 HTML 페이지와는 다르다. API는 오류 페이지를 보여주는 것 외에도, 각 오류 상황에 따른 응답 스펙을 제공해야 한다. 

 

[1. 서블릿 오류 페이지 활용]

'WebServerCustomizer' 를 사용하여 서블릿의 오류 페이지 경로를 설정할 수 있다. 이를 통해, WAS에서 예외가 발생하거나 'response.sedError()'가 호출될 때 지정한 오류 페이지 경로로 이동하게 된다.

@Component
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);
    }
}

---

[2. API 예외 컨트롤러]

'ApiExceptionCeontroller' 에서는 회원 정보를 반환하는 기능을 제공한다. 특정 조건 (id값이 ex일 경우)에 오류가 발생 시킨다.

@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;
    }
}

---

[3. 오류 페이지 컨트롤러]

기본적으로 API를 호출하면, 예외가 발생해도 HTML 페이지가 반환된다. 하지만 클라이언트는 JSON 형식의 응답을 기대하므로, 오류 페이지컨트롤러를 수정하여 JSON 응답을 할 수 있게 해야한다.

@Slf4j
@Controller
public class ErrorPageController {

    @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의 Accpt 의 값이 application/json 일 때 해당 메서드가 호출된다는 것이다. 결국 클라이언트가 받고 싶은 미디어타입이 json이면 이 컨트롤러의 메서드가 호출된다.

 

응답 데이터를 위해서 Map를 만들고 status, message 키에 값을 할당한다. jackson 라이브러리는 Map을 JSON구조로 변환할 수 있다.

 

ResponseEntity를 사용해서 응답하기 때문에 메시지 컨버터가 동작하면서 클라이언트에 JSON이 반환된다

 

http://localhost:8080/api/members/ex

{
 "message": "잘못된 사용자",
 "status": 500
}

 

 

 

스프링 부트 - 기본 오류 처리

---

[1. API 예외 처리 - 스프링 부트 기본 오류 처리]

스프링 부트에서 API 예외 처리는 기본적으로 'BasicErrorController' 를 활용해 처리한다. 이 컨트롤러는 HTTP 요청 헤더의 'Accept' 값을 바탕으로 적절한 오류 응답을 반환 해준다.

 

BasicErrorController

@RequestMapping(produces = MediaType.TEXT_HTML_VALUE)
public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) {}

@RequestMapping
public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {}

• errorHtml() 메서드 : 클라이언트가 'text/html' 을 원하면 이 메서드를 통해 HTML 오류 페이지를 제공한다.
• error() 메서드 : 기타 모든 요청에서 이 메서드가 호출되며, 오류 정보를 JSON 형태로 반환한다

스프링 부트의 기본 설정에 따르면, 오류 발생 시 '/error' 경로로 오류 페이지 요청이 이루어진다. 그리고 'BasicErrorController' 는 이 경로를 기본으로 받아 처리한다.

 

테스트 결과 - 오류 발생 시 반환되는 기본 JSON 응답

---

[2. API 오류 처리의 문제점]

'BasicErrorController' 는 웹 페이지 기반의 오류 처리에는 훌륭하지만, API 기반의 서비스에서의 예외 처리에는 한계가 있다. API는 세밀한 예외 처리를 요구하기 때문에 '@ExceptionHandler' 를 사용하는 것이 더 적합하다.

 

예를 들어, 회원과 관련된 API에서 발생하는 예외와 상품 관련 API에서 발생하는 예외의 형태나 메시지가 다를 수 있다.

 

 

 

 

API 예외 처리 - HandlerExceptionResolver 

---

예외가 발생해서 서블릿으로 넘어 WAS까지 예외가 전달되면, 상태코드 500으로 처리된다. 발생하는 예외에 따라서 400,404 등 다른 상태코드로도 처리할 수 있다. 또한 오류 메시지, 형식들을 API마다 다르게 처리할 수 있다.

 

[1. 상태코드 변환]

예를 들어서 lilegalArgumentException 을 처리하지 못해 컨트롤러 밖으로 넘어가는 일이 발생하면, 상태코드 400으로 처리하고 싶다. 

 

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);
}

{
     "status": 500,
     "error": "Internal Server Error",
     "exception": "java.lang.IllegalArgumentException",
     "path": "/api/members/bad"
}

http://localhost:8080/api/members/bad 호출 시, 실행해보면 상태 코드가 500인것을 확인할 수 있다.

---

[2. HandlerExceptionReslover]

 

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

 

ExceptionResolver 적용 전

ExceptionResolver 적용 후
* ExceptionResolver 적용 후, 예외를 해결해도 postHandle() 은 호출되지 않는다.

 

HandlerExceptionResolver - 인터페이스

• 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("IllegalArgumentsException 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 가 ModelAndView 를 반환하는 이유는 마치 try, catch를 하듯이, Excetion을 처리해서 정상 흐름처럼 변경하는 것이 목적이다. 이름 그대로 Exception을 Resolver(해결)하는 것이 목적이다.

 

여기서 lilegalArgumentException 이 발생하면 respons.sendError(400)을 호출해서 HTTP 상태 코드를 400으로 지정하고, 빈 ModelAndView 를 반환한다.

---

[3. 반환 값에 따른 동작 방식]

 

HnadlerExceptionResolver 의 반환 값에 따른 DispatcherServlet 의 동작 방식은 다음과 같다.

 

빈 ModelAndView

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

 

ModelAndView 지정 

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

 

null

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

---

[4. ExceptionResolver 활용]

 

예외 상태 코드 변환

• 예외를 response.sendError(xxx) 호출로 변경해서 서블릿에서 상태 코드에 따른 오류를 처리하도록 위임이후
• WAS 는 서블릿 오류 페이지를 찾아서 내부 호출, 예 : 스프링 부트가 기본적으로 설정한 /error 가 호출됨

뷰 템플릿 처리

• ModelAndView에 값을 채워서 예외 따른 새로운 오류 화면 뷰 렌더링 해서 고객에게 제공

 

API 응답 처리

• response.getWriter().println("hello");처럼  HTTP응답 바디에 직접 데이터를 넣어주는 것도 가능하다. JSON으로 응답하면 API 응답처리를 할 수 있다.

 

WebConfig - 추가

@Configuration
public class WebConfig implements WebMvcConfigurer {

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

configureHandlerExceptionResovlers(..) 를 사용하면 스프링이 기본으로 등록하는

ExceptionResolver 가 제거되므로 주의, extendHandlerExceptionResolver 를 사용하자.

 

Postman 실행

http://localhost:8080/api/members/ex  ➜ 500 Internal Server Error

http://localhost:8080/api/members/bad ➜ 400 Bad Request

 

 

 

 

API 예외 처리 - HandlerExceptionResolver 활용

---

예외가 발생하면 WAS까지 예외가 던져지고, WAS에서 오류 페이지 정보를 찾아서 다시 /error 를 호출하는 과정은 너무 복잡하다. ExceptionResolver 를 활용하면 예외가 발생했을 때, 이런 복잡한 과정이 생략되고 해결할 수 있다.

 

[1. 사용자 정의 예외 - UserException]

package hello.exception.exception;

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);
    }
}

---

[2. API 예외 발생 - ApiExceptionController]

@Slf4j
@RestController
public class 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("잘못된 입력 값");
        }
        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;
    }
}

---

[3. 예외 처리 리졸버 - 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 {
                    return new ModelAndView("error/500");
                }
            }
        } catch (IOException e) {
            log.error("resolver ex", e);
        }
        return null;
    }
}

 

HTTP 요청 헤더의 ACCEPT 값이 application/josn이면 JSON으로 오류를 반환하고, 그 외 경우에는 error/500 있는 HTML오류 페이지를 반환한다.

---

[4. WebConfig - UserHandlerExceptionResolver]

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

 

실행
http://localhost:8090/api/members/user-ex

ACCEPT : application

ACCEPT : HTML

<!DOCTYPE HTML>
<html>
...
</html>

 

ExceptionResolver를 사용하면 컨트롤러에서 예외가 발생해도 ExceptionResolver에서 예외를 처리한다.

따라서 예외가 발생해도 서블릿 컨테이너 WAS까지 예외가 전달되지 않고, 스프링 MVC에서 예외 처리는 끝이 난다.

결과적으로 WAS 입장에서는 정상 처리가 된것이다. 

 

스프링의 기본 예외 처리 로직을 우회하여 자신만의 예외 처리 전략을 구현할 수 있다.

 

서블릿 컨테이너까지 예외가 올라가면 복잡하고 지저분하게 추가 프로세스가 실행된다. 반면에 ExceptionResolver를 사용하면 예외처리가 상당히 깔끔해진다.

 

그런데 직접 ExceptionResolver를 구현하려고 하면 코드가 상당히 복잡하다. 그래서 스프링이 제공하는 ExceptionResolver가 존재한다.

---

 

 

 

API 예외 처리 - 스프링이 제공하는 ExceptionResolver1 (ResponseStatusExceptionResolver)

---

[1. 스프링이 제공하는 ExceptionResolver]

 

HandlerExceptionResolverCompostie에 다음 순서로 등록

1. ExceptionHandlerExceptionResolver

2. ResponseStatusExceptionResolver

3. DefaultHandlerExceptionResolver ➜ 우선 순위가 가장 낮다.

 

"ExceptionHandlerExceptionResolver"

- @ExceptionHanlder을 처리한다. API 예외처리는 대부분 이 기능으로 해결한다.

 

"ResponseStatusExceptionResolver"

- HTTP 상태코드를 지정- 예 : @ResponsStatus(value = HttpStatus.NOT_FOUND)

 

"DefaultHandlerExceptionResolver"- 스프링 내부 기본 예외를 처리한다.

 

 

[2. ResponseStatusExceptionResolver]

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

 

다음 두 가지 경우를 처리한다.

- @ResponseStatus 가 달려있는 예외

- ResponsStatusException 예외

 

@ResponseStatus 예시

package hello.exception.exception;

import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ResponseStatus;

@ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "잘못된 요청 오류")
public class BadRequestException extends RuntimeException {
}

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

 

ResponseStatusExceptiomResolver 코드를 확인해보면, 결국 response.sendError(statusCode, resolverReason)를 호출하는 것을 확인할 수 있다. sendError(400)를 호출했기 떄문에 WAS에서 다시 오류 페이지(/error)를 내부 요청한다.

 

ApiExceptionController - 추가

@GetMapping("/api/response-status-ex1")
public String responseStatusEx1() {
    throw new BadRequestException();
}

또한 'reason' 속성은 'MessageSource'를 사용해서 메시지를 조회하는 것도 지원한다. 이렇게 하면 여러 국가 및 언어에 대한 메시지 국제화가 수월해진다.

 

messages.properties

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

 

실행
http://localhost:8090/api/response-status-ex1?message=

 

---

[3. ResponseStatusException]

@ResponseStatus는 개발자가 직접 변경할 수 없는 예외(예 : 라이브러리 예외)에는 적용할 수 없다. 또한 조건에 따라 동적으로 변경하는 것이 어렵다. 이런 경우에 'ResponseStatusException' 을 사용할 수 있다.

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

이 경우에도 HTTP 상태 코드는 400로 설정되며, 메시지는 'MessageSource'에서 "error.bad'를 조회하여 반환한다.

 

실행
http://localhost:8090/api/response-status-ex2

 

 

정리

ResponseStatusExceptionResolver는 HTTP 상태코드를 지정해주는 역할을 한다.

• @ResponseStatus : 어노테이션을 통해 예외 발생 시 원하는 HTTP 상태코드와 메시지를 반환한다.
• ResponseSatusException :  동적으로 또는 외부 라이브러리 예외 HTTP 상태코드와 메시지를 정할 수 있다.

---

 

 

 

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

---

[1. DefaultHanldlerExceptionResolver란? ]

'DefaultHandlerExceptionResolver'는 스프링 내부에서 발생하는 예외를 처리하는 역할을 한다. 이를 통해 사용자가 자주 마주치게 될 여러 스프링 예외를 HTTP 상태 코드로 변환하여 적잘한 응답을 제공하게 된다.

---

[2. 주요기능]

대표적으로 파라미터 바인딩 시점에 타입이 맞지 않으면 내부에서 TypeMismatchException이 발생하는데, 이 경우 예외가 발생했기 때문에 서블릿 컨테이너 WAS까지 오류가 전달되고, 결과적으로 500 오류가 발생한다.

 

그런데 파라미터 바인딩은 대부분 클라이언트가 HTTP 요청 정보를 잘못해서 발생하는 문제이기 때문에, HTTP 에서는 이런 경우 HTTP 상태 코드 400을 사용하도록 되어 있다.

 

DefaultHandlerExceptionResolver는 이것을 상태코드 500이 아니라, 상태코드 400으로 변경한다.

---

[3. 코드 예시]

ApiExceptionController - 추가

@GetMapping("/api/default-handler-ex")
public String defaultException(@RequestParam Integer data) {
    return "ok";
}

Integer data에 문자를 입력하면 내부에서 TypeMismatchException이 발생한다.

 

실행 
http://localhost:8090/api/default-handler-ex?data=hello&message

'DefaultHandlerExceptionResolver' 는 이 예외를 처리하여 HTTP 상태 코드 400(Bad Request)로 응답한다.

 

 

정리

'DefaultHandlerExceptionResolver' 는 스프링 내부에서 발생하는 예외를 적절한 HTTP 상태 코드로 변환하여 처리한다. 이를 통해 API를 사용하는 클라이언트에게 오류 응답을 제공할 수 있다.

---

 

 

 

API 예외 처리 - 스프링이 제공하는 ExceptionResolver3 (@ExceptionHandler)

---

[1. API와 HTML 화면 오류 차이 ]

HTML 화면 오류 

: 웹 브라우저에 HTMl 화면을 제공할 때는 오류 발생 시 'BasicErrorController' 가 적합하다. 이는 5xx, 4xx와 같은 오류 화면을 간단히 보여줄때 유용하다.

 

API 오류

: API는 각 시스템이 제공하는 응답과 스펙이 다르다. 때문에 예외 상황에 따라 다양한 데이터를 출력해야 할 수도 있다.

---

[2. API 예외 처리의 어려움 ]

스프링에서 API 예외처리를 위해 'HandlerExceptionResolver' 를 사용할 때, 반환 값으로 'ModelAndView' 를 사용해야 한다는 제한이 있다. 이는 API 응답에는 필요하지 않다. 이로 인해 직접적인 응답 데이터 처리가 번거롭다.

 

특정 컨트롤러에서만 발생하는 예외를 별도로 처리하기 어렵다. 예를 들어서 회원을 처리하는 컨트롤러, 상품을 관리하는 컨트롤러에서 발생하는 각각의 RuntimeException 예외를 서로 다른 방식으로 처리하고 싶다면 어떻게 해야할까?

---

[3. @ExceptionHanlder의 등장 ]

'@ExceptionHandler' 는 'ExceptionHanlderExceptionResolver' 와 함께 동작하여 API 예외처리를 보다 쉽게 도와준다.

스프링은 ExceptionHanlderExceptionResolver 를 기본으로 제공하고,

기본으로 제공하는 ExceptionResolver 중에 우선순위도 가장 높다. 실무에서 API 예외 처리는 대부분 이 기능을 사용한다.

 

코드 예제
ErrorResult - 예외가 발생했을 때 API 응답으로 사용하는 객체 정의

@Data
@AllArgsConstructor
public class ErrorResult {
    private String code;
    private String message;
}

 

ApiExceptionV2Controller

@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());
    }
	//... 다른 예외 처리 로직
}

 

[5. @ExceptionHandler 예외처리 방법과 우선순위 ]

@ExceptionHandler 어노테이션을 선언하고, 해당 컨트롤러에서 처리하고 싶은 예외를 지정해주면 된다. 

해당 컨트롤러에서 예외가 발생하면 이 메서드가 호출된다. 참고로 지정한 예외 또는 그 예외 자식은 클래스는 모두 잡을 수 있다.

 

스프링의 우선순위는 항상 자세한 것이 우선권을 가진다. 예를 들어서 부모, 자식 클래스가 있고 다음과 같이 예외 처리가 된다.

@ExceptionHandler(부모예외.class)
public String 부모예외처리()(부모예외 e) {}

@ExceptionHandler(자식예외.class)
public String 자식예외처리()(자식예외 e) {}

@ExceptionHanlder 에 지정한 부모 클래스는 자식 클래스까지 처리할 수 있다. 따라서 자식 예외가 발생하면 부모예외처리(), 자식예외처리() 둘다 호출 대상이 된다. 이 중 더 자세한 것이 우선권을 가지므로, 자식예외처리()가 호출된다.

---

[6. 다양한 예외 ]

다음과 같이 다양한 예외를  한번에 처리할 수 있다.

@ExceptionHandler({AException.class, BException.class})
public String ex(Exception e) {
    log.info("exception e", e);
}

예외 생략
@ExceptionHandler에 예외를 생략할 수 있다. 생략하면 메서드 파라미터의 예외가 지정된다.

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

 

파라미터와 응답
공식 메뉴얼

@ExceptionHandler 에는 마치 스프링의 컨트롤러의 파라미터 응답처럼 다양한 파라미터와 응답을 지정할 수 있다.

https://docs.spring.io/spring-framework/reference/

 

lilegalArgumentException 처리

@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(IllegalArgumentException.class)
public ErrorResult illegalExHandler(IllegalArgumentException e) {
    log.error("[exceptionHandler] ex", e);
    return new ErrorResult("BAD", e.getMessage());
}

 

실행 흐름

• 컨트롤러를 호출한 결과 lilegalArgumentException 예외가 컨트롤러 밖으로 던져진다.
• 예외가 발생했으므로 ExceptionResolver 가 작동한다. 가장 우선순위가 높은 ExceptionHandlerExceptionResolver가 실행된다.
• ExceptionHandlerExceptionResolver 는 해당 컨트롤러에 lilegalArgumentException 을 처리할 수 있는 @ExceptionHandler가 있는지 확인한다.
• illegalExHandle() 를 실행한다. @RestController 이므로, illegalExHandle() 에도 @ResponseBody 가 적용된다. 따라서 HTTP 컨버터가 사용되고, 응답이 다음과 같은 JSON으로 반환된다.
• @ResponseStatus(HttpStatus.BAD_REQUEST) 를 지정했으므로 HTTP 상태코드 400으로 응답한다.

 

UserException 처리

@ExceptionHandler
public ResponseEntity<ErrorResult> userExHandler(UserException e) {
    log.error("[exceptionHandler] ex", e );
    ErrorResult errorResult = new ErrorResult("USER-EX", e.getMessage());
    return new ResponseEntity(errorResult, HttpStatus.BAD_REQUEST);
}

• @ExceptionHandler 에 예외를 지정하지 않으면 해당 메서드 파라미터 예외를 사용한다.여기서 UserException 을 사용한다.
• ResponceEntity 를 사용해서 HTTP 메시지 바디에 직접 응답한다. 물론 HTTP 컨터버가 사용된다.
• ResponceEntity를 사용하면 HTTP 응답코드를 프로그래밍해서 동적으로 변경할 수 있다. 앞서 살펴본 @ResponseStatus 는 어노테이션이므로 HTTP 응답코드를 동적으로 변경할 수 있다.

 

Exception

@GetMapping("/api2/members/{id}")
public MemberDto getMember(@PathVariable("id") String id) {

    if (id.equals("ex")) {
        throw new RuntimeException("잘못된 사용자");
    }

    return new MemberDto(id, "hello" + id);
}

@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
@ExceptionHandler
public ErrorResult exHandler(Exception e) {
    log.error("[exceptionHandler] ex", e);
    return new ErrorResult("EX", "내부 오류");
}

• throw new RuntimeException("잘못된 사용자") 이 코드가 실행되면서, 컨트롤러 밖으로 RuntimException 이 던져진다.
• RuntimeException 은 Exception 의 자식 클래스이다. 따라서 이 메서드가 호출된다.
• @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) 로 HTTP 상태코드 500으로 응답한다.

 

기타 - HTML 오류화면
다음과 같이 ModelAndView 를 사용해서 오류화면(HTML)f를 응답하는데 사용할 수도 있다.

@ExceptionHandler(ViewException.class)
public ModelAndView ex(ViewException e) {
    log.info("exception e", e);
    return new ModelAndView("error");
}

---

 

 

 

API 예외 처리 - @ControllerAdvice, @RestControllerAdvice

---

@ControllerAdive 와 @RestControllerAdvice 는 스프링 MVC에서 제공하는 어노테이션으로, 여러 컨트롤러에 걸쳐서 예외 처리, 바인딩 설정 또는 Model 객체 조작과 같은 공통적인 코드를 모듈화하는데 유용하다.

 

[1. 기본 구조 ] 

ExControllerAdvice.java

@Slf4j
@RestControllerAdvice(basePackages = "hello.exception.api")
public class ExControllerAdvice {

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(IllegalArgumentException.class)
    public ErrorResult illegalExHandler(IllegalArgumentException e) {
        log.error("[exceptionHandler] ex", e);
        return new ErrorResult("BAD", e.getMessage());
    }
    
    @ExceptionHandler
    public ResponseEntity<ErrorResult> userExHandler(UserException e) {
        log.error("[exceptionHandler] 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 exHandler(Exception e) {
        log.error("[exceptionHandler] ex", e);
        return new ErrorResult("EX", "내부 오류");
    }

}

 

ApiExceptionV2Controller.jav

@Slf4j
@RestController
public class ApiExceptionV2Controller {

//    @ResponseStatus(HttpStatus.BAD_REQUEST)
//    @ExceptionHandler(IllegalArgumentException.class)
//    public ErrorResult illegalExHandler(IllegalArgumentException e) {
//        log.error("[exceptionHandler] ex", e);
//        return new ErrorResult("BAD", e.getMessage());
//    }
//
//    @ExceptionHandler
//    public ResponseEntity<ErrorResult> userExHandler(UserException e) {
//        log.error("[exceptionHandler] 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 exHandler(Exception e) {
//        log.error("[exceptionHandler] 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);
    }
}

 

---

[2. 대상 컨트롤러 지정방법 ]

// 예시
@ControllerAdvice(annotations = RestController.class)
public class ExampleAdvice1 {}

@ControllerAdvice("org.example.controllers")
public class ExampleAdvice2 {}

@ControllerAdvice(assignableTypes = {ControllerInterface.class, AbstractController.class})
public class ExampleAdvice3 {}

특정 어노테이션이 있는 컨트롤러를 지정할 수 있고, 특정 패키지를 직접 지정할 수도 있다. 패키지 지정의 경우 해당 패키지와 그 하위에 있는 컨트롤러가 대싱이 된다. 또한 특정 클래스를 지정할 수도 있다. 대상 컨트롤러 지정을 생략하면 모든 컨트롤러에 적용된다.

 

정리

@ExceptionHandler 와 @ControllerAdvice 를 조합하면 예외처리를 깔끔하게 해결할 수 있다.

---

출처 : 인프런 - 🔗 스프링 MVC 2 - 백엔드 개발 활용 기술 by 우아한형제 김영한님