StringBoot自定义统一响应类,返回值类型为String出现异常问题分析
通常我们会对接口返回数据进行统一封装如图
然后实现ResponseBodyAdvice接口重写supports()和**beforeBodyWrite()**如图
这就可以对请求接口的响应进行封装了 ,但是遇到返回值类型为String时会抛出异常
为什么会出现这个问题了 当mvc配置文件初始化时我们的消息转换器messageConverters会默认添加这十种消息转换器(当然你也可以自己定义)
当我们返回值类型为String时可以看到我们进行消息转换的对象为StringHttpMessageConverter
然后我们可以看到
在StringHttpMessageConverter这个类的这个方法报错。
当我们返回值类型为String时,converter是StringHttpMessageConverter这个对象
当调用write()方法时StringHttpMessageConverter这个类本身没有这个方法, 会去走到父类AbstractGenericHttpMessageConverter的write()方法,父类中的write() 会调用this.addDefaultHeaders(headers, t, contentType); 而当前这个对象为StringHttpMessageConverter,我们可以看到当传入这个write()的t参数是对象 而StringHttpMessageConverter的addDefaultHeaders()这个方法中接受的是String 所以出现ClassCastException
解决办法
第一种添加一个String返回类型判断 将对象转String返回
` @Override
public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
//格式化返回参数
if (body instanceof ActionResult) {
//接口已处理的类型 不做格式化
} else if (body instanceof List) {
PageResult<Object> pageResult = new PageResult<>();
pageResult.setLists((List<Object>) body);
ActionResult actionResult = new ActionResult();
actionResult.setData(pageResult);
return actionResult;
}else if(body instanceof String){
ActionResult actionResult = new ActionResult();
actionResult.setData(body);
String s = JSONObject.toJSONString(actionResult);
return s;
} else {
ActionResult actionResult = new ActionResult();
actionResult.setData(body);
return actionResult;
}
return body;
}`
第二种修改配置文件
@Configuration
public class MyWebConfiguration implements WebMvcConfigurer {
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
// 第一种方式是将 json 处理的转换器放到第一位并且是继承GenericHttpMessageConverter,这样json转换器就会进行处理 String转换器就处理不了了。
//converters.add(0, new MappingJackson2HttpMessageConverter());
// 第二种就是把String类型的转换器去掉,会找到后面的转换器进行转换
// converters.removeIf(httpMessageConverter -> httpMessageConverter.getClass() == StringHttpMessageConverter.class);
}
}