优雅处理API统一返回

概述:

API:application program-interface 应用编程接口。在web应用中常见的是前端开发工程师与后端开发工程师沟通的桥梁,是重要的规范文档。良好的API可以提高前后端协调的效率。

如何设计良好的API:

1.命名风格统一

如列表相关接口统一用ListXXXXX,获取详情接口getXXX,删除delXXX

2.返回格式统一

以返回json 格式为例:{ #返回状态码 code:integer, #返回信息描述 message:string, #返回值 data:object}

3.良好的状态码规范、说明

优雅处理API统一返回_第1张图片

具体代码实现

一、定义枚举类,讲返回的code 和message 保存在枚举类中

优雅处理API统一返回_第2张图片

二、controller层  将需要返回的信息包装成Result 

优雅处理API统一返回_第3张图片

三、但是这样写,每个接口方法都需去包装一下,有点重复工作。优化思路:

1、先定义一个注解@ResponseResult,表示这个接口返回的值需要包装一下 

2、拦截请求,判断此请求是否需要被@ResponseResult注解

3、核心步骤就是实现接口ResponseBodyAdvice和@ControllerAdvice,判断是否需要包装返回值,如果需要,就把Controller接口的返回值进行重写

 

 

你可能感兴趣的:(设计模式,Java,Spring,优雅处理接口返回)