@Controller和@RestController的区别？

news2025/1/4 21:38:35

本文为joshua317原创文章,转载请注明：转载自joshua317博客 @Controller和@RestController的区别？ - joshua317的博客

@Controller和@RestController的区别？

在springboot开发中控制层使用注解@Controller时，加有@GetMapping(@PostMapping或@RequestMapping)注解的方法返回值对应的是一个视图，而使用@RestController返回值对应的是json数据，也就是说@RestController注解相当于@ResponseBody+@Controller合在一起的作用。

如果只使用@RestController注解控制器xxController,方法中只会返回return中的内容，视图解析器InternalResourceViewResolver不会作用，不会返回jsp,html页面。

如果返回到指定页面的话，则需要在xxController上添加注解@Controller并且要配合视图解析器InternalResourceViewResolver。如果是XML,JSON或自定义枚举类型内容到页面，需要在请求的方法上添加@ResponseBody注解

接下来我们使用thymeleaf模板引擎为例：

引入thymeleaf模板引擎依赖

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

首先在application.properties或者application.yml设置thymeleaf的配置,可以再对应的文件中查看ThymeleafProperties.class

spring:
  thymeleaf:
    suffix: .html
    prefix: classpath:/templates/

1. @Controller的测试

在控制层创建TestController的类

package com.joshua317.myweb.controller;

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

@Controller
public class TestController {

    @GetMapping("/hello/controller")
    public String index() {
        return "hello/controller";
    }
}

在模板templates目录下，创建hello/controller.html

<!DOCTYPE html>
<!--导入thymeleaf的名称空间-->
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <!--/*@thymesVar id="name" type="java.lang.String"*/-->
    <title th:text="'欢迎来到'">Title</title>
</head>
<body>
<!--th:text 为 Thymeleaf 属性，用于获取指定属性的值-->
<!--/*@thymesVar id="name" type="java.lang.String"*/-->
<h1 th:text="'欢迎来到@controller注解介绍'"></h1>
</body>
</html>

查看结果，会发现执行到了hello/controller.html页面

2. @RestController的测试

直接把TestController的类中，@Controller注解换成@RestController注解

package com.joshua317.myweb.controller;

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

@RestController
public class TestController {

    @GetMapping("/hello/controller")
    public String index() {
        return "hello/controller";
    }
}

重新测试执行，结果为：

也就是说使用RestController注解是无法返回jsp页面或者html，配置的视图解析器 InternalResourceViewResolver不起作用，返回的内容就是Return 里的内容。

3. @Controller+@ResponseBody的测试

如果在使用@Controller注解时，想要返回JSON，XML或自定义mediaType内容到页面，则需要在对应的方法上加上@ResponseBody注解。

package com.joshua317.myweb.controller;

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

@Controller
public class TestController {

    @GetMapping("/hello/controller")
    public String index() {
        return "hello/controller";
    }

    @GetMapping("/hello/responsebody")
    @ResponseBody
    public String respone() {
        return "responsebody";
    }
}

查看结果：