Spring RestController返回错误的内容类型

基础概念

@RestController 是 Spring 框架中的一个注解，用于定义一个 RESTful 风格的控制器。它结合了 @Controller 和 @ResponseBody 的功能，使得每个方法返回的对象都会被直接写入 HTTP 响应体中，而不是渲染视图。

类型

@RestController 可以返回多种类型的内容，包括但不限于：

字符串
基本数据类型
自定义对象
集合
响应实体（如 ResponseEntity）

应用场景

适用于构建 RESTful API，特别是在前后端分离的架构中，后端通过返回 JSON 或 XML 等格式的数据供前端使用。

问题及解决方法

问题：返回错误的内容类型

原因：

配置错误：可能是在 Spring 配置中错误地设置了默认的内容类型。
方法返回类型错误：方法返回了不支持的内容类型。
序列化问题：Spring 无法正确地将对象序列化为指定的内容类型。

解决方法：

检查配置：

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
        configurer.defaultContentType(MediaType.APPLICATION_JSON);
    }
}

确保默认的内容类型设置正确。

检查方法返回类型：

@RestController
public class ExampleController {

    @GetMapping(value = "/example", produces = MediaType.APPLICATION_JSON_VALUE)
    public ExampleResponse getExample() {
        return new ExampleResponse();
    }
}

确保方法上使用了 produces 属性来指定返回的内容类型。

处理序列化问题：

如果 Spring 无法正确序列化对象，可以自定义序列化器：

@RestController
public class ExampleController {

    @Autowired
    private ExampleService exampleService;

    @GetMapping(value = "/example", produces = MediaType.APPLICATION_JSON_VALUE)
    public ExampleResponse getExample() {
        ExampleResponse response = exampleService.getExample();
        return new ExampleResponseAdapter(response);
    }
}

class ExampleResponseAdapter {
    private ExampleResponse response;

    public ExampleResponseAdapter(ExampleResponse response) {
        this.response = response;
    }

    // 自定义 getter 和 setter 方法
}