SpringBoot 统一异常处理和统一数据返回

596 阅读1分钟

在实际开发中,我们希望对接口结果的返回,进行一次统一的封装,即便接口发生异常。比如,我们可以这样设计接口的返回:

SpringBoot 统一异常处理和统一数据返回

统一数据返回

我们希望有一种统一的方式来处理异常,并且有一种统一的方式来对接口结果进行返回,并且尽可能少编写代码,尽可能和业务逻辑的处理分离开来。


实践

第一步:定义通用的数据返回对象

SpringBoot 统一异常处理和统一数据返回

GlobalResponse

这里我们定义通用的数据返回对象,并且提供一个正常数据返回/一个异常数据返回的快速设置方法。

第二步:定义统一处理handler

SpringBoot 统一异常处理和统一数据返回

GlobalResponseHandler

SpringBoot 统一异常处理和统一数据返回

@ControllerAdvice+@ExceptionHandler配合使用

首先,我们通过@ControllerAdvice来定义一个controller增强处理器,可以通过配合使用@ExceptionHandler来进行异常的统一处理。

其次,通过实现ResponseBodyAdvice,对于数据的返回,进行进一步的处理,使得接口的返回值都是统一的对象。

SpringBoot 统一异常处理和统一数据返回

业务异常


运行结果

SpringBoot 统一异常处理和统一数据返回

接口正常返回

SpringBoot 统一异常处理和统一数据返回

正常返回的数据被统一包装

SpringBoot 统一异常处理和统一数据返回

接口异常

SpringBoot 统一异常处理和统一数据返回

异常返回


好了,到这里,咱们对springboot中的异常处理以及统一接口数据返回就有了一个认识~