相信JAVA后端的同學(xué)們會(huì)經(jīng)?？吹蕉紩?huì)經(jīng)?？吹?code>@RequestBody、@pathvariable、@RequestParam，什么時(shí)候該用什么樣的注解或者是不用注解。讓我們來了解一下。
RequestParam
RequestParam會(huì)獲取url鏈接上面的參數(shù)內(nèi)容，然后獲取匹配的參數(shù)作為接口參數(shù)傳遞給方法執(zhí)行邏輯。如果請求的參數(shù)和接口方法參數(shù)名稱一致，可以不需要顯式使用該注解，例子如下：
package com.example.demo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
@SpringBootApplication
@RestController("/")
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
/**
* 接口參數(shù)使用默認(rèn)
*
* @param var1
* @param var2
* @return
*/
@GetMapping("/getTest")
public String getTest(String var1,String var2) {
return "getTest: " + var1 + "---" + var2;
} @GetMapping("/getTestWithRequestParam")
public String getTest1(@RequestParam("var3") String var1, String var2) {
return "getTest: " + var1 + "---" + var2;
}}
在本地起一個(gè)簡單的springboot項(xiàng)目之后，簡單修改一下代碼，分別請求兩個(gè)接口,大家猜猜分別返回什么？
請求1:
http://localhost:8080/getTest?var1=1&var2=22&var3=333
返回：
getTest: 1---22
請求2：
http://localhost:8080/getTestWithRequestParam?var1=1&var2=22&var3=333
返回：
getTest: 333---22
從上面的例子可以看出，如果不指定@RequestParam的值，默認(rèn)會(huì)獲取同名參數(shù)，如果指定值，則會(huì)在url中獲取對應(yīng)名稱的值。
另外，點(diǎn)進(jìn)@RequestParam注解中，我們可以看到有對應(yīng)三個(gè)參數(shù),分別對應(yīng)參數(shù)名，參數(shù)值以及是否必填
package org.springframework.web.bind.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.core.annotation.AliasFor;
@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RequestParam {
@AliasFor("name")
String value() default "";
@AliasFor("value")
String name() default "";
boolean required() default true;
String defaultValue() default "nttnttnue000ue001ue002nttttn";
}
PathVariable
@PathVariable注解相當(dāng)于一個(gè)占位符的操作方式， 可以獲取請求路徑中的值。
用法如下：
@GetMapping("/getTestWithPathParam/{var1}/{var2}")
public String getTest1(@PathVariable("var1") String var1,@PathVariable("var2") String var2) {
return "getTest: " + var1 + "---" + var2;
}// 請求： http://localhost:8080/getTestWithPathParam/11/22
// 返回： getTest: 11---22
這種做法將參數(shù)也放進(jìn)了請求映射的路由當(dāng)中，有時(shí)候可以使代碼邏輯更加明顯。
如將用戶和行為都當(dāng)成請求連接的一部分@GetMapping("/getTestWithPathParam/{userId}/{action}")
RequestBody
@RequestBody直接以String接收前端傳過來的參數(shù)數(shù)據(jù)。也就是ajax中的data內(nèi)容。RequestBody的值，需要配合請求中的 content-type，一般使用application/json,用于接收一個(gè)json對象
package org.springframework.web.bind.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RequestBody {
boolean required() default true;
}
下面一些示例：
@PostMapping("/postTest")
public String postTest(@RequestBody String var1,@RequestBody String var2) { return "postTest: " + var1 + "---" + var2;
}//請求: POST http://localhost:8080/postTest
//Content-Type: application/x-www-form-urlencoded
//var1=1&var2=22
// 返回
// postTest: var1=1&var2=22---var1=1&var2=22
// --------------------
// 請求：POST http://localhost:8080/postTest
// Content-Type: application/json
//{"var1": "11","var2": "22"}
//返回
// 報(bào)錯(cuò) Bad Request
總結(jié)
requestParam只會(huì)讀取url后面的參數(shù)，requestBody只會(huì)請求body中的data。其實(shí)也是算是跟名字描述一樣了哈哈。pathVariable根據(jù)實(shí)際情況可以定義。
個(gè)人在嘗試過程中，content-type 如果是 application/x-www-form-urlencoded,其實(shí)相當(dāng)于將url后的參數(shù)進(jìn)行urlencoded之后作為參數(shù)。也是一個(gè)詞如其名了。
最后，還是建議要多寫寫，多試試。
talk is cheap , show me the code本文由博客一文多發(fā)平臺(tái) OpenWrite 發(fā)布！
