【Java报错已解决】org.springframework.http.converter.HttpMessageNotWritableException

最新推荐文章于 2025-05-16 16:55:01 发布

原创最新推荐文章于 2025-05-16 16:55:01 发布 · 2.8k 阅读

21 ·

CC 4.0 BY-SA版权

文章标签：

#java #http #开发语言

在这里插入图片描述

🎬 鸽芷咕：个人主页
🔥 个人专栏: 《C++干货基地》《粉丝福利》

⛺️生活的理想，就是为了理想的生活!

博主简介

博主致力于嵌入式、Python、人工智能、C/C++领域和各种前沿技术的优质博客分享，用最优质的内容带来最舒适的阅读体验！在博客领域获得 C/C++领域优质、CSDN年度征文第一、掘金2023年人气作者、华为云享专家、支付宝开放社区优质博主等头衔。

个人社区 & 个人社群加入点击即可

介绍	加入链接
个人社群	社群内包含各个方向的开发者，有多年开发经验的大佬，一起监督打卡的创作者，开发者、在校生、考研党、均可加入并且咱每周都会有粉丝福利放送保你有所收获，一起加入我们共同进步吧！
个人社区	点击即可加入【咕咕社区】，让我们一起共创社区内容，输出优质文章来让你的写作能力更近一步一起加油！

⛳️ 推荐

前些天发现了一个巨牛的人工智能学习网站，通俗易懂，风趣幽默，忍不住分享一下给大家。点击跳转到网站。

专栏介绍

专栏名称	专栏介绍
科技杂谈	本专栏主要撰写各种科技数码等的评测体验心得，带大家一起体验最前沿的科技机技术产品体验
C++干货基地	本专栏主要撰写C++干货内容和编程技巧，让大家从底层了解C++，把更多的知识由抽象到简单通俗易懂。
《数据结构&算法》	本专栏主要是注重从底层来给大家一步步剖析数据存储的奥秘，一起解密数据在存储中数据的基本存储结构！
《docker容器精解篇》	全面深入解析 docker 容器，从基础到进阶，涵盖原理、操作、实践案例，助您精通 docker。
《linux深造日志》	本专栏的标题灵感是来自linux中系统产生的系统日志。而我们也可以每天输出内容不断前进，以达到精深的境地。
《C语言进阶篇》	想成为编程高手嘛？来看看《C语言进阶篇》成为编程高手的必学知识，带你一步步认识C语言最核心最底层原理。
写作技巧	写作涨粉太慢？不知道如何写博客？想成为一名优质的博主那么这篇专栏你一定要去了解

在这里插入图片描述

引言

在Java开发的Web应用领域，Spring框架无疑是一款强大的利器。然而，即使是这样成熟的框架，在使用过程中也可能出现一些让人头疼的报错，其中org.springframework.http.converter.HttpMessageNotWritableException就是一个典型的例子。这个异常一旦出现，可能会导致数据无法正确地从服务器端发送到客户端，严重影响Web应用的功能和用户体验。那么，面对这个问题，我们该如何深入剖析原因并找到有效的解决方法呢？让我们一同展开探索。

一、问题描述

1.1 报错示例

以下是一个可能导致org.springframework.http.converter.HttpMessageNotWritableException报错的代码示例：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.Date;
import java.util.HashMap;
import java.util.Map;

@SpringBootApplication
@RestController
public class HttpMessageErrorExample {

    @GetMapping("/example")
    public ResponseEntity<Map<String, Object>> getExample() {
        Map<String, Object> response = new HashMap<>();
        response.put("message", "This is an example response");
        response.put("timestamp", new Date());
        // 这里假设我们尝试放入一个不可序列化的对象，比如一个线程对象
        response.put("thread", Thread.currentThread()); 
        return new ResponseEntity<>(response, HttpStatus.OK);
    }

    public static void main(String[] args) {
        SpringApplication.run(HttpMessageErrorExample.class, args);
    }
}

在这个示例中，我们创建了一个简单的Spring Boot应用程序，其中有一个/example的端点。当请求这个端点时，我们尝试返回一个包含多种类型数据的Map，但其中包含了一个不可序列化的Thread对象。

1.2 报错分析

org.springframework.http.converter.HttpMessageNotWritableException主要是在Spring框架尝试将对象转换为HTTP响应消息时出现问题而抛出的，原因如下：

对象序列化问题：
- 在上述示例中，当Spring尝试将包含Thread对象的Map转换为HTTP响应时，由于Thread类没有实现Serializable接口（或者没有合适的序列化机制），无法将其转换为可通过网络传输的格式，从而导致异常。一般来说，Java中的对象如果要在网络中传输或者持久化，需要实现序列化接口，以便将对象状态转换为字节流。
- 即使对象实现了序列化接口，如果对象内部包含了对其他不可序列化对象的引用，也会出现问题。例如，一个自定义的类中包含了一个FileInputStream对象（它是不可序列化的），当这个自定义类作为响应内容时，就会引发异常。
HTTP消息转换器配置问题：
- Spring使用HTTP消息转换器来处理对象到HTTP消息的转换。如果没有合适的消息转换器配置来处理特定类型的对象，就可能导致无法将对象转换为响应消息。例如，如果项目中添加了一个新的自定义数据类型，但没有为其配置相应的消息转换器，当尝试返回该类型的对象时就会报错。
- 消息转换器的顺序也可能影响转换过程。Spring会按照一定的顺序遍历消息转换器来尝试转换对象，如果没有正确配置消息转换器的顺序，可能导致使用了不适合的转换器或者无法找到合适的转换器来处理对象。
响应内容类型问题：
- 如果客户端请求指定了特定的内容类型（如application/json），而Spring无法将响应对象转换为该指定类型的消息，就会抛出异常。例如，当客户端期望接收JSON格式的响应，但服务器端没有合适的JSON消息转换器或者无法将对象正确地转换为JSON格式，就会出现问题。
- 服务器端可能配置了多种内容类型的支持，但在转换过程中可能选择了错误的内容类型或者没有正确地处理多种内容类型的转换情况。例如，同时支持XML和JSON格式，但在某些情况下错误地将对象转换为了一种客户端不期望的格式。

1.3 解决思路

首先，检查响应对象中是否存在不可序列化的对象，确保所有要返回的对象都能正确序列化。
确认HTTP消息转换器的配置是否正确，包括是否有针对特定类型对象的转换器以及转换器的顺序是否合理。
检查响应内容类型相关的问题，确保服务器能够根据客户端请求正确地转换响应对象的格式。

二、解决方法

2.1 方法一：处理对象序列化问题

检查对象的可序列化性：
- 对于要作为响应内容返回的对象，逐一检查其是否实现了Serializable接口。如果没有，根据对象的性质决定是否需要使其可序列化。对于简单的自定义类，可以通过实现Serializable接口来解决。例如：

import java.io.Serializable;

class MySerializableClass implements Serializable {
    private int value;
    // 类的其他成员和方法
}

- 如果对象内部包含对其他对象的引用，检查这些引用对象是否可序列化。如果不可序列化，考虑修改对象结构或者找到一种替代的表示方式。例如，如果一个类中有一个`File`对象引用，可以在返回响应之前将相关的文件信息提取出来（如文件名、路径等），以可序列化的形式返回，而不是直接返回`File`对象。

处理复杂对象的序列化问题：
- 对于一些复杂的对象，如包含动态生成的数据结构或者与特定运行时环境相关的对象（如数据库连接对象等），可能需要自定义序列化逻辑。可以通过实现writeObject和readObject方法（对于Serializable接口）或者使用Externalizable接口来控制对象的序列化和反序列化过程。例如：

class ComplexObject implements Serializable {
    private transient SomeRuntimeObject runtimeObject; // 假设这是一个不可直接序列化的对象

    private int otherValue;

    private void writeObject(java.io.ObjectOutputStream out) throws IOException {
        out.defaultWriteObject();
        // 在这里可以将runtimeObject的关键信息以可序列化的形式写出
        out.writeUTF(runtimeObject.getName()); 
    }

    private void readObject(java.io.ObjectInputStream in) throws IOException, ClassNotFoundException {
        in.defaultReadObject();
        // 在这里根据写出的信息重新创建runtimeObject或其替代表示
        String name = in.readUTF(); 
        runtimeObject = createRuntimeObject(name); 
    }
}

2.2 方法二：检查HTTP消息转换器配置

检查消息转换器的存在性：
- 查看项目的依赖，确认是否包含了必要的消息转换器依赖。例如，如果要处理JSON数据，需要确保jackson-databind等相关JSON消息转换器库被正确引入。在Maven项目中，可以在pom.xml文件中检查依赖项，确保类似以下的依赖存在：

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.13.3</version>
</dependency>

- 对于自定义的数据类型，检查是否创建了相应的自定义消息转换器。如果有新的类需要在HTTP响应中传输，需要实现一个`HttpMessageConverter`接口的实现类来处理该类型的转换。例如：

import org.springframework.http.HttpInputMessage;
import org.springframework.http.HttpOutputMessage;
import org.springframework.http.MediaType;
import org.springframework.http.converter.AbstractHttpMessageConverter;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.http.converter.HttpMessageNotWritableException;
import java.io.IOException;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.List;

class MyCustomMessageConverter extends AbstractHttpMessageConverter<MyCustomType> {

    public MyCustomMessageConverter() {
        super(new MediaType("application", "my-custom-type", Charset.forName("UTF-8")));
    }

    @Override
    protected boolean supports(Class<?> clazz) {
        return MyCustomType.class.isAssignableFrom(clazz);
    }

    @Override
    protected MyCustomType readInternal(Class<? extends MyCustomType> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException {
        // 实现从输入消息读取自定义类型对象的逻辑
        return null;
    }

    @Override
    protected void writeInternal(MyCustomType value, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException {
        // 实现将自定义类型对象写入输出消息的逻辑
        }
}

调整消息转换器的顺序：
- 在Spring配置中，可以指定消息转换器的顺序。如果存在多种消息转换器可能适用于某个对象的转换，可以通过调整顺序来确保使用最合适的转换器。在Java配置中，可以通过WebMvcConfigurer接口的configureMessageConverters方法来调整顺序。例如：

import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import java.util.List;

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        // 假设我们有一个自定义消息转换器myCustomConverter和其他默认转换器
        converters.add(0, myCustomConverter); 
        // 将自定义转换器放在列表开头，优先使用
    }
}

2.3 方法三：解决响应内容类型问题

检查内容类型协商机制：
- Spring使用内容类型协商机制来根据客户端请求确定响应的内容类型。检查ContentNegotiationConfigurer的配置（如果使用Java配置）。例如：

import org.springframework.context.annotation.Configuration;
import org.springframework.http.MediaType;
import org.springframework.web.servlet.config.annotation.ContentNegotiationConfigurer;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Override
    public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
        // 可以指定默认的内容类型，例如JSON
        configurer.defaultContentType(MediaType.APPLICATION_JSON); 
        // 或者设置基于请求参数、头信息等的内容类型协商策略
        configurer.parameterName("format"); 
    }
}

- 确保内容类型协商机制能够正确地根据客户端请求确定响应内容类型。如果客户端通过请求头（如`Accept`头）指定了内容类型，检查服务器端是否能够正确解析和响应。

处理多种内容类型支持问题：
- 如果服务器端支持多种内容类型（如XML和JSON），检查在转换响应对象时是否能够正确处理不同内容类型的请求。可以在消息转换器中添加对不同内容类型的处理逻辑。例如，在JSON消息转换器中，确保能够正确地将对象转换为JSON格式，在XML消息转换器中（如果有），同样要正确处理XML格式的转换。
- 对于存在多种内容类型支持的情况，检查是否有逻辑来避免在转换过程中出现冲突。例如，当客户端请求application/json但服务器端错误地尝试将对象转换为XML格式，需要检查这种错误的转换逻辑并修复。可以通过更精确的内容类型协商和消息转换器的配置来解决。

2.4 方法四：检查异常处理和日志记录

增强异常处理：
- 在应用程序中，可以添加更详细的异常处理逻辑来捕获org.springframework.http.converter.HttpMessageNotWritableException，并提供更有帮助的错误信息。例如，可以在全局异常处理类（实现@ControllerAdvice）中添加以下方法：

import org.springframework.http.HttpStatus;
import org.springframework.http.converter.HttpMessageNotWritableException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(HttpMessageNotWritableException.class)
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    public String handleHttpMessageNotWritableException(HttpMessageNotWritableException e) {
        return "Error while writing HTTP message: " + e.getMessage();
    }
}

- 这样可以在异常发生时返回更友好的错误信息给客户端，同时也可以在异常处理方法中添加更多的日志记录逻辑，以便更好地分析问题。

完善日志记录：
- 检查项目中的日志配置，确保在消息转换过程中能够记录足够详细的信息。可以在Spring的日志配置中（如logback.xml）设置合适的日志级别和输出格式。例如，将与HTTP消息转换相关的类（如HttpMessageConverter的实现类）的日志级别设置为DEBUG或TRACE，以便在出现问题时查看详细的转换过程。
- 分析日志信息，查找可能导致无法写入HTTP消息的线索。例如，日志可能显示某个消息转换器在转换特定类型对象时出现了问题，或者在内容类型协商过程中的异常情况，这些信息可以帮助进一步定位和解决问题。

三、其他解决方法

检查请求和响应拦截器：
- 如果应用程序中使用了请求和响应拦截器（实现HandlerInterceptor接口），检查这些拦截器是否对请求或响应对象进行了修改，从而影响了消息的可写性。例如，一个拦截器可能在请求处理过程中添加了一些不可序列化的属性到请求对象中，当这些属性在响应处理过程中被包含在返回对象中时，就可能导致问题。
- 确保拦截器的逻辑不会干扰正常的消息转换过程。可以在拦截器中添加日志记录或调试语句来检查其对请求和响应对象的影响。如果发现拦截器有问题，可以修改其逻辑或者暂时移除拦截器来确定是否是拦截器导致的异常。
检查运行时环境和服务器配置：
- 考虑运行时环境对消息转换的影响。例如，如果应用程序在容器环境（如Docker容器）中运行，检查容器的配置是否限制了某些功能或资源，从而影响了消息转换器的正常运行。可能需要调整容器的内存限制、网络设置等。
- 对于应用服务器（如Tomcat、Jetty等）的配置，检查是否有与HTTP消息处理相关的设置可能影响了转换过程。例如，服务器可能有默认的内容类型设置或者对消息大小的限制，这些可能与Spring的消息转换机制相互作用，导致异常。可以根据服务器的文档来调整相关配置。

四总结

本文围绕org.springframework.http.converter.HttpMessageNotWritableException这个Java报错展开了深入探讨。通过具体的代码示例展示了可能出现异常的场景，详细分析了导致该异常的原因，包括对象序列化问题、HTTP消息转换器配置问题和响应内容类型问题等。针对这些原因，我们提出了一系列的解决方法，如处理对象序列化问题（检查可序列化性和处理复杂对象的序列化）、检查HTTP消息转换器配置（检查转换器的存在性和调整顺序）、解决响应内容类型问题（检查内容类型协商机制和处理多种内容类型支持）以及检查异常处理和日志记录。此外，还介绍了其他相关的解决方法，如检查请求和响应拦截器以及检查运行时环境和服务器配置。当再次遇到org.springframework.http.converter.HttpMessageNotWritableException异常时，开发者和环境配置者可以按照上述步骤，全面系统地排查问题，从对象本身到消息转换机制，再到运行时环境和服务器配置等多个方面入手，从而快速有效地解决问题，确保HTTP消息能够正确地从服务器端发送到客户端，保障Web应用的正常运行。