Spring Boot 2.x（十）：構建優雅的RESTful接口

nevermind 發布于2019-08-19 10:18 / 2326人閱讀

摘要：滿足這些約束條件和原則的應用程序或設計就是。需要注意的是，是設計風格而不是標準。同一個路徑，因為請求方式的不同，而去找尋不同的接口，完成對資源狀態的轉變。一個符合風格的就可以稱之一個的接口。

RESTful

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

REST（Representational State Transfer）表述性狀態轉移是一組架構約束條件和原則。滿足這些約束條件和原則的應用程序或設計就是RESTful。需要注意的是，REST是設計風格而不是標準。REST通常基于使用HTTP，URI，和XML（標準通用標記語言下的一個子集）以及HTML（標準通用標記語言下的一個應用）這些現有的廣泛流行的協議和標準。

也許這段話有些晦澀難懂，換個角度我們來解釋一下RESTful。

首先來看一組例子：

//查詢所有人員（傳統）
localhost:8088/api/user/findAll 請求方式：GET
//查詢所有人員（RESTful）
localhost:8088/api/users    請求方式：GET

//修改人員（傳統）
localhost:8088/api/user/update 請求方式：POST
//修改人員（RESTful）
localhost:8088/api/users    請求方式：PUT

//添加人員（傳統）
localhost:8088/api/user/add    請求方式：POST
//添加人員（RESTful）
localhost:8088/api/users    請求方式：POST

//刪除人員（傳統）
localhost:8088/api/user/delete    請求方式：DELETE
//刪除人員（RESTful）
localhost:8088/api/users    請求方式：DELETE

我們通常稱地址欄中輸入的地址為URI（Uniform Resource Identifier），翻譯成中文就是統一資源標識符。

資源，我們在瀏覽器頁面上看到的東西都可以稱之為資源，比如圖片，文字，語音等等。

而URI就是用于定位這些資源的位置的，RESTful風格的接口中只出現了表示資源的名詞，關于這個資源的操作，通過HTTP內置的幾種請求類型來區分。同一個路徑localhost:8088/api/users，因為請求方式的不同，而去找尋不同的接口，完成對資源狀態的轉變。

總結一下，REST就是指對同一個URI的資源的不同請求方式（GET，POST，PUT，DELETE）（表述）下的做出的不同的操作（查，增，改，刪），改變的是資源的狀態，即表述性狀態轉移。一個符合REST風格的URI就可以稱之一個RESTful的接口。

看到這里，相信RESTful已經了解的差不多了，下面我們來看看在Spring Boot中如何去使用

SpringMVC 構建RESTful接口

SpringMVC中給我們提供了一些注解，可以幫助我們去構建RESTful的接口，下面來直接看代碼：

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;

/**
 * 
 *  前端控制器
 * 
 *
 * @author viyoung
 * @since 2019-01-23
 */
@RestController
@RequestMapping("/users")
@Slf4j
@CrossOrigin
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping
    public List get() {
        log.info("GET方法執行。。。");
        return userService.list();
    }

    @GetMapping(value = "/{id}")
    public User get(@PathVariable String id) {
        log.info("GET..{}...方法執行。。。",id);
        return userService.getById(id);
    }

    @PostMapping
    public void post() {
        log.info("POST方法執行。。。");
    }

    @PutMapping
    public void put() {
        log.info("PUT方法執行。。。");
    }

    @DeleteMapping
    public void delete() {
        log.info("DELETE方法執行。。。");
    }
}

這里的工程創建可以參照Spring Boot 2.x（五）：Mybatis-Plus + Spring Boot。

下面我們也許需要一個前端的工程或者POSTMAN等測試接口的工具來發送不同的請求，我這里已經寫好了一個前端的基于vue的工程，有需要的可以去下載一下：viboot-front。記得順手點個star喲~

依次點擊這五個按鈕，可以看到后臺的控制臺分別打印出了不同的語句：

公眾號

原創文章，才疏學淺，如有不對之處，萬望告知！

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://m.specialneedsforspecialkids.com/yun/75799.html

Spring Boot [如何優雅的編寫文檔]

摘要：導讀在團隊協作的時候許多時候需要用到接口文檔，我們通常通過手工編寫大量重復格式的文檔，讓我想起了程序員最討厭的兩件事沒有文檔，編寫文檔。對應的資料可自行谷歌。關于和官網是這樣描述的。我們可以理解為為基于構建的自動生成文檔。導讀：在團隊協作的時候許多時候需要用到接口文檔，我們通常通過手工編寫大量重復格式的文檔，讓我想起了程序員最討厭的兩件事：沒有文檔，編寫文檔。哈哈，如果使用過swa...

曹金海 2019-08-16 10:33 評論0 收藏0
SpringBoot-vue 基于Java的微服務全棧快速開發實踐

摘要：本項目將使用配合最簡單的邏輯來展示一個基于的微服務全棧快速開發實踐的。提供一系列大型項目常用的非功能性特征，比如內嵌服務器，安全，指標，健康檢測，外部化配置。 SprintBoot-Vue SpringBoot ＋前端MVVM 基于Java的微服務全棧快速開發實踐 showImg(https://segmentfault.com/img/remote/1460000010167913...

FleyX 2019-08-21 11:48 評論0 收藏0
SpringBoot-vue 基于Java的微服務全棧快速開發實踐

摘要：本項目將使用配合最簡單的邏輯來展示一個基于的微服務全棧快速開發實踐的。提供一系列大型項目常用的非功能性特征，比如內嵌服務器，安全，指標，健康檢測，外部化配置。 SprintBoot-Vue SpringBoot ＋前端MVVM 基于Java的微服務全棧快速開發實踐 showImg(https://segmentfault.com/img/remote/1460000010167913...

neu 2019-08-15 10:50 評論0 收藏0
SpringBoot 實戰 (五) | 集成 Swagger2 構建強大的 RESTful API

摘要：今天給你們帶來集成的教程。接口返回結果不明確。這些痛點在前后端分離的大型項目上顯得尤為煩躁。接口返回結果非常明確，包括數據類型，狀態碼，錯誤信息等。生成后的文件依賴如下這里使用的是的版本。另外，關注之后在發送可領取免費學習資料。微信公眾號：一個優秀的廢人如有問題或建議，請后臺留言，我會盡力解決你的問題。前言快過年了，不知道你們啥時候放年假，忙不忙。反正我是挺閑的，所以有時間寫 b...

Rindia 2019-08-16 15:12 評論0 收藏0