Spring Boot 2.x(十):構建優雅的RESTful接口

RESTful

相信在座的各位對於RESTful都是略有耳聞,那麼RESTful究竟是什麼呢?html

REST(Representational State Transfer)表述性狀態轉移是一組架構約束條件和原則。知足這些約束條件和原則的應用程序或設計就是RESTful。須要注意的是,REST是 設計風格而不是標準。REST一般基於使用HTTP,URI,和XML(標準通用標記語言下的一個子集)以及HTML(標準通用標記語言下的一個應用)這些現有的普遍流行的協議和標準。

也許這段話有些晦澀難懂,換個角度咱們來解釋一下RESTful。前端

首先來看一組例子:vue

//查詢全部人員(傳統)
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),翻譯成中文就是統一資源標識符java

資源,咱們在瀏覽器頁面上看到的東西均可以稱之爲資源,好比圖片,文字,語音等等。git

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

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

看到這裏,相信RESTful已經瞭解的差很少了,下面咱們來看看在Spring Boot中如何去使用spring

SpringMVC 構建RESTful接口

SpringMVC中給咱們提供了一些註解,能夠幫助咱們去構建RESTful的接口,下面來直接看代碼:api

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喲~

依次點擊這五個按鈕,能夠看到後臺的控制檯分別打印出了不一樣的語句:

公衆號

原創文章,才疏學淺,若有不對之處,萬望告知!
相關文章
相關標籤/搜索