一文詳解Spring中的HttpMessageNotReadableException異常處理

更新時間：2025年02月28日 08:13:55 作者：碼農阿豪@新空間

這篇文章主要為大家詳細介紹了Spring中的HttpMessageNotReadableException異常,分析其產生的原因并通過實際代碼示例展示如何有效地捕獲和處理這一異常,感興趣的可以了解下

在現(xiàn)代的Web開發(fā)中，Spring框架因其強大的功能和靈活的配置而廣受歡迎。然而，隨著應用復雜度的增加，異常處理成為了開發(fā)過程中不可忽視的一部分。本文將深入探討Spring框架中的HttpMessageNotReadableException異常，分析其產生的原因，并通過實際代碼示例展示如何有效地捕獲和處理這一異常。

1. 異常概述

1.1 什么是HttpMessageNotReadableException

HttpMessageNotReadableException是Spring框架中的一個異常類，屬于org.springframework.http.converter包。它通常在以下情況下拋出：

請求體解析失敗：當客戶端發(fā)送的HTTP請求體（通常是JSON或XML格式）無法正確解析為服務器端期望的對象時，可能會拋出此異常。例如，請求體的JSON格式不正確，或者字段類型不匹配。

反序列化失敗：當Spring嘗試將請求體反序列化為目標對象時，如果反序列化過程中出現(xiàn)問題（如JSON字段與目標對象的字段類型不匹配），也會拋出此異常。

1.2 異常的產生場景

在實際開發(fā)中，HttpMessageNotReadableException異常通常出現(xiàn)在以下幾種場景中：

JSON格式錯誤：客戶端發(fā)送的JSON數(shù)據(jù)格式不正確，例如缺少必要的字段、字段類型不匹配等。

請求體為空：客戶端發(fā)送的請求體為空，而服務器端期望接收一個非空的請求體。

反序列化錯誤：請求體中的JSON數(shù)據(jù)無法正確映射到目標對象的字段上，例如JSON中的字符串無法轉換為目標對象的日期類型。

2. 異常處理機制

2.1 使用@ExceptionHandler注解

在Spring中，我們可以使用@ExceptionHandler注解來捕獲和處理特定的異常。@ExceptionHandler注解可以用在控制器類中，用于定義處理特定異常的方法。當控制器中拋出指定的異常時，Spring會自動調用對應的異常處理方法。

2.2 捕獲HttpMessageNotReadableException

以下是一個捕獲HttpMessageNotReadableException異常的示例代碼：

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler({HttpMessageNotReadableException.class})
    public ResultVO messageExceptionHandler(HttpMessageNotReadableException e) {
        Throwable cause = e.getCause();
        if (cause instanceof JsonMappingException) {
            List<JsonMappingException.Reference> list = ((JsonMappingException) cause).getPath();
            if (!CollectionUtils.isEmpty(list)) {
                JsonMappingException.Reference reference = list.get(0);
                String result = JSON.toJSONString(reference.getFrom());
                log.error("http請求參數(shù)轉換異常: " + result);
            }
        }
        return ResultUtil.error(ErrorEnum.DATA_FORMAT_ERROR);
    }
}

2.3 代碼解析

讓我們逐行解析上述代碼：

@RestControllerAdvice：這是一個組合注解，結合了@ControllerAdvice和@ResponseBody。它用于定義全局的異常處理類，并且所有的異常處理方法都會返回JSON格式的響應。

@ExceptionHandler({HttpMessageNotReadableException.class})：這個注解用于指定處理HttpMessageNotReadableException異常的方法。當控制器中拋出HttpMessageNotReadableException異常時，Spring會自動調用這個方法。

messageExceptionHandler方法：這是處理HttpMessageNotReadableException異常的具體方法。它接收一個HttpMessageNotReadableException類型的參數(shù)，并返回一個ResultVO對象。

Throwable cause = e.getCause()：獲取異常的根因。HttpMessageNotReadableException通常是由其他異常引起的，例如JsonMappingException。

if (cause instanceof JsonMappingException)：檢查根因是否是JsonMappingException。如果是，則表示在JSON反序列化過程中發(fā)生了映射錯誤。

List<JsonMappingException.Reference> list = ((JsonMappingException) cause).getPath()：獲取映射錯誤的路徑信息。JsonMappingException.Reference包含了映射錯誤的詳細信息，例如出錯的字段名和字段值。

if (!CollectionUtils.isEmpty(list))：檢查路徑信息是否為空。如果不為空，則獲取第一個錯誤路徑，并將其轉換為JSON字符串。

log.error("http請求參數(shù)轉換異常: " + result)：記錄錯誤日志，方便后續(xù)排查問題。

return ResultUtil.error(ErrorEnum.DATA_FORMAT_ERROR)：返回一個表示數(shù)據(jù)格式錯誤的ResultVO對象。ResultUtil是一個工具類，用于生成標準的錯誤響應。

2.4 返回結果

ResultVO是一個通用的響應對象，通常包含以下字段：

code：錯誤碼，用于標識錯誤的類型。
message：錯誤信息，用于描述錯誤的詳細信息。
data：響應數(shù)據(jù)，通常為空。

以下是一個ResultVO的示例：

public class ResultVO<T> {
    private int code;
    private String message;
    private T data;

    // 省略getter和setter方法
}

ErrorEnum是一個枚舉類，用于定義常見的錯誤類型。以下是一個ErrorEnum的示例：

public enum ErrorEnum {
    DATA_FORMAT_ERROR(1001, "數(shù)據(jù)格式錯誤"),
    PARAMETER_ERROR(1002, "參數(shù)錯誤"),
    // 其他錯誤類型
    ;

    private int code;
    private String message;

    // 省略getter和setter方法
}

ResultUtil是一個工具類，用于生成標準的錯誤響應。以下是一個ResultUtil的示例：

public class ResultUtil {
    public static <T> ResultVO<T> error(ErrorEnum errorEnum) {
        ResultVO<T> resultVO = new ResultVO<>();
        resultVO.setCode(errorEnum.getCode());
        resultVO.setMessage(errorEnum.getMessage());
        return resultVO;
    }
}

3. 實際應用

3.1 場景描述

假設我們有一個RESTful API，用于接收用戶注冊請求?？蛻舳诵枰l(fā)送一個JSON格式的請求體，包含用戶的姓名、郵箱和密碼。服務器端期望接收一個User對象，并將其保存到數(shù)據(jù)庫中。

以下是一個User類的示例：

public class User {
    private String name;
    private String email;
    private String password;

    // 省略getter和setter方法
}

3.2 控制器代碼

以下是一個處理用戶注冊請求的控制器代碼：

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

    @PostMapping("/register")
    public ResultVO<User> register(@RequestBody User user) {
        // 處理用戶注冊邏輯
        return ResultUtil.success(user);
    }
}

3.3 異常處理

如果客戶端發(fā)送的JSON數(shù)據(jù)格式不正確，例如缺少必要的字段或字段類型不匹配，Spring會拋出HttpMessageNotReadableException異常。此時，我們之前定義的全局異常處理類GlobalExceptionHandler會自動捕獲并處理這個異常，返回一個表示數(shù)據(jù)格式錯誤的ResultVO對象。

3.4 測試用例

以下是一個測試用例，用于模擬客戶端發(fā)送錯誤的JSON數(shù)據(jù)：

@Test
public void testRegisterWithInvalidJson() {
    String invalidJson = "{\"name\": \"John\", \"email\": \"john@example.com\"}"; // 缺少password字段
    mockMvc.perform(post("/users/register")
            .contentType(MediaType.APPLICATION_JSON)
            .content(invalidJson))
            .andExpect(status().isBadRequest())
            .andExpect(jsonPath("$.code").value(1001))
            .andExpect(jsonPath("$.message").value("數(shù)據(jù)格式錯誤"));
}

在這個測試用例中，我們模擬了一個缺少password字段的JSON請求體。當發(fā)送這個請求時，服務器端會拋出HttpMessageNotReadableException異常，并返回一個表示數(shù)據(jù)格式錯誤的ResultVO對象。