API返回的错误是否视为接口的一部分?
创始人
2024-09-07 13:31:58
0次

根据RESTful API设计规范,错误码和错误消息应该统一格式,以便客户端能够根据返回的状态码和消息进行有效的处理和展示。常见的错误码和消息可以定义为枚举类或常量类,如下:

public enum ResultCode {
    SUCCESS(0, "请求成功"),
    UNKNOWN_ERROR(1, "未知错误"),
    PARAM_ERROR(2, "参数错误");

    private int code;
    private String message;

    ResultCode(int code, String message) {
        this.code = code;
        this.message = message;
    }

    public int getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }
}

public class Result {
    private int code;
    private String message;
    private T data;

    // getter and setter
}

在API处理过程中,如果出现错误,可以通过定义统一的错误处理器来返回错误码和消息,如下:

@RestControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(value = Exception.class)
    public Result handleException(Exception e) {
        e.printStackTrace();
        return new Result<>(ResultCode.UNKNOWN_ERROR.getCode(), ResultCode.UNKNOWN_ERROR.getMessage(), null);
    }

    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public Result handleValidationException(MethodArgumentNotValidException e) {
        BindingResult bindingResult = e.getBindingResult();
        StringBuilder builder = new StringBuilder();
        for (ObjectError error : bindingResult.getAllErrors()) {
            builder.append(error.getDefaultMessage()).append(";");
        }
        return new Result<>(ResultCode.PARAM_ERROR.getCode(), builder.toString(), null);
    }
}

以上是一些常见的API错误处理方式。在实际开发过程中,还需要根据具体的业务场景来进行调整。

相关内容

热门资讯

前端-session、jwt 目录:   (1)session (2&#x...
linux入门---制作进度条 了解缓冲区 我们首先来看看下面的操作: 我们首先创建了一个文件并在这个文件里面添加了...
关于测试,我发现了哪些新大陆 关于测试 平常也只是听说过一些关于测试的术语,但并没有使用过测试工具。偶然看到编程老师...
前缀和与对数器与二分法 1. 前缀和 假设有一个数组,我们想大量频繁的去访问L到R这个区间的和,...
nodejs:本地安装nvm实... 一、背景-使用不同版本node的原因 vue3+ts、nuxt3版本,node...
JAVA集合知识整理 Java集合知识整理 HashMap相关 HashMap的底层数据结构:jdk1.8之...
无刷直流电机介绍及单片机控制实... 无刷直流电机介绍及单片机控制实例前言基本概念优势与劣势使用寿命基本结构使用单片机控制实例电子调速器&...
fwdiary(2) dp2 1.传纸条  AcWing 275. 传纸条 - AcWing 走两条路,走一条最大的...
常用的DOS命令 常用的DOS命令 DOS(Disk Operating System,磁...
<C++> 类和对象(下) 1.const成员函数将const修饰的“成员函数”称之为const成员函数,cons...