今天就跟大家聊聊有關(guān)SpringBoot如何實(shí)現(xiàn)后端接口,可能很多人都不太了解,為了讓大家更加了解,小編給大家總結(jié)了以下內(nèi)容,希望大家根據(jù)這篇文章可以有所收獲。
一個(gè)后端接口大致分為四個(gè)部分組成:接口地址(url)、接口請(qǐng)求方式(get、post等)、請(qǐng)求數(shù)據(jù)(request)、響應(yīng)數(shù)據(jù)(response)。如何構(gòu)建這幾個(gè)部分每個(gè)公司要求都不同,沒有什么“一定是最好的”標(biāo)準(zhǔn),但一個(gè)優(yōu)秀的后端接口和一個(gè)糟糕的后端接口對(duì)比起來差異還是蠻大的,其中最重要的關(guān)鍵點(diǎn)就是看是否規(guī)范!
本文就一步一步演示如何構(gòu)建起一個(gè)優(yōu)秀的后端接口體系,體系構(gòu)建好了自然就有了規(guī)范,同時(shí)再構(gòu)建新的后端接口也會(huì)十分輕松。
所需依賴包
這里用的是SpringBoot配置項(xiàng)目,本文講解的重點(diǎn)是后端接口,所以只需要導(dǎo)入一個(gè)spring-boot-starter-web包就可以了:
本文還用了swagger來生成API文檔,lombok來簡(jiǎn)化類,不過這兩者不是必須的,可用可不用。
參數(shù)校驗(yàn)
一個(gè)接口一般對(duì)參數(shù)(請(qǐng)求數(shù)據(jù))都會(huì)進(jìn)行安全校驗(yàn),參數(shù)校驗(yàn)的重要性自然不必多說,那么如何對(duì)參數(shù)進(jìn)行校驗(yàn)就有講究了。
業(yè)務(wù)層校驗(yàn)
首先我們來看一下最常見的做法,就是在業(yè)務(wù)層進(jìn)行參數(shù)校驗(yàn):
public String addUser(User user) { if (user == null || user.getId() == null || user.getAccount() == null || user.getPassword() == null || user.getEmail() == null) { return "對(duì)象或者對(duì)象字段不能為空"; } if (StringUtils.isEmpty(user.getAccount()) || StringUtils.isEmpty(user.getPassword()) || StringUtils.isEmpty(user.getEmail())) { return "不能輸入空字符串"; } if (user.getAccount().length() < 6 || user.getAccount().length() > 11) { return "賬號(hào)長(zhǎng)度必須是6-11個(gè)字符"; } if (user.getPassword().length() < 6 || user.getPassword().length() > 16) { return "密碼長(zhǎng)度必須是6-16個(gè)字符"; } if (!Pattern.matches("^[a-zA-Z0-9_-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$", user.getEmail())) { return "郵箱格式不正確"; } // 參數(shù)校驗(yàn)完畢后這里就寫上業(yè)務(wù)邏輯 return "success"; }