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

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;

/**
 * <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方法執行。。。");
        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喲~

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

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

公眾號

您的推薦就是對我最大的支持！