只需一步,在Spring Boot中统一Restful API返回值格式与统一处理异常
程序员文章站
2022-07-21 17:19:00
统一返回值 在前后端分离大行其道的今天,有一个统一的返回值格式不仅能使我们的接口看起来更漂亮,而且还可以使前端可以统一处理很多东西,避免很多问题的产生。 比较通用的返回值格式如下: 最原始的接口如下: 当我们需要统一返回值时,可能会使用这样一个办法: 这个方法确实达到了统一接口返回值的目的,但是却有 ......
统一返回值
在前后端分离大行其道的今天,有一个统一的返回值格式不仅能使我们的接口看起来更漂亮,而且还可以使前端可以统一处理很多东西,避免很多问题的产生。
比较通用的返回值格式如下:
public class result<t> { // 接口调用成功或者失败 private integer code = 0; // 失败的具体code private string errorcode = ""; // 需要传递的信息,例如错误信息 private string msg; // 需要传递的数据 private t data; ... }
最原始的接口如下:
@getmapping("/test") public user test() { return new user(); }
当我们需要统一返回值时,可能会使用这样一个办法:
@getmapping("/test") public result test() { return result.success(new user()); }
这个方法确实达到了统一接口返回值的目的,但是却有几个新问题诞生了:
- 接口返回值不明显,不能一眼看出来该接口的返回值。
- 每一个接口都需要增加额外的代码量。
所幸spring boot已经为我们提供了更好的解决办法,只需要在项目中加上以下代码,就可以无感知的为我们统一全局返回值。
/** * 全局返回值统一封装 */ @enablewebmvc @configuration public class globalreturnconfig { @restcontrolleradvice static class resultresponseadvice implements responsebodyadvice<object> { @override public boolean supports(methodparameter methodparameter, class<? extends httpmessageconverter<?>> aclass) { return true; } @override public object beforebodywrite(object body, methodparameter methodparameter, mediatype mediatype, class<? extends httpmessageconverter<?>> aclass, serverhttprequest serverhttprequest, serverhttpresponse serverhttpresponse) { if (body instanceof result) { return body; } return new result(body); } } }
而我们的接口只需要写成最原始的样子就行了。
@getmapping("/test") public user test() { return new user(); }
统一处理异常
将返回值统一封装时我们没有考虑当接口抛出异常的情况。当接口抛出异常时让用户直接看到服务端的异常肯定是不够友好的,而我们也不可能每一个接口都去try/catch进行处理,此时只需要使用@exceptionhandler
注解即可无感知的全局统一处理异常。
@restcontrolleradvice public class globalexceptionhandler { private static final logger log = loggerfactory.getlogger(globalexceptionhandler.class); /** * 全局异常处理 */ @exceptionhandler public jsondata handleexception(httpservletrequest request, httpservletresponse response, final exception e) { log.error(e.getmessage(), e); if (e instanceof alertexception) {//可以在前端alert的异常 if (((alertexception) e).getretcode() != null) {//预定义异常 return new result(((alertexception) e).getretcode()); } else { return new result(1, e.getmessage() != null ? e.getmessage() : ""); } } else {//其它异常 if (util.isproduct()) {//如果是正式环境,统一提示 return new result(retcode.error); } else {//测试环境,alert异常信息 return new result(1, stringutils.isnotblank(e.getmessage()) ? e.getmessage() : e.tostring()); } } } }
其中的alertexception
为我们自定义的异常,因此当业务中需要抛出错误时,可以手动抛出alertexception
。
以上就是统一处理返回值和统一处理异常的两步。
转评赞就是最大的鼓励
上一篇: DBUtils框架的使用(下)