后端开发统一规范

最新推荐文章于 2025-03-16 17:18:06 发布

取名字很费劲

最新推荐文章于 2025-03-16 17:18:06 发布

阅读量237

点赞数

本文链接：https://blog.csdn.net/qq_51219147/article/details/132738765

版权

本文介绍了后端接口开发的统一规范，包括接口统一响应对象返回、使用注解进行参数校验、统一异常处理，旨在提升代码的规范性、可读性和维护性。详细阐述了标准响应对象的构建、Spring Boot中的参数校验以及自定义异常处理的方法，并提供了相关测试示例。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

后端接口开发的统一规范

日常工作中，我们开发接口时，一般都会涉及到参数校验、异常处理、封装结果返回等处理。

如果每个后端开发在参数校验、异常处理等都是各写各的，没有统一处理的话，代码就不优雅，也不容易维护。所以，作为一名合格的后端开发工程师，我们需要统一校验参数，统一异常处理、统一结果返回，让代码更加规范、可读性更强、更容易维护。

1、接口统一响应对象返回

作为后端开发，我们项目的响应结果，需要统一标准的返回格式。一般一个标准的响应报文对象，有一下几个属性

code ：响应状态码
message ：响应结果描述
data：返回的数据

1）响应状态码一般用枚举表示:

public enum ResultCode {

    /**操作成功**/
    SUCCESS("200","操作成功"),

    /**操作失败**/
    ERROR("500","操作失败"),;

    /**
     * 自定义状态码
     **/
    private String code;
    
    
    /**自定义描述**/
    private String message;

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

    public String getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }
}

2）因为返回的数据类型不是确定的，我们可以使用泛型，如下：

public class BaseResponse<T> implements Serializable {

    private static final long serialVersionUID = 1901152752394073986L;

    /**
     * 响应状态码
     */
    private String code;


    /**
     * 响应结果描述
     */
    private String message;

    /**
     * 返回的数据
     */
    private T data;


    /**
     * 成功返回
     * @param data
     * @return: com.msb.hjycommunity.common.core.domain.BaseResponse<T>
     */
    public static <T> BaseResponse<T> success(T data){

        BaseResponse<T> response = new BaseResponse<>();
        response.setCode(ResultCode.SUCCESS.getCode())