springboot RESTful以及參數註解的使用方式

Posted on by

springboot RESTful及參數註解使用

RESTful

Spring的復雜性不是來自於它處理的對象，而是來自於自身，不斷演進發展的Spring會帶來時間維度上復雜性，比如SpringMVC以前版本的@RequestMapping，到瞭新版本被下面新註釋替代，相當於增加的選項：

@GetMapping
@PostMapping
@PutMapping
@DeleteMapping
@PatchMapping

說明

1、@GetMapping

@RequestMapping(method = RequestMethod.GET)的簡寫

作用：對應查詢，表明是一個查詢URL映射

2、@PostMapping

@RequestMapping(method = RequestMethod.POST)的簡寫

作用：對應增加，表明是一個增加URL映射

3、@PutMapping

@RequestMapping(method = RequestMethod.PUT)的簡寫

作用：對應更新，表明是一個更新URL映射

4、@DeleteMapping

@RequestMapping(method = RequestMethod.DELETE)的簡寫

作用：對應刪除，表明是一個刪除URL映射

5、@PatchMapping

Patch方式是對put方式的一種補充;

put方式是可以更新.但是更新的是整體.patch是對局部更新;

參數註解的使用

@PathVariable
@RequestParam
@RequestBody
@ModelAttribute

說明

1. @PathVariable

獲取路徑參數。即url/{id}這種形式

@PathVariable綁定URI模板變量值

@PathVariable是用來獲得請求url中的動態參數的

@PathVariable用於將請求URL中的模板變量映射到功能處理方法的參數上。//配置url和方法的一個關系@RequestMapping(“item/{itemId}”)

2.@RequestParam

獲取查詢參數。即url?name=這種形式

@RequestParam註解主要有哪些參數：

  • value：參數名字，即入參的請求參數名字，如username表示請求的參數區中的名字為username的參數的值將傳入；
  • required：是否必須，默認是true，表示請求中一定要有相應的參數，否則將報404錯誤碼；
  • defaultValue：默認值，表示如果請求中沒有同名參數時的默認值，例如：
public List getItemTreeNode(@RequestParam(value=“id”,defaultValue=“0”)long parentId)

3.@RequestBody

@requestBody註解常用來處理content-type不是默認的application/x-www-form-urlcoded編碼的內容，比如說：application/json或者是application/xml等。一般情況下來說常用其來處理application/json類型。

通過@requestBody可以將請求體中的JSON字符串綁定到相應的bean上，當然，也可以將其分別綁定到對應的字符串上。

4.@ModelAttribute

在使用RESTful風格時，使用get請求，又想使用對象接收參數，就可以使用這個註解

不光適用於get請求，同樣也適用於put和delete請求

springboot Restful使用記錄

創建項目

通過spring官網創建項目

https://start.spring.io/

在這裡插入圖片描述

  • 項目名稱取為studyRest
  • 項目依賴WEB

Rest組件使用

使用@RestController標記類為提供Restful服務的Contoller

@GetMapping為資源定位一部分，也就是url，對應http://localhost:8080/test

@RestController
public class MyRestContoller1 {
	@GetMapping("/test")
	public Map<String, String> getData() {
		Map<String, String> data = new HashMap<String, String>();
		data.put("id", "111");
		data.put("name", "zhangsan");
		return data;
	}
}

測試（這裡使用瀏覽器測試，後續使用Postman工具）

在這裡插入圖片描述

@GetMapping關鍵字對應GET請求，也就是查詢，請求還可以有參數，對應@PathVariable與@RequestParam註解

	@GetMapping("/test/{id}")
	public Map<String, String> getData2(@PathVariable String id, @RequestParam(required = false) String name) {
		Map<String, String> data = new HashMap<String, String>();
		data.put("id", id);
		data.put("name", name);
		return data;
	}

測試，返回值為入參傳入參數

在這裡插入圖片描述

Post類型，新增操作

新增使用@PostMapping描述URL

新增一般都會帶有大量數據，一般都是使用@RequestBody註解封裝參數

	@PostMapping("/test2/add")
	public Map<String, String> addData(@RequestBody Map<String, String> data) {
		return data;
	}

測試

在這裡插入圖片描述

註意兩點，不正確都會報錯

  • 請求類型必須是POST
  • Content-type必須要設置為application/json，因為入參形式為JSON格式

在這裡插入圖片描述

更新與刪除操作

使用上與Post一致，隻是不同類型需要使用對應的主機

  • PUT：@PutMapping
  • DELETE：@DeleteMapping
	@PutMapping("/test2/update")
	public Map<String, String> updateData(@RequestBody Map<String, String> data) {
		return data;
	}
	
	@DeleteMapping("/test2/delete")
	public Map<String, String> deleteData(@RequestBody Map<String, String> data) {
		return data;
	}

RequestMapping使用

RequestMapping是一個通用註解，包含上述所有操作

@RestController
@RequestMapping(value = "/parent")
public class RequestRestContoller {
	@RequestMapping(value = "/get", method = RequestMethod.GET)
	public Map<String, String> get() {
		Map<String, String> data = new HashMap<String, String>();
		data.put("id", "111");
		data.put("name", "zhangsan");
		return data;
	}
	
	@RequestMapping(value = "/add", method = RequestMethod.POST)
	public Map<String, String> add() {
		Map<String, String> data = new HashMap<String, String>();
		data.put("id", "111");
		data.put("name", "zhangsan");
		return data;
	}
	
	@RequestMapping(value = "/update", method = RequestMethod.PUT)
	public Map<String, String> update() {
		Map<String, String> data = new HashMap<String, String>();
		data.put("id", "111");
		data.put("name", "zhangsan");
		return data;
	}
	
	@RequestMapping(value = "/delete", method = RequestMethod.DELETE)
	public Map<String, String> delete() {
		Map<String, String> data = new HashMap<String, String>();
		data.put("id", "111");
		data.put("name", "zhangsan");
		return data;
	}
}

上述還有貼在class上面的註解：@RequestMapping(value = “/parent”)，如果是class上面的註解，那麼方法上面的url需要加上class上面的註解

如：http://localhost:8080/parent/get或http://localhost:8080/parent/add

其中可以屬於請求參數和響應數據類型

@RequestMapping(value = "/parent", consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)

其中consumes 約束入參類型，produces 約束響應數據類型

測試Content-Type：text/plain報錯，由於設置瞭JSON格式

在這裡插入圖片描述

支持哪些格式參考Media定義

org.springframework.http.MediaType

XML格式數據支持

這裡擴展一下，返回XML格式數據

引入XML依賴包

	<dependency>
		<groupId>com.fasterxml.jackson.dataformat</groupId>
		<artifactId>jackson-dataformat-xml</artifactId>
	</dependency>

測試類

@RestController
public class DataRestContoller {
	@RequestMapping(value = "/addJsonResponseXml", consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_XML_VALUE)
	public Map<String, String> add(@RequestBody Map<String, String> data) {
		return data;
	}
}

測試

在這裡插入圖片描述

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：