一文詳解如何使用Spring MVC實(shí)現(xiàn)RESTful API接口
一、RESTful 核心概念
1. 請(qǐng)求類(lèi)型與操作對(duì)應(yīng)關(guān)系
- POST → 新增數(shù)據(jù)
- PUT → 修改數(shù)據(jù)
- GET → 查詢(xún)數(shù)據(jù)
- DELETE → 刪除數(shù)據(jù)
2. RESTful 設(shè)計(jì)原則
- 路徑代表資源(使用名詞,不用動(dòng)詞)
- 請(qǐng)求類(lèi)型代表動(dòng)作
- 瀏覽器默認(rèn)發(fā)送 GET 請(qǐng)求
二、傳統(tǒng)傳參 vs RESTful 傳參
傳統(tǒng)方式(查詢(xún)參數(shù))
https://google.com/search?q=keyword&page=1
- 使用
?和&拼接參數(shù)
RESTful 風(fēng)格(路徑參數(shù))
/api/users/123
- 參數(shù)值直接放在路徑中
- 使用
/分隔多個(gè)參數(shù) - 不需要參數(shù)名
三、Spring MVC 實(shí)現(xiàn)示例
1. 無(wú)參 GET 請(qǐng)求
@RestController
@RequestMapping("/api")
public class ApiController {
@GetMapping("/test")
public String getNoParam() {
return "無(wú)參GET請(qǐng)求API接口方法";
}
}
2. RESTful 風(fēng)格帶參 GET 請(qǐng)求
@GetMapping("/user/{id}")
public String getWithPathParam(@PathVariable String id) {
return "RESTful請(qǐng)求傳值方法,ID: " + id;
}
訪問(wèn)路徑:/api/user/123
3. 傳統(tǒng)方式帶參 GET 請(qǐng)求
@GetMapping("/user")
public String getWithQueryParam(@RequestParam String id) {
return "GET普通請(qǐng)求傳值方法,ID: " + id;
}
訪問(wèn)路徑:/api/user?id=123
4. POST 請(qǐng)求(接收請(qǐng)求體)
@PostMapping("/save")
public String postMethod(@RequestBody Map<String, Object> map) {
return "POST請(qǐng)求接收成功: " + map;
}
5. PUT 請(qǐng)求
@PutMapping("/update/{id}")
public String putMethod(@PathVariable String id, @RequestBody Map<String, Object> map) {
return "PUT請(qǐng)求接收成功,ID: " + id + ", 數(shù)據(jù): " + map;
}
6. DELETE 請(qǐng)求
@DeleteMapping("/delete/{id}")
public String deleteMethod(@PathVariable String id) {
return "DELETE請(qǐng)求接收成功,ID: " + id;
}
四、關(guān)鍵注解說(shuō)明
@RestController: 組合注解,包含@Controller和@ResponseBody@RequestMapping: 類(lèi)級(jí)別的路徑映射@GetMapping/@PostMapping/@PutMapping/@DeleteMapping: 方法級(jí)別的請(qǐng)求映射@PathVariable: 從路徑中獲取參數(shù)值@RequestParam: 從查詢(xún)參數(shù)中獲取值@RequestBody: 從請(qǐng)求體中獲取數(shù)據(jù)
五、測(cè)試工具
- API Fox
- Postman
- 其他接口調(diào)試工具
六、Spring MVC 匹配機(jī)制
Spring MVC 會(huì)根據(jù):
- 請(qǐng)求類(lèi)型(GET/POST/PUT/DELETE)
- 請(qǐng)求路徑
- 參數(shù)傳遞方式
自動(dòng)匹配對(duì)應(yīng)的控制器方法。
實(shí)際開(kāi)發(fā)建議
- 保持 RESTful 風(fēng)格的一致性
- 合理設(shè)計(jì)資源路徑(使用名詞)
- 根據(jù)操作類(lèi)型選擇合適的 HTTP 方法
- 在實(shí)際項(xiàng)目中,這些方式都會(huì)用到,根據(jù)場(chǎng)景靈活選擇
以上就是一文詳解如何使用Spring MVC實(shí)現(xiàn)RESTful API接口的詳細(xì)內(nèi)容,更多關(guān)于Spring MVC實(shí)現(xiàn)RESTful API接口的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
java 使用URLDecoder和URLEncoder對(duì)中文進(jìn)行處理
這篇文章主要介紹了java 使用URLDecoder和URLEncoder對(duì)中文進(jìn)行處理的相關(guān)資料,需要的朋友可以參考下2017-02-02
通過(guò)實(shí)例解析POJO和JavaBean的區(qū)別
這篇文章主要介紹了通過(guò)實(shí)例解析POJO和JavaBean的區(qū)別,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-07-07
學(xué)習(xí)JVM之java內(nèi)存區(qū)域與異常
關(guān)于JVM內(nèi)存區(qū)域的知識(shí)對(duì)于初學(xué)者來(lái)說(shuō)其實(shí)是很重要的,了解Java內(nèi)存分配的原理,這對(duì)于以后JAVA的學(xué)習(xí)會(huì)有更深刻的理解。下面來(lái)看看詳細(xì)介紹。2016-07-07
java 對(duì)象參數(shù)去空格方式代碼實(shí)例
這篇文章主要介紹了java 對(duì)象參數(shù)去空格方式代碼實(shí)例,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2019-10-10
PostConstruct注解標(biāo)記類(lèi)ApplicationContext未加載空指針
這篇文章主要為大家介紹了@PostConstruct注解標(biāo)記類(lèi)ApplicationContext未加載空指針示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2022-11-11
Java中的八種基本數(shù)據(jù)類(lèi)型詳解
本文詳細(xì)講解了Java中的八種基本數(shù)據(jù)類(lèi)型,文中通過(guò)示例代碼介紹的非常詳細(xì)。對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2022-03-03
使用maven創(chuàng)建普通項(xiàng)目命令行程序詳解
大部分使用maven創(chuàng)建的是web項(xiàng)目,這里使用maven創(chuàng)建一個(gè)命令行程序,目的是讓大家了解maven特點(diǎn)和使用方式,有需要的朋友可以借鑒參考下2021-10-10
關(guān)于Maven依賴(lài)沖突解決之exclusions
這篇文章主要介紹了關(guān)于Maven依賴(lài)沖突解決之exclusions用法,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-12-12

