[Java知识库]Springboot 项目中关于异常的设计

Springboot 项目中关于异常的设计

ErrorCode

错误码接口

/**
 * @Description 异常码接口
 * @Author yin.jinbiao
 * @Date 2021/10/1 20:24
 * @Version 1.0
 */
public interface ErrorCode {

    int getCode();

    String getMsg();
}

ErrorCodeEnum

自定义错误码枚举（参考支付宝开发平台设计）

/**
 * @Description 错误码
 * @Author yin.jinbiao
 * @Date 2021/9/27 14:31
 * @Version 1.0
 */
@Getter
public enum ErrorCodeEnum implements ErrorCode {

    /**
     * 接口调用成功
     */
    SUCCESS(10000,"success."),
    /**
     * 服务不可用
     */
    UNKNOW_ERROR(20000,"unknow error."),
    /**
     * 授权权限不足
     */
    UNKNOW_PERMISSION(20001,"unknow permission."),
    /**
     * 缺少必选参数
     */
    PARAM_MISS(40001,"missing param."),
    /**
     * 非法的参数
     */
    PARAM_ILLEGAL(40002,"illegal param."),
    /**
     * 业务处理失败
     */
    BUSINESS_FAIL(40004,"business fail."),
    /**
     * 权限不足
     */
    PERMISSION_DENY(40006,"permission denied."),
    /**
     * 调用频次超限
     */
    CALL_LIMTIED(40005,"call limited.")
    ;

    private int code;
    private String msg;
    ;

    ErrorCodeEnum(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }

}

CustomException

自定义异常

/**
 * @Description 业务异常
 * @Author yin.jinbiao
 * @Date 2021/9/27 14:26
 * @Version 1.0
 */
@Data
public class CustomException extends RuntimeException{
    // 错误码
    private ErrorCode errorCode;
    // 明细返回码
    private String subCode;
    // 明细返回码描述
    private String subMsg;

    public CustomException(ErrorCode errorCode, String subCode, String subMsg) {
        super(errorCode.getMsg());
        this.subCode = subCode;
        this.subMsg = subMsg;

    }
}

GlobalExceptionHandler

/**
 * @Description 全局异常处理
 * @Author yin.jinbiao
 * @Date 2021/10/1 15:00
 * @Version 1.0
 */
@RestControllerAdvice
@Slf4j
public class GlobalExceptionHandler {

    @ExceptionHandler(CustomException.class)
    public ResponseErrorResult customException(CustomException e) {
        log.error(e.getMessage(), e);
        ResponseErrorResult response = new ResponseErrorResult();
        response.setCode(e.getErrorCode().getCode());
        response.setMsg(e.getErrorCode().getMsg());
        response.setSubCode(e.getSubCode());
        response.setSubMsg(e.getSubMsg());
        return response;
    }

    @ExceptionHandler(Exception.class)
    public ResponseErrorResult handleException(Exception e) {
        log.error(e.getMessage(), e);
        ResponseErrorResult response = new ResponseErrorResult();
        response.setCode(ErrorCodeEnum.UNKNOW_ERROR.getCode());
        response.setMsg(ErrorCodeEnum.UNKNOW_ERROR.getMsg());
        response.setSubCode(e.getClass().getName());
        response.setSubMsg(e.getMessage());
        return response;
    }

    @Data
    private class ResponseErrorResult{
        private int code;
        private String msg;
        private String subCode;
        private String subMsg;
    }
}

说明：CustomException会被捕获，返回具体的异常码与异常信息。如果需要捕获其它异常自定义返回信息，请照着CustomException的方式添加。

使用案例

    /**
     * 添加信息到人脸库
     * @param form
     * @param file
     * @return
     * @throws IOException
     */
    @PostMapping("/add")
    public ResponseResult addFacePerson(FacePersonForm form, MultipartFile file) throws IOException {

        // TODO 同步上传图片到文件库（自己另外实现文件上传服务）
        // 提取人脸特征存储
        ImageInfo rgbData = ImageFactory.getRGBData(file.getBytes());
        List<FaceInfo> faceInfoList = faceEngineService.detectFaces(rgbData);
        if (CollectionUtil.isEmpty(faceInfoList)) {
            throw new CustomException(ErrorCodeEnum.PARAM_ILLEGAL,"not recognize face.","没有检测到人脸信息。");
        }
        FacePerson facePerson = new FacePerson();
        byte[] feature = faceEngineService.extractFaceFeature(rgbData, faceInfoList.get(0));
        facePerson.setName(form.getName());
        facePerson.setFeature(feature);
        facePersonService.add(facePerson);
        return ResponseResult.ok();

    }

调用示例

{
	code:40002,
	msg:"illegal param.",
	subCode:"not recognize face.",
	subMsg:""没有检测到人脸信息。"
}

参考资料

• 支付宝文档中心