spring boot 400 处理

原创

mob64ca12d32849 2024-12-05 05:07:02 ©著作权

文章标签 spring 错误处理 JSON 文章分类 spring boot 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12d32849的原创作品，请联系作者获取转载授权，否则将追究法律责任

如何在Spring Boot中处理400错误

在开发过程中，使用Spring Boot处理HTTP请求是非常常见的。如果请求格式不正确，服务器就会返回400 Bad Request错误。我们今天将一起学习如何在Spring Boot中优雅地处理这个错误。

流程概述

我们将通过以下步骤来实现400错误处理：

步骤	描述
1	创建Spring Boot项目
2	编写Controller类
3	创建自定义异常处理器
4	增加全局错误处理机制
5	测试错误处理功能

1. 创建Spring Boot项目

首先，您可以使用[Spring Initializr]( Boot项目。选择您的项目的基础信息并添加以下依赖项：

Spring Web

下载生成的zip包并解压到您的工作目录中。

2. 编写Controller类

在项目中创建一个简单的REST Controller。我们假设我们有一个处理用户请求的接口。

package com.example.demo.controller;

import org.springframework.web.bind.annotation.*;

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

    @PostMapping("/users")
    public String createUser(@RequestBody User user) {
        // 这里将处理用户创建的逻辑
        return "User created: " + user.getName();
    }
}

@RestController：用于处理HTTP请求的控制器类。
@RequestMapping("/api")：为控制器指定的基本路径。
@PostMapping("/users")：映射HTTP POST请求到该方法。
@RequestBody：从请求体中获取JSON数据并转换为User对象。

3. 创建自定义异常处理器

在Spring Boot中，我们可以使用@ControllerAdvice来处理全局性的异常。接下来，我们创建一个自定义的异常处理器。

package com.example.demo.exception;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public ResponseEntity<String> handleValidationExceptions(MethodArgumentNotValidException ex) {
        return ResponseEntity
            .status(HttpStatus.BAD_REQUEST)
            .body("Invalid request: " + ex.getMessage());
    }
}

@ControllerAdvice：用于集中处理控制器中的异常。
@ExceptionHandler(MethodArgumentNotValidException.class)：指明处理特定类型的异常。
ResponseEntity<String>：返回一个包含错误信息的响应实体。

4. 增加全局错误处理机制

对于更通用的400错误，可以针对HttpMessageNotReadableException或MethodArgumentNotValidException进行处理：

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;

// 继续在GlobalExceptionHandler类中添加以下:
@ExceptionHandler(HttpMessageNotReadableException.class)
@ResponseStatus(HttpStatus.BAD_REQUEST)
public ResponseEntity<String> handleHttpMessageNotReadable(HttpMessageNotReadableException ex) {
    return ResponseEntity
        .status(HttpStatus.BAD_REQUEST)
        .body("Malformed JSON request");
}

HttpMessageNotReadableException：处理无法读取请求体时的异常。这通常是由于请求体格式错误引起的。

5. 测试错误处理功能

最后，您可以通过Postman等工具向您的接口发送测试请求。如果您发送一个格式错误的JSON，会看到自定义的错误消息。

{
    "name": 1234 // 错误类型，应该是字符串
}

此时，您将收到400 Bad Request响应，并带有您在异常处理器中定义的消息。

关系图

使用mermaid语法表示系统组件之间的关系：

erDiagram
    USER {
      String name
      String email
    }
    USER ||--o{ REQUEST : creates

旅行图

接下来，这是我们在处理错误时的旅程跟踪：

journey
    title Spring Boot 400 Error Handling Example
    section User sends invalid request
      User submits JSON: 5: Invalid JSON format
    section App processes request
      Spring Boot handles it: 5: Recognizes bad request
    section App returns error
      App responds with 400: 5: Returns error message