Обработка исключений в Spring MVC с помощью аннотации @ExceptionHandler
В процессе работы с веб-приложениями исключения могут возникать по различным причинам: ошибки валидации, неверные параметры запроса, ошибки доступа и т.д. В Spring MVC для обработки исключений используется аннотация @ExceptionHandler, которая позволяет обрабатывать различные исключения на уровне контроллера.
Основные функции @ExceptionHandler
Централизованное управление ошибками: позволяет определять обработчики исключений в каждом контроллере.
Упрощение обработки ошибок: с @ExceptionHandler мы можем управлять отображением пользовательских сообщений об ошибках, логированием, возвратом специальных HTTP-кодов и шаблонов страниц ошибок.
Простой пример использования @ExceptionHandler
Создадим контроллер, который генерирует исключение IllegalArgumentException при передаче определенного параметра.
Если number меньше 0, метод testError генерирует IllegalArgumentException. Обработчик handleIllegalArgumentException обрабатывает это исключение, добавляя сообщение об ошибке в модель и направляя пользователя на страницу errorPage.
errorPage.html:
Обработка нескольких исключений
Если контроллер может генерировать разные исключения, можно определить несколько методов с @ExceptionHandler, каждый из которых будет обрабатывать конкретное исключение.
Пример обработки двух типов исключений:
#Java #Training #Spring #ExceptionHandler
В процессе работы с веб-приложениями исключения могут возникать по различным причинам: ошибки валидации, неверные параметры запроса, ошибки доступа и т.д. В Spring MVC для обработки исключений используется аннотация @ExceptionHandler, которая позволяет обрабатывать различные исключения на уровне контроллера.
Основные функции @ExceptionHandler
Централизованное управление ошибками: позволяет определять обработчики исключений в каждом контроллере.
Упрощение обработки ошибок: с @ExceptionHandler мы можем управлять отображением пользовательских сообщений об ошибках, логированием, возвратом специальных HTTP-кодов и шаблонов страниц ошибок.
Простой пример использования @ExceptionHandler
Создадим контроллер, который генерирует исключение IllegalArgumentException при передаче определенного параметра.
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
@Controller
public class ErrorController {
@GetMapping("/testError")
public String testError(@RequestParam("number") int number) {
if (number < 0) {
throw new IllegalArgumentException("Number cannot be negative");
}
return "result";
}
@ExceptionHandler(IllegalArgumentException.class)
public String handleIllegalArgumentException(IllegalArgumentException ex, Model model) {
model.addAttribute("errorMessage", ex.getMessage());
return "errorPage";
}
}
Если number меньше 0, метод testError генерирует IllegalArgumentException. Обработчик handleIllegalArgumentException обрабатывает это исключение, добавляя сообщение об ошибке в модель и направляя пользователя на страницу errorPage.
errorPage.html:
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<title>Error Page</title>
</head>
<body>
<h2>Error Occurred:</h2>
<p th:text="${errorMessage}">An unexpected error occurred</p>
</body>
</html>
Обработка нескольких исключений
Если контроллер может генерировать разные исключения, можно определить несколько методов с @ExceptionHandler, каждый из которых будет обрабатывать конкретное исключение.
Пример обработки двух типов исключений:
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
@Controller
public class MultipleErrorController {
@GetMapping("/testMultipleErrors")
public String testErrors(@RequestParam("type") String type) {
if ("null".equals(type)) {
throw new NullPointerException("Null value detected");
} else if ("illegal".equals(type)) {
throw new IllegalArgumentException("Illegal argument provided");
}
return "result";
}
@ExceptionHandler(NullPointerException.class)
public String handleNullPointerException(NullPointerException ex, Model model) {
model.addAttribute("errorMessage", ex.getMessage());
return "nullErrorPage";
}
@ExceptionHandler(IllegalArgumentException.class)
public String handleIllegalArgumentException(IllegalArgumentException ex, Model model) {
model.addAttribute("errorMessage", ex.getMessage());
return "illegalErrorPage";
}
}
В этом случае NullPointerException и IllegalArgumentException обрабатываются разными методами, и в зависимости от типа исключения отображаются разные страницы ошибок.
#Java #Training #Spring #ExceptionHandler
Глобальная обработка исключений с @ControllerAdvice
В некоторых случаях удобно создать глобальный обработчик ошибок, который будет обрабатывать исключения для всех контроллеров. В Spring MVC для этого используется аннотация @ControllerAdvice, которая позволяет создавать централизованный класс для обработки исключений.
Пример:
Настройка кода ответа HTTP для исключений
Кроме отображения страниц, можно задавать HTTP-коды, которые будут возвращаться клиенту в случае исключений. Например, при возникновении IllegalArgumentException мы можем вернуть код 400 Bad Request.
Пример:
#Java #Training #Spring #ExceptionHandler
В некоторых случаях удобно создать глобальный обработчик ошибок, который будет обрабатывать исключения для всех контроллеров. В Spring MVC для этого используется аннотация @ControllerAdvice, которая позволяет создавать централизованный класс для обработки исключений.
Пример:
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
@ControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(IllegalArgumentException.class)
public String handleIllegalArgumentException(IllegalArgumentException ex, Model model) {
model.addAttribute("errorMessage", ex.getMessage());
return "globalErrorPage";
}
@ExceptionHandler(NullPointerException.class)
public String handleNullPointerException(NullPointerException ex, Model model) {
model.addAttribute("errorMessage", "A null value was encountered");
return "globalErrorPage";
}
}
Здесь класс GlobalExceptionHandler обрабатывает все исключения IllegalArgumentException и NullPointerException, возникающие в любых контроллерах приложения. Это позволяет централизовать обработку ошибок.
Настройка кода ответа HTTP для исключений
Кроме отображения страниц, можно задавать HTTP-коды, которые будут возвращаться клиенту в случае исключений. Например, при возникновении IllegalArgumentException мы можем вернуть код 400 Bad Request.
Пример:
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
@Controller
public class ErrorCodeController {
@GetMapping("/testErrorCode")
public String testError(@RequestParam("number") int number) {
if (number < 0) {
throw new IllegalArgumentException("Number cannot be negative");
}
return "result";
}
@ExceptionHandler(IllegalArgumentException.class)
@ResponseStatus(HttpStatus.BAD_REQUEST)
public String handleIllegalArgumentException(IllegalArgumentException ex, Model model) {
model.addAttribute("errorMessage", ex.getMessage());
return "errorPage";
}
}
Теперь клиент получит код 400 в случае возникновения ошибки, что может быть полезно для REST API.
#Java #Training #Spring #ExceptionHandler