總結(jié)：@RestController中的常用方法注解及其省略情況

在 Spring Boot 中，@RestController 是一個(gè)用于處理 RESTful 風(fēng)格請(qǐng)求的組合注解，它結(jié)合了 @Controller 和 @ResponseBody，使得返回的對(duì)象直接轉(zhuǎn)換成 JSON 或 XML 格式，無(wú)需視圖解析。它常用于 API 接口，尤其是處理 HTTP 請(qǐng)求時(shí)常用的方法注解如下：

1.@GetMapping

作用：處理 HTTP GET 請(qǐng)求，通常用于獲取資源。

示例：

@GetMapping("/greet")
public String greet() {
    return "Hello, World!";
}

省略情況：

可以省略 @RequestParam：如果請(qǐng)求參數(shù)的名稱與方法參數(shù)名稱一致，@RequestParam 可以省略。

如果沒有查詢參數(shù)，也可以省略 @RequestParam 注解。

2.@PostMapping

作用：處理 HTTP POST 請(qǐng)求，通常用于創(chuàng)建資源。

示例：

@PostMapping("/createUser")
public String createUser(@RequestBody User user) {
    return "User created: " + user.getName();
}

省略情況：

@RequestBody 不能省略：在處理 POST 請(qǐng)求時(shí)，@RequestBody 用于將請(qǐng)求體數(shù)據(jù)映射到 Java 對(duì)象。

3.@PutMapping

作用：處理 HTTP PUT 請(qǐng)求，通常用于更新資源。

示例：

@PutMapping("/updateUser/{id}")
public String updateUser(@PathVariable Long id, @RequestBody User user) {
    return "User with id " + id + " updated to: " + user.getName();
}

省略情況：

@PathVariable 和 @RequestBody 不能省略，除非你不需要從 URL 或請(qǐng)求體獲取參數(shù)。

4.@DeleteMapping

作用：處理 HTTP DELETE 請(qǐng)求，通常用于刪除資源。

示例：

@DeleteMapping("/deleteUser/{id}")
public String deleteUser(@PathVariable Long id) {
    return "User with id " + id + " deleted";
}

省略情況：

@PathVariable 不能省略，如果 URL 路徑中有動(dòng)態(tài)參數(shù)。

5.@PatchMapping

作用：處理 HTTP PATCH 請(qǐng)求，通常用于部分更新資源。

示例：

@PatchMapping("/updateUser/{id}")
public String patchUser(@PathVariable Long id, @RequestBody User user) {
    return "User with id " + id + " partially updated to: " + user.getName();
}

省略情況：

@PathVariable 和 @RequestBody 不能省略，除非請(qǐng)求中沒有對(duì)應(yīng)的路徑或請(qǐng)求體。

6.@RequestMapping

作用：通用注解，用于處理所有 HTTP 請(qǐng)求類型（如 GET、POST、PUT、DELETE 等），可以指定 method 屬性限制特定的 HTTP 方法。

示例：

@RequestMapping(value = "/greet", method = RequestMethod.GET)
public String greet() {
    return "Hello, World!";
}

省略情況：

使用更具體的注解（如 @GetMapping、@PostMapping 等）時(shí)，@RequestMapping 可以省略。

7.@RequestParam

作用：獲取 HTTP 請(qǐng)求中的查詢參數(shù)。

示例：

@GetMapping("/greet")
public String greet(@RequestParam String name) {
    return "Hello, " + name;
}

省略情況：

可以省略：如果查詢參數(shù)的名稱與方法參數(shù)名稱一致，Spring 會(huì)自動(dòng)綁定查詢參數(shù)到方法參數(shù)。

8.@PathVariable

作用：從 URL 路徑中獲取動(dòng)態(tài)參數(shù)。

示例：

@GetMapping("/greet/{name}")
public String greet(@PathVariable String name) {
    return "Hello, " + name;
}

省略情況：

可以省略：如果方法參數(shù)的名稱與 URL 路徑變量名稱一致，Spring 自動(dòng)綁定。

9.@RequestBody

作用：將 HTTP 請(qǐng)求體中的數(shù)據(jù)映射為 Java 對(duì)象。

示例：

@PostMapping("/createUser")
public String createUser(@RequestBody User user) {
    return "User created: " + user.getName();
}

省略情況：

不能省略，如果方法需要從請(qǐng)求體中獲取數(shù)據(jù)。

10.@ResponseBody

作用：指示 Spring 將方法的返回值直接寫入 HTTP 響應(yīng)體，而不是進(jìn)行視圖解析。

示例：

@RestController
public class MyController {
    @GetMapping("/greet")
    @ResponseBody
    public String greet() {
        return "Hello, World!";
    }
}

省略情況：

可以省略：在 @RestController 中，@ResponseBody 已隱式包含，不需要顯式使用。

11.@Valid和@Validated

作用：用于驗(yàn)證請(qǐng)求體中的數(shù)據(jù)，通常與 @RequestBody 配合使用。

示例：

@PostMapping("/createUser")
public String createUser(@RequestBody @Valid User user) {
    return "User created: " + user.getName();
}

省略情況：

可以省略：如果不需要對(duì)請(qǐng)求體進(jìn)行驗(yàn)證，@Valid 或 @Validated 可以省略。

12.@ModelAttribute

作用：將 HTTP 請(qǐng)求中的參數(shù)綁定到 Java 對(duì)象。常用于表單提交或 GET 請(qǐng)求的查詢參數(shù)。

示例：

@PostMapping("/createUser")
public String createUser(@ModelAttribute User user) {
    return "User created: " + user.getName();
}

省略情況：

可以省略：如果你直接使用 @RequestParam 或 @RequestBody 來(lái)處理參數(shù)綁定。

小結(jié)：每種注解的省略情況

結(jié)論：

這些注解讓 Spring Boot 中的 API 方法更具靈活性。合理使用它們并了解何時(shí)可以省略，能夠讓代碼更加簡(jiǎn)潔、易于維護(hù)。

到此這篇關(guān)于Spring Boot 中 controller層注解常用方法詳解的文章就介紹到這了,更多相關(guān)springboot controller層注解內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論