前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >@RestController vs @Controller

@RestController vs @Controller

作者头像
Guide哥
发布2020-05-08 12:05:24
2K0
发布2020-05-08 12:05:24
举报
文章被收录于专栏:JavaGuide

周末的时候分享了一个技术session,讲到了@RestController 和 @Controller,当时没有太讲清楚,因为 team 里很多同事之前不是做 Java的,所以对这两个东西不太熟悉,于是写了篇文章整理了一下,顺便分享一下。这是一个比较基础的问题,可以拿来回顾一下 Spring 基础。

@RestController vs @Controller

Controller 返回一个页面

单独使用 @Controller 不加 @ResponseBody的话一般使用在要返回一个视图的情况,这种情况属于比较传统的Spring MVC 的应用,对应于前后端不分离的情况。

SpringMVC 传统工作流程

@RestController 返回JSON 或 XML 形式数据

@RestController只返回对象,对象数据直接以 JSON 或 XML 形式写入 HTTP 响应(Response)中,这种情况属于 RESTful Web服务,这也是目前日常开发所接触的最常用的情况(前后端分离)。

SpringMVC+RestController

@Controller +@ResponseBody 返回JSON 或 XML 形式数据

如果你需要在Spring4之前开发 RESTful Web服务的话,你需要使用@Controller 并结合@ResponseBody注解,也就是说@Controller +@ResponseBody= @RestController(Spring 4 之后新加的注解)。

@ResponseBody 注解的作用是将 Controller 的方法返回的对象通过适当的转换器转换为指定的格式之后,写入到HTTP 响应(Response)对象的 body 中,通常用来返回 JSON 或者 XML 数据,返回 JSON 数据的情况比较多。

Spring3.xMVC RESTfulWeb服务工作流程

Reference:

  • https://dzone.com/articles/spring-framework-restcontroller-vs-controller(图片来源)
  • https://javarevisited.blogspot.com/2017/08/difference-between-restcontroller-and-controller-annotations-spring-mvc-rest.html?m=1

示例1: @Controller 返回一个页面

当我们需要直接在后端返回一个页面的时候,Spring 推荐使用 Thymeleaf 模板引擎。Spring MVC中@Controller中的方法可以直接返回模板名称,接下来 Thymeleaf 模板引擎会自动进行渲染,模板中的表达式支持Spring表达式语言(Spring EL)。如果需要用到 Thymeleaf 模板引擎,注意添加依赖!不然会报错。

Gradle:

代码语言:javascript
复制
 compile 'org.springframework.boot:spring-boot-starter-thymeleaf'

Maven:

代码语言:javascript
复制
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

src/main/java/com/example/demo/controller/HelloController.java

代码语言:javascript
复制
@Controller
public class HelloController {
    @GetMapping("/hello")
    public String greeting(@RequestParam(name = "name", required = false, defaultValue = "World") String name, Model model) {
        model.addAttribute("name", name);
        return "hello";
    }
}

src/main/resources/templates/hello.html

Spring 默认会去 resources 目录下 templates 目录下找,所以建议把页面放在 resources/templates 目录下

代码语言:javascript
复制
<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <title>Getting Started: Serving Web Content</title>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
</head>
<body>
<p th:text="'Hello, ' + ${name} + '!'"/>
</body>
</html>

访问:http://localhost:8999/hello?name=team-c ,你将看到下面的内容

代码语言:javascript
复制
Hello, team-c!

如果要对页面在templates目录下的hello文件夹中的话,返回页面的时候像下面这样写就可以了。

src/main/resources/templates/hello/hello.html

代码语言:javascript
复制
   return "hello/hello";

示例2: @Controller+@ResponseBody 返回 JSON 格式数据

SpringBoot 默认集成了 jackson ,对于此需求你不需要添加任何相关依赖。

src/main/java/com/example/demo/controller/Person.java

代码语言:javascript
复制
public class Person {
    private String name;
    private Integer age;
    ......
    省略getter/setter ,有参和无参的construtor方法
}

src/main/java/com/example/demo/controller/HelloController.java

代码语言:javascript
复制
@Controller
public class HelloController {
    @PostMapping("/hello")
    @ResponseBody
    public Person greeting(@RequestBody Person person) {
        return person;
    }

}

使用 post 请求访问 http://localhost:8080/hello ,body 中附带以下参数,后端会以json 格式将 person 对象返回。

代码语言:javascript
复制
{
    "name": "teamc",
    "age": 1
}

示例3: @RestController 返回 JSON 格式数据

只需要将HelloController改为如下形式:

代码语言:javascript
复制
@RestController
public class HelloController {
    @PostMapping("/hello")
    public Person greeting(@RequestBody Person person) {
        return person;
    }

}
本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2019-08-19,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 JavaGuide 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • @RestController vs @Controller
    • Controller 返回一个页面
      • @RestController 返回JSON 或 XML 形式数据
        • @Controller +@ResponseBody 返回JSON 或 XML 形式数据
          • 示例1: @Controller 返回一个页面
            • 示例2: @Controller+@ResponseBody 返回 JSON 格式数据
              • 示例3: @RestController 返回 JSON 格式数据
              领券
              问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档