聚合统一，SpringBoot实现全局响应和全局异常处理

目录

前言

全局响应

数据规范

状态码(错误码)

全局响应类

使用

优化

全局异常处理

为什么需要全局异常处理

业务异常类

全局捕获

使用

优化

总结

---

前言

        在悦享校园1.0版本中的数据返回采用了以Map对象返回的方式，虽然较为便捷但也带来一些问题。一是在Controller中所有方法均需要实例化一个Map对象。二是当返回数据较多时使用put方式添加信息会容易出现遗漏的问题。在异常处理方面，虽然该版本中对所有异常通过继承RuntimeException的方式来进行封装，但业务异常较多时这一操作就显得冗余，且需要使用上述提到的Map对象包装异常信息。对于以上问题在2.0版本中通过结合SpringBoot来进行优雅的解决。

全局响应

数据规范

一般来讲我们提供给前端接口调用的返回值为如下的JSON格式，其包含结果状态，状态码，响应信息和响应数据。通常会使用@ResponseBody注解配合一个响应类来实现这一功能。但需要注意的是，当方法返回值为String类型时，@ResponseBody注解并不会将其转为JSON格式，需要手动进行转换。

{
    "success": true,
    "code": 0,
    "message": "操作成功",
    "data": "Hello"
}

状态码(错误码)

通过第一步数据规范可知，当接口被调用后会返回对应信息，若调用成功时返回固定的状态码即可，但调用失败时则需要不同的状态码来标识。为解决这个问题这里使用枚举的方式来定义出现异常时的错误信息。(此处的枚举对象名称可以自定义)

 块的错误。(此处的枚举对象名称可以自定义)

@AllArgsConstructor
@Getter
public enum ExceptionCodeEnum {
    // 操作成功
    EC0(0,"操作成功"),
    // 通用模块错误
    EC10000(10000,"系统内部错误"),
    EC10001(10001,"参数错误"),
    EC10002(10002,"资源不存在"),
    
    // 用户模块错误
    EC20000(20000,"用户名已被占用"),
    EC20001(20001,"用户不存在"),
    EC20002(20002,"用户名或密码错误"),
    
    // 其它模块....

    /**
     * 异常代码
     */
    private Integer code;
    /**
     * 描述信息
     */
    private String message;
}

全局响应类

此处创建一个泛型类来实现全局返回信息的格式统一，并且提供返回结果不同状态下的构造方法。

@Data
@Builder
@AllArgsConstructor
public class ResultDataVO {
    /**
     * 调用结果状态
     */
    private Boolean success;
    /**
     * 响应代码
     */
    private Integer code;
    /**
     * 详细信息
     */
    private String message;
    /**
     * 返回数据,数据为空则不返回
     */
    @JsonInclude(JsonInclude.Include.NON_NULL)
    private T data;


    /**
     * 操作成功时返回的数据
     * @param result
     * @param 
     * @return
     */
    public static  ResultDataVO success(T result) {

        return ResultDataVO.builder()
                .success(true)
                .code(ExceptionCodeEnum.EC0.getCode())
                .message(ExceptionCodeEnum.EC0.getMessage())
                .data(result)
                .build();
    }

    /**
     * 操作失败
     * @param 
     * @param exceptionCodeEnum 错误类型枚举
     * @return
     */
    public static  ResultDataVO failure(ExceptionCodeEnum exceptionCodeEnum){

        return ResultDataVO.builder()
                .success(false)
                .code(exceptionCodeEnum.getCode())
                .message(exceptionCodeEnum.getMessage())
                .data(null)
                .build();
    }

    /**
     * 操作失败,返回信息
     * @param exceptionCodeEnum 错误信息列表
     * @param result 对应失败信息对象
     * @param 
     * @return
     */
    public static  ResultDataVO failure(ExceptionCodeEnum exceptionCodeEnum, T result){

        return ResultDataVO.builder()
                .success(false)
                .code(exceptionCodeEnum.getCode())
                .message(exceptionCodeEnum.getMessage())
                .data(result)
                .build();
    }
}

使用

通过以上操作已经实现了一个基础的全局数据响应处理，可以通过如下方式来使用。

@GetMapping("/{id}")
    public ResultDataVO getMsg(@RequestParam(required = false) String name,
                               @Max(value = 10,message = "最大值不能超过10")
                               @PathVariable(name = "id") int uid) {
        String result = "Hello,"+name+" id "+uid;

        return ResultDataVO.success(result);
    }

优化

虽然到这里我们已经基本实现了全局响应，但如果不想要在每个方法中调用ResultDataVO的success方法，可以通过如下方式解决。这里新建处理类实现了ResponseBodyAdvice接口，该接口包含三个方法，supports、beforeBodyWrite、handleEmptyBody。

supports用于指明方法是否需要对进入的方法进行后续包装处理，默认返回true，即对所有方法处理。

beforeBodyWrite用于在控制器方法返回结果后，但在响应体写入之前调用。可以在此方法中修改body对象，如包装、添加元数据等。在该方法中将使用ResultDataVO的success方法进行包装，由此将可以省去在Controller方法中重复调用success方法。

handleEmptyBody用于处理null值，由于ResultDataVO类中已经对null值进行了处理，因此无需重写该方法。

@RestControllerAdvice
@Slf4j
public class GlobalExceptionAdvice implements ResponseBodyAdvice