@RestController 与 @Controller 注解说明

@RestController 与 @Controller 注解说明

一、@Controller 注解

@Controller 是 Spring MVC 中用于标记控制器类的注解，主要用于处理 HTTP 请求并返回视图（如 JSP、Thymeleaf 页面）。若需直接返回数据（而非视图），需配合 @ResponseBody 注解。

代码示例：

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

/**
 * 传统 MVC 控制器（可返回视图或数据）
 */
@Controller
public class MyController {

    /**
     * 处理 /hello 请求，返回字符串数据
     * @return 直接作为 HTTP 响应体返回的字符串
     */
    @RequestMapping("/hello")
    @ResponseBody  // 关键：将方法返回值直接作为响应体，而非视图名称
    public String hello() {
        return "Hello, World!";
    }

    /**
     * 若不使用 @ResponseBody，默认返回视图名称
     * @return 视图名称（如 "index" 对应 index.html 或 index.jsp）
     */
    @RequestMapping("/index")
    public String index() {
        // 返回视图名称，由视图解析器解析为实际页面
        return "index";
    }
}

二、@RestController 注解

@RestController 是 Spring 4.0 引入的组合注解，等价于 @Controller + @ResponseBody。被该注解标记的控制器类中，所有方法的返回值都会直接作为 HTTP 响应体（无需再单独添加 @ResponseBody），适用于构建 RESTful API。

代码示例：

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

/**
 * REST 风格控制器（默认返回数据，不返回视图）
 */
@RestController  // 等价于 @Controller + @ResponseBody
public class MyRestController {

    /**
     * 处理 /hello 请求，直接返回字符串数据
     * 无需额外添加 @ResponseBody，默认返回响应体
     */
    @RequestMapping("/hello")
    public String hello() {
        return "Hello, World!";
    }

    /**
     * 返回 JSON 数据（Spring 会自动将对象转换为 JSON）
     */
    @RequestMapping("/user")
    public User getUser() {
        User user = new User();
        user.setId(1L);
        user.setName("张三");
        return user;  // 自动转换为 {"id":1,"name":"张三"}
    }
}

// 实体类示例
class User {
    private Long id;
    private String name;
}

三、核心区别对比

特性 @Controller @RestController
本质 标记 MVC 控制器类 组合注解（@Controller + @ResponseBody）
返回值默认处理 返回视图名称（需视图解析器解析） 直接返回数据（作为 HTTP 响应体）
是否需要 @ResponseBody 需手动添加才能返回数据 无需添加，默认返回数据
适用场景 传统 Web 应用（返回页面） RESTful API 接口（返回 JSON/XML 等数据）

四、使用场景总结

@Controller：适用于传统 Web 开发，需要返回页面（如 JSP、Thymeleaf 模板）时使用，需返回数据时配合 @ResponseBody。
@RestController：适用于前后端分离架构或 API 服务开发，无需返回页面，直接返回 JSON/XML 等数据时使用，简化代码编写。

通过合理选择注解，可使控制器职责更清晰，代码更简洁。