GsonHttpMessageConverter序列化泛型报错

概述

在使用GsonHttpMessageConverter的时候，使用ResponseBodyAdvice的beforeBodyWrite包装controller返回值（PageResultWrapper< SdcUserVo>）时，报错。

Could not write JSON: Can not set java.lang.Long field net.ai.cloud.support.factory.page.PageResultWrapper.total to net.ai.cloud.support.databinder.dto.ResponseWrapper; 
nested exception is java.lang.IllegalArgumentException: Can not set java.lang.Long field net.ai.cloud.support.factory.page.PageResultWrapper.total to net.ai.cloud.support.databinder.dto.ResponseWrapper

环境搭建

我的环境

<dependencies>
      <!-- spring boot包 -->
      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-web</artifactId>
          <!-- 排除jackson依赖 -->
          <exclusions>
              <exclusion>
                  <groupId>com.fasterxml.jackson.core</groupId>
                  <artifactId>jackson-databind</artifactId>
              </exclusion>
          </exclusions>
      </dependency>

      <dependency>
          <groupId>org.projectlombok</groupId>
          <artifactId>lombok</artifactId>
      </dependency>

      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-devtools</artifactId>
          <scope>provided</scope>
      </dependency>

      <dependency>
          <groupId>com.google.code.gson</groupId>
          <artifactId>gson</artifactId>
      </dependency>
  </dependencies>

@Data
@Builder
public class UserVo {
    private String name;
    private Integer age;
}
@Data
@Builder
public class ResponseResult<T> {
    private String msg;
    private T response;
}

@ControllerAdvice
public class GsonMessageAdvice implements ResponseBodyAdvice<Object> {

    @Override
    public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
        return true;
    }

    @Override
    public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {

        if(null == o){
            return null;
        }else if(o instanceof ResponseResult){
            return o;
        }else {
            return ResponseResult.builder().msg("test").response(o).build();
        }
    }
}

@RestController
public class GsonController {

    @PostMapping("list")
    public List<UserVo> list(){
        List<UserVo> list = new ArrayList<>();
        list.add(UserVo.builder().age(23).name("xxx").build());
        list.add(UserVo.builder().age(24).name("yyy").build());
        list.add(UserVo.builder().age(25).name("ooo").build());
        list.add(UserVo.builder().age(26).name("aaa").build());
        return list;
    }
}

最后的结果就是
调用接口显示错误，错误码为500

控制台输出错误

上面的图片就是问题所在了，显示是说不能转换某块部分的功能。神奇，因为用的是GsonHttpMessageConverter，所以debug下。

object就是最终要转换成的结果类型，而type是controller返回的结果

利用idea的debug功能，得到这个方法就是问题所在，所以点进去，继续。

如果是上面的jsonWriter错误的话，那么就应该抛出io异常，所以继续toJson方法

在try语句前面的语句更像是在将gson的设置设置到writer中去，所以没什么关系，继续到writer方法中查看，然后就出现直接跳转到finally里面了，这个时候使用idea查看执行结果可以看到

然后可以看到转换异常了com.bokeyuan.gson.domain.ResponseResult cannot be cast to java.util.Collection,所以

上面的基本上就是错误了，也就是错误找到了。
如果走的是下面图中的else的话，那就没事儿，因为这是其他的所有的共同走的

那么解决方法就是

@Configuration
public class MvcConfig implements WebMvcConfigurer {
    @Override
    public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        converters.removeIf(httpMessageConverter -> httpMessageConverter instanceof MappingJackson2HttpMessageConverter);
        // 加这个0是因为可能会出现SpringBoot自动注入的GsonHttpMessageConverter
        converters.add(0, new MyGsonHttpMessageConverter());
    }

    private class MyGsonHttpMessageConverter extends GsonHttpMessageConverter {

        @Override
        protected void writeInternal(Object object, Type type, Writer writer) throws Exception {
            if (type instanceof ParameterizedType && object.getClass().isAssignableFrom(type.getClass())) {
                getGson().toJson(object, type, writer);
            }
            else {
                getGson().toJson(object, writer);
            }
        }
    }
}

结果

这个就算是我的修改，如果不对，烦请指出，不胜感激