刚参加工作的表弟问我,公司里开发的接口为什么统一接口返回值?

为什么要统一接口返回值

最近刚培训完的表弟问我:表哥我写了一个返回值是String的接口,领导问我是不是培训班出来的?
作为他的表哥,我肯定要好好讲解一下!

统一返回值类型是接口开发中的一种良好的开发习惯(公司中99%的业务接口的返回值都是统一的),统一接口返回值的目的蜗觉得有两个:第一是可以节省前后端的沟通时间,前端默认后端接口返回的都是同一种结构,第二是接口有很好的可读性,干净,整齐,易于形成好的写代码习惯。举个例子,请看下面的三个接口及返回值:统一接口返回值类型.png

上图中有三个接口,返回值类型分别是String,Map,Object,三个接口本身都没有问题,这也是没有参加过工作的同学最常见的写法,前端要什么类型我返回什么类型。这么写可以吗?其实也可以,上图已经返回预期的值。

工作中我们很少会这么去定义返回值,这么写是不利于开发进度与团队协作的,为什么这么说呢?缘由如下:

  1. 于后端而言,所有接口返回值类型统一,就会显得代码更规范
  2. 与前端而言就相对重要了,一个接口返回一种类型,那么前端就需要写不同的代码来处理不同的返回结果,如果后端统一返回值,前端就可以写一个统一的处理返回值的代码

如何统一接口返回值

看看统一接口返回值之后,前端接收的值是什么样的:

统一接口返回值.png

通过两张图的对比,其实后端代码并没有大的改变,更改最大的点在于三个接口的返回值类型都变成了我定义的RestResult,然后前端接收的值就赏心悦目了,前端处理接收的数据时,只要获取key为data的value值即可,好不好相信都能看的见。

总结

统一接口返回值是企业中最基本的要求,使用它的原因不止于上文,比如msg可以告诉前端调用失败还是 成功,code可以告诉前端具体的业务类型错误,它的编写方式有很多,比如工厂模式创建(本文采用的方法),编写一个统一返回值的类等等。方式有很多,如果大家想了解如何设计一个统一返回值的类,请评论区留言,以后会专门出一篇文章来说明。

  • 6
    点赞
  • 13
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 3
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Jayden 

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值