您当前的位置:首页 > 电脑百科 > 程序开发 > 语言 > JAVA

Java如何设计系统接口?

时间:2019-08-05 14:36:51  来源:  作者:

一、规范性建议

1.职责原则

设计接口时,必须明确接口的职责,即接口类型,接口应解决什么业务问题等

2.单一性原则

在明确接口职责的条件下,尽量做到接口单一,即一个接口只做一件事,而非两件以上。

很多非资深接口设计者,在设计接口时,总认为接口所做的事越多,越牛叉,这是非常严重的错误认识。

3.协议规范

在设计接口时,应明确接口协议,是采用HTTP协议,HTTPS协议还是FTP协议,要根据具体情况来定。

(1)FTP协议(File Transfer Protocol,简称FTP),是一套标准的文件传输协议,用于传输文件,如.txt,.csv等,一般文件传输,采用FTP协议

(2)HTTP协议,适用一般对安全性要求比较低或没要求的业务情景

(3)HTTPS=HTTP+SSL,适用于对安全性要求较高的业务情景

4.路径规则

由于api获取的是一种资源,所以网址中尽量为名词,而非动词

/api/v1.0/Product/2019

/api/v1.0/Users/2019

5.http请求方式

接口基本访问协议:get(获取),post(新增),put(修改)和delete(删除)

get /users:列出所有用户

get /users/id:根据id获取用户

post /user:新增用户

put /user/id:根据用户id更新用户

delete /user/id:根据用户id删除用户

6.域名

一般地,域名分为主域名和专有域名,主域名适合api长期不变或变化较少的业务,专有域名是解决具体的专有业务的

以百度举例:

(1)主域名:www.baidu.com

(2)产品服务类

百度文库:https://wenku.baidu.com/

百度知道:https://zhidao.baidu.com/

百度资讯: https://zhidao.baidu.com/

(3)市场活动类

百度公益:http://gongyi.baidu.com

百度logo:http://logo.baidu.com/

百度世界:https://baiduworld.baidu.com

7.跨域考虑

在明确域名的情况下,一定要考虑接口是否跨域,以及跨域应采用的技术手段等

8.api版本

对于接口的url,应加版本号http://api.demo.com/v{d}/,如 ,其中d表示版本号,如v1.0,v2.0

例子:获取产品号为2019,版本号为v1.0的版本号的产品信息

/api/v1.0/Pruducts/2019

9.适度过滤信息

当记录数比较多时(如 SELECT * FROM TBName),应适当添加一些条件对数据进行过滤,如TOP,分页,分组,排序和WHERE条件等

下面是一些常见的参数。

?limit=100:返回100条数据

?offset=101:从第101条数据开始返回

?page=10:指第10页

per_page=100:每页100条数据

?sortby=name:排序字段

?order=desc:降序

?group=groupName:分组

?producy_type=1:筛选条件

10.返回数据格式

返回数据格式,一般包括三个字段:

(1)失败情况(状态码、错误码和错误描述)

 

{
 “status”:0,//状态码 0-表示失败,1-表示成功
 “error_code”:“2003”,//错误码,一般在设计时定义
 “error_des”:“身份验证失败”//错误描述,一般在设计时定义
}

(2)成功情况(标识id,数据对象,状态码)

{
 “sid“:“sh20190111”,//token id
 “users”:{
 “id”:“al201901111341”,//用户id
 “name”:“Alan_beijing”,//用户名
 “addr”:“用户地址”
 },
 “status”:1//状态码 0-表示失败,1-表示成功
}

11.安全性原则

接口暴露的考虑,接口并发量的考虑,接口防攻击的考虑,接口跨域的考虑等

12.可扩展性原则

在设计接口时,充分考虑接口的可扩展性。

13.定义api界限

任何api,从权限上,可归结为匿名api和非匿名api,前者不需要验证,后者需要验证

14.定义api返回码

在api设计时,要定好api返回码,如

  • 1 --授权过期
  • 404--未找到资源
  • 500--内部服务器错误
  • 600--账号被锁

二 、反规范性建议

存在这样一种业务场景:某个接口需要返回多个api接口组合的结果 ,在类似的业务场景下,所设计的接口,具有一定的反规范性。

1.Request

data:[
 {url:'api1',type:'get',data:{...}},
 {url:'api2',type:'get',data:{...}},
]

2.Responce

{
 status:0,
 msg:'',
 data:[
 {status:1,msg:'',data:[]},
 {status:1,msg:'',data:{}}
 ]
}

三 实例

假设存在这样一个一个业务:一个ERP系统,需要提供两个接口,一个是用户访问接口(需要验证),另一个是用户注册接口(不需要验证)。

根据本篇文章一,二部分的建议,我们来设计满足该业务需求的接口

(一)定义统一参数

1.定义统一输入参数

Java程序员必备软素质:如何优雅的设计系统接口?

 

2.定义统一输出参数

Java程序员必备软素质:如何优雅的设计系统接口?

 

3.定义统一错误码

Java程序员必备软素质:如何优雅的设计系统接口?

 

(二)定义接口授权类别

如下为定义接口授权类别

Java程序员必备软素质:如何优雅的设计系统接口?

 

(三)用户接口

1.用户注册

Java程序员必备软素质:如何优雅的设计系统接口?

 

2.Request

Java程序员必备软素质:如何优雅的设计系统接口?

 

3.Responce

Java程序员必备软素质:如何优雅的设计系统接口?

 

4.code示例

Request:
{
 "mobile":13636595499,
 "verify_code":"987654",
 "pwd":"123456"
}
Responce:
(1)error
{
 "status":0,
 "error_code":1001,
 "error_desc":"手机验证码已失效"
}
(2)succed
{
 "sid":"sh201901141529",
 "uid":1,
 "status":1
}

(四)用户登录

1.登录接口概述

Java程序员必备软素质:如何优雅的设计系统接口?

 

2.Request

Java程序员必备软素质:如何优雅的设计系统接口?

 

3.Responce

Java程序员必备软素质:如何优雅的设计系统接口?

 

4.Code

Responce:
1.error
{
 "status":0,
 "error_code":1002,
 "error_desc":"密码错误"
}
2.succeed
{
 "sid":"sh201901141529",
 "user":{
 "id":1,
 "username":"",
 age:0,
 gender:0
 },
 "status":1
}


Tags:Java 系统接口   点击:()  评论:()
声明:本站部分内容及图片来自互联网,转载是出于传递更多信息之目的,内容观点仅代表作者本人,如有任何标注错误或版权侵犯请与我们联系(Email:2595517585@qq.com),我们将及时更正、删除,谢谢。
▌相关推荐
一、规范性建议1.职责原则在设计接口时,必须明确接口的职责,即接口类型,接口应解决什么业务问题等2.单一性原则在明确接口职责的条件下,尽量做到接口单一,即一个接口只做一件事,而...【详细内容】
2019-08-05  Tags: Java 系统接口  点击:(274)  评论:(0)  加入收藏
▌简易百科推荐
面向对象的特征之一封装 面向对象的特征之二继承 方法重写(override/overWrite) 方法的重载(overload)和重写(override)的区别: 面向对象特征之三:多态 Instanceof关键字...【详细内容】
2021-12-28  顶顶架构师    Tags:面向对象   点击:(2)  评论:(0)  加入收藏
一、Redis使用过程中一些小的注意点1、不要把Redis当成数据库来使用二、Arrays.asList常见失误需求:把数组转成list集合去处理。方法:Arrays.asList 或者 Java8的stream流式处...【详细内容】
2021-12-27  CF07    Tags:Java   点击:(3)  评论:(0)  加入收藏
文章目录 如何理解面向对象编程? JDK 和 JRE 有什么区别? 如何理解Java中封装,继承、多态特性? 如何理解Java中的字节码对象? 你是如何理解Java中的泛型的? 说说泛型应用...【详细内容】
2021-12-24  Java架构师之路    Tags:JAVA   点击:(5)  评论:(0)  加入收藏
大家好!我是老码农,一个喜欢技术、爱分享的同学,从今天开始和大家持续分享JVM调优方面的经验。JVM调优是个大话题,涉及的知识点很庞大 Java内存模型 垃圾回收机制 各种工具使用 ...【详细内容】
2021-12-23  小码匠和老码农    Tags:JVM调优   点击:(12)  评论:(0)  加入收藏
前言JDBC访问Postgresql的jsonb类型字段当然可以使用Postgresql jdbc驱动中提供的PGobject,但是这样在需要兼容多种数据库的系统开发中显得不那么通用,需要特殊处理。本文介绍...【详细内容】
2021-12-23  dingle    Tags:JDBC   点击:(13)  评论:(0)  加入收藏
Java与Lua相互调用案例比较少,因此项目使用需要做详细的性能测试,本内容只做粗略测试。目前已完成初版Lua-Java调用框架开发,后期有时间准备把框架进行抽象,并开源出来,感兴趣的...【详细内容】
2021-12-23  JAVA小白    Tags:Java   点击:(11)  评论:(0)  加入收藏
Java从版本5开始,在 java.util.concurrent.locks包内给我们提供了除了synchronized关键字以外的几个新的锁功能的实现,ReentrantLock就是其中的一个。但是这并不意味着我们可...【详细内容】
2021-12-17  小西学JAVA    Tags:JAVA并发   点击:(11)  评论:(0)  加入收藏
一、概述final是Java关键字中最常见之一,表示“最终的,不可更改”之意,在Java中也正是这个意思。有final修饰的内容,就会变得与众不同,它们会变成终极存在,其内容成为固定的存在。...【详细内容】
2021-12-15  唯一浩哥    Tags:Java基础   点击:(17)  评论:(0)  加入收藏
1、问题描述关于java中的日志管理logback,去年写过关于logback介绍的文章,这次项目中又优化了下,记录下,希望能帮到需要的朋友。2、解决方案这次其实是碰到了一个问题,一般的情况...【详细内容】
2021-12-15  软件老王    Tags:logback   点击:(19)  评论:(0)  加入收藏
本篇文章我们以AtomicInteger为例子,主要讲解下CAS(Compare And Swap)功能是如何在AtomicInteger中使用的,以及提供CAS功能的Unsafe对象。我们先从一个例子开始吧。假设现在我们...【详细内容】
2021-12-14  小西学JAVA    Tags:JAVA   点击:(22)  评论:(0)  加入收藏
最新更新
栏目热门
栏目头条