1. 问题描述
在写SpringBoot项目的时候,由于是前后端分离项目,为了统一接口形式,使用一个类封装了返回数据的形式,但是在测试的时候报异常HttpMessageNotWritableException
后续附上解决办法(有些时候看上去一头雾水的bug可能只是一个很小的问题 so不要放弃~!)
封装类的代码:
package com.xiaobai.realtimesystem.realtimeserver.utils;
/**
* @author xiaobai
* @version 1.0
* @date 2019/5/22 16:43
* @email baijinfeng1202@gmail.com
* @address www.rbx1213.top
* @describe 用于实现接口返回规范的类 所有接口返回值都由该类封装
*/
@SuppressWarnings("ALL")
public class AppResponse<T> {
/**
* 返回值代码 由Status类定义
* @see Status
*/
private int code;
/**
* 返回的附加提示信息
*/
private String msg;
/**
* 返回的数据 若没有则为空
*/
private T data;
/**
* 无参构造必须有
*/
private AppResponse(){ }
/**
* 全参构造方法
* @param code 状态码
* @param msg 附加提示信息
* @param data 数据
*/
private AppResponse(int code,String msg,T data){
this.code = code;
this.msg = msg;
this.data = data;
}
/**
* 成功消息的返回
* +2 重载方法
* @return
*/
public static AppResponse success(){
return builder().code(Status.OK).build();
}
/**
* 成功消息的返回
* +2 重载方法
* @param msg 附加提示消息
* @return
*/
public static AppResponse success(String msg){
return builder().code(Status.OK).msg(msg).build();
}
/**
* 成功消息的返回
* +2 重载方法
* @param msg 附加提示消息
* @param data 需要返回的数据
* @param <T>
* @return
*/
public static <T> AppResponse success(String msg,T data){
return builder().code(Status.OK).msg(msg).data(data).build();
}
/**
* 出错消息提示 该方法要求必须返回错误消息
* @param msg 错误消息
* @return
*/
public static AppResponse error(String msg){
return builder().code(Status.ERR).msg(msg).build();
}
/**
* 产生异常提示 必须返回异常消息
* @param msg 异常消息
* @return
*/
public static AppResponse exception(String msg){
return builder().code(Status.EXCEPTION).msg(msg).build();
}
/**
* 未找到的提示消息返回
* @return
*/
public static AppResponse notFound(){
return builder().code(Status.NOTFOND).build();
}
/**
* 构建一个AppResponseBuilder 对象
* @param <T>
* @return
*/
public static <T> AppResponseBuilder builder(){
return new AppResponseBuilder();
}
/**
* 内部类 用来解决static 不能使用泛型的问题
* @param <T>
*/
private static class AppResponseBuilder<T>{
/**
* 返回值代码 由Status类定义
* @see Status
*/
private int code;
/**
* 返回的附加提示信息
*/
private String msg;
/**
* 返回的数据 若没有则为空
*/
private T data;
/**
* 构建一个AppResponse 对象
* @return
*/
public AppResponse build() {
return new AppResponse<T>(this.code, this.msg, this.data);
}
/**
* 链式调用 设置状态码
* @param status 状态 参考Status
* @return
*/
public AppResponseBuilder code(Status status) {
this.code = status.value;
return this;
}
/**
* 链式调用 设置提示信息
* @param msg 提示信息
* @return
*/
public AppResponseBuilder msg(String msg) {
this.msg = msg;
return this;
}
/**
* 链式调用 设置返回数据
* @param data 返回数据
* @return
*/
public AppResponseBuilder data(T data) {
this.data = data;
return this;
}
}
@Override
public String toString() {
return "AppResponse{" +
"code=" + code +
", msg='" + msg + '\'' +
", data=" + data +
'}';
}
}
postman 测试报错截图:
具体错误(为了方便大家查看是否和我是一样的错误,请ctrl +F 搜索报错关键字!):
Resolved [org.springframework.http.converter.HttpMessageNotWritableException: No converter found for return value of type: class com.xiaobai.realtimesystem.realtimeserver.utils.AppResponse]
{"timestamp":"2019-05-22T09:41:18.799+0000","status":500,"error":"Internal Server Error","message":"No converter found for return value of type: class com.xiaobai.realtimesystem.realtimeserver.utils.AppResponse","trace":"org.springframework.http.converter.HttpMessageNotWritableException: No converter found for return value of type: class com.xiaobai.realtimesystem.realtimeserver.utils.AppResponse\r\n\tat org.springframework.web.servlet.mvc.method.annotation.AbstractMessageConverterMethodProcessor.writeWithMessageConverters(AbstractMessageConverterMethodProcessor.java:233)\r\n\tat org.springframework.web.servlet.mvc.method.annotation.RequestResponseBodyMethodProcessor.handleReturnValue(RequestResponseBodyMethodProcessor.java:180)\r\n\tat org.springframework.web.method.support.HandlerMethodReturnValueHandlerComposite.handleReturnValue(HandlerMethodReturnValueHandlerComposite.java:82)\r\n\tat org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:122)\r\n\tat org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:892)\r\n\tat org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:797)\r\n\tat org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:87)\r\n\tat org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1039)\r\n\tat org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:942)\r\n\tat org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1005)\r\n\tat org.springframework.web.servlet.FrameworkServlet.doPost(FrameworkServlet.java:908)\r\n\tat javax.servlet.http.HttpServlet.service(HttpServlet.java:660)\r\n\tat org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:882)\r\n\tat javax.servlet.http.HttpServlet.service(HttpServlet.java:741)\r\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:231)\r\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)\r\n\tat org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:53)\r\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)\r\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)\r\n\tat org.springframework.web.filter.RequestContextFilter.doFilterInternal(RequestContextFilter.java:99)\r\n\tat org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:107)\r\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)\r\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)\r\n\tat org.springframework.web.filter.FormContentFilter.doFilterInternal(FormContentFilter.java:92)\r\n\tat org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:107)\r\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)\r\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)\r\n\tat org.springframework.web.filter.HiddenHttpMethodFilter.doFilterInternal(HiddenHttpMethodFilter.java:93)\r\n\tat org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:107)\r\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)\r\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)\r\n\tat org.springframework.web.filter.CharacterEncodingFilter.doFilterInternal(CharacterEncodingFilter.java:200)\r\n\tat org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:107)\r\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:193)\r\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:166)\r\n\tat org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:200)\r\n\tat org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:96)\r\n\tat org.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:490)\r\n\tat org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:139)\r\n\tat org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:92)\r\n\tat org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:74)\r\n\tat org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:343)\r\n\tat org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:408)\r\n\tat org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:66)\r\n\tat org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:836)\r\n\tat org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1747)\r\n\tat org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:49)\r\n\tat java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149)\r\n\tat java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624)\r\n\tat org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)\r\n\tat java.lang.Thread.run(Thread.java:748)\r\n","path":"/account/register"}
2. 造成原因:
我的原因是没有为属性生成get/set方法(对,就是这么简单!)导致无法获取属性的值进而导致转换成json报错
网上还有说其他原因的,比如springboot自动配置的json转换器不好用,或者是因为对象中younull值导致转换失败等,具体 原因请大家自行分析。
3.解决办法:
解决办法就很简单了,给所有的属性加上get/set方法即可解决问题!
附上我解决问题后的代码:(代码中get/set集合!)
package com.xiaobai.realtimesystem.realtimeserver.utils;
/**
* @author xiaobai
* @version 1.0
* @date 2019/5/22 16:43
* @email baijinfeng1202@gmail.com
* @address www.rbx1213.top
* @describe 用于实现接口返回规范的类 所有接口返回值都由该类封装
*/
@SuppressWarnings("ALL")
public class AppResponse<T> {
/**
* 返回值代码 由Status类定义
* @see Status
*/
private int code;
/**
* 返回的附加提示信息
*/
private String msg;
/**
* 返回的数据 若没有则为空
*/
private T data;
/**
* 无参构造必须有
*/
private AppResponse(){ }
/**
* 全参构造方法
* @param code 状态码
* @param msg 附加提示信息
* @param data 数据
*/
private AppResponse(int code,String msg,T data){
this.code = code;
this.msg = msg;
this.data = data;
}
//=============================start of get/set 集合========================
public int getCode() {
return code;
}
public void setCode(int code) {
this.code = code;
}
public String getMsg() {
return msg;
}
public void setMsg(String msg) {
this.msg = msg;
}
public T getData() {
return data;
}
public void setData(T data) {
this.data = data;
}
//=============================end of get/set 集合========================
/**
* 成功消息的返回
* +2 重载方法
* @return
*/
public static AppResponse success(){
return builder().code(Status.OK).build();
}
/**
* 成功消息的返回
* +2 重载方法
* @param msg 附加提示消息
* @return
*/
public static AppResponse success(String msg){
return builder().code(Status.OK).msg(msg).build();
}
/**
* 成功消息的返回
* +2 重载方法
* @param msg 附加提示消息
* @param data 需要返回的数据
* @param <T>
* @return
*/
public static <T> AppResponse success(String msg,T data){
return builder().code(Status.OK).msg(msg).data(data).build();
}
/**
* 出错消息提示 该方法要求必须返回错误消息
* @param msg 错误消息
* @return
*/
public static AppResponse error(String msg){
return builder().code(Status.ERR).msg(msg).build();
}
/**
* 产生异常提示 必须返回异常消息
* @param msg 异常消息
* @return
*/
public static AppResponse exception(String msg){
return builder().code(Status.EXCEPTION).msg(msg).build();
}
/**
* 未找到的提示消息返回
* @return
*/
public static AppResponse notFound(){
return builder().code(Status.NOTFOND).build();
}
/**
* 构建一个AppResponseBuilder 对象
* @param <T>
* @return
*/
public static <T> AppResponseBuilder builder(){
return new AppResponseBuilder();
}
/**
* 内部类 用来解决static 不能使用泛型的问题
* @param <T>
*/
private static class AppResponseBuilder<T>{
/**
* 返回值代码 由Status类定义
* @see Status
*/
private int code;
/**
* 返回的附加提示信息
*/
private String msg;
/**
* 返回的数据 若没有则为空
*/
private T data;
/**
* 构建一个AppResponse 对象
* @return
*/
public AppResponse build() {
return new AppResponse<T>(this.code, this.msg, this.data);
}
/**
* 链式调用 设置状态码
* @param status 状态 参考Status
* @return
*/
public AppResponseBuilder code(Status status) {
this.code = status.value;
return this;
}
/**
* 链式调用 设置提示信息
* @param msg 提示信息
* @return
*/
public AppResponseBuilder msg(String msg) {
this.msg = msg;
return this;
}
/**
* 链式调用 设置返回数据
* @param data 返回数据
* @return
*/
public AppResponseBuilder data(T data) {
this.data = data;
return this;
}
}
@Override
public String toString() {
return "AppResponse{" +
"code=" + code +
", msg='" + msg + '\'' +
", data=" + data +
'}';
}
}
再次测试:
问题解决(哈哈,方法还没有实现,但是接口可以正常返回数据就说明bug已经解决了)