SpringBoot全局异常处理的三种方式

SpringBoot 全局异常处理

在使用 SpringBoot 开发 Web 应用时，异常处理是必不可少的一部分。在应用中，异常可能会出现在任何地方，例如在控制器、服务层、数据访问层等等。如果不对异常进行处理，可能会导致应用崩溃或者出现未知的错误。因此，对于异常的处理是非常重要的。

在 SpringBoot 中，有多种方式可以对异常进行处理，本文将介绍其中的三种方式。

1. 使用@ControllerAdvice 注解

@ControllerAdvice 是 SpringBoot 提供的一个注解，用于定义全局异常处理器。在使用@ControllerAdvice 注解时，需要使用@ExceptionHandler 注解来指定处理的异常类型。

下面是一个使用@ControllerAdvice 注解的例子：

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    public ResponseEntity<String> handleException(Exception e) {
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(e.getMessage());
    }
}

在上面的例子中，我们使用@ControllerAdvice 注解定义了一个全局异常处理器，然后使用@ExceptionHandler 注解指定了要处理的异常类型为 Exception。当应用中出现 Exception 类型的异常时，就会调用 handleException 方法来处理异常。

2. 使用@ExceptionHandler 注解

除了使用@ControllerAdvice 注解外，还可以在控制器中使用@ExceptionHandler 注解来处理异常。这种方式的好处是可以针对不同的控制器方法定义不同的异常处理器。

下面是一个使用@ExceptionHandler 注解的例子：

@RestController
public class UserController {

    @Autowired
    private UserService userService;

    @ExceptionHandler(UserNotFoundException.class)
    public ResponseEntity<String> handleUserNotFoundException(UserNotFoundException e) {
        return ResponseEntity.status(HttpStatus.NOT_FOUND).body(e.getMessage());
    }

    @GetMapping("/users/{id}")
    public ResponseEntity<User> getUser(@PathVariable Long id) {
        User user = userService.getUserById(id);
        if (user == null) {
            throw new UserNotFoundException("User not found");
        }
        return ResponseEntity.ok(user);
    }
}

在上面的例子中，我们在控制器中定义了一个 handleUserNotFoundException 方法，用于处理 UserNotFoundException 类型的异常。当 getUser 方法中出现 UserNotFoundException 类型的异常时，就会调用 handleUserNotFoundException 方法来处理异常。

3. 使用 HandlerExceptionResolver 接口

除了使用@ControllerAdvice 注解和@ExceptionHandler 注解外，还可以实现 HandlerExceptionResolver 接口来处理异常。这种方式比较灵活，可以自定义异常处理器的实现方式。

下面是一个使用 HandlerExceptionResolver 接口的例子：

public class GlobalExceptionHandler implements HandlerExceptionResolver {

    @Override
    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        ModelAndView mav = new ModelAndView();
        mav.addObject("exception", ex);
        mav.setViewName("error");
        return mav;
    }
}

在上面的例子中，我们实现了 HandlerExceptionResolver 接口，并重写了 resolveException 方法来处理异常。当应用中出现异常时，就会调用 resolveException 方法来处理异常。

总结：

在本文中，我们介绍了 SpringBoot 中三种处理异常的方式，分别是使用@ControllerAdvice 注解、@ExceptionHandler 注解和 HandlerExceptionResolver 接口。这些方式各有优缺点，开发者可以根据自己的需求选择适合自己的方式来处理异常。

JetBrains全家桶激活，持续跟随Jetbrains软件版本更新中……

Arcstack资源社区

Github Idea激活码永久有效

Gitee Idea激活码永久有效

关注VX-公众号【顶尖架构师栈】，回复 C01 获取超10G后端学习面试资源

本文由mdnice多平台发布