SpringBoot中如何实现接口的统一返回和异常的统一捕获

待我称王封你为后i 2022-12-31 07:26 150阅读 0赞

## 接口的统一返回 ##

在开发公司接口时，发现Controller层的接口返回都需要用一个Result包裹，如下图所示：

![图片][3008e08e9c584b356db3706c61221658.png]

图示代码中无论是创建接口或者查询接口，这里都需要用一个Result去接收，我们来看看Result的结构：

![20201229090513492.gif][]

这个Result中有几个字段：

> “
> 
>  *  code：状态码
>  *  message：状态信息
>  *  data：装载正真返回的数据
>  *  exception：异常数据
> 
> ”

然后我们测试下接口，看看返回样式：

![图片][e6fe4cf3f342702d78e9c7c16e29cad2.png]

![图片][397dd108a848fdc59438f6002f00a30c.png]

调用接口，返回格式为：

{
      "code": 200,
      "message": "SUCCESS",
      "data": {
          ...
      }
      "exception": xxx
    }

写完后我就在思考，每个接口都需要包一层Result，感觉影响了接口的可读性。作为开发来说这样包裹一层也很麻烦。

> “
> 
> 那么有没有一种方法，可以通过框架自动包裹一层Result，开发只要在Controller层直接返回实体就行了呢？
> 
> ”

还真有这样的方法，能实现Controller层接口的统一返回：

![图片][2b9bcb08b48681fdcb392a1f4bd927cc.png]

如上代码，我们使用`ResponseBodyAdvice`来拦截Controller层方法默认返回参数。说白了就是个拦截器。主要是看`beforeBodyWrite()`方法，在这个方法中，如果Controller中的返回已经是Result，那就直接返回Result。如果不是，那就使用Result去包装。

我们来看看效果：

![图片][095b408fd148c5205bb4a49b612e8dfb.png]

如上代码，我们直接返回实体，我们看看Swagger的返回：

![20201229090513504.gif][]

swagger的返回的格式是我们拦截器的格式。

> “
> 
> 这里我又有一个疑问，接口正常返回已经被Result包裹了，如果接口抛异常该怎么返回一样的格式呢？
> 
> ”

## 全局的异常捕获 ##

这里就需要全局的异常捕捉了。关于全局异常捕捉，相信很多童鞋都知道了：

![20201229090513507.gif][]

我们需要写一个捕捉类，在上面添加`@ControllerAdvice`注解，然后编写处理异常的方法：

![图片][75f7682d274a39e845ee3ac3897bbdc8.png]

我们添加`@ResponseBody`注解和`@ExceptionHandler`注解，这里的`value = Exception.class`，表示我们捕捉Exception类型的异常。我们就可以使直接抛异常了：

![图片][64f1b43caaee7099e2eb1211aece37c9.png]

也可以这么抛：

![20201229090513505.gif][]

我们测试，如果代码抛异常，接口就会返回：

![20201229090513502.gif][]

格式符合预期。

但是这里还是有一个问题，每次我都需要写if语句：

if(条件) {
       throw new RuntimeException("...");
    }

这样写还是太麻烦，而且啥异常都抛`RuntimeException`。这样还是太粗糙了。

于是我决定自定义一个业务异常，并且封装一些异常抛出方法，说干就干。

## 自定义业务异常 ##

![图片][5cbd4d54ffa84f8ee4b5f13cb1a26adc.png]

我们定义一个业务异常，这里面封装了异常状态码，和异常信息数据。

## 优雅抛异常 ##

然后我们编写一个业务异常判断类：

![图片][7a5bc656b5461353187ec1c47bad9c77.png]

这里只截取了部分代码，里面其实只有两个方法`checkArgument()`和`checkNotNull()`。他们有什么用呢？如果要做非空校验，一般是这么做的：

if (updateEntity == null) {
        throw new RuntimeException("传入参数为null");
    }

但是现在可以这么做了：

BusinessExceptionAssert.checkNotNull(updateEntity, "参数不能为null");

抛出的是我自定义的业务异常。

如果是一般的逻辑校验呢？以前的代码是这么写的：

if(!"1".equals(id)) {
       throw new RuntimeException(String.format("参数id【%s】只能为1",id));
    }

现在可以有更优雅的实现方式：

BusinessExceptionAssert.checkArgument("1".equals(id), 500, "参数id【%s】只能为1",id);

因为抛的是业务异常，我们还可以自定义异常码。

完整测试代码：

@ApiOperation(value = "test-测试异常", httpMethod = "POST", notes = "测试代码，勿动")
     @PostMapping(value = "testBusinessException")
     public int testBusinessException(@RequestParam String id) {
         BusinessExceptionAssert.checkArgument("1".equals(id), 500, "参数id【%s】只能为1",id);
         return 1;
     }

我们测试结果：

![图片][f0960d37055a9d5c3c797a8187613a7f.png]

符合预期。

这篇文章写到这里就结束了，本文主要讲解了：

> “
> 
>  *  如何实现接口统一返回
>  *  如何自定义业务异常，并被统一捕获
>  *  如何优雅的抛异常
> 
> ”

如果还有改进的，欢迎大家积极交流。

[3008e08e9c584b356db3706c61221658.png]: /images/20221120/2eee188960914c33aa36dffae5541a32.png
[20201229090513492.gif]: /images/20221120/112ffdf6d4e34debbd0f7e86596f181d.png
[e6fe4cf3f342702d78e9c7c16e29cad2.png]: https://img-blog.csdnimg.cn/img_convert/e6fe4cf3f342702d78e9c7c16e29cad2.png
[397dd108a848fdc59438f6002f00a30c.png]: https://img-blog.csdnimg.cn/img_convert/397dd108a848fdc59438f6002f00a30c.png
[2b9bcb08b48681fdcb392a1f4bd927cc.png]: https://img-blog.csdnimg.cn/img_convert/2b9bcb08b48681fdcb392a1f4bd927cc.png
[095b408fd148c5205bb4a49b612e8dfb.png]: https://img-blog.csdnimg.cn/img_convert/095b408fd148c5205bb4a49b612e8dfb.png
[20201229090513504.gif]: https://img-blog.csdnimg.cn/20201229090513504.gif
[20201229090513507.gif]: https://img-blog.csdnimg.cn/20201229090513507.gif
[75f7682d274a39e845ee3ac3897bbdc8.png]: https://img-blog.csdnimg.cn/img_convert/75f7682d274a39e845ee3ac3897bbdc8.png
[64f1b43caaee7099e2eb1211aece37c9.png]: https://img-blog.csdnimg.cn/img_convert/64f1b43caaee7099e2eb1211aece37c9.png
[20201229090513505.gif]: https://img-blog.csdnimg.cn/20201229090513505.gif
[20201229090513502.gif]: https://img-blog.csdnimg.cn/20201229090513502.gif
[5cbd4d54ffa84f8ee4b5f13cb1a26adc.png]: https://img-blog.csdnimg.cn/img_convert/5cbd4d54ffa84f8ee4b5f13cb1a26adc.png
[7a5bc656b5461353187ec1c47bad9c77.png]: https://img-blog.csdnimg.cn/img_convert/7a5bc656b5461353187ec1c47bad9c77.png
[f0960d37055a9d5c3c797a8187613a7f.png]: https://img-blog.csdnimg.cn/img_convert/f0960d37055a9d5c3c797a8187613a7f.png