已解决：org.springframework.web.HttpMediaTypeNotAcceptableException

文章目录

• • 写在前面
  • 问题描述
  • • 报错原因分析：
  • 解决思路
  • 解决办法
  • • [1. 确保客户端请求的 `Accept` 头正确](#1. 确保客户端请求的 Accept 头正确)
    • [2. 修改 Controller 方法的 `produces` 参数](#2. 修改 Controller 方法的 produces 参数)
    • [3. 配置合适的消息转换器](#3. 配置合适的消息转换器)
    • [4. 检查 Spring 配置中的媒体类型](#4. 检查 Spring 配置中的媒体类型)
    • [5. 其他解决方案](#5. 其他解决方案)
  • 总结

写在前面

在开发过程中，Spring 框架中的 org.springframework.web.HttpMediaTypeNotAcceptableException 是一个常见的异常，它表明服务器无法根据客户端请求提供可接受的媒体类型。本次内容将通过具体的分析，帮助你理解这个错误的成因并提供详细的解决方案。

问题描述

报错代码行：

org.springframework.web.HttpMediaTypeNotAcceptableException

报错原因分析：

1. 不支持的媒体类型 ：客户端请求中的 Accept 头部包含的媒体类型，服务器无法生成符合的响应。
2. Controller 方法没有正确的媒体类型注解 ：可能是 @RequestMapping 或 @GetMapping 等方法的 produces 参数没有与客户端请求的 Accept 类型匹配。
3. 响应内容转换器不支持 ：Spring MVC 中的 HttpMessageConverter 无法找到适合的转换器来处理请求的响应格式。

解决思路

1. 确认客户端的请求头是否正确 ：检查客户端发出的 Accept 头是否包含了服务器能够处理的媒体类型。
2. 检查 Controller 的 produces 属性 ：确保控制器方法的 produces 属性正确配置，以生成客户端可接受的响应类型。
3. 检查 Spring MVC 配置的消息转换器 ：确认 Spring 框架的 HttpMessageConverter 是否支持客户端请求的媒体类型。

解决办法

1. 确保客户端请求的 Accept 头正确

客户端请求应包含正确的 Accept 头部，确保服务器能够提供该类型的响应。例如：

Accept: application/json

2. 修改 Controller 方法的 produces 参数

在 Controller 方法中，明确指定可接受的响应媒体类型：

@RequestMapping(value = "/example", method = RequestMethod.GET, produces = "application/json")
public ResponseEntity<Example> getExample() {
    // 处理逻辑
    return ResponseEntity.ok(new Example());
}

3. 配置合适的消息转换器

如果使用自定义媒体类型或有特定格式要求，需要在 Spring 中添加合适的 HttpMessageConverter。例如，确保 JSON 格式能够被正确转换：

@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
    converters.add(new MappingJackson2HttpMessageConverter());
}

4. 检查 Spring 配置中的媒体类型

确认是否有全局配置未启用合适的媒体类型支持。可以通过以下配置全局处理 JSON 响应：

@Bean
public HttpMessageConverter<Object> createMappingJackson2HttpMessageConverter() {
    return new MappingJackson2HttpMessageConverter();
}

5. 其他解决方案

• 全局异常处理 ：使用 @ExceptionHandler 捕获 HttpMediaTypeNotAcceptableException，并返回友好的提示信息。

@ExceptionHandler(HttpMediaTypeNotAcceptableException.class)
public ResponseEntity<String> handleHttpMediaTypeNotAcceptableException() {
    return ResponseEntity.status(HttpStatus.NOT_ACCEPTABLE).body("不可接受的媒体类型");
}

总结

org.springframework.web.HttpMediaTypeNotAcceptableException 异常通常由于客户端请求的 Accept 头与服务器响应媒体类型不匹配引发。通过正确设置 Accept 头、检查 Controller 方法的 produces 参数，以及确保 HttpMessageConverter 支持相应的格式，能够有效解决该问题。