【Java】已解决：org.springframework.web.HttpMediaTypeNotSupportedException

屿小夏

发布于 2024-09-15 08:14:20

1.8K0

已解决：org.springframework.web.HttpMediaTypeNotSupportedException

一、分析问题背景

在使用Spring框架开发Web应用时，可能会遇到org.springframework.web.HttpMediaTypeNotSupportedException错误。这通常发生在客户端发送的请求Content-Type不被服务器端支持时。例如，当你在开发一个RESTful API，并希望接收JSON格式的数据时，如果客户端发送的是其他格式的数据（如XML），则可能会导致此错误。

场景描述

假设你正在开发一个用户注册功能，客户端通过POST请求将用户数据发送到服务器。你的控制器方法如下所示：

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

    @PostMapping(consumes = "application/json")
    public ResponseEntity<String> registerUser(@RequestBody User user) {
        // 注册用户逻辑
        return ResponseEntity.ok("User registered successfully");
    }
}

如果客户端发送的Content-Type不是application/json，则会抛出HttpMediaTypeNotSupportedException。

二、可能出错的原因

Content-Type不匹配：客户端发送的请求Content-Type不是服务器预期的格式。
缺少合适的HttpMessageConverter：Spring没有配置能够处理客户端发送的数据格式的HttpMessageConverter。
代码中定义的consumes属性不正确：控制器方法中定义的consumes属性与客户端发送的数据格式不匹配。

三、错误代码示例

以下是一个可能导致该错误的代码示例：

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

    @PostMapping(consumes = "application/json")
    public ResponseEntity<String> registerUser(@RequestBody User user) {
        // 注册用户逻辑
        return ResponseEntity.ok("User registered successfully");
    }
}

假设客户端发送的请求头如下：

POST /users HTTP/1.1
Host: example.com
Content-Type: application/xml

由于Content-Type为application/xml，而服务器预期的是application/json，因此会抛出HttpMediaTypeNotSupportedException。

四、正确代码示例

为了避免此错误，确保客户端发送的请求Content-Type与服务器端预期的格式一致。以下是一个正确的代码示例：

客户端请求

客户端应该发送如下请求：

POST /users HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "username": "john_doe",
    "password": "secure_password"
}

服务器端代码

确保控制器方法能够处理application/json格式的数据：

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

    @PostMapping(consumes = "application/json")
    public ResponseEntity<String> registerUser(@RequestBody User user) {
        // 注册用户逻辑
        return ResponseEntity.ok("User registered successfully");
    }
}

此外，可以配置Spring应用以支持多种数据格式：

@Configuration
public class WebConfig implements WebMvcConfigurer {

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