day07-SpringBoot接收參數相關註解

来源:https://www.cnblogs.com/liyuelian/archive/2023/03/19/17234226.html
-Advertisement-
Play Games

SpringBoot接收參數相關註解 1.基本介紹 SpringBoot接收客戶端提交數據/參數會使用到相關註解 詳解@PathVariable、@RequestHeader、@ModelAttribute、@RequestParam、@CookieValue、@RequestBody 2.接參數相 ...


SpringBoot接收參數相關註解

1.基本介紹

  1. SpringBoot接收客戶端提交數據/參數會使用到相關註解
  2. 詳解@PathVariable、@RequestHeader、@ModelAttribute、@RequestParam、@CookieValue、@RequestBody

2.接參數相關註解應用實例

演示各種方式提交數據/參數給伺服器，伺服器如何使用註解接收

2.1@PathVariable

通過@RequestMapping和@PathVariable，獲取映射路徑的占位符匹配的參數，並賦給方法形參。

index.html

<a href="/monster/100/king">@PathVariable-路徑變數 monster/100/king</a>

ParameterController.java

...
@RestController
public class ParameterController {
    @GetMapping("/monster/{id}/{name}")
    public String pathVariable(@PathVariable("id") Integer id,//單個接收
                               @PathVariable("name") String name,
                               //使用map可以一次接收多個路徑占位符
                               @PathVariable Map<String, String> map) {
        System.out.println("id=" + id);
        System.out.println("name=" + name);
        System.out.println("map=" + map);
        return "success";
    }
}

訪問超鏈接，結果後臺輸出：

id=100
name=king
map={id=100, name=king}

2.2@RequestHeader

@RequestHeader用於將請求的頭信息區數據映射到功能處理方法的參數上，@RequestHeader("xxx") 代表獲取請求頭的xxx屬性，xxx不區分大小寫。

index.html

<a href="/requestHeader">@RequestHeader-獲取HTTP請求頭</a>

ParameterController.java

//@RequestHeader("xxx") 代表獲取請求頭的xxx屬性,xxx不區分大小寫
//@RequestHeader Map<String,String> header 表示將獲取請求頭的所有屬性，並放入map中
@GetMapping("/requestHeader")
public String requestHeader(@RequestHeader("Host") String host,
                            @RequestHeader Map<String, String> header) {
    System.out.println("host=" + host);
    System.out.println("header=" + header);
    return "success";
}

訪問超鏈接，後臺輸出：

host=localhost:8080
header={host=localhost:8080, user-agent=Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:109.0) Gecko/20100101 Firefox/110.0, accept=text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,*/*;q=0.8, accept-language=zh-CN,zh;q=0.8,zh-TW;q=0.7,zh-HK;q=0.5,en-US;q=0.3,en;q=0.2, accept-encoding=gzip, deflate, br, connection=keep-alive, referer=http://localhost:8080/index.html, cookie=Idea-f24e85b1=ae595c67-c988-4ef0-856d-44549b2b2eb7, upgrade-insecure-requests=1, sec-fetch-dest=document, sec-fetch-mode=navigate, sec-fetch-site=same-origin, sec-fetch-user=?1}

2.3@RequestParam

該註解的作用是：把請求中的指定名稱的參數傳遞給控制器中的形參賦值

  1. value / name：請求參數中的名稱 （必寫參數）
  2. required：請求參數中是否必須提供此參數，預設值是true，true為必須提供
  3. defaultValue：預設值

index.html

<a href="/hi?name=傑克&hobby=羽毛球&hobby=籃球">@RequestParam-獲取請求參數</a>

ParameterController.java

也可以使用map接收所有參數值，但是如果有多個相同名稱的參數值，只能接收第一個，因為map的key衝突了

@GetMapping("/hi")
public String hi(@RequestParam("name") String username,
                 @RequestParam("hobby") List<String> hobbies) {
    System.out.println("username=" + username);
    System.out.println("hobby=" + hobbies);
    return "success";
}

訪問超鏈接，後臺輸出：

username=傑克
hobby=[羽毛球, 籃球]

2.4@CookieValue

通過@CookieValue註解可以拿到cookie的值，它的屬性有：

  1. value：參數名稱
  2. required：是否必須
  3. defaultValue：預設值

ParameterController.java

/**
 * 1.value="xxx"表示接收名字為xx的cookie
 * 如果瀏覽器帶有對應的cookie，若後面的參數類型為String，則接收到的是對應的value
 * 若後面的參數類型為Cookie，則接收到的是對應的cookie
 * 2.required = false 表示該值為非必須的，預設是true
 */
@GetMapping("/cookie")
public String cookie(@CookieValue(value = "cookie_key", required = false) String val,
                     @CookieValue(value = "username", required = false) Cookie cookie) {
    System.out.println("cookie_value=" + val);
    if (cookie != null) {
        System.out.println("username=" + cookie.getName() + "-" + cookie.getValue());
    }
    return "success";
}

瀏覽器訪問方法路徑，如果沒有對應的cookie，就會輸出null，如果有則輸出對應的cookie值：

cookie_value=hello
username=username-king

2.5@RequestBody

@RequestBody接收的參數來自requestBody中，即請求體。一般用於處理非Content-Type: application/x-www-form-urlencoded編碼格式的數據，比如：application/json、application/xml等類型的數據。

就application/json類型的數據而言，使用註解@RequestBody可以將body裡面所有的json數據傳到後端，後端再進行解析。

index.html：一般來說，@RequestBody註解一般使用在post請求中，因為前端將json數據放在了請求體中。

<h1>測試@RequestBody獲取數據，獲取post請求體</h1>
<form action="/save" method="post">
    姓名：<input name="name"/><br/>
    年齡：<input name="age"/><br/>
    <input type="submit" value="提交"/>
</form>

ParameterController.java

@PostMapping("/save")
public String postMethod(@RequestBody String content) {
    System.out.println("content=" + content);
    return "success";
}

瀏覽器填寫表單，提交：

image-20230319172940260

後端輸出：content=name=jack&age=25

2.6@RequestAttribute

@RequestAttribute 可以獲取request請求域中的數據

index.html

<a href="/login">@RequestAttribute-獲取request域屬性</a>

RequestController.java

package com.li.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestAttribute;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.servlet.http.HttpServletRequest;

/**
 * @author 李
 * @version 1.0
 */
@Controller
public class RequestController {
    @GetMapping("/login")
    public String login(HttpServletRequest request) {
        request.setAttribute("user", "Smith");//向request域中添加數據
        return "forward:/ok";//轉發到/ok（需要在配置中啟用視圖解析器）
    }

    @GetMapping("/ok")
    @ResponseBody
    public String ok(@RequestAttribute(value = "user", required = false) String username) {
        //獲取到request域中的數據
        System.out.println("username=" + username);
        return "success";
    }
}

瀏覽器訪問超鏈接 /login，後臺輸出：

username=Smith

2.7@SessionAttribute

@SessionAttribute用來標註在介面的參數上，參數的值來源於session作用域。

RequestController.java

package com.li.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestAttribute;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.SessionAttribute;

import javax.servlet.http.HttpServletRequest;

/**
 * @author 李
 * @version 1.0
 */
@Controller
public class RequestController {
    @GetMapping("/login")
    public String login(HttpServletRequest request) {
        //向session中添加數據
        request.getSession().setAttribute("website", "https://www.baidu.com");
        return "forward:/ok";//轉發到/ok（需要在配置中啟用視圖解析器）
    }

    @GetMapping("/ok")
    @ResponseBody
    public String ok(@SessionAttribute(value = "website", required = false) String site) {
        //獲取session域的數據
        System.out.println("site=" + site);
        return "success";
    }
}

瀏覽器訪問/login，後臺輸出：

site=https://www.baidu.com

3.複雜參數的使用

3.1基本介紹

  1. 在開發中，SpringBoot在響應客戶端請求時也支持複雜參數
  2. Map、Model、Errors/BindingResult、RedirectAttributes、ServletResponse、SessionStatus、UriComponentsBuilder、ServletUriComponentsBuilder、HttpSession
  3. Map、Model數據會被放在request域中
  4. RedirectAttributes重定向攜帶數據

3.2複雜參數應用實例

說明：演示覆雜參數的使用，重點演示Map、Model、ServletResponse

控制器中添加兩個方法

//模擬響應一個註冊的請求
@GetMapping("/register")
public String register(Map<String, Object> map,
                       Model model,
                       HttpServletResponse response) {
    //如果有一個註冊請求，會將註冊數據封裝到map或者model中（這裡沒有寫表單，手動添加一下）
    map.put("user", "jack");
    map.put("job", "java後端");
    model.addAttribute("salary", 10000);
    //map和model中的數據會被自動放入到request域中
    
    //演示創建cookie，通過response添加到客戶端
    Cookie cookie = new Cookie("email","[email protected]");
    response.addCookie(cookie);
    
    return "forward:/registerOk";//請求轉發
}

@GetMapping("/registerOk")
@ResponseBody
public String regOk(HttpServletRequest request) {
    System.out.println("user=" + request.getAttribute("user"));
    System.out.println("job=" + request.getAttribute("job"));
    System.out.println("salary=" + request.getAttribute("salary"));
    return "success";
}

瀏覽器訪問register方法，後臺輸出：

user=jack
job=java後端
salary=10000

為什麼map和model中的數據會被自動放入到request域中?

register()方法通過response參數將cookie返回給瀏覽器：

image-20230319184901600

4.自定義對象參數-自動封裝

4.1基本介紹

  1. 在開發中，SpringBoot在響應客戶端請求時，也支持自定義對象參數
  2. 完成自動類型轉換與格式化
  3. 支持級聯封裝

4.2應用實例

演示自定義對象參數的使用，完成自動封裝，類型轉換

save.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>save</title>
</head>
<body>
<h1>根據表單數據-自動封裝POJO(級聯封裝)</h1>
<form action="/saveMonster" method="post">
  編號：<input name="id" value=""/><br/>
  姓名：<input name="name" value=""/><br/>
  年齡：<input name="age" value=""/><br/>
  婚否：<input name="isMarried" value=""/><br/>
  生日：<input name="birth" value=""/><br/>
  坐騎名稱：<input name="car.name" value=""/><br/>
  坐騎價格：<input name="car.price" value=""/><br/>
  <input type="submit" value="保存"/>
</form>
</body>
</html>

bean/Car.java

package com.li.bean;

import lombok.Data;

/**
 * @author 李
 * @version 1.0
 */
@Data
public class Car {
    private String name;
    private Double price;
}

bean/Monster.java

package com.li.bean;

import lombok.Data;

import java.util.Date;

/**
 * @author 李
 * @version 1.0
 */
@Data
public class Monster {
    private Integer id;
    private String name;
    private Integer age;
    private Boolean isMarried;
    private Date birth;
    private Car car;
}

控制器ParameterController.java添加處理請求

//處理添加Monster的方法
@PostMapping("/saveMonster")
@ResponseBody
public String saveMonster(Monster monster) {
    System.out.println("monster=" + monster);
    return "success";
}

瀏覽器訪問save.html，輸入數據點擊提交：

image-20230319204044833

後端接收到表單信息，自動封裝到對象中（支持級聯封裝）：

monster=Monster(id=10086, name=白骨精, age=567, isMarried=false, birth=Thu Dec 23 00:00:00 CST 1456, car=Car(name=寶馬, price=200000.0))

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

-Advertisement-
Play Games
更多相關文章
  • 怎麼使用硬體同步原語替代鎖？
    這篇文章主要描述硬體同步原語，它是由電腦硬體提供的一組原子操作。 我們常見的原語操作有CAS和FAA兩種。在某些情景下，我們可以使用它來替代鎖，從而更加安全高效的操作數據。 ...
  • 再談編程範式(3):理解面向過程/面向對象/函數式編程的精髓
    這篇文章主要關註分散式鎖，包括加鎖和解鎖的過程，鎖的用法，加鎖帶來的代價，對性能的影響以及如何避免死鎖。 ...
  • 讀Java性能權威指南（第2版）筆記22_ 操作系統工具和Java監控工具
    1. 性能優化是圍繞工具展開的 1.1. 最重要的工具大都是Java開發工具包（JDK）自帶的 1.2. 查看應用程式性能時，首先應該考察的就是CPU時間 2. 操作系統工具 2.1. Unix系統 2.1.1. sar（System Accounting Report）及其組成工具 2.1.2.  ...
  • 為什麼要重寫equals要重寫hashcode方法
    Java 比較（==, equals) 一、= = ==：比較兩個對象的引用是否是同一個地址 二、equals object中equals方法調用的就是==，可以在其他類中重寫該方法。 三、為什麼要重寫equals要重寫hashcode方法 因為散列集合插入對象時會進行判斷，先調用hashcode， ...
  • Django筆記三之使用model對資料庫進行增刪改查
    大家好，我是3y啊。 大概不知道從什麼時候，「微服務」「分散式」這兩個詞又再次頻繁出現在我的視線里。 「微服務」「分散式」在我剛畢業的時候還是比較關註的，那時候還入門了一把SpringCloud，寫了一篇很長的文章，還是很頂的，有不少的大號都給我轉載了，在知乎又獲得了很多的贊。 那時候覺得懂「分散式 ...
  • Collection單列集合總結
    這篇文章記錄了Collection集合，List集合，Set集合 在文章第七點總結了兩大系列集合的五種實現類的區別，有需要的小伙伴可以直接去查看 一、什麼是集合 集合是Java中存儲對象數據的一種容器 二、集合有什麼特點 大小不固定，類型也可以不固定（通常需要泛型約束） 集合只能存儲引用數據類型 集 ...
  • JAVA -01（簡單知識介紹）
    JAVA -01 前期準備 介紹 1972年C誕生【兩大問題：指針；記憶體管理】 1982年C++誕生【面向對象；相容C；圖形領域和游戲，但是更複雜】 1995年JAVA誕生【沒有指針沒有記憶體管理；面向對象；類型安全；高質量類庫；跨平臺（JVM實現）；applet圖形界面程式】 小碎點 三高問題：高可 ...
  • 2023最新ELK日誌平臺（elasticsearch+logstash+kibana）搭建
    去年公司由於不斷發展，內部自研系統越來越多，所以後來搭建了一個日誌收集平臺，並將日誌收集功能以二方包形式引入自研系統，避免每個自研系統都要建立一套自己的日誌模塊，節約了開發時間，管理起來也更加容易。 這篇文章主要介紹ELK最新版本的搭建，二方包的介紹可以看小霸王的另外一篇文章。 ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類