Spring中@RestController和@Controller使用及區(qū)別

@RestController 是 Spring Web 提供的一個用來開發(fā) RESTful Web 服務的關鍵注解，它是 @Controller 和 @ResponseBody 的組合注解。通過 @RestController，我們可以實現(xiàn)處理 HTTP 請求并直接返回 JSON、XML 或其他格式的數(shù)據(jù)，而不是返回視圖頁面。

以下是對 @RestController 注解的詳細解析：

1. 基本定義

@RestController 的作用

• 它是一個 標記類 的注解，標識該類是一個 Spring MVC 控制器，且所有方法的返回值會直接作為 HTTP 響應體（Response Body）。
• 可以用來簡化 RESTful API 的開發(fā)。

注解的來源

@RestController 是 Spring 4.0 引入的，屬于 org.springframework.web.bind.annotation 包。

組合關系

它相當于 @Controller 和 @ResponseBody 的組合：

@Target(value=TYPE)
@Retention(value=RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController {
}

@Controller：

• 標識當前類是一個 Spring MVC 控制器，用于處理 HTTP 請求。

@ResponseBody：

• 方法的返回值不會被解析為視圖名稱，而是直接寫入 HTTP 響應體中。

2. 使用場景

@RestController 一般用于開發(fā) RESTful 風格的服務接口，如前后端分離的項目中，前端通過 AJAX 或其他 Http 客戶端調用后端接口，獲取 JSON 或 XML 數(shù)據(jù)。

與 @Controller 的區(qū)別在于：

• @RestController 專注于返回數(shù)據(jù)（如 JSON、XML）。
• @Controller 通常用于返回視圖頁面（如 HTML、JSP）。

3. 使用示例

示例 1：創(chuàng)建一個簡單的 RESTful API

import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/api/users")
public class UserController {

    // GET 請求，獲取用戶信息
    @GetMapping("/{id}")
    public String getUserById(@PathVariable("id") Long id) {
        return "User ID: " + id;
    }

    // POST 請求，創(chuàng)建新用戶
    @PostMapping
    public String createUser(@RequestBody String user) {
        return "User created: " + user;
    }
}

請求說明：

1. @RestController 標注了 UserController 這個類是 RESTful 控制器。
2. 返回值直接寫入響應體，不需要額外使用 @ResponseBody。
3. 示例中實現(xiàn)了兩個接口：
   • 獲取用戶信息（GET /api/users/{id}）。
   • 創(chuàng)建用戶（POST /api/users）。

4. 與 @Controller 的對比

示例對比：

@RestController 示例：

@RestController
@RequestMapping("/api")
public class ApiController {
    @GetMapping("/greeting")
    public String greeting() {
        return "Hello, World!";
    }
}

返回結果：Hello, World! 作為純文本響應。

@Controller 示例：

@Controller
@RequestMapping("/web")
public class WebController {
    @GetMapping("/greeting")
    public String greeting() {
        return "greeting"; // 返回視圖名稱
    }
}

返回結果：渲染名為 greeting.html 的視圖。

5. 常用注解配合使用

5.1 配合 @RequestMapping

@RequestMapping 用于指定類或方法的請求路徑?？梢耘c @RestController 配合使用，設置 RESTful API 的基礎路徑。

示例：

@RestController
@RequestMapping("/api")
public class MyController {
    @GetMapping("/hello")
    public String sayHello() {
        return "Hello, API!";
    }
}

請求路徑：GET /api/hello

5.2 配合 @GetMapping、@PostMapping

• @GetMapping：用于處理 HTTP GET 請求。
• @PostMapping：用于處理 HTTP POST 請求。

示例：

@RestController
@RequestMapping("/users")
public class UserController {

    // GET 請求
    @GetMapping("/{id}")
    public String getUser(@PathVariable Long id) {
        return "User ID: " + id;
    }

    // POST 請求
    @PostMapping
    public String createUser(@RequestBody String user) {
        return "Created User: " + user;
    }
}

5.3 配合 @RequestBody

@RequestBody 將 JSON 請求體轉換為 Java 對象。

示例：

@RestController
@RequestMapping("/books")
public class BookController {

    @PostMapping
    public String createBook(@RequestBody Book book) {
        return "Created Book: " + book.getTitle();
    }
}
class Book {
    private String title;
    private String author;
    // Getter and Setter
}

請求數(shù)據(jù)：

{
    "title": "Spring in Action",
    "author": "Craig Walls"
}

5.4 配合 @PathVariable 和 @RequestParam

• @PathVariable：從請求路徑中獲取變量。
• @RequestParam：從查詢參數(shù)中獲取值。

示例：

@RestController
@RequestMapping("/products")
public class ProductController {

    @GetMapping("/{id}")
    public String getProduct(@PathVariable Long id, @RequestParam String name) {
        return "Product ID: " + id + ", Name: " + name;
    }
}

• 請求路徑：GET /products/123?name=Phone
• 返回結果：Product ID: 123, Name: Phone

6. 返回 JSON 數(shù)據(jù)

@RestController 默認將返回值序列化為 JSON 格式（如果依賴的 Jackson 庫存在）。

示例：

@RestController
@RequestMapping("/users")
public class UserController {

    @GetMapping("/{id}")
    public User getUser(@PathVariable Long id) {
        return new User(id, "John");
    }
}
class User {
    private Long id;
    private String name;
    // Constructor, Getter, Setter
}

返回結果：

{
    "id": 1,
    "name": "John"
}

7. 常見問題

7.1 返回值無法序列化

• 如果返回的對象沒有提供 getter 或沒有無參構造函數(shù)，可能導致 JSON 序列化失敗。
• 解決方法：確保返回的對象有正確的 getter 和無參構造器。

7.2 404 Not Found 錯誤

• 檢查請求路徑是否正確。
• 確?？刂破黝惡头椒ǖ?@RequestMapping 路徑匹配。

7.3 415 Unsupported Media Type 問題

• 如果使用 @RequestBody，確保請求頭中有 Content-Type: application/json。

8. 特性總結

總結

• @RestController 是 Spring Web 提供的一個便捷注解，專用于處理 RESTful API 請求。
• 它簡化了傳統(tǒng)的 @Controller + @ResponseBody 的開發(fā)方式。
• 配合其他注解（如 @RequestMapping、@GetMapping、@RequestBody 等）可以快速開發(fā)健壯的 RESTful 服務。
• 在前后端分離的應用中，@RestController 是必不可少的工具之一。

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

最新評論