相信JAVA后端的同學們會經常看到都會經常看到@RequestBody、@pathvariable、@RequestParam，什么時候該用什么樣的注解或者是不用注解。讓我們來了解一下。
RequestParam
RequestParam會獲取url鏈接上面的參數內容，然后獲取匹配的參數作為接口參數傳遞給方法執行邏輯。如果請求的參數和接口方法參數名稱一致，可以不需要顯式使用該注解，例子如下：
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);
}
/**
* 接口參數使用默認
*
* @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;
}}
在本地起一個簡單的springboot項目之后，簡單修改一下代碼，分別請求兩個接口,大家猜猜分別返回什么？
請求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的值，默認會獲取同名參數，如果指定值，則會在url中獲取對應名稱的值。
另外，點進@RequestParam注解中，我們可以看到有對應三個參數,分別對應參數名，參數值以及是否必填
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注解相當于一個占位符的操作方式， 可以獲取請求路徑中的值。
用法如下：
@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
這種做法將參數也放進了請求映射的路由當中，有時候可以使代碼邏輯更加明顯。
如將用戶和行為都當成請求連接的一部分@GetMapping("/getTestWithPathParam/{userId}/{action}")
RequestBody
@RequestBody直接以String接收前端傳過來的參數數據。也就是ajax中的data內容。RequestBody的值，需要配合請求中的 content-type，一般使用application/json,用于接收一個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"}
//返回
// 報錯 Bad Request
總結
requestParam只會讀取url后面的參數，requestBody只會請求body中的data。其實也是算是跟名字描述一樣了哈哈。pathVariable根據實際情況可以定義。
個人在嘗試過程中，content-type 如果是 application/x-www-form-urlencoded,其實相當于將url后的參數進行urlencoded之后作為參數。也是一個詞如其名了。
最后，還是建議要多寫寫，多試試。
talk is cheap , show me the code本文由博客一文多發平臺 OpenWrite 發布！
