SpringBoot RestController 空对象导致序列化异常

问题描述

在SpringBoot使用RestController返回jackson序列化数据时出现了序列化异常，大体报错信息如下：

2022-04-04 16:15:22.485 ERROR 53776 --- [nio-8181-exec-2] o.a.c.c.C.[.[.[/].[dispatcherServlet]    : Servlet.service() for servlet [dispatcherServlet] in context with path [] threw exception [Request processing failed; nested exception is org.springframework.http.converter.HttpMessageConversionException: Type definition error: [simple type, class java.io.FileDescriptor]; nested exception is com.fasterxml.jackson.databind.exc.InvalidDefinitionException: No serializer found for class java.io.FileDescriptor and no properties discovered to create BeanSerializer (to avoid exception, disable SerializationFeature.FAIL_ON_EMPTY_BEANS) (through reference chain: java.util.HashMap["one"]->java.util.HashMap["zlzs"]->org.springframework.web.multipart.commons.CommonsMultipartFile[0]->org.springframework.web.multipart.commons.CommonsMultipartFile["fileItem"]->org.apache.commons.fileupload.disk.DiskFileItem["inputStream"]->java.io.FileInputStream["fd"])] with root cause
 
com.fasterxml.jackson.databind.exc.InvalidDefinitionException: No serializer found for class java.io.FileDescriptor and no properties discovered to create BeanSerializer (to avoid exception, disable SerializationFeature.FAIL_ON_EMPTY_BEANS) (through reference chain: java.util.HashMap["one"]->java.util.HashMap["zlzs"]->org.springframework.web.multipart.commons.CommonsMultipartFile[0]->org.springframework.web.multipart.commons.CommonsMultipartFile["fileItem"]->org.apache.commons.fileupload.disk.DiskFileItem["inputStream"]->java.io.FileInputStream["fd"])

问题分析

其中出现的关键报错信息为 no properties discovered to create BeanSerializer (to avoid exception, disable SerializationFeature.FAIL_ON_EMPTY_BEANS)
出现原因经过查阅应该是由于要序列化的数据是个空对象，如 new object()，而追究到实际情况大体是由于在使用 web3j 的 java-sdk 时尝试减少返回数据而将某个参数改为false使得部分数据未进行渲染引起的。实际调用代码如下：

// 是由于第二个参数false
web3j.getBlockByNumber(DefaultBlockParameter.valueOf(1),false)
.send().getBlock();

解决方案 1

重写 WebMvcConfigurationSupport 中的 configureMessageConverters 方法按照报错信息的提示进行更改，具体代码如下：

@Configuration
public class GlobalConfig extends WebMvcConfigurationSupport {
    @Override
    protected void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        super.configureMessageConverters(converters);
        converters.add(mappingJackson2HttpMessageConverter());
    }

    // 解决序列化空对象问题
    private MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter() {
        ObjectMapper mapper = new ObjectMapper();
        // 关键代码
        mapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
        MappingJackson2HttpMessageConverter converter =
                new MappingJackson2HttpMessageConverter(mapper);
        return converter;
    }
}

解决方案 2

[application.properties](http://application.properties) 中添加

spring.jackson.serialization.FAIL_ON_EMPTY_BEANS=false