day02-REST和SpringMVC映射請求數據

来源:https://www.cnblogs.com/liyuelian/archive/2023/02/05/17094036.html
-Advertisement-
Play Games

REST和SpringMVC映射請求數據 7.REST-優雅的url請求風格 7.1REST基本介紹 REST風格詳細介紹 REST：即 Representational State Transfer，表述性狀態傳遞。它結構清晰，同時可以隱藏行為。 通過一個url來直觀展示傳統風格與REST風格的區 ...


REST和SpringMVC映射請求數據

7.REST-優雅的url請求風格

7.1REST基本介紹

REST風格詳細介紹

  1. REST：即 Representational State Transfer，表述性狀態傳遞。它結構清晰，同時可以隱藏行為。

  2. 通過一個url來直觀展示傳統風格與REST風格的區別：

    • 傳統風格：
      當我們在瀏覽器上訪問一些資源時，可以看到有些網頁的url為

      http://localhost/students/selectById?id=1 （該地址表示查找id為1的students對象）

      http://localhost/students/saveStudent（該地址表示保存students信息）

    • REST風格：
      http://localhosts/student/1

      http://localhosts/student

    通過這兩種風格的對比，我們可以看到REST風格的一部分優點：

    （1）可以隱藏資源訪問行為（如隱藏了selectById等），這樣就無法通過地址得知對資源進行了哪種操作

    （2）可以明顯的看到其書寫簡化了，不僅書寫簡化了，在開發時代碼也可以簡化。

  3. HTTP 協議里，四個表示操作方式的動詞：GET，POST，PUT，DELETE。它們分別對應四種基本操作：GET用來獲取資源，POST用來新建資源，PUT用來更新資源，DELETE用來刪除資源。

  4. 傳統的url通過參數說明 crud的類型，而rest則是通過 get/post/put/delete 來說明 crud的類型

  • REST的核心過濾器
    1. 當前的瀏覽器只支持 post/get 請求，因此為了得到 put/delete 的請求方式，需要使用 Spring 提供的HiddenHttpMethodFilter 過濾器進行轉換。
    2. HiddenHttpMethodFilter ：瀏覽器form表單隻支持GET 和 POST請求，而DELETE、PUT 等method並不支持，Spring 添加了一個過濾器，可以將這些請求轉換為標準的http方法，使得支持這四種請求方式。
    3. 需要特別註意：HiddenHttpMethodFilter 只能對 post請求方式進行轉換
    4. 這個過濾器需要在web.xml中配置

7.2Rest風格的url-完成crud操作

7.2.1需求說明

image-20230204205731358

7.2.2代碼實現

  1. 修改web.xml添加 HiddenHttpMethodFilter過濾器，它的作用是將post請求轉換為指定的delete或put請求

    <!--配置HiddenHttpMethodFilter過濾器
    1.它的作用是將以post方式提交的delete請求和put請求進行轉換
    2.配置url-pattern為/*，表示所有請求都經過hiddenHttpMethodFilter過濾
    -->
<filter>
    <filter-name>hiddenHttpMethodFilter</filter-name>
    <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>hiddenHttpMethodFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

  2. 在SpringDispatcherServlet-servlet.xml添加兩個常規的配置

    <!--加入兩個常規的配置-->
<!--支持SpringMVC的高級功能，比如：JSR303校驗，映射動態請求-->
<mvc:annotation-driven></mvc:annotation-driven>
<!--將SpringMVC不能處理的請求，交給tomcat處理，比如css，js-->
<mvc:default-servlet-handler/>

    註意：mvc:annotion添加的是尾碼為mvc的命名空間：

    image-20230205162517025

  3. 創建rest.jsp

    Idea中導入jquery無法生效的解決方法

    <%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>rest</title>
    <script type="text/javascript" src="script/jquery-3.6.0.min.js"></script>
    <script type="text/javascript">
        $(function () {
            $("#deleteBook").click(function () {
                //將當前的超鏈接的href的值，賦給hiddenForm表單的action屬性
                $("#hiddenForm").attr("action", this.href);
                $(":hidden").val("DELETE");//給hidden的_method參數賦值為delete
                $("#hiddenForm").submit();//提交表單
                return false;//改變超鏈接行為，不再提交
            })

            //與上同理，不一樣的是這裡原本就是表單post請求
            $("#updateBook").click(function () {
                //帶上目標請求格式,HiddenHttpMethodFilter會自動將post請求轉成你指定的格式
                $(":hidden").val("PUT");//給hidden的_method參數賦值為put
            })
        })
    </script>
</head>
<body>
<h2>Rest風格的crud操作案例</h2>
<hr/>

<h3>rest風格的url 查詢書籍[get]</h3>
<a href="user/book/200">點擊查詢書籍</a>
<hr/>

<h3>rest風格的url 添加書籍[post]</h3>
<form action="user/book" method="post">
    name:<input name="bookName" type="text"/><br/>
    <input type="submit" value="添加書籍"/>
</form>
<hr/>

<h3>rest風格的url 刪除書籍[delete]</h3>
<%--說明：
1.在預設情況下，超鏈接是get請求
2.要將get請求轉成SpringMVC可以識別的delete，就要考慮HiddenHttpMethodFilter機制：
   public static final String DEFAULT_METHOD_PARAM = "_method";
   -------------------------------------
   private static final List<String> ALLOWED_METHODS =
      Collections.unmodifiableList(Arrays.asList(HttpMethod.PUT.name(),
          HttpMethod.DELETE.name(), HttpMethod.PATCH.name()));
   -------------------------------------
   //獲取請求的方式，如果是post方式，就進行處理
   if ("POST".equals(request.getMethod()) && request.getAttribute(WebUtils.ERROR_EXCEPTION_ATTRIBUTE) == null) {
         String paramValue = request.getParameter(this.methodParam);
         if (StringUtils.hasLength(paramValue)) {
            String method = paramValue.toUpperCase(Locale.ENGLISH);
            if (ALLOWED_METHODS.contains(method)) {//若指定method在ALLOWED_METHODS中存在
               //進行包裝，轉換為springmvc可以解析的請求
                requestToUse = new HttpMethodRequestWrapper(request, method);
            }
         }
      }
   --------------------------------------
3.從上述代碼可以看到，HiddenHttpMethodFilter 過濾器可以對以
    Post方式提交的delete，put，patch轉換成springmvc識別的RequestMethod.DElETE，RequestMethod.PUT...
4.但是當前的超鏈接為 get請求，怎麼將get請求轉換成 post的請求方式呢？
5.我們可以使用jquery來進行處理，讓用戶點擊超鏈接的時候，走一個表單的請求
--%>
<a href="user/book/600" id="deleteBook">刪除指定id的書籍</a>
<form action="" method="post" id="hiddenForm">
    <input type="hidden" name="_method"/>
</form>
<hr/>

<h3>rest風格的url 修改書籍[put]</h3>
<form action="user/book/666" method="post" id="updateBook">
    <input type="hidden" name="_method">
    <input type="submit" value="修改書籍"/>
</form>
</body>
</html>

  4. BookHandle.java

    1. 下麵的代碼中可以看到，許多方法的REST風格匹配的url是一樣的，但是由於它們的請求方式不同，所以匹配到的方法不同。這也是rest風格的優點：不僅簡化了url，而且隱藏了行為。
    2. 所以實際上SpringMVC的Controller層的url是可以相同的，會另外根據請求方式的不同來匹配方法
    package com.li.web.rest;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;

/**
 * @author 李
 * @version 1.0
 * 用於處理rest風格的請求-crud
 */
@RequestMapping(value = "/user")
@Controller
public class bookHandler {
    //查詢[get]
    @RequestMapping(value = "/book/{id}", method = RequestMethod.GET)
    public String getBook(@PathVariable("id") String id) {
        System.out.println("查詢書籍 id=" + id);
        return "success";
    }

    //添加[post]
    @PostMapping(value = "/book")
    public String addBook(String bookName) {//註意參數名字要和表單提交的參數名稱一致
        System.out.println("添加書籍 bookName=" + bookName);
        return "success";
    }

    //刪除[delete]
    @DeleteMapping(value = "/book/{id}")
    public String delBook(@PathVariable("id") String id) {
        System.out.println("刪除書籍 id=" + id);
        //return "success";//這樣寫，返回會報錯：HTTP Status 405 - JSPs only permit GET POST or HEAD
        //redirect:/user/success 重定向，會被解析成 /web工程路徑/user/success,然後返回給瀏覽器解析
        return "redirect:/user/success";//重定向到一個沒有指定method的 Handler方法
    }

    //如果請求是 /user/success,就轉發到success.jsp
    @RequestMapping(value = "/success")
    public String successGeneral() {
        return "success";//該方法轉發到success.jsp頁面
    }

    @PutMapping(value = "/book/{id}")
    public String updateBook(@PathVariable("id") String id) {
        System.out.println("修改書籍 id=" + id);
        return "redirect:/user/success";//同理
    }
}

  5. success.jsp

    <%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>操作成功</title>
</head>
<body>
<h1>恭喜，操作成功！</h1>
</body>
</html>

  6. 測試，redeployTomcat，訪問：http://localhost:8080/springmvc/rest.jsp，在分別點擊四種提交方式，前端頁面和後臺輸出如下：

    image-20230205202322764 image-20230205203330172

7.3註意事項和使用細節

  1. HiddenHttpMethodFilter在將 post請求轉成 delete/put請求時，是按照 _method 參數名來讀取的

    image-20230205203712186

  2. 如果web項目是運行在 Tomcat8及以上，會發現被過濾成 DELETE和 PUT請求後，到達控制器Controller時能順利執行，但是返回（forward）會報HTTP 405 提示：HTTP Status 405 - JSPs only permit GET POST or HEAD。意為JSP只允許GET POST 或 HEAD

    （1）解決方式1：使用Tomcat7

    （2）解決方式2：將請求轉發（forward）改為重定向（redirect），重定向到一個Handler，由Handler轉發到頁面。

    image-20230205204252465

  3. 頁面測試時，如果出現點擊修改書籍，仍然走的是刪除url，可能是瀏覽器緩存等原因，換成Chrome即可。如果再不行，使用js修改表單的hidden的_method的值

8.SpringMVC映射請求數據

8.1獲取參數值

在開發中，如何獲取到 http://xxx/url?參數名1=參數值1&參數名2=參數值2 中的參數？

之前的案例中我們知道：提交的url的參數名必須和映射的方法中的形參名保持一致。否則方法獲取的是null。

但是如果url的參數名和方法的形參名不一致，又要獲取該參數，應該解決這個問題呢？

答案是使用 @RequestParam 註解。

應用實例

  1. request_parameter.jsp：
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>測試request_parameter</title>
</head>
<body>
<h2>獲取到超鏈接參數值</h2>
<a href="vote/vote01?name=jack">獲取超鏈接的參數</a>
</body>
</html>
  1. VoteHandler.java：
package com.li.web.requestparam;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;

/**
 * @author 李
 * @version 1.0
 */
@RequestMapping(value = "/vote")
@Controller
public class VoteHandler {

    /**
     * 1.獲取到超鏈接傳遞的數據
     * 請求為 http://localhost:8080/springmvc/vote/vote01?name=xxx
     * (即提交的參數名和方法形參名不一致)
     * 2.@RequestParam 表示會接收提交的參數
     * 3.value = "name" 表示提交的參數名是name
     * 4.required = false 表示該參數可以沒有（預設true，表示必須有該參數）
     * 5.當我們使用了 @RequestParam(value = "name", required = false) 後，
     * 請求的參數名和方法形參名可以不一致
     *
     * @param username
     * @return
     */
    @RequestMapping(value = "/vote01")
    public String test01(@RequestParam(value = "name", required = false) String username) {
        System.out.println("獲取到的username=" + username);
        return "success";
    }

}

  1. 訪問http://localhost:8080/springmvc/request_parameter.jsp，點擊超鏈接。

    image-20230205200906238

  2. 後臺輸出如下，說明在提交參數和方法形參名不一致的情況下，通過@RequestParam 註解可以獲取到參數

    image-20230205201018260

8.2獲取http請求消息頭

開發中，如何獲取到http請求的消息頭信息（使用較少）

在映射的方法的形參前添加@RequestHeader(value="要獲取的Header參數")，即可獲取相關信息，然後將其值賦給方法的形參。

應用實例

  1. 在VoteHandler.java
package com.li.web.requestparam;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;

/**
 * @author 李
 * @version 1.0
 */
@RequestMapping(value = "/vote")
@Controller
public class VoteHandler {

    //需求：獲取請求頭的Accept-Encoding和 Host
    @RequestMapping(value = "/vote02")
    public String test02(@RequestHeader("Accept-Encoding") String ae,
                         @RequestHeader(value = "Host") String host) {
        System.out.println("Accept-Encoding=" + ae);
        System.out.println("Host=" + host);
        return "success";
    }
}

  1. 瀏覽器地址欄發送請求 http://localhost:8080/springmvc/vote/vote02，後臺輸出：

    image-20230205211624109

8.3獲取Javabean形式的數據

  • 在開發中，如何獲取到Javabean的數據？即如何按照java對象的形式來接收數據？

使用場景說明：例如，在實際開發中提交一個表單。表單提交後，希望在後端handler接收到表單數據時，自動地將這些數據封裝到某個Javabean中。

應用實例

  1. Pet.java
package com.li.entity;

/**
 * @author 李
 * @version 1.0
 * entity
 */
public class Pet {
    private Integer id;
    private String name;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @Override
    public String toString() {
        return "Pet{" +
                "id=" + id +
                ", name='" + name + '\'' +
                '}';
    }
}
  1. Master.java
package com.li.entity;

/**
 * @author 李
 * @version 1.0
 * entity
 */
public class Master {
    private Integer id;
    private String name;
    private Pet pet;//對象的屬性級聯

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Pet getPet() {
        return pet;
    }

    public void setPet(Pet pet) {
        this.pet = pet;
    }

    @Override
    public String toString() {
        return "Master{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", pet=" + pet +
                '}';
    }
}
  1. VoteHandler.java

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

-Advertisement-
Play Games
更多相關文章
  • uni-app + .NET 7實現微信小程式訂閱消息推送
    為了方便操作apk 實現app的自動化點擊 封裝了個adb操作類。基本上的操作都有了， 如果配合好C# 程式和模擬器 基本上什麼樣的操作都可以實現。 using System; using System.Collections; using System.Collections.Generic; u ...
  • Linux部署-Net並配置進程守護
    在種草了很多天之後，最近終於在淘寶下單了友善 nanoPi R5S。 選擇友善 nanoPi R5S 有兩點主要理由： 1. 自帶 EMMC 存儲，可以使用 RockChip 提供的 MaskRom 模式直接連線燒系統，不依賴 TF 卡（我覺得 TF 卡太累贅了，買普通的又慢又不穩定，對於我這種新手 ...
  • 通過Docker部署SpringBoot項目
    Docker部署SpringBoot項目 前言: 以前幾次在雲伺服器上部署項目都是手動打包，安裝mysql等環境最後再部署運行，相對比較麻煩而且加上網上各種教程質量層次不齊，如果過程中出錯的話排查問題對於新人來說已經夠喝一壺了。（我自己第一次手動裝mysql8.0就出過問題，最後找不到問題所在只能推 ...
  • 讓 MSYS2 Bash 像 Git Bash 一樣顯示 Git 分支名稱
    Git for Windows 的 Bash 有一個很實用的功能，如果當前目錄處於 Git 倉庫中，那麼命令行中會顯示當前 Git 分支的名稱（見下圖）。 然而原版的 MSYS2 Bash 沒有這個功能（見下圖），不過我們可以自己動手配置出相同的效果。 配置方法 打開 MSYS2 的家目錄，找到 . ...
  • order by原理
    一：背景 1. 講故事 上一篇寫完 SQLSERVER 的四個事務隔離級別到底怎麼理解？ 之後，有朋友留言問什麼時候可以把 snapshot 隔離級別給補上，這篇就來安排，快照隔離級別看起來很魔法，不過在修車之前，得先看下怎麼開車。 二：snapshot 隔離詳解 1. snapshot 之前的困境 ...
  • 洛谷oj題單【入門2】分支結構-入門難度（Java）
    洛谷oj題單【入門2】分支結構-入門難度（Java） 來源：https://www.luogu.com.cn/training/101#problems P5709 【深基2.習6】Apples Prologue / 蘋果和蟲子 import java.util.Scanner; public cl ...
  • Python 內置界面開發框架 Tkinter入門篇 丙(文末有福利彩蛋，今天可是元宵節)
    以下內容為本人的學習筆記，如需要轉載，請聲明原文鏈接 微信公眾號「ENG八戒」https://mp.weixin.qq.com/s/B1hH5Qzd2RkAiiUId1tLWw 本文大概 2874 個字，閱讀需花 10 分鐘 內容不多，但也花了一些精力 如要交流，歡迎關註我然後評論區留言 謝謝你的點 ...
  • Odoo 菜單定義和修改學習總結
    odoo菜單定義和修改學習總結 環境 odoo-14.0.post20221212.tar 定義菜單 方式1： <?xml version="1.0"?> <odoo> <menuitem id="root_menu_id" name="TopMenu" web_icon="estate,stati ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 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 ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類