快捷導(dǎo)航

Spring Boot構(gòu)建優(yōu)雅的RESTful接口過(guò)程詳解

更新時(shí)間：2019年08月07日 10:49:22 作者：Vi的技術(shù)博客

這篇文章主要介紹了spring boot構(gòu)建優(yōu)雅的RESTful接口過(guò)程詳解,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下

RESTful

相信在座的各位對(duì)于RESTful都是略有耳聞，那么RESTful到底是什么呢？

REST（Representational State Transfer）表述性狀態(tài)轉(zhuǎn)移是一組架構(gòu)約束條件和原則。滿足這些約束條件和原則的應(yīng)用程序或設(shè)計(jì)就是RESTful。需要注意的是，REST是設(shè)計(jì)風(fēng)格而不是標(biāo)準(zhǔn)。REST通常基于使用HTTP，URI，和XML（標(biāo)準(zhǔn)通用標(biāo)記語(yǔ)言下的一個(gè)子集）以及HTML（標(biāo)準(zhǔn)通用標(biāo)記語(yǔ)言下的一個(gè)應(yīng)用）這些現(xiàn)有的廣泛流行的協(xié)議和標(biāo)準(zhǔn)。

也許這段話有些晦澀難懂，換個(gè)角度我們來(lái)解釋一下RESTful。

首先來(lái)看一組例子：

//查詢所有人員（傳統(tǒng)）
localhost:8088/api/user/findAll 請(qǐng)求方式：GET
//查詢所有人員（RESTful）
localhost:8088/api/users 請(qǐng)求方式：GET
//修改人員（傳統(tǒng)）
localhost:8088/api/user/update 請(qǐng)求方式：POST
//修改人員（RESTful）
localhost:8088/api/users 請(qǐng)求方式：PUT
//添加人員（傳統(tǒng)）
localhost:8088/api/user/add 請(qǐng)求方式：POST
//添加人員（RESTful）
localhost:8088/api/users 請(qǐng)求方式：POST
//刪除人員（傳統(tǒng)）
localhost:8088/api/user/delete 請(qǐng)求方式：DELETE
//刪除人員（RESTful）
localhost:8088/api/users 請(qǐng)求方式：DELETE

我們通常稱地址欄中輸入的地址為URI（Uniform Resource Identifier），翻譯成中文就是統(tǒng)一資源標(biāo)識(shí)符。

資源，我們?cè)跒g覽器頁(yè)面上看到的東西都可以稱之為資源，比如圖片，文字，語(yǔ)音等等。

而URI就是用于定位這些資源的位置的，RESTful風(fēng)格的接口中只出現(xiàn)了表示資源的名詞，關(guān)于這個(gè)資源的操作，通過(guò)HTTP內(nèi)置的幾種請(qǐng)求類型來(lái)區(qū)分。同一個(gè)路徑localhost:8088/api/users，因?yàn)檎?qǐng)求方式的不同，而去找尋不同的接口，完成對(duì)資源狀態(tài)的轉(zhuǎn)變。

總結(jié)一下，REST就是指對(duì)同一個(gè)URI的資源的不同請(qǐng)求方式（GET，POST，PUT，DELETE）（表述）下的做出的不同的操作（查，增，改，刪），改變的是資源的狀態(tài)，即表述性狀態(tài)轉(zhuǎn)移。一個(gè)符合REST風(fēng)格的URI就可以稱之一個(gè)RESTful的接口。

看到這里，相信RESTful已經(jīng)了解的差不多了，下面我們來(lái)看看在Spring Boot中如何去使用

SpringMVC 構(gòu)建RESTful接口

SpringMVC中給我們提供了一些注解，可以幫助我們?nèi)?gòu)建RESTful的接口，下面來(lái)直接看代碼：

package indi.viyoung.viboot.restful.controller;
import indi.viyoung.viboot.restful.entity.User;
import indi.viyoung.viboot.restful.service.UserService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.util.List;

/**
 * <p>
 * 前端控制器
 * </p>
 *
 * @author viyoung
 * @since 2019-01-23
 */
@RestController
@RequestMapping("/users")
@Slf4j
@CrossOrigin
public class UserController {
 @Autowired
 private UserService userService;
 @GetMapping
 public List<User> get() {
  log.info("GET方法執(zhí)行。。。");
  return userService.list();
 }
 @GetMapping(value = "/{id}")
 public User get(@PathVariable String id) {
  log.info("GET..{}...方法執(zhí)行。。。",id);
  return userService.getById(id);
 }
 @PostMapping
 public void post() {
  log.info("POST方法執(zhí)行。。。");
 }
 @PutMapping
 public void put() {
  log.info("PUT方法執(zhí)行。。。");
 }
 @DeleteMapping
 public void delete() {
  log.info("DELETE方法執(zhí)行。。。");
 }
}

下面我們也許需要一個(gè)前端的工程或者POSTMAN等測(cè)試接口的工具來(lái)發(fā)送不同的請(qǐng)求，我這里已經(jīng)寫好了一個(gè)前端的基于vue的工程，有需要的可以去下載一下：viboot-front。記得順手點(diǎn)個(gè)star喲~