腳本之家服務(wù)器常用軟件

快捷導(dǎo)航

基于SpringMVC對(duì)接前端參數(shù)注解

更新時(shí)間：2023年09月01日 09:48:14 作者：夜白宋

這篇文章主要介紹了基于SpringMVC對(duì)接前端參數(shù)注解的使用,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教

一、請(qǐng)求方式

HTTP/1.1 協(xié)議規(guī)定的 HTTP 請(qǐng)求方法有 OPTIONS、GET、HEAD、POST、PUT、DELETE、TRACE、CONNECT這幾種。

其中 POST 一般用來向服務(wù)端提交數(shù)據(jù)，GET/HEAD請(qǐng)求雖然可以攜帶請(qǐng)求體，但是在實(shí)際瀏覽器是不被規(guī)范允許的，所以需要注意

HTTP 協(xié)議是以 ASCII 碼傳輸。他是建立在 TCP/IP 協(xié)議之上的應(yīng)用層規(guī)范，

規(guī)定HTTP 請(qǐng)求分為三個(gè)部分：

狀態(tài)行
headers 請(qǐng)求頭
entity-body 消息主體

類似于下面這樣：

<method> <request-URL> <version>
<headers>
<entity-body>

二、參數(shù)格式

值	描述
application/x-www-form-urlencoded	在發(fā)送前編碼所有字符（默認(rèn)）
multipart/form-data	不對(duì)字符編碼。在使用包含文件上傳控件的表單時(shí)，必須使用該值。
application/json	作為請(qǐng)求頭告訴服務(wù)端消息主體是序列化的JSON字符串。除低版本的IE，基本都支持。
text/plain	空格轉(zhuǎn)換為 “+” 加號(hào)，但不對(duì)特殊字符編碼。

三、注解描述

1. @RequestParam

將請(qǐng)求參數(shù)綁定到你控制器的方法參數(shù)上（是springmvc中接收普通參數(shù)的注解），主要是從url中解析對(duì)應(yīng)的參數(shù)名，并綁定對(duì)應(yīng)值，默認(rèn)值為hello

語(yǔ)法：

@RequestParam(value=”參數(shù)名”,required=”true/false”,defaultValue=””)?

value：參數(shù)名
required：是否包含該參數(shù)，默認(rèn)為true，表示該請(qǐng)求路徑中必須包含該參數(shù)，如果不包含就報(bào)錯(cuò)。
defaultValue：默認(rèn)參數(shù)值，如果設(shè)置了該值，required=true將失效，自動(dòng)為false,如果沒有傳該參數(shù)，就使用默認(rèn)值

2. @RequestBody

主要用來接收前端傳遞給后端的json字符串中的數(shù)據(jù)的(請(qǐng)求體中的數(shù)據(jù)的)，使用@RequestBody接收數(shù)據(jù)時(shí)，一般都用POST方式進(jìn)行提交。

注：@RequestBody與@RequestParam()可以同時(shí)使用，@RequestBody最多只能有一個(gè)，而@RequestParam()可以有多個(gè)。

注：一個(gè)請(qǐng)求，只有一個(gè)RequestBody；一個(gè)請(qǐng)求，可以有多個(gè)RequestParam。

注：當(dāng)同時(shí)使用@RequestParam和@RequestBody時(shí)，@RequestParam指定的參數(shù)可以是普通元素、數(shù)組、集合、對(duì)象等等(即:當(dāng)，@RequestBody 與@RequestParam可以同時(shí)使用時(shí)，原SpringMVC接收參數(shù)的機(jī)制不變，只不過RequestBody 接收的是請(qǐng)求體里面的JSON數(shù)據(jù)；而RequestParam接收的是key-value里面的參數(shù)，所以它會(huì)被切面進(jìn)行處理從而可以用普通元素、數(shù)組、集合、對(duì)象等接收。即：如果參數(shù)時(shí)放在請(qǐng)求體中，application/json傳入后臺(tái)的話，那么后臺(tái)要用@RequestBody才能接收到；如果不是放在請(qǐng)求體中的話，那么后臺(tái)接收前臺(tái)傳過來的參數(shù)時(shí)，要用@RequestParam來接收，或則形參前什么也不寫也能接收。

注：如果參數(shù)前寫了@RequestParam(xxx)，那么前端必須有對(duì)應(yīng)的xxx名字才行(不管其是否有值，當(dāng)然可以通過設(shè)置該注解的required屬性來調(diào)節(jié)是否必須傳)，如果沒有xxx名的話，那么請(qǐng)求會(huì)出錯(cuò)，報(bào)400。

注：如果參數(shù)前不寫@RequestParam(xxx)的話，那么就前端可以有可以沒有對(duì)應(yīng)的xxx名字才行，如果有xxx名的話，那么就會(huì)自動(dòng)匹配；沒有的話，請(qǐng)求也能正確發(fā)送。

追注：這里與feign消費(fèi)服務(wù)時(shí)不同；feign消費(fèi)服務(wù)時(shí)，如果參數(shù)前什么也不寫，那么會(huì)被默認(rèn)是@RequestBody的。

四、實(shí)際調(diào)用

1.Get請(qǐng)求

1.1 普通元素傳參

前端請(qǐng)求

在這里插入圖片描述

后端接收入?yún)ⅲ?/p>

@GetMapping("/testPrint")
    public void testPrint1(String name) {
        System.out.println("testPrint1: " + name);
    }
    或
    @GetMapping("/testPrint")
    public void testPrint2(@RequestParam("name") String name) {
        System.out.println("testPrint2: " + name);
    }

1.2 數(shù)組傳參

前端請(qǐng)求

在這里插入圖片描述

后端接收入?yún)ⅲ?/p>

@GetMapping("/testPrint1")
    public void testPrint1(String[] name) {
        System.out.println("testPrint1: " + JSON.toJSONString(name));
    }
	或
    @GetMapping("/testPrint2")
    public void testPrint2(@RequestParam("name") String[] name) {
        System.out.println("testPrint2: " + JSON.toJSONString(name));
    }

2.Post請(qǐng)求

2.1 application/x-www-form-urlencoded請(qǐng)求傳參

前端請(qǐng)求類型

在這里插入圖片描述

后端接收入?yún)ⅲ?/p>

@PostMapping("/testPrint1")
    public void testPrint1(Bb bb) {
        System.out.println("testPrint1: " + JSON.toJSONString(bb));
    }

此處一定要注意不能使用@RequestBody，否則就會(huì)拋出415錯(cuò)誤， “Unsupported Media Type”,

2.2 application/json請(qǐng)求傳參

前端請(qǐng)求類型

在這里插入圖片描述

后端接收入?yún)ⅲ?/p>

@PostMapping("/testPrint2")
    public void testPrint2(@RequestBody Bb bb) {
        System.out.println("testPrint2: " + JSON.toJSONString(bb));
    }

此處一定要使用@RequestBody，否則無法解析JSON數(shù)據(jù)