您的位置 首页 java

设计java中的接口需要遵循哪些原则

设计java接口的规范性建议:

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/Pruduct/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删除用

推荐教程:java开发入门

文章来源:智云一二三科技

文章标题:设计java中的接口需要遵循哪些原则

文章地址:https://www.zhihuclub.com/16285.shtml

关于作者: 智云科技

热门文章

网站地图