SpringBoot中异常处理实例分析

在开发Spring Boot应用程序时，异常处理是一个非常重要的环节。良好的异常处理机制不仅可以提高应用程序的健壮性，还能为用户提供更好的体验。本文将详细介绍如何在Spring Boot中进行异常处理，并通过实例分析来加深理解。

1. Spring Boot中的异常处理机制

Spring Boot提供了多种方式来处理异常，主要包括以下几种：

1. 全局异常处理：通过@ControllerAdvice和@ExceptionHandler注解来实现全局异常处理。
2. 自定义异常：通过定义自定义异常类来处理特定的业务异常。
3. HTTP状态码处理：通过@ResponseStatus注解来指定异常对应的HTTP状态码。
4. 默认错误页面：Spring Boot默认提供了/error路径来处理未捕获的异常。

接下来，我们将通过实例来详细分析这些异常处理方式。

2. 全局异常处理

2.1 使用@ControllerAdvice和@ExceptionHandler

@ControllerAdvice注解用于定义全局的异常处理类，而@ExceptionHandler注解用于定义具体的异常处理方法。

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    public ResponseEntity<String> handleException(Exception ex) {
        return new ResponseEntity<>("An error occurred: " + ex.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
    }

    @ExceptionHandler(CustomException.class)
    public ResponseEntity<String> handleCustomException(CustomException ex) {
        return new ResponseEntity<>("Custom error: " + ex.getMessage(), HttpStatus.BAD_REQUEST);
    }
}

在上面的代码中，GlobalExceptionHandler类通过@ControllerAdvice注解标记为全局异常处理类。handleException方法处理所有Exception类型的异常，而handleCustomException方法处理自定义的CustomException异常。

2.2 自定义异常

自定义异常通常用于处理特定的业务逻辑异常。我们可以通过继承RuntimeException来定义自定义异常。

public class CustomException extends RuntimeException {
    public CustomException(String message) {
        super(message);
    }
}

在业务逻辑中，我们可以抛出这个自定义异常：

@Service
public class MyService {

    public void doSomething() {
        throw new CustomException("Something went wrong!");
    }
}

当doSomething方法抛出CustomException时，全局异常处理类中的handleCustomException方法将会被调用。

3. HTTP状态码处理

在某些情况下，我们希望特定的异常返回特定的HTTP状态码。可以通过@ResponseStatus注解来实现。

@ResponseStatus(value = HttpStatus.NOT_FOUND, reason = "Resource not found")
public class ResourceNotFoundException extends RuntimeException {
    public ResourceNotFoundException(String message) {
        super(message);
    }
}

当抛出ResourceNotFoundException时，Spring Boot会自动返回404状态码，并附带指定的错误信息。

4. 默认错误页面

Spring Boot默认提供了一个/error路径来处理未捕获的异常。我们可以通过自定义ErrorController来覆盖默认的错误处理逻辑。

@Controller
public class CustomErrorController implements ErrorController {

    @RequestMapping("/error")
    public ResponseEntity<String> handleError(HttpServletRequest request) {
        Integer statusCode = (Integer) request.getAttribute("javax.servlet.error.status_code");
        Exception exception = (Exception) request.getAttribute("javax.servlet.error.exception");
        return new ResponseEntity<>("Error occurred: " + statusCode + " " + exception.getMessage(), HttpStatus.valueOf(statusCode));
    }

    @Override
    public String getErrorPath() {
        return "/error";
    }
}

在上面的代码中，CustomErrorController类实现了ErrorController接口，并重写了handleError方法来处理错误请求。

5. 实例分析

假设我们有一个简单的REST API，用于获取用户信息。我们可以通过以下代码来实现：

@RestController
@RequestMapping("/users")
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping("/{id}")
    public ResponseEntity<User> getUserById(@PathVariable Long id) {
        User user = userService.getUserById(id);
        if (user == null) {
            throw new ResourceNotFoundException("User not found with id: " + id);
        }
        return new ResponseEntity<>(user, HttpStatus.OK);
    }
}

在UserService中，我们可能会抛出ResourceNotFoundException：

@Service
public class UserService {

    public User getUserById(Long id) {
        // 模拟数据库查询
        if (id == 1) {
            return new User(1, "John Doe");
        } else {
            throw new ResourceNotFoundException("User not found with id: " + id);
        }
    }
}

当访问/users/2时，由于用户不存在，ResourceNotFoundException将被抛出，并返回404状态码。

6. 总结

通过本文的实例分析，我们了解了如何在Spring Boot中进行异常处理。全局异常处理、自定义异常、HTTP状态码处理以及默认错误页面都是Spring Boot中常用的异常处理方式。合理使用这些机制，可以大大提高应用程序的健壮性和用户体验。

在实际开发中，建议根据业务需求选择合适的异常处理方式，并确保异常信息能够清晰地传达给用户或开发人员。