在Spring Boot中，RESTful API的實現(xiàn)通過控制器類中的方法和特定的注解來完成。每個注解對應(yīng)不同的HTTP請求方法，并通過處理請求參數(shù)和返回響應(yīng)來實現(xiàn)不同的操作。

下面將詳細(xì)解釋RESTful API中的各個方面，包括@GetMapping, @PostMapping, @PutMapping, 和 @DeleteMapping的作用及區(qū)別、請求參數(shù)和返回參數(shù)。

作用及區(qū)別

1. @GetMapping:

   • 作用: 處理HTTP GET請求，用于獲取資源。通常用于讀取數(shù)據(jù)，不應(yīng)更改服務(wù)器上的資源。
   • 區(qū)別: 是冪等的，多次請求相同資源不會改變服務(wù)器狀態(tài)。
   • 示例:

     @GetMapping("/users")
     public List<User> getAllUsers() {// 獲取所有用戶
     }@GetMapping("/users/{id}")
     public User getUserById(@PathVariable Long id) {// 獲取指定ID的用戶
     }
     

2. @PostMapping:

   • 作用: 處理HTTP POST請求，用于創(chuàng)建新資源。通常用于提交數(shù)據(jù)，服務(wù)器會創(chuàng)建新的資源。
   • 區(qū)別: 不是冪等的，多次請求會創(chuàng)建多個資源。
   • 示例:

     @PostMapping("/users")
     public User createUser(@RequestBody User user) {// 創(chuàng)建新用戶
     }
     

3. @PutMapping:

   • 作用: 處理HTTP PUT請求，用于更新資源。通常用于更新現(xiàn)有資源的全部內(nèi)容。
   • 區(qū)別: 是冪等的，多次請求相同資源會導(dǎo)致相同的更新結(jié)果。
   • 示例:

     @PutMapping("/users/{id}")
     public User updateUser(@PathVariable Long id, @RequestBody User user) {// 更新指定ID的用戶
     }
     

4. @DeleteMapping:

   • 作用: 處理HTTP DELETE請求，用于刪除資源。通常用于刪除服務(wù)器上的資源。
   • 區(qū)別: 是冪等的，多次請求相同資源刪除操作只會導(dǎo)致資源被刪除一次。
   • 示例:

     @DeleteMapping("/users/{id}")
     public void deleteUser(@PathVariable Long id) {// 刪除指定ID的用戶
     }
     

請求參數(shù)

1. @RequestBody:

   • 作用: 將請求體中的JSON數(shù)據(jù)綁定到方法參數(shù)上。
   • 使用場景: 常用于@PostMapping和@PutMapping。
   • 示例:

     @PostMapping("/users")
     public User createUser(@RequestBody User user) {// 請求體中的JSON數(shù)據(jù)將綁定到user對象
     }
     

2. @PathVariable:

   • 作用: 將URL路徑中的變量綁定到方法參數(shù)上。
   • 使用場景: 常用于@GetMapping, @PutMapping, 和 @DeleteMapping。
   • 示例:

     @GetMapping("/users/{id}")
     public User getUserById(@PathVariable Long id) {// URL中的id將綁定到方法參數(shù)id
     }
     

3. @RequestParam:

   • 作用: 將查詢參數(shù)綁定到方法參數(shù)上。
   • 使用場景: 適用于各種HTTP方法。
   • 示例:

     @GetMapping("/users")
     public List<User> getUsersByAge(@RequestParam int age) {// URL中的查詢參數(shù)age將綁定到方法參數(shù)age
     }
     

返回參數(shù)

1. 返回對象:

   • 作用: 方法可以直接返回對象，Spring Boot會自動將其轉(zhuǎn)換為JSON格式。
   • 示例:

     @GetMapping("/users/{id}")
     public User getUserById(@PathVariable Long id) {// 返回User對象，自動轉(zhuǎn)換為JSON
     }
     

2. ResponseEntity:

   • 作用: 可以自定義HTTP響應(yīng)狀態(tài)碼、響應(yīng)頭和響應(yīng)體。
   • 示例:

     @PostMapping("/users")
     public ResponseEntity<User> createUser(@RequestBody User user) {User createdUser = userService.createUser(user);return ResponseEntity.status(HttpStatus.CREATED).body(createdUser);
     }
     

綜合示例

@RestController
@RequestMapping("/api/users")
public class UserController {@GetMappingpublic List<User> getAllUsers() {// 獲取所有用戶return userService.findAll();}@GetMapping("/{id}")public ResponseEntity<User> getUserById(@PathVariable Long id) {User user = userService.findById(id);if (user == null) {return ResponseEntity.notFound().build();}return ResponseEntity.ok(user);}@PostMappingpublic ResponseEntity<User> createUser(@RequestBody User user) {User createdUser = userService.createUser(user);return ResponseEntity.status(HttpStatus.CREATED).body(createdUser);}@PutMapping("/{id}")public ResponseEntity<User> updateUser(@PathVariable Long id, @RequestBody User user) {User updatedUser = userService.updateUser(id, user);if (updatedUser == null) {return ResponseEntity.notFound().build();}return ResponseEntity.ok(updatedUser);}@DeleteMapping("/{id}")public ResponseEntity<Void> deleteUser(@PathVariable Long id) {userService.deleteUser(id);return ResponseEntity.noContent().build();}
}

總結(jié)

Spring Boot中的RESTful API通過使用@GetMapping, @PostMapping, @PutMapping, 和 @DeleteMapping注解，使得每種HTTP請求類型都能簡便地映射到控制器的方法上。

通過@RequestBody, @PathVariable, 和 @RequestParam處理請求參數(shù)，并利用返回對象或ResponseEntity構(gòu)建響應(yīng)，使得RESTful API的開發(fā)變得高效且易維護。