SpringBoot接收參數使用的註解實例講解
1.基本介紹
SpringBoot 接收客戶端提交數據/參數會使用到相關註解
詳 解 @PathVariable 、 @RequestHeader 、 @ModelAttribute 、 @RequestParam 、 @MatrixVariable、@CookieValue、@RequestBody
2.接收參數相關註解應用實例
1.需求: 演示各種方式提交數據/參數給服務器，服務器如何使用註解接收
2.應用實例演示
需求: 演示各種方式提交數據/參數給服務器，服務器如何使用註解接收
創建src\main\resources\static\index.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>index</title>
</head>
<body>
<h1>hello, llp</h1>
基本註解：
<hr/>
<a href="/monster/200/jack" rel="external nofollow" >@PathVariable-路徑變量 monster/200/jack</a><br/><br/>
</body>
</html>
@PathVariable 使用
演示@PathVariable 使用，創建src\main\java\com\llp\springboot\controller\ParameterController.java， 完成測試
@RestController
public class ParameterController {
/**
* /monster/{id}/{name} 解讀
* 1. /monster/{id}/{name} 構成完整請求路徑
* 2. {id} {name} 就是占位變量
* 3. @PathVariable("name"): 這裡name 和{name} 命名保持一致
* 4. String name_ 這裡自定義，和{name}命名無關
* 5. @PathVariable Map<String, String> map 把所有傳遞的值傳入map
* 6. 可以看下@PathVariable源碼
*/
@GetMapping("/monster/{id}/{name}")
public String pathVariable(@PathVariable("id") Integer id,
@PathVariable("name") String name,
@PathVariable Map<String, String> map) {
System.out.println("id-" + id);
System.out.println("name-" + name);
System.out.println("map-" + map);
return "success";
}
}
@RequestHeader 使用
演示@RequestHeader 使用，修改 ParameterController.java ， 完成測試
√ 修改 index.html
<a href="/requestHeader" rel="external nofollow" >@RequestHeader-獲取Http請求頭 </a><br/><br/>
√ 修改 ParameterController.java
/**
* @RequestHeader("Host") 獲取http請求頭的 host信息
* @RequestHeader Map<String, String> header: 獲取到http請求的所有信息
*/
@GetMapping("/requestHeader")
public String requestHeader(@RequestHeader("host") String host,
@RequestHeader Map<String, String> header,
@RequestHeader("accept") String accept) {
System.out.println("host-" + host);
System.out.println("header-" + header);
System.out.println("accept-" + accept);
return "success";
}
@RequestParam 使用
演示@RequestParam 使用，修改 ParameterController.java ， 完成測試
√ 修改 index.html
<a href="/hi?name=wukong&fruit=apple&fruit=pear&id=300&address=北京" rel="external nofollow" >@RequestParam-獲取請求參數</a><br/><br/>
√ 修改 ParameterController.java
/**
* @param username wukong
* @param fruits List<String> fruits 接收集合 [apple, pear]
* @param paras Map<String, String> paras 如果我們希望將所有的請求參數的值都獲取到，
* 可以通過@RequestParam Map<String, String> paras這種方式
* 一次性的接收所有的請求參數 {name=wukong, fruit=apple, id=300, address=北京}
* 如果接收的某個參數中有多個之值比如這裡fruits是一個集合，從map中隻能拿到一個
* 可以理解map底層會將相同的key的value值進行覆蓋
* @return
* @RequestParam
*/
@GetMapping("/hi")
public String hi(@RequestParam(value = "name") String username,
@RequestParam("fruit") List<String> fruits,
@RequestParam Map<String, String> paras) {
//username-wukong
System.out.println("username-" + username);
//fruit-[apple, pear]
System.out.println("fruit-" + fruits);
//paras-{name=wukong, fruit=apple, id=300, address=北京}
System.out.println("paras-" + paras);
return "success";
}
@CookieValue 使用
演示@CookieValue 使用，修改 ParameterController.java ， 完成測試
√ 修改 index.html
<a href="/cookie" rel="external nofollow" >@CookieValue-獲取cookie值</a><br/><br/>
√ 修改 ParameterController.java
/**
* 因為我的瀏覽器目前沒有cookie，我們可以自己設置cookie[技巧還是非常有用]
* 如果要測試，可以先寫一個方法，在瀏覽器創建對應的cookie
* 說明 1. value = "cookie_key" 表示接收名字為 cookie_key的cookie
* 2. 如果瀏覽器攜帶來對應的cookie , 那麼 後面的參數是String ,則接收到的是對應對value
* 3. 後面的參數是Cookie ,則接收到的是封裝好的對應的cookie
*/
@GetMapping("/cookie")
public String cookie(@CookieValue(value = "cookie_key", required = false) String cookie_value,
HttpServletRequest request,
@CookieValue(value = "username", required = false) Cookie cookie) {
System.out.println("cookie_value-" + cookie_value);
if (cookie != null) {
System.out.println("username-" + cookie.getName() + "-" + cookie.getValue());
}
System.out.println("-------------------------");
Cookie[] cookies = request.getCookies();
for (Cookie cookie1 : cookies) {
System.out.println(cookie1.getName() + "=>" + cookie1.getValue());
}
return "success";
}
@RequestBody 使用
演示@RequestBody 使用，修改 ParameterController.java ， 完成測試
√ 修改 index.html
<hr/>
<h1>測試@RequestBody獲取數據: 獲取POST請求體</h1>
<form action="/save" method="post">
姓名: <input name="name"/> <br>
年齡: <input name="age"/> <br/>
<input type="submit" value="提交"/>
</form>
√ 修改 ParameterController.java
/**
* @RequestBody 是整體取出Post請求內容
*/
@PostMapping("/save")
public String postMethod(@RequestBody String content) {
System.out.println("content-" + content);
return "success";
}
@RequestAttribute 和 @SessionAttribute使用
演示@RequestAttribute @SessionAttribute使用，創建 com/hspedu/web/controller/RequestController.java ， 完成測試
√ 修改 index.html
<a href="/login" rel="external nofollow" >@RequestAttribute、@SessionAttribute-獲取request域、session屬性-</a>
√ 創建 RequestController.java
@GetMapping("/login")
public String login(HttpServletRequest request) {
request.setAttribute("user", "llp");
//向session中添加數據
request.getSession().setAttribute("website", "http://www.baidu.com");
//這裡需要使用forward關鍵字，如果不適用則會走視圖解析器，這
//裡視圖解析器前綴配置的是/ 後綴配置的.html ---> /ok.html
//而請求轉發在服務器端執行，/被解析成 ip:port/工程路徑
//進而最終得到的完整路徑是 ip:port/工程路徑/ok.html
//但是我們這裡希望訪問的是 ip:port/工程路徑/ok這個請求路徑
//因此這裡手動的設置forward:/ok ，底層會根據我們設置的路徑進行請求轉發
return "forward:/ok";
}
@GetMapping("ok")
//返回字符串，不走視圖解析器
@ResponseBody
public String ok(@RequestAttribute(value = "user", required = false) String username,
@SessionAttribute(value = "website",required = false) String website, HttpServletRequest request) {
System.out.println("username= " + username);
System.out.println("通過servlet api 獲取 username-" + request.getAttribute("user"));
System.out.println("website = " + website);
System.out.println("通過servlet api 獲取 website-"+request.getSession().getAttribute("website"));
return "success";
}
}
3.復雜參數
1.基本介紹
- 在開發中，SpringBoot 在響應客戶端請求時，也支持復雜參數
- Map、Model、Errors/BindingResult、RedirectAttributes、ServletResponse、SessionStatus、 UriComponentsBuilder、ServletUriComponentsBuilder、HttpSession
- Map、Model 數據會被放在 request 域， 底層 request.setAttribute()
- RedirectAttributes 重定向攜帶數據
2.復雜參數應用實例
####1.說明 : 演示復雜參數的使用，重點: Map、Model、ServletResponse
2.代碼實現
//響應一個註冊請求
@GetMapping("/register")
public String register(Map<String,Object> map,
Model model,
HttpServletResponse response) {
//如果一個註冊請求,會將註冊數據封裝到map或者model
//map中的數據和model的數據，會被放入到request域中
map.put("user","llp");
map.put("job","碼農");
model.addAttribute("sal", 2500);
//一會我們再測試response使用
//我們演示創建cookie,並通過response 添加到瀏覽器/客戶端
Cookie cookie = new Cookie("email", "[email protected]");
response.addCookie(cookie);
//請求轉發
return "forward:/registerOk";
}
@ResponseBody
@GetMapping("/registerOk")
public String registerOk(HttpServletRequest request) {
System.out.println("user-" + request.getAttribute("user"));
System.out.println("job-" + request.getAttribute("job"));
System.out.println("sal-" + request.getAttribute("sal"));
return "success";
}
4.自定義對象參數-自動封裝
1.基本介紹
- 在開發中，SpringBoot 在響應客戶端請求時，也支持自定義對象參數
- 完成自動類型轉換與格式化
- 支持級聯封裝
2.自定義對象參數-應用實例
1.需求說明 : 演示自定義對象參數使用，完成自動封裝，類型轉換
2.代碼實現
1.創建src\main\resources\static\save.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>添加妖怪</title></head>
<body><h1>添加妖怪-坐騎[測試封裝 POJO；]</h1>
<form action="/savemonster" method="post">
編號： <input name="id" value="100"><br/>
姓名： <input name="name" value="牛魔王"/><br/>
年齡： <input name="age" value="120"/> <br/>
婚否： <input name="isMarried" value="true"/> <br/>
生日： <input name="birth" value="2000/11/11"/> <br/>
<!--註意這裡car對象是monster的屬性，給對象屬性賦值時需要以對象名.字段名的方式-->
坐騎：<input name="car.name" value="法拉利"/><br/>
價格：<input name="car.price" value="99999.9"/>
<input type="submit" value="保存"/>
</form>
</body>
</html>
2.修改src\main\java\com\llp\springboot\controller\ParameterController.java
@PostMapping("/savemonster")
public String saveMonster(Monster monster) {
System.out.println("monster= " + monster);
return "success";
}
到此這篇關於SpringBoot接收參數使用的註解實例講解的文章就介紹到這瞭,更多相關SpringBoot接收參數內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！
推薦閱讀：
- SpringBoot請求參數相關註解說明小結
- 聊聊@RequestParam,@PathParam,@PathVariable等註解的區別
- SpringMVC中請求參數的獲取方式
- SpringBoot多種場景傳參模式
- 基於params、@PathVariabl和@RequestParam的用法與區別說明