点击上方蓝色“方志朋”，选择“设为星标”
回复“666”获取独家整理的学习资料！
无侵入式 统一返回JSON格式
其实本没有没打算写这篇博客的，但还是要写一下写这篇博客的起因是因为，现在呆着的这家公司居然没有统一的API返回格式?，询问主管他居然告诉我用HTTP状态码就够用了（fxxk），天哪HTTP状态码真的够用吗？
在仔细的阅读了项目源码后发现，在API请求的是居然没有业务异常（黑人问好）。好吧 居然入坑了只能遵照项目风格了，懒得吐槽了。
因为项目已经开发了半年多了, 要是全部接口都做修改工作量还是挺大的, 只能用这种无侵入式的方案来解决.
“项目源代码: /469753862/galaxy-blogs/tree/master/code/responseResult
定义JSON格式
定义返回JSON格式
后端返回给前端一般情况下使用JSON格式, 定义如下
{"code":200,"message":"OK","data":{}}
code: 返回状态码
message: 返回信息的描述
data: 返回值
定义JavaBean字段
定义状态码枚举类
@ToString@GetterpublicenumResultStatus{SUCCESS(HttpStatus.OK,200,"OK"),BAD_REQUEST(HttpStatus.BAD_REQUEST,400,"BadRequest"),INTERNAL_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR,500,"InternalServerError"),;/**返回的HTTP状态码,符合http请求*/privateHttpStatushttpStatus;/**业务异常码*/privateIntegercode;/**业务异常信息描述*/privateStringmessage;ResultStatus(HttpStatushttpStatus,Integercode,Stringmessage){this.httpStatus=httpStatus;this.code=code;this.message=message;}}
状态码和信息以及http状态码就能一一对应了便于维护, 有同学有疑问了为什么要用到http状态码呀,因为我要兼容项目以前的代码, 没有其他原因, 当然其他同学不喜欢http状态码的可以吧源码中HttpStatus给删除了
定义返回体类
@Getter@ToStringpublicclassResult<T>{/**业务错误码*/privateIntegercode;/**信息描述*/privateStringmessage;/**返回参数*/privateTdata;privateResult(ResultStatusresultStatus,Tdata){this.code=resultStatus.getCode();this.message=resultStatus.getMessage();this.data=data;}/**业务成功返回业务代码和描述信息*/publicstaticResult<Void>success(){returnnewResult<Void>(ResultStatus.SUCCESS,null);}/**业务成功返回业务代码,描述和返回的参数*/publicstatic<T>Result<T>success(Tdata){returnnewResult<T>(ResultStatus.SUCCESS,data);}/**业务成功返回业务代码,描述和返回的参数*/publicstatic<T>Result<T>success(ResultStatusresultStatus,Tdata){if(resultStatus==null){returnsuccess(data);}returnnewResult<T>(resultStatus,data);}/**业务异常返回业务代码和描述信息*/publicstatic<T>Result<T>failure(){returnnewResult<T>(ResultStatus.INTERNAL_SERVER_ERROR,null);}/**业务异常返回业务代码,描述和返回的参数*/publicstatic<T>Result<T>failure(ResultStatusresultStatus){returnfailure(resultStatus,null);}/**业务异常返回业务代码,描述和返回的参数*/publicstatic<T>Result<T>failure(ResultStatusresultStatus,Tdata){if(resultStatus==null){returnnewResult<T>(ResultStatus.INTERNAL_SERVER_ERROR,null);}returnnewResult<T>(resultStatus,data);}}
因为使用构造方法进行创建对象太麻烦了, 我们使用静态方法来创建对象这样简单明了
Result实体返回测试
@RestController@RequestMapping("/hello")publicclassHelloController{privatestaticfinalHashMap<String,Object>INFO;static{INFO=newHashMap<>();INFO.put("name","galaxy");INFO.put("age","70");}@GetMapping("/hello")publicMap<String,Object>hello(){returnINFO;}@GetMapping("/result")@ResponseBodypublicResult<Map<String,Object>>helloResult(){returnResult.success(INFO);}}
到这里我们已经简单的实现了统一JSON格式了, 但是我们也发现了一个问题了,想要返回统一的JSON格式需要返回Result<Object>才可以, 我明明返回Object可以了, 为什么要重复劳动, 有没有解决方法, 当然是有的啦, 下面我们开始优化我们的代码吧
统一返回JSON格式进阶-全局处理(@RestControllerAdvice)
我师傅经常告诉我的一句话: “你就是一个小屁孩, 你遇到的问题都已经不知道有多少人遇到过了, 你会想到的问题, 已经有前辈想到过了. 你准备解决的问题, 已经有人把坑填了”。是不是很鸡汤, 是不是很励志, 让我对前辈们充满着崇拜, 事实上他对我说的是: “自己去百度”, 这五个大字, 其实这五个大字已经说明上明的B话了, 通过不断的百度和Google发现了很多的解决方案.
我们都知道使用@ResponseBody注解会把返回Object序列化成JSON字符串,就先从这个入手吧, 大致就是在序列化前把Object赋值给Result<Object>就可以了, 大家可以观摩org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice和org.springframework.web.bind.annotation.ResponseBody
@ResponseBody继承类
我们已经决定从@ResponseBody注解入手了就创建一个注解类继承@ResponseBody, 很干净什么都没有哈哈,@ResponseResultBody 可以标记在类和方法上这样我们就可以跟自由的进行使用了
@Retention(RetentionPolicy.RUNTIME)@Target({ElementType.TYPE,ElementType.METHOD})@Documented@ResponseBodypublic@interfaceResponseResultBody{}
ResponseBodyAdvice继承类
@RestControllerAdvicepublicclassResponseResultBodyAdviceimplementsResponseBodyAdvice<Object>{privatestaticfinalClass<?extendsAnnotation>ANNOTATION_TYPE=ResponseResultBody.class;/***判断类或者方法是否使用了@ResponseResultBody*/@Overridepublicbooleansupports(MethodParameterreturnType,Class<?extendsHttpMessageConverter<?>>converterType){returnAnnotatedElementUtils.hasAnnotation(returnType.getContainingClass(),ANNOTATION_TYPE)||returnType.hasMethodAnnotation(ANNOTATION_TYPE);}/***当类或者方法使用了@ResponseResultBody就会调用这个方法*/@OverridepublicObjectbeforeBodyWrite(Objectbody,MethodParameterreturnType,MediaTypeselectedContentType,Class<?extendsHttpMessageConverter<?>>selectedConverterType,ServerHttpRequestrequest,ServerHttpResponseresponse){//防止重复包裹的问题出现if(bodyinstanceofResult){returnbody;}returnResult.success(body);}}
RestControllerAdvice返回测试
@RestController@RequestMapping("/helloResult")@ResponseResultBodypublicclassHelloResultController{privatestaticfinalHashMap<String,Object>INFO;static{INFO=newHashMap<String,Object>();INFO.put("name","galaxy");INFO.put("age","70");}@GetMapping("hello")publicHashMap<String,Object>hello(){returnINFO;}/**测试重复包裹*/@GetMapping("result")publicResult<Map<String,Object>>helloResult(){returnResult.success(INFO);}@GetMapping("helloError")publicHashMap<String,Object>helloError()throwsException{thrownewException("helloError");}@GetMapping("helloMyError")publicHashMap<String,Object>helloMyError()throwsException{thrownewResultException();}}
是不是很神奇, 直接返回Object就可以统一JSON格式了, 就不用每个返回都返回Result<T>对象了,直接让SpringMVC帮助我们进行统一的管理, 简直完美
只想看接口哦, helloError和helloMyError是会直接抛出异常的接口,我好像没有对异常返回进行统一的处理哦
统一返回JSON格式进阶-异常处理(@ExceptionHandler))
卧槽, 异常处理, 差点把这茬给忘了, 这个异常处理就有很多方法了,先看看我师傅的处理方式, 我刚拿到这个代码的时候很想吐槽, 对异常类的处理这么残暴的吗, 直接用PrintWriter直接输出结果, 果然是老师傅, 我要是有100个异常类, 不得要写100个 if else了. 赶紧改改睡吧
@ConfigurationpublicclassMyExceptionHandlerimplementsHandlerExceptionResolver{publicModelAndViewresolveException(HttpServletRequestrequest,HttpServletResponseresponse,Objecthandler,Exceptionex){PrintWriterout=getPrintWrite(response);if(exinstanceofXXXException){out.write(JsonUtil.formatJson(ResultEnum.PAY_ERROR.getCode(),ex.getMessage()));}else{out.write(JsonUtil.formatJson(ResultEnum.FAIL.getCode(),"服务器异常"));}if(null!=out){out.close();}returnmav;}privatePrintWritergetPrintWrite(HttpServletResponseresponse){PrintWriterout=null;try{response.setHeader("Content-type","text/html;charset=UTF-8");response.setCharacterEncoding("UTF-8");out=response.getWriter();}catch(IOExceptione){log.error("PrintWriterisexception",e);}returnout;}}
上面的代码看看还是没有问题的, 别学过去哦,
异常处理@ResponseStatus(不推荐)
@ResponseStatus用法如下,可用在Controller类和Controller方法上以及Exception类上但是这样的工作量还是挺大的
@RestController@RequestMapping("/error")@ResponseStatus(value=HttpStatus.INTERNAL_SERVER_ERROR,reason="Java的异常")publicclassHelloExceptionController{privatestaticfinalHashMap<String,Object>INFO;static{INFO=newHashMap<String,Object>();INFO.put("name","galaxy");INFO.put("age","70");}@GetMapping()publicHashMap<String,Object>helloError()throwsException{thrownewException("helloError");}@GetMapping("helloJavaError")@ResponseStatus(value=HttpStatus.INTERNAL_SERVER_ERROR,reason="Java的异常")publicHashMap<String,Object>helloJavaError()throwsException{thrownewException("helloError");}@GetMapping("helloMyError")publicHashMap<String,Object>helloMyError()throwsException{thrownewMyException();}}@ResponseStatus(value=HttpStatus.INTERNAL_SERVER_ERROR,reason="自己定义的异常")classMyExceptionextendsException{}
全局异常处理@ExceptionHandler(推荐)
把ResponseResultBodyAdvice类进行改造一下,代码有点多了
主要参考了org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler#handleException()方法, 有空可以看一下
@Slf4j@RestControllerAdvicepublicclassResponseResultBodyAdviceimplementsResponseBodyAdvice<Object>{privatestaticfinalClass<?extendsAnnotation>ANNOTATION_TYPE=ResponseResultBody.class;/**判断类或者方法是否使用了@ResponseResultBody*/@Overridepublicbooleansupports(MethodParameterreturnType,Class<?extendsHttpMessageConverter<?>>converterType){returnAnnotatedElementUtils.hasAnnotation(returnType.getContainingClass(),ANNOTATION_TYPE)||returnType.hasMethodAnnotation(ANNOTATION_TYPE);}/**当类或者方法使用了@ResponseResultBody就会调用这个方法*/@OverridepublicObjectbeforeBodyWrite(Objectbody,MethodParameterreturnType,MediaTypeselectedContentType,Class<?extendsHttpMessageConverter<?>>selectedConverterType,ServerHttpRequestrequest,ServerHttpResponseresponse){if(bodyinstanceofResult){returnbody;}returnResult.success(body);}/***提供对标准SpringMVC异常的处理**@paramexthetargetexception*@paramrequestthecurrentrequest*/@ExceptionHandler(Exception.class)publicfinalResponseEntity<Result<?>>exceptionHandler(Exceptionex,WebRequestrequest){log.error("ExceptionHandler:{}",ex.getMessage());HttpHeadersheaders=newHttpHeaders();if(exinstanceofResultException){returnthis.handleResultException((ResultException)ex,headers,request);}//TODO:/10/05galaxy这里可以自定义其他的异常拦截returnthis.handleException(ex,headers,request);}/**对ResultException类返回返回结果的处理*/protectedResponseEntity<Result<?>>handleResultException(ResultExceptionex,HttpHeadersheaders,WebRequestrequest){Result<?>body=Result.failure(ex.getResultStatus());HttpStatusstatus=ex.getResultStatus().getHttpStatus();returnthis.handleExceptionInternal(ex,body,headers,status,request);}/**异常类的统一处理*/protectedResponseEntity<Result<?>>handleException(Exceptionex,HttpHeadersheaders,WebRequestrequest){Result<?>body=Result.failure();HttpStatusstatus=HttpStatus.INTERNAL_SERVER_ERROR;returnthis.handleExceptionInternal(ex,body,headers,status,request);}/***org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler#handleExceptionInternal(java.lang.Exception,java.lang.Object,org.springframework.http.HttpHeaders,org.springframework.http.HttpStatus,org.springframework.web.context.request.WebRequest)*<p>*Asingleplacetocustomizetheresponsebodyofallexceptiontypes.*<p>Thedefaultimplementationsetsthe{@linkWebUtils#ERROR_EXCEPTION_ATTRIBUTE}*requestattributeandcreatesa{@linkResponseEntity}fromthegiven*body,headers,andstatus.*/protectedResponseEntity<Result<?>>handleExceptionInternal(Exceptionex,Result<?>body,HttpHeadersheaders,HttpStatusstatus,WebRequestrequest){if(HttpStatus.INTERNAL_SERVER_ERROR.equals(status)){request.setAttribute(WebUtils.ERROR_EXCEPTION_ATTRIBUTE,ex,WebRequest.SCOPE_REQUEST);}returnnewResponseEntity<>(body,headers,status);}}
热门内容：
MySQL大表优化方案
从零搭建 Spring Cloud 服务（超级详细）
编写 if 时不带 else，你的代码会更好！
第 3 次读 Effective Java，这 58 个技巧最值！
10大黑客专用的 Linux 操作系统，每个都很酷！
最近面试BAT，整理一份面试资料《Java面试BAT通关手册》，覆盖了Java核心技术、JVM、Java并发、SSM、微服务、数据库、数据结构等等。获取方式：点“在看”，关注公众号并回复666领取，更多内容陆续奉上。明天见(｡･ω･｡)ﾉ♡
