java設(shè)計(jì)接口的原則和規(guī)范

今天就跟大家聊聊有關(guān)java設(shè)計(jì)接口的原則和規(guī)范，可能很多人都不太了解，為了讓大家更加了解，小編給大家總結(jié)了以下內(nèi)容，希望大家根據(jù)這篇文章可以有所收獲。

1.職責(zé)原則

在設(shè)計(jì)接口時(shí)，必須明確接口的職責(zé)，即接口類型，接口應(yīng)解決什么業(yè)務(wù)問題等

2.單一性原則

在明確接口職責(zé)的條件下，盡量做到接口單一，即一個(gè)接口只做一件事，而非兩件以上。很多非資深接口設(shè)計(jì)者，在設(shè)計(jì)接口時(shí)，總認(rèn)為接口所做的事越多，越牛叉，這是非常嚴(yán)重的錯(cuò)誤認(rèn)識(shí)。

3.協(xié)議規(guī)范

在設(shè)計(jì)接口時(shí)，應(yīng)明確接口協(xié)議，是采用HTTP協(xié)議,HTTPS協(xié)議還是FTP協(xié)議，要根據(jù)具體情況來定。

(1)FTP協(xié)議(File Transfer Protocol，簡(jiǎn)稱FTP)，是一套標(biāo)準(zhǔn)的文件傳輸協(xié)議，用于傳輸文件，如.txt，.csv等，一般文件傳輸，采用FTP協(xié)議

(2)HTTP協(xié)議，適用一般對(duì)安全性要求比較低或沒要求的業(yè)務(wù)情景

(3)HTTPS=HTTP+SSL,適用于對(duì)安全性要求較高的業(yè)務(wù)情景

4.路徑規(guī)則

由于api獲取的是一種資源，所以網(wǎng)址中盡量為名詞，而非動(dòng)詞

/api/v1.0/Pruduct/2019

/api/v1.0/Users/2019

5.http請(qǐng)求方式

接口基本訪問協(xié)議：get(獲取)，post(新增)，put(修改)和delete(刪除)

get     /users：列出所有用戶

get    /users/id：根據(jù)id獲取用戶

post   /user：新增用戶

put      /user/id：根據(jù)用戶id更新用戶

delete   /user/id：根據(jù)用戶id刪除用

看完上述內(nèi)容，你們對(duì)java設(shè)計(jì)接口的原則和規(guī)范有進(jìn)一步的了解嗎？如果還想了解更多知識(shí)或者相關(guān)內(nèi)容，請(qǐng)關(guān)注億速云行業(yè)資訊頻道，感謝大家的支持。