当前位置: 首页 > news >正文

java api接口怎么写_看看人家那后端API接口写的,那叫一个优雅

2551095383d762df9454ce31667e6527.png

来源:小哈学Java 作者:里奥ii r6d.cn/tEvn 在移动互联网,分布式、微服务盛行的今天,现在项目绝大部分都采用的微服务框架,前后端分离方式,(题外话:前后端的工作职责越来越明确,现在的前端都称之为大前端,技术栈以及生态圈都已经非常成熟;以前后端人员瞧不起前端人员,那现在后端人员要重新认识一下前端,前端已经很成体系了)。 一般系统的大致整体架构图如下:

65c91853c908198a8456fc1ea301fbe1.png

前端和后端进行交互,前端按照约定请求URL路径,并传入相关参数,后端服务器接收请求,进行业务处理,返回数据给前端。 着重介绍一下后端服务器如何实现把数据返回给前端? 返回格式 后端返回给前端我们一般用JSON体方式,定义如下: { #返回状态码 code:integer, #返回信息描述 message:string, #返回值 data:object} CODE状态码 code返回状态码,一般小伙伴们是在开发的时候需要什么,就添加什么。 如接口要返回用户权限异常,我们加一个状态码为101吧,下一次有要加一个数据参数异常,就加一个102的状态码。这样虽然能够照常满足业务,但状态码太凌乱了 我们应该可以参考HTTP请求返回的状态码

d9e4b5916dbd1c78be1a51edea8da2cd.png

我们可以参考这样的设计,这样的好处就把错误类型归类到某个区间内,如果区间不够,可以设计成4位数。 #1000~1999 区间表示参数错误#2000~2999 区间表示用户错误#3000~3999 区间表示接口异常 这样前端开发人员在得到返回值后,根据状态码就可以知道,大概什么错误,再根据message相关的信息描述,可以快速定位。 Message 这个字段相对理解比较简单,就是发生错误时,如何友好的进行提示。一般的设计是和code状态码一起设计,如

3ace728a6f636f36825bce29a66f68b2.png

再在枚举中定义,状态码

f9781e60b8a25c2947da5ab2d0848f80.png

状态码和信息就会一一对应,比较好维护。 Data 返回数据体,JSON格式,根据不同的业务有不同的JSON体。 我们要设计一个返回体类Result

d8da46fa56a3fafc409965b3d47827ee.png

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

76e6702bd5c6c46d7e620fdfb39e545f.png

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

b8f465949b0440bb44664af0d7218e3f.png

那我们来改造一下Controller

f1ccfb5ac8120bdba139ea325486464b.png

代码是不是比较简洁了,也美观了。 优雅优化 上面我们看到在Result类中增加了静态方法,使得业务处理代码简洁了。但小伙伴们有没有发现这样有几个问题: 我们最好的方式直接返回真实业务对象,最好不要改变之前的业务方式,如下图

e1c915bd0fe5a65101d95bde3791d2d8.png

这个和我们平时的代码是一样的,非常直观,直接返回order对象,这样是不是很完美。那实现方案是什么呢? 实现方案 小伙伴们怎么去实现是不是有点思路,在这个过程中,我们需要做几个事情 注解类 用来标记方法的返回值,是否需要包装

8583174f4db691f659a072ee8bf9b36e.png

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

a206ebf5e2ac30608a12e5052f169ab5.png

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

c30d86dc541d870c55e59f31e46fa24f.png

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

f3592806550305ec0d17b3f757451942.png

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

78c99bc3c41b1928c7c261138e5ed632.png

在控制器类上或者方法体上加上@ResponseResult注解,这样就ok了,简单吧。到此返回的设计思路完成,是不是又简洁,又优雅。 总结 这个方案还有没有别的优化空间,当然是有的。如:每次请求都要反射一下,获取请求的方法是否需要包装,其实可以做个缓存,不需要每次都需要解析。当然整体思路了解,小伙伴们就可以在此基础上面自行扩展。谢谢!!!

本文转载自网易号【自己的身体】,更多内容请点击“阅读原文”

905267e497eea6fdc8dbe121d337ca3e.png

相关文章:

  • 彻底解决Symbian全屏显示问题
  • python与java后台_【Web后端工程师-Python/Java是做什么的】知乎2020年Web后端工程师-Python/Java岗位职责-看准网...
  • python os模块需要安装吗_Python模块常用的几种安装方式
  • python获取当前时间的函数_在Python中获取毫秒和微秒
  • 浅析互联网创新为电信业发展带来的启示
  • mysql replace函数_mysql数据库学习(第二十二篇)- 函数
  • 3G与WIMAX竞争中融合 终端内容趋同
  • word 正则表达式 替换_GVIM正则表达式
  • 书讯 -- Training Kit:SQL Server 2005 实作与维护 I II
  • 成功人生生涯规划精进要诀24条
  • 随机抽人名小程序_python小程序(3):turtle随机画心
  • 个人理财十大“通用”原则
  • c++ lambda函数_c++ functors 和 自定义比较函数
  • 人生理财的六个阶段详解
  • python可以开多少线程_python线程数量与线程池
  • 【划重点】MySQL技术内幕:InnoDB存储引擎
  • 【译】React性能工程(下) -- 深入研究React性能调试
  • 【跃迁之路】【699天】程序员高效学习方法论探索系列(实验阶段456-2019.1.19)...
  • axios 和 cookie 的那些事
  • Docker 笔记(2):Dockerfile
  • input实现文字超出省略号功能
  • JDK 6和JDK 7中的substring()方法
  • JS题目及答案整理
  • NSTimer学习笔记
  • spring cloud gateway 源码解析(4)跨域问题处理
  • Vue UI框架库开发介绍
  • win10下安装mysql5.7
  • 复杂数据处理
  • 规范化安全开发 KOA 手脚架
  • 和 || 运算
  • 想写好前端,先练好内功
  • 小程序button引导用户授权
  • 原生js练习题---第五课
  • 《码出高效》学习笔记与书中错误记录
  • 3月7日云栖精选夜读 | RSA 2019安全大会:企业资产管理成行业新风向标,云上安全占绝对优势 ...
  • Java性能优化之JVM GC(垃圾回收机制)
  • ###项目技术发展史
  • (C语言)strcpy与strcpy详解,与模拟实现
  • (Redis使用系列) Springboot 实现Redis消息的订阅与分布 四
  • (二)正点原子I.MX6ULL u-boot移植
  • (附源码)spring boot车辆管理系统 毕业设计 031034
  • (六)vue-router+UI组件库
  • (论文阅读笔记)Network planning with deep reinforcement learning
  • (三)Hyperledger Fabric 1.1安装部署-chaincode测试
  • (三)Pytorch快速搭建卷积神经网络模型实现手写数字识别(代码+详细注解)
  • (三)uboot源码分析
  • (四)汇编语言——简单程序
  • (转)nsfocus-绿盟科技笔试题目
  • .NET 反射的使用
  • .NET 中的轻量级线程安全
  • .NET/C# 反射的的性能数据,以及高性能开发建议(反射获取 Attribute 和反射调用方法)
  • .NET程序员迈向卓越的必由之路
  • .Net环境下的缓存技术介绍
  • .NET简谈互操作(五:基础知识之Dynamic平台调用)
  • .Net转Java自学之路—SpringMVC框架篇六(异常处理)