SpringBoot 如何使用 @ResponseStatus 注解处理异常状态码

SpringBoot 如何使用 @ResponseStatus 注解处理异常状态码

在 SpringBoot 应用程序中，异常处理是一个非常重要的话题。当应用程序出现异常时，我们需要对异常进行处理，以保证应用程序的稳定性和可靠性。除了使用异常处理器外，SpringBoot 还提供了另一种处理异常状态码的方式，即使用 @ResponseStatus 注解。本文将介绍如何使用 @ResponseStatus 注解处理异常状态码。

什么是 @ResponseStatus 注解？

@ResponseStatus 注解用于指定控制器方法抛出异常时的 HTTP 状态码和对应的错误信息。当控制器方法抛出指定类型的异常时，SpringBoot 会自动将 @ResponseStatus 注解中定义的状态码和错误信息返回给客户端。该注解的语法如下：

@ResponseStatus(value = HttpStatus.BAD_REQUEST, reason = "Bad request")
public class BadRequestException extends RuntimeException {

}

在上面的代码中，@ResponseStatus 注解定义了一个 BadRequestException 异常类，并指定了 HTTP 状态码为 400（Bad Request），错误信息为 “Bad request”。当控制器方法抛出 BadRequestException 异常时，SpringBoot 会自动将 HTTP 状态码和错误信息返回给客户端。

如何使用 @ResponseStatus 注解处理异常状态码

下面我们通过一个示例来演示如何使用 @ResponseStatus 注解处理异常状态码。

步骤 1：创建 SpringBoot 项目

首先，我们需要创建一个 SpringBoot 项目。可以使用 Spring Initializr 快速创建一个空的 SpringBoot 项目。在项目中添加以下依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

其中，spring-boot-starter-web 依赖用于创建 Web 项目。

步骤 2：定义异常类

接下来，我们需要定义一个异常类，用于抛出异常。在异常类中，我们使用 @ResponseStatus 注解来定义 HTTP 状态码和错误信息。具体代码如下：

@ResponseStatus(value = HttpStatus.BAD_REQUEST, reason = "Bad request")
public class BadRequestException extends RuntimeException {

}

在上面的代码中，@ResponseStatus 注解定义了一个 BadRequestException 异常类，并指定了 HTTP 状态码为 400（Bad Request），错误信息为 “Bad request”。

步骤 3：创建控制器

接下来，我们需要创建一个控制器，用于处理请求。在控制器中，我们抛出 BadRequestException 异常。具体代码如下：

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

    @GetMapping("/{id}")
    public ResponseEntity<User> getUserById(@PathVariable Long id) {
        if (id <= 0) {
            throw new BadRequestException();
        }

        User user = userRepository.findById(id).orElseThrow(() -> new ResourceNotFoundException("User", "id", id));
        return ResponseEntity.ok().body(user);
    }

}

在上面的代码中，当 URL 中的 id 参数小于等于 0 时，我们抛出 BadRequestException 异常。

步骤 4：测试

最后，我们可以使用 Postman 或类似的工具来测试我们的控制器。例如，我们可以发送一个 GET 请求到 /users/0，这会导致控制器抛出 BadRequestException 异常，并返回 HTTP 状态码为 400 和错误信息为 “Bad request” 的响应。

总结

本文介绍了如何使用 @ResponseStatus 注解处理异常状态码。通过 @ResponseStatus 注解，我们可以方便地指定控制器方法抛出异常时的 HTTP 状态码和对应的错误信息，以保证应用程序的稳定性和可靠性。在实际开发中，我们可以根据具体的业务需求来选择合适的异常处理方式，并编写相应的异常处理逻辑，以保证应用程序的正常运行。