赞叹不已！后端API接口设计尽显优雅风范

Yaml墨韵

已于 2024-04-12 10:38:35 修改

阅读量1k

点赞数 14

分类专栏： springboot 文章标签：状态模式后端API接口 spring boot

于 2024-04-12 10:23:06 首次发布

本文链接：https://blog.csdn.net/Yaml4/article/details/137666987

版权

springboot 专栏收录该内容

96 篇文章 1 订阅

订阅专栏

在移动互联网，分布式、微服务盛行的今天，现在项目绝大部分都采用的微服务框架，前后端分离方式，（题外话：前后端的工作职责越来越明确，现在的前端都称之为大前端，技术栈以及生态圈都已经非常成熟；以前后端人员瞧不起前端人员，那现在后端人员要重新认识一下前端，前端已经很成体系了）。

接口交互

前端和后端进行交互，前端按照约定请求URL路径，并传入相关参数，后端服务器接收请求，进行业务处理，返回数据给前端。

针对URL路径的restful风格，以及传入参数的公共请求头的要求（如：app_version,api_version,device等），老顾这里就不介绍了，小伙伴们可以自行去了解，也比较简单。

着重介绍一下后端服务器如何实现把数据返回给前端？

返回格式

后端返回给前端我们一般用JSON体方式，定义如下：

{
  #返回状态码
  code:integer,
  #返回信息描述
  message:string,
  #返回值
  data:object
}

CODE状态码

code返回状态码，一般小伙伴们是在开发的时候需要什么，就添加什么。

如接口要返回用户权限异常，我们加一个状态码为101吧，下一次又要加一个数据参数异常，就加一个102的状态码。这样虽然能够照常满足业务，但状态码太凌乱了。

我们应该可以参考HTTP请求返回的状态码（下面是常见的HTTP状态码）：

200 - 请求成功
301 - 资源（网页等）被永久转移到其它URL
404 - 请求的资源（网页等）不存在
500 - 内部服务器错误

我们可以参考这样的设计，这样的好处就把错误类型归类到某个区间内，如果区间不够，可以设计成4位数。

#1000～1999 区间表示参数错误
#2000～2999 区间表示用户错误
#3000～3999 区间表示接口异常

这样前端开发人员在得到返回值后，根据状态码就可以知道，大概什么错误，再根据message相关的信息描述，可以快速定位。

Message

这个字段相对理解比较简单，就是发生错误时，如何友好的进行提示。一般的设计是和code状态码一起设计，如：

//状态码枚举
public enum ResultCode {

    private Integer code;
    private String message;

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

再在枚举中定义，状态码

//返回状态码
public enum ResultCode {
    private Integer code;
    private String message;
    ResultCode(Integer code,String message){
        this.code= code;
        this.message = message;
    }
    public Integer code(){
        return this.code;
    }
    public String message() {
        return this.message;
    }
    /*成功状态码*/
    SUCCESS(1,"成功"),
    /*参数错误:1001-1999 */
    PARAM_IS_INVALID(1001,"参数无效"),
    PARAM_IS_BLANK(1002,"参数为空"),
    PARAM_TYPE_BIND_ERROR(1003,"参数类型错误"),
    PARAM_NOT_COMPLETE(1004,"参数缺失"),
    /*本用户错误:2001-2999*/
    USER_NOT_LOGGED_IN(2001,"用户未登录,访问的路径需要验证,请登录"),
    USER_LOGIN_ERROR(2002,"账号不存在或密码错误"),
    USER_ACCOUNT_FORBIDDEN(2003,"账号已被禁用"),
    USER_NOT_EXIST(2004,"用户不存在"),
    USER_HAS_EXISTED(2005,"用户已存在")
}

状态码和信息就会一一对应，比较好维护。

Data

返回数据体，JSON格式，根据不同的业务又不同的JSON体。

我们要设计一个返回体类Result

@Data
public class Result implements Serializable {

    private Integer code;

    private String message;

    private Object data;

    public Result(ResultCode resultcode,Object data)
        this.code = resultCode.code();
        this.message = resultCode.message();
        this.data = data;
    }
}

控制层Controller

我们会在controller层处理业务请求，并返回给前端，以order订单为例：

@RestController
@RequestMapping("/orders")
public class OrderController {

    @Autowired
    private OrderService orderservice;

    @GetMapping("{id}")
    public Result getOrder(@PathVariable("id")Integer id){
        Order order = orderService.getOrderById(id);
        Result result = new Result(Resultcode.SuCCESs,order);
        return result;
    }
}

我们看到在获得order对象之后，我们是用的Result构造方法进行包装赋值，然后进行返回。小伙伴们有没有发现，构造方法这样的包装是不是很麻烦，我们可以优化一下。

美观优化

我们可以在Result类中，加入静态方法，一看就懂


@Data
public class Result implements Serializable {

    private Integer code;

    private String message;

    private Object data;

    public Result(ResultCode resultcode,Object data)
        this.code = resultCode.code();
        this.message = resultCode.message();
        this.data = data;
    }
    
    //返回成功
    public static Result success(){
        Result result = new Result();
        result.setResultCode(ResultCode. suCCESS);
        return result;
    }
    
    //返回成功
    public static Result success(Object data) {
        Result result = new Result(;
        result.setResultCode(ResultCode.suCCESS);
        result.setData(data);
    }
    
    //返回失败
    public static Result failure(Resultcode resultCode){
        Result result= new Result();
        result.setResultCode(resultCode);
        return result;
    }

    //返回失败
    public static Result failure(ResultCode resultCode，Object data){
        Result result = new Result();
        result.setResultCode(resultCode);
        result.setData(data);
        return result;
    }
}

那我们来改造一下Controller

@RestController
@RequestMapping(" /orders")
public class OrderController {

    @Autowired
    private OrderService orderService;

    @GetMapping("{id}")
    public Result getOrder(PathVariable("id") Integer id){
        if(id == null){
            return Result.failure(ResultCode.PARAM_IS_INVALID);
        }
        Order order = orderService.getOrderById(id);
        return Result.success(order);
    }
}

代码是不是比较简洁了，也美观了。

优雅优化

上面我们看到在Result类中增加了静态方法，使得业务处理代码简洁了。但小伙伴们有没有发现这样有几个问题：

1、每个方法的返回都是Result封装对象，没有业务含义
2、在业务代码中，成功的时候我们调用Result.success，异常错误调用Result.failure。是不是很多余
3、上面的代码，判断id是否为null，其实我们可以使用hibernate validate做校验，没有必要在方法体中做判断。

我们最好的方式直接返回真实业务对象，最好不要改变之前的业务方式，如下图：


@RestController
@RequestMapping("/orders")
public class OrderController {

    @Autowired
    private OrderService orderService;

    @GetMapping("{id}")
    public Order getOrder(PathVariable("id") Integer id){
        Order order = orderService.getOrderById( id);
        return order;
    }
}

这个和我们平时的代码是一样的，非常直观，直接返回order对象，这样是不是很完美。那实现方案是什么呢？

实现方案

小伙伴们怎么去实现是不是有点思路，在这个过程中，我们需要做几个事情

1、定义一个注解@ResponseResult，表示这个接口返回的值需要包装一下
2、拦截请求，判断此请求是否需要被@ResponseResult注解
3、核心步骤就是实现接口ResponseBodyAdvice和@ControllerAdvice，判断是否需要包装返回值，如果需要，就把Controller接口的返回值进行重写。

注解类

用来标记方法的返回值，是否需要包装

@Retention(RUNTIME)
@Target({ TYPE,METHOD })
@Documented
public @interface ResponseResult {

}

拦截器

拦截请求，是否此请求返回的值需要包装，其实就是运行的时候，解析@ResponseResult注解

//请求拦截器
@Slf4j
@Component
public class ResponseResultInterceptor implemients HandlerInterceptor {

    //标记名称
    public static final String RESPONSE_RESULT_ANN ="RESPONSE-RESULT-AN" ;

    @Override
    public boolean preHandle(HttpServletRequest request，HttpServletResponse response，Object handler)throws Exception {
    
    //请求的方法
    if (handler instanceof HandlerNethod){
        final HandlerMethod handlerMethod(HandlerMethod) handler;
        final Class<?> clazz = handlerMethod.getBeanType();
        final Method method - handlerMethod.getMethod();

        //判断是否在类对象上面加了注解
        if (clazz.iSAnnotationPresent(ResponseResult.class)){
            //设置此请求返回体，需要包装,往下传递,在ResponseBodyAdvice接口进行判断
            request.setAttribute(RESPONSE_RESULT_ANN,clazz.getAnnotation(ResponseResult.class));
        }else if (method.isAnnotationPresent(ResponseResult.class)){//方法体上是否有注解

            //设置此请求返回体,需要包装,往下传递,在ResponseBodyAdvice接口进行判断
            request.setAttribute(RESPONSE_RESULT_AN,method.getAnnotation(ResponseResult.class));
        }
        returm true;
    }
}

此代码核心思想，就是获取此请求，是否需要返回值包装，设置一个属性标记。

重写返回体

@Slf4
@ControllerAdvicd
public class ResponseResultHandler implements ResponseBodyAdvice<Ubject> {

    //标记名称
    public static final String RESPONSE_RESULT_AN=“RESPONSE-RESULT-AN;

    //是否请求,包含了包装注解标记,没有就直接返园。不需要重写返回体
    @Override
    publc boolean supports(NethodParameter returnType, Class, extends HttpMessageConverter converterType){
        ServletRequestAttributes sra((ServletRequestAttributes)RequestContextiolder.getRequestAttributes(0);
        HttpservletRequest request= sra.getRequest(;
        //判断请求，是否有包装标记
        ResponseResult responseResultAnn = (ResponseResuit) request.getAttribute(RESPONSE_RESULT_AN);
        return responseResultAnn null ? false : true;
    }
    
    
    @Override
    publtc Object beforeBodywrite(Object body,MethodParameter returnype,MediaType selectedContentType,Class<? extends RttpNessageconverter<?>> selectedConverterType, ServerHttpRequest request,SeverHttpResponse response){
    log.into("进入返回体重写格式处理中。-..- ");return Result.success(body);
    }
}

上面代码就是判断是否需要返回值包装，如果需要就直接包装。这里我们只处理了正常成功的包装，如果方法体报异常怎么办？处理异常也比较简单，只要判断body是否为异常类。

@Override
public Object beforeBodywrite(Object body，MethodParameter returnType,MediaType selectedContentType,Class<? extends HttpMessageConverter<?> selectedConverterType, ServerHttpRequest request,ServerHttpResponse response) {
    log.info("进入返回体重写格式处理中。。。。");
    if (body instanceof ErrorResult){
        log.info("返回值异常作包装处理中。。。");
        ErrorResult errorResult = (ErrorResult) body;
        return Result.failure(errorResult.getCode(),errorResult.getNessage(),errorResult.getErrors());
    }
    return Result.success(body);
}

怎么做全局的异常处理，篇幅原因，老顾这里就不做介绍了，只要思路理清楚了，自行改造就行。

重写Controller

@RestController
@RequestMapping("/orders")
@ResponseResult
public class OrderController {

    @Autowired
    private OrderService orderService;

    @GetMapping("{id}")
    public Order getOrder(PathVariable("id") Integer id){
        Order order = orderService.getOrderById( id);
        return order;
    }
}

在控制器类上或者方法体上加上@ResponseResult注解，这样就ok了，简单吧。到此返回的设计思路完成，是不是又简洁，又优雅。

总结

这个方案还有没有别的优化空间，当然是有的。如：每次请求都要反射一下，获取请求的方法是否需要包装，其实可以做个缓存，不需要每次都需要解析。当然整体思路了解，小伙伴们就可以在此基础上面自行扩展。

Yaml墨韵

关注

14
点赞
踩
19

收藏

觉得还不错? 一键收藏
打赏
1
评论
赞叹不已！后端API接口设计尽显优雅风范

这个方案还有没有别的优化空间，当然是有的。如：每次请求都要反射一下，获取请求的方法是否需要包装，其实可以做个缓存，不需要每次都需要解析。当然整体思路了解，小伙伴们就可以在此基础上面自行扩展。
复制链接

扫一扫