Правильное использование Spring Boot ErrorController и Spring ResponseEntityExceptionHandler

Я признаю, что я не слишком хорошо знаком с ErrorController Spring, но, глядя на указанные вами цели, я считаю, что все они могут быть достигнуты с помощью Spring @ControllerAdvice. Ниже приведен пример того, как я использую его в своих собственных приложениях:

@ControllerAdvice
public class ExceptionControllerAdvice {

    private static final String INCOMING_REQUEST_FAILED = "Incoming request failed:";
    private static final Logger LOGGER = LoggerFactory.getLogger(ExceptionControllerAdvice.class);
    private final MessageSource source;

    public ExceptionControllerAdvice2(final MessageSource messageSource) {
        source = messageSource;
    }

    @ExceptionHandler(value = {CustomException.class})
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ResponseBody
    public ErrorMessage badRequest(final CustomException ex) {
        LOGGER.error(INCOMING_REQUEST_FAILED, ex);
        final String message = source.getMessage("exception.BAD_REQUEST", null, LocaleContextHolder.getLocale());
        return new ErrorMessage(HttpStatus.BAD_REQUEST.value(), message);
    }

    @ExceptionHandler(Throwable.class)
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ResponseBody
    public ErrorMessage internalServerError(final Exception ex) {
        LOGGER.error(INCOMING_REQUEST_FAILED, ex);
        final String message =
                source.getMessage("exception.INTERNAL_SERVER_ERROR", null, LocaleContextHolder.getLocale());
        return new ErrorMessage(HttpStatus.INTERNAL_SERVER_ERROR.value(), message);
    }
}

Приложение Spring Boot имеет конфигурацию по умолчанию для обработки ошибок — Эррормвкаутоконфигуратион.

Что он в основном делает, если не предусмотрена дополнительная настройка:

• он создает глобальный контроллер ошибок по умолчанию - BasicErrorController
• он создает статическое представление «ошибка» по умолчанию «Страница ошибки Whitelabel».

BasicErrorController по умолчанию подключен к «/ error». Если в приложении нет настроенного представления «ошибка», в случае исключения, выданного любым контроллером, пользователь попадает на страницу с белой меткой /error, заполненную информацией с помощью BasicErrorController.

Если в приложении есть контроллер, реализующий ErrorController, это заменяетBasicErrorController.

Если в контроллере обработки ошибок возникает какое-либо исключение, оно проходит через фильтр исключений Spring (подробнее см. ниже) и, наконец, если ничего не найдено, это исключение будет обрабатываться базовым контейнером приложения, например. Кот. Базовый контейнер обработает исключение и покажет некоторую страницу/сообщение об ошибке в зависимости от его реализации.

В BasicErrorControllerjavadoc есть интересная информация:

Basic global error Controller, rendering ErrorAttributes. More specific errors can be handled either using Spring MVC abstractions (e.g. @ExceptionHandler) or by adding servlet server error pages.

BasicErrorController или ErrorController реализация — это глобальный обработчик ошибок. Его можно использовать вместе с @ExceptionHandler.

Здесь мы подходим к ResponseEntityExceptionHandler

A convenient base class for @ControllerAdvice classes that wish to provide centralized exception handling across all @RequestMapping methods through @ExceptionHandler methods. This base class provides an @ExceptionHandler method for handling internal Spring MVC exceptions.

Другими словами, это означает, что ResponseEntityExceptionHandler — это просто удобный класс, который уже содержит обработку исключений Spring MVC. И мы можем использовать его в качестве базового класса для нашего пользовательского класса для обработки исключений контроллеров. Чтобы наш пользовательский класс работал, он должен быть аннотирован @ControllerAdvice.

Классы, аннотированные @ControllerAdvice, можно использовать одновременно с глобальным обработчиком ошибок (реализацией BasicErrorController или ErrorController). Если наш аннотированный класс @ControllerAdvice (который может/или не расширять ResponseEntityExceptionHandler) не обрабатывает какое-то исключение, оно переходит в глобальный обработчик ошибок.

До сих пор мы рассматривали контроллер ErrorHandler и все, что помечено @ControllerAdvice. Но это намного сложнее. Я нашел действительно ценную информацию в вопросе - Установка приоритета нескольких @ControllerAdvice @ExceptionHandlers.

Редактировать:

Чтобы не усложнять:

1. First Spring ищет обработчик исключений (метод с аннотацией @ExceptionHandler) в классах @ControllerAdvice. См. ExceptionHandlerExceptionResolver.
2. Затем он проверяет, аннотировано ли выброшенное исключение @ResponseStatus или является производным от ResponseStatusException. См. ResponseStatusExceptionResolver.
3. Затем он проходит через обработчики исключений Spring MVC по умолчанию. См. DefaultHandlerExceptionResolver.
4. И в конце, если ничего не найдено, элемент управления перенаправляется на представление страницы с ошибкой, за которой стоит глобальный обработчик ошибок. Этот шаг не выполняется, если исключение исходит от самого обработчика ошибок.
5. Если представление ошибок не найдено (например, глобальный обработчик ошибок отключен) или шаг 4 пропущен, то исключение обрабатывается контейнером.