@RestController和@Controller

@RestController和@Controller

在 Spring MVC 中，@RestController 和 @Controller 是用于定义控制器的注解，但它们有一些重要的区别。下面是对它们的详细解释和示例：

@Controller

@Controller 注解用于标记一个类是一个 Spring MVC 控制器，通常用于返回视图名以便视图解析器可以根据逻辑视图名找到实际视图。返回的视图通常是 JSP、Thymeleaf 等模板引擎生成的 HTML 页面。

示例

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class HomeController {

    @GetMapping("/home")
    public String home(Model model) {
        model.addAttribute("message", "Welcome to the Home Page!");
        return "home";  // 返回视图名 "home"，视图解析器会将其解析为实际的视图文件。
    }
}

在上面的示例中，/home 请求将返回视图名 “home”，并由视图解析器解析为实际的视图文件（例如 home.html 或 home.jsp）。

@RestController

@RestController 是 @Controller 和 @ResponseBody 的组合注解。它用于处理 RESTful Web 服务请求，通常返回 JSON 或 XML 数据。使用 @RestController 的控制器方法返回的对象会直接写入 HTTP 响应体。

示例

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    @GetMapping("/user")
    public User getUser() {
        return new User("john", "Doe");
    }
}

class User {
    private String firstName;
    private String lastName;

    // Constructors, getters and setters

    public User(String firstName, String lastName) {
        this.firstName = firstName;
        this.lastName = lastName;
    }

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }
}

在上面的示例中，/user 请求将返回一个 User 对象，Spring MVC 会将其序列化为 JSON 格式，并写入 HTTP 响应体。

主要区别

1. 返回内容:

   • @Controller：通常返回视图名，通过视图解析器解析为视图文件。
   • @RestController：返回对象，直接写入 HTTP 响应体，通常用于返回 JSON 或 XML。

2. 注解组合:

   • @Controller：需要配合 @ResponseBody 注解在方法级别使用，才能将方法返回的对象写入响应体。
   • @RestController：隐含了 @ResponseBody 注解，无需在方法级别单独使用。

示例对比

使用 @Controller 和 @ResponseBody

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class ProductController {

    @GetMapping("/product")
    @ResponseBody
    public Product getProduct() {
        return new Product("Laptop", 1500);
    }
}

class Product {
    private String name;
    private int price;

    // Constructors, getters and setters

    public Product(String name, int price) {
        this.name = name;
        this.price = price;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getPrice() {
        return price;
    }

    public void setPrice(int price) {
        this.price = price;
    }
}

使用 @RestController

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ProductController {

    @GetMapping("/product")
    public Product getProduct() {
        return new Product("Laptop", 1500);
    }
}

两种方式的最终效果相同，但 @RestController 更为简洁，不需要在每个方法上添加 @ResponseBody 注解。