快捷導(dǎo)航

Spring中的@RestController注解詳細解析

更新時間：2024年01月30日 10:26:00 作者：小小懶懶

這篇文章主要介紹了Spring中的@RestController注解詳細解析,@RestController 是 Spring Framework 中的一個注解,用于標識一個類為 RESTful Web 服務(wù)的控制器(Controller),處理 HTTP 請求并返回相應(yīng)的數(shù)據(jù),

@RestController

@RestController 是 Spring Framework 中的一個注解，用于標識一個類為 RESTful Web 服務(wù)的控制器（Controller）。

在 Spring MVC 中，@RestController 注解結(jié)合其他注解，如 @RequestMapping、@GetMapping、@PostMapping 等，用于處理 HTTP 請求并返回相應(yīng)的數(shù)據(jù)。

下面是對 @RestController 的詳細講解：

RESTful Web 服務(wù)

REST（Representational State Transfer）是一種設(shè)計風(fēng)格，用于構(gòu)建分布式系統(tǒng)中的 Web 服務(wù)。

RESTful Web 服務(wù)基于 HTTP 協(xié)議，使用不同的 HTTP 方法（如 GET、POST、PUT、DELETE）來執(zhí)行不同的操作，通過 URL 定位資源，并使用 JSON、XML 等格式來傳輸數(shù)據(jù)。

@RestController 注解

@RestController是一個組合注解，它包含了@Controller和@ResponseBody 注解的功能。

@Controller用于將類標識為控制器，而@ResponseBody 則表示方法的返回值直接作為 HTTP 響應(yīng)的內(nèi)容，而不是通過視圖解析器進行渲染。

常見用法

使用 @RestController 注解的類通常會定義多個處理 HTTP 請求的方法，每個方法對應(yīng)不同的 URL 和 HTTP 方法。

例如：

@RestController
@RequestMapping("/api")
public class UserController {
    @GetMapping("/users")
    public List<User> getUsers() {
        // 處理獲取用戶列表的邏輯
        // 返回用戶列表數(shù)據(jù)
    }
    @PostMapping("/users")
    public User createUser(@RequestBody User user) {
        // 處理創(chuàng)建用戶的邏輯
        // 返回創(chuàng)建的用戶數(shù)據(jù)
    }
    // 其他方法...
}

在上述示例中，UserController 類使用 @RestController 注解標識為 RESTful Web 服務(wù)的控制器。

通過 @RequestMapping 注解指定了基礎(chǔ) URL 路徑為 "/api"，然后使用 @GetMapping 和 @PostMapping 注解分別定義了處理 GET 和 POST 請求的方法。

getUsers 方法處理 "/api/users" 的 GET 請求，返回用戶列表數(shù)據(jù)；

createUser 方法處理 "/api/users" 的 POST 請求，接收一個 User 對象作為請求體，并返回創(chuàng)建的用戶數(shù)據(jù)。