SpringMVC開發RESTful介面

来源:https://www.cnblogs.com/yangyuanhu/archive/2020/02/13/12304791.html
-Advertisement-
Play Games

概念: 什麼是REST? REST是Representational State Transfer的縮寫。翻譯為"表現層狀態轉化",restful是一種介面設計風格,它不是一個協議,通常是基於HTTP協議的; 為什麼需要這麼一個風格呢? RESTful的重點之一就是統一的介面命名規則; 每個開發者可 ...


概念:

什麼是REST?

REST是Representational State Transfer的縮寫。翻譯為"表現層狀態轉化",restful是一種介面設計風格,它不是一個協議,通常是基於HTTP協議的;

為什麼需要這麼一個風格呢?

RESTful的重點之一就是統一的介面命名規則;

每個開發者可能會有不同的介面風格,最常見的就類似於於getUserInfo,deleteUserInfo等等.....,但是這個純粹是跟每個開發者的習慣有關,多人協同開發時就可能會產生問題,特別是前後臺分離時,前臺人員不得不填寫大量各不相同的url來請求數據;

RESTful風格:

rest將每一個URI都看作是一個資源,這是一個概念,實際可以是一個圖片,一條記錄,一組記錄都可以; 每一種請求方法都對應著對某個資源的操作,通常包含以下四種:

  • GET 獲取資源
  • PUT 更新資源
  • POST 提交資源
  • DELETE 刪除資源

假設我們將id為1的用戶數據看做是一個資源,那麼我們要在前臺操作這個資源時就要向伺服器發送能夠定位這個資源的請求地址,如:http://localhost:8080/SSMDemo/user/1 ,通過URI找到資源後,我們還要告訴伺服器我們要對這個資源進行什麼樣的操作,就通過HTTP的請求方法;如GET

簡單的說:RESTful就是用URI來定位資源,在通過請求方法來定義要執行的操作;

目前而言完全按照RESTful來設計的網站並不多,亞馬遜算是最早採用這種風格的網站之一,它的URL是像這樣:https://www.amazon.cn/gp/product/B00MCW8R1S

RESTful的無狀態性:

無狀態約束使伺服器的變化對客戶端是不可見的,兩次連續的請求中,客戶端不依賴於同一臺伺服器,這使得伺服器具備更好的伸縮性;

RESTful為系統帶來的好處:

降低開發的複雜性,提高系統的可伸縮性,使得介面更加規範化;

URI與URL:

URL是統一資源標識 (只要能唯一標識一個資源就叫做URI)

URL是統一資源路徑

URL屬於URI的一種

SpringMVC中的RESTful

可以看出來,RESTful的變化在於,請求地址的處理,以及請求方法的定義;

我們有兩個事情要做:

  • 需要從URL中獲取一些參數
  • 使得同一個介面的不同請求方法可以完成對應的操作

案例:設計一個對課程資源進行操作的RESTful介面

編寫controller

package com.kkb.controller;

import com.kkb.pojo.Course;
import com.kkb.service.CourseService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

@RestController
public class RESTCourseController {

    @Autowired
    CourseService service;

    //獲取全部課程
        @RequestMapping(value = "/course",method = RequestMethod.GET)
    public List<Course> getCourseList(){
        System.out.println("getCourseList");
        return service.selectCourses();
    }  
    //根據id獲取某個課程
    @RequestMapping(value = "/course/{id}",method = RequestMethod.GET)
    public Course getCourse(@PathVariable Integer id){
        System.out.println("getCourse");
        System.out.println("參數:"+id);
        return service.selectByID(id);
    }
      //添加新的課程
    @RequestMapping(value = "/course",method = RequestMethod.POST)
    public String addCourse(@RequestBody Course course){
        System.out.println("addCourse");
        System.out.println("參數:"+course);
        service.insertCourse(course);
        return "{\"msg\":\"success\"}";
    }
        //根據id刪除課程
    @RequestMapping(value = "/course/{id}",method = RequestMethod.DELETE)
    public String deleteCourse(@PathVariable Integer id){
        System.out.println("deleteCourse");
        System.out.println("參數:"+id);
        service.deleteCourse(id);
        return "{\"msg\":\"success\"}";
    }
    //根據id更新課程
    @RequestMapping(value = "/course",method = RequestMethod.PUT)
    public String updateCourse(@RequestBody Course course){
        System.out.println("updateCourse");
        System.out.println("參數:"+course);
        service.updateCourse(course);
        return "{\"msg\":\"success\"}";
    }
}

@PathVariable是專門用於從url中獲取參數的,在RequestMapping中添加{參數名稱},作為占位符, 參數名稱需要與方法中的參數名稱相同,若不同可以為@PathVariable添加value(通常沒必要這麼做),像下麵這樣:

  @RequestMapping(value = "/course/{cid}",method = RequestMethod.GET)
    public Course getCourse(@PathVariable("cid") Integer id){
        System.out.println("getCourse");
        System.out.println("參數:"+id);
        return service.selectByID(id);
    }

介面測試推薦使用postman mac可使用paw,

另外在實際開發中我們需要前臺傳遞用戶令牌,以驗證身份;可以通過攔截器來實現;

補充:

Tomcat 只會解析get和post中的參數,若SpringMVC中使用了PUT或是DELETE,並且使用的是表單提交,那麼將無法獲取參數,應為Tomcat沒有經參數接續出來放到request中,SpringMVC提供了一個過濾器,專門幫助tomcat解析put/delete中的參數並放入request中,配置方法如下:

web.xml:

<!--配置SpringMVC,解析PUT/DELETE的表單數據放入request-->
    <filter>
        <filter-name>HttpPutFormContentFilter</filter-name>
        <filter-class>org.springframework.web.filter.FormContentFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>HttpPutFormContentFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

上述的問題在使用json交互時不會出現,因為SpringMVC是直接從請求體中獲取json數據的,不通過request;

啰嗦:如果頁面上的表單使用了PUT/或DELETE請求方式,就需要在web.xml中加入上面的過濾器;


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 一、cookie的保存與讀取 1.cookie的保存-FileCookie.Jar from urllib import request,parse from http import cookiejar #創建cookiejar實例 filename = "cookie.txt" cookie = ...
  • JavaSE學習筆記(12) 線程 多線程 併發與並行 併發 :指兩個或多個事件在 同一個時間段內 發生。 並行 :指兩個或多個事件在 同一時刻 發生(同時發生)。 在操作系統中,安裝了多個程式,併發指的是在一段時間內巨集觀上有多個程式同時運行,這在單 CPU 系統中,每一時刻只能有一道程式執行,即微 ...
  • MySQL官方對索引的定義為:索引(Index)是幫助MySQL高效獲取數據的數據結構。 資料庫查詢是資料庫的最主要功能之一,我們都希望查詢數據的速度能儘可能的快,因此資料庫系統的設計者會從查詢演算法的角度進行優化,這篇文章對索引做一個系統的梳理,希望對大家有幫助。 一、MySQL有哪些索引類型 索引 ...
  • 最近需要設計一個API伺服器,想要把API介面搞得規範一下,就通過網上搜集到了一些資料,以下便是自己的一些理解以及相關的具體實現 本文采用的是spring boot+maven的方案 restful規範 這個規範我在這裡也不打算長篇大論地講解,怎麼說呢,有人喜歡有人討厭,我也不去爭,因為我經驗不多, ...
  • 一、判斷一個數字X的i位是不是1 二、把一個數字二進位下的第i位改成1 三、把一個數字二進位下的最靠右的第一個1改成0(去掉) ...
  • windows破解教程 1. 首先下載jar包:(雲盤鏈接發不上去,大家關註gzh" 灰太狼學爪哇 "回覆 idea 獲取)將其放到合適的文件夾(首選IDEA的同級目錄)進行管理; 2. 進入C盤 — 用戶 — 用戶名 — .IntelliJIdea2019.2或者.IntelliJIdea2019 ...
  • VisualVM在Java 8中是JDK自帶的一個圖形化工具,項目主頁 "VisualVM" ,在後續版本中可能會從JDK移除。 VisualVM可以監控Java進程的CPU與記憶體占用情況,可以監控Java進程內的各個線程的執行情況,還可以與MAT工具一樣用來分析堆轉儲快照。 監控遠程Tomcat進 ...
  • 1.前提條件 1). 確保已經安裝需要的Python版本 2). 確保已經將Python的目錄加入到環境變數中 2. Python安裝包的幾種常用方式 1). pip安裝方式(正常線上安裝) 2). whl安裝方式(離線安裝),一般是.whl格式的包 3). 源碼安裝方式(離線安裝),tar.gz/ ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...