Gestion des exceptions dans les contrôleurs à ressort

En pratique, il est souvent nécessaire de gérer de manière centralisée les exceptions au sein d'un contrôleur ou même d'une application entière. Dans cet article, nous analyserons les principales fonctionnalités fournies par Spring Framework pour résoudre ce problème et, à l'aide d'exemples simples, voyons comment tout fonctionne. Qui est intéressé par ce sujet - bienvenue sous la coupe!

Initialement, avant Spring 3.2, les principaux moyens de gérer les exceptions dans une application étaient les annotations HandlerExceptionResolver et @ExceptionHandler . Nous les analyserons plus en détail ci-dessous, mais ils présentent certains inconvénients. À partir de la version 3.2, l'annotation @ControllerAdvice a été introduite , ce qui supprime les limitations des solutions précédentes. Et au printemps 5, une nouvelle classe ResponseStatusException a été ajoutée, ce qui est très pratique pour gérer les erreurs de base des API REST .

Et maintenant, tout d'abord, c'est parti!

Gestion des exceptions de contrôleur - @ExceptionHandler

@ExceptionHandler . , , .

:

@RestController
public class Example1Controller {

    @GetMapping(value = "/testExceptionHandler", produces = APPLICATION_JSON_VALUE)
    public Response testExceptionHandler(@RequestParam(required = false, defaultValue = "false") boolean exception)
            throws BusinessException {
        if (exception) {
            throw new BusinessException("BusinessException in testExceptionHandler");
        }
        return new Response("OK");
    }

    @ExceptionHandler(BusinessException.class)
    public Response handleException(BusinessException e) {
        return new Response(e.getMessage());
    }

}

testExceptionHandler, BusinessException, — . , , .

handleException . @ExceptionHandler(BusinessException.class), BusinessException. @ExceptionHandler , : @ExceptionHandler({BusinessException.class, ServiceException.class}).

— 200 JSON . , @ResponseStatus, @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR).

:

:

@ExceptionHandler , . @ExceptionHandler , , , .

HandlerExceptionResolver

HandlerExceptionResolver Spring. HandlerExceptionResolver. , , Spring . :

ExceptionHandlerExceptionResolver — @ExceptionHandler, .

DefaultHandlerExceptionResolver — Spring , :

, REST API . . ModelAndView, , .

ResponseStatusExceptionResolver — @ResponseStatus.

ServiceException:

@ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR)
public class ServiceException extends Exception {

    public ServiceException(String message) {
        super(message);
    }

}

ServiceException @ResponseStatus value INTERNAL_SERVER_ERROR, - 500.

:

@RestController
public class Example2Controller {

    @GetMapping(value = "/testResponseStatusExceptionResolver", produces = APPLICATION_JSON_VALUE)
    public Response testResponseStatusExceptionResolver(@RequestParam(required = false, defaultValue = "false") boolean exception)
            throws ServiceException {
        if (exception) {
            throw new ServiceException("ServiceException in testResponseStatusExceptionResolver");
        }
        return new Response("OK");
    }

}

GET- exception=true, 500- :

— . , @ResponseStatus .

HandlerExceptionResolver , - JSON XML . , .

:

@Component
public class CustomExceptionResolver extends AbstractHandlerExceptionResolver {

    @Override
    protected ModelAndView doResolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        ModelAndView modelAndView = new ModelAndView(new MappingJackson2JsonView());
        if (ex instanceof CustomException) {
            modelAndView.setStatus(HttpStatus.BAD_REQUEST);
            modelAndView.addObject("message", "CustomException was handled");
            return modelAndView;

        }
        modelAndView.setStatus(HttpStatus.INTERNAL_SERVER_ERROR);
        modelAndView.addObject("message", "Another exception was handled");
        return modelAndView;
    }

}

, . , : , ModelAndView. JSON, .

-, . . , . , — :

@RestController
public class Example3Controller {

    @GetMapping(value = "/testCustomExceptionResolver", produces = APPLICATION_JSON_VALUE)
    public Response testCustomExceptionResolver(@RequestParam(required = false, defaultValue = "false") boolean exception)
            throws CustomException {
        if (exception) {
            throw new CustomException("CustomException in testCustomExceptionResolver");
        }
        return new Response("OK");
    }

}

:

200 JSON .

@ControllerAdvice

— . Spring 3.2 @ControllerAdvice.

:

@ControllerAdvice
public class DefaultAdvice {

    @ExceptionHandler(BusinessException.class)
    public ResponseEntity<Response> handleException(BusinessException e) {
        Response response = new Response(e.getMessage());
        return new ResponseEntity<>(response, HttpStatus.OK);
    }

}

, @ControllerAdvice , .

DefaultAdvice handleException. handleException @ExceptionHandler, , , . BusinessException.

: @ExceptionHandler({BusinessException.class, ServiceException.class}). @ExceptionHandler .

, handleException ResponseEntity Response:

public class Response {

    private String message;

    public Response() {
    }

    public Response(String message) {
        this.message = message;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

}

, JSON . message HttpStatus.OK, 200.

:

@RestController
public class Example4Controller {

    @GetMapping(value = "/testDefaultControllerAdvice", produces = APPLICATION_JSON_VALUE)
    public Response testDefaultControllerAdvice(@RequestParam(required = false, defaultValue = "false") boolean exception)
            throws BusinessException {
        if (exception) {
            throw new BusinessException("BusinessException in testDefaultControllerAdvice");
        }
        return new Response("OK");
    }

}

, , JSON 200:

?

! :

@ControllerAdvice(annotations = CustomExceptionHandler.class)
public class CustomAdvice {

    @ExceptionHandler(BusinessException.class)
    public ResponseEntity<Response> handleException(BusinessException e) {
        String message = String.format("%s %s", LocalDateTime.now(), e.getMessage());
        Response response = new Response(message);
        return new ResponseEntity<>(response, HttpStatus.OK);
    }

}

@ControllerAdvice(annotations = CustomExceptionHandler.class). CustomAdvice , @CustomExceptionHandler.

@CustomExceptionHandler :

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface CustomExceptionHandler {
}

:

@RestController
@CustomExceptionHandler
public class Example5Controller {

    @GetMapping(value = "/testCustomControllerAdvice", produces = APPLICATION_JSON_VALUE)
    public Response testCustomControllerAdvice(@RequestParam(required = false, defaultValue = "false") boolean exception)
            throws BusinessException {
        if (exception) {
            throw new BusinessException("BusinessException in testCustomControllerAdvice");
        }
        return new Response("OK");
    }

}

Example5Controller @CustomExceptionHandler, Example4Controller . BusinessException CustomAdvice, DefaultAdvice, .

CustomAdvice — :

. @ControllerAdvice, . .

ResponseStatusException.

ResponseStatusException:

@RestController
public class Example6Controller {

    @GetMapping(value = "/testResponseStatusException", produces = APPLICATION_JSON_VALUE)
    public Response testResponseStatusException(@RequestParam(required = false, defaultValue = "false") boolean exception) {
        if (exception) {
            throw new ResponseStatusException(HttpStatus.INTERNAL_SERVER_ERROR, "ResponseStatusException in testResponseStatusException");
        }
        return new Response("OK");
    }

}

ResponseStatusException , , . @ResponseStatus — -. , .

:

Résumé : Nous avons vu différentes manières de gérer les exceptions, chacune avec ses propres caractéristiques. Dans une grande application, vous pouvez trouver plusieurs approches à la fois, mais vous devez être très prudent et essayer de ne pas trop compliquer la logique de gestion des erreurs. Sinon, il s'avérera qu'une exception sera gérée dans le mauvais gestionnaire et la réponse sera différente de celle attendue. Par exemple, si l'application dispose de plusieurs conseillers, lors de la création d'un nouveau, vous devez vous assurer qu'il ne rompt pas l'ordre existant de gestion des exceptions des anciens contrôleurs.

Soyez donc prudent et tout fonctionnera à merveille!

Lien vers les sources de l'article