SpringBoot系列教程web篇之返回文本、网页、图片的操作姿势

最新推荐文章于 2024-09-01 21:55:51 发布
最新推荐文章于 2024-09-01 21:55:51 发布
阅读量2.7k 收藏 4
点赞数
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/liuyueyi25/article/details/103369878
版权

前面几篇博文介绍了如何获取get/post传参，既然是http请求，一般也都是有来有往，有请求参数传递，就会有数据返回。那么我们通过springboot搭建的web应用，可以怎样返回数据呢？

本篇将主要介绍以下几种数据格式的返回实例

  • 返回文本

  • 返回数组

  • 返回json串

  • 返回静态网页

  • 返回图片

I. 环境搭建

首先得搭建一个web应用才有可能继续后续的测试，借助SpringBoot搭建一个web应用属于比较简单的活;

创建一个maven项目，pom文件如下


   
   
  1. <parent>
  2.  <groupId>org.springframework.boot</groupId>
  3.  <artifactId>spring-boot-starter-parent</artifactId>
  4.  <version>2.1.7</version>
  5.  <relativePath/> <!-- lookup parent from update -->
  6. </parent>
  8. <properties>
  9.  <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  10.  <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  11.  <spring-cloud.version>Finchley.RELEASE</spring-cloud.version>
  12.  <java.version>1.8</java.version>
  13. </properties>
  15. <dependencies>
  16.  <dependency>
  17.  <groupId>org.springframework.boot</groupId>
  18.  <artifactId>spring-boot-starter-web</artifactId>
  19.  </dependency>
  20. </dependencies>
  22. <build>
  23.  <pluginManagement>
  24.  <plugins>
  25.  <plugin>
  26.  <groupId>org.springframework.boot</groupId>
  27.  <artifactId>spring-boot-maven-plugin</artifactId>
  28.  </plugin>
  29.  </plugins>
  30.  </pluginManagement>
  31. </build>
  32. <repositories>
  33.  <repository>
  34.  <id>spring-milestones</id>
  35.  <name>Spring Milestones</name>
  36.  <url>https://repo.spring.io/milestone</url>
  37.  <snapshots>
  38.  <enabled>false</enabled>
  39.  </snapshots>
  40.  </repository>
  41. </repositories>

依然是一般的流程，pom依赖搞定之后，写一个程序入口


   
   
  1. /**
  2.  * Created by @author yihui in 15:26 19/9/13.
  3.  */
  4. @SpringBootApplication
  5. public class Application {
  6.  public static void main(String[] args) {
  7.  SpringApplication.run(Application.class);
  8.  }
  9. }

II. 数据返回姿势实例

以下返回实例都放在同一个Controller中，具体定义如下


   
   
  1. @Controller
  2. @RequestMapping(path = "data")
  3. public class DataRespRest {
  4. }

1. 文本返回

这个属于基础功能了，发起请求，返回一串文本，在SpringMVC的体系中，要实现这种通常的写法通常是直接定义方法的返回为String；当然还有另外一种非常基础的写法，直接将返回的数据通过 HttpServletResponse写入到输出流中

下面给出这两种写法的实例


   
   
  1. @ResponseBody
  2. @GetMapping(path = "str")
  3. public String strRsp() {
  4.  return "hello " + UUID.randomUUID().toString();
  5. }
  7. @ResponseBody
  8. @GetMapping(path = "str2")
  9. public void strRsp2(HttpServletResponse response) throws IOException {
  10.  Map<String, String> ans = new HashMap<>(2);
  11.  ans.put("a", "b");
  12.  ans.put("b", "c");
  13.  response.getOutputStream().write(JSON.toJSONString(ans).getBytes());
  14.  response.getOutputStream().flush();
  15. }

注意上面的实现中，方法上面多了一个注解 @ResponseBody，这个表示返回数据，而不是视图（后面会详细说明）

strRsp2的输出借助了FastJson来实现将map序列化为json串，然后写入输出流

实例访问如下

从上面的输出也可以看出，第一种返回方式， ResponseHeaders的 Content-Type:text/html;charset=UTF-8；而第二种方式则没有这个响应头，需要我们自己主动设置（这里注意一下即可，在后面的返回图片中有实例）

2，返回数组

前面请求参数的博文中，我们看到请求参数允许传入数组，那么我们返回可以直接返回数组么？讲道理的话，应该没啥问题


   
   
  1. /**
  2.  * 返回数组
  3.  *
  4.  * @return
  5.  */
  6. @ResponseBody
  7. @GetMapping(path = "ary")
  8. public String[] aryRsp() {
  9.  return new String[]{UUID.randomUUID().toString(), LocalDateTime.now().toString()};
  10. }

然后请求输出为

注意下响应头，为 application/json, 也就是说SpringMVC将数组当成json串进行返回了

3. Bean返回

在我们实际的业务开发中，这种应该属于非常常见的使用姿势了，直接返回一个POJO，调用者接收的是一个json串，可以很容易的反序列化为需要的对象


   
   
  1. /**
  2.  * 返回POJO
  3.  *
  4.  * @return
  5.  */
  6. @ResponseBody
  7. @GetMapping(path = "bean")
  8. public DemoRsp beanRsp() {
  9.  return new DemoRsp(200, "success", UUID.randomUUID().toString() + "--->data");
  10. }


4. 网页返回

前面都是直接返回数据，但是我们平常在使用浏览器，更多的是发起一个请求，然后返回一个网页啊，难道说springmvc不能直接返回网页么？

当然返回网页怎么可能会不支持，（题外话：个人感觉在前后端分离逐渐流行之后，直接由后端返回网页的case不太多了，前端和后端作为独立的项目部署，两者之间通过json串进行交流；这里扯远了），我们下面看一下SpringMVC中如何返回网页

我们可以从上面直接返回字符串的case中，得到一个思路，如果我直接返回一个html文本，会怎样？既然返回 content-type是 text/html，那浏览器应该可以解析为网页的，下面实测一下


   
   
  1. @ResponseBody
  2. @GetMapping(path = "html")
  3. public String strHtmlRsp() {
  4.  return "<html>\n" + "<head>\n" + " <title>返回数据测试</title>\n" + "</head>\n" + "<body>\n" +
  5.  "<h1>欢迎欢迎，热烈欢迎</h1>\n" + "</body>\n" + "</html>";
  6. }

测试如下

浏览器发起请求之后，将我们返回的html文本当做网页正常渲染了，所以我们如果想返回网页，就这么干，没毛病！

上面这种方式虽然说可以返回网页，然而在实际业务中，如果真要我们这么干，想想也是可怕，还干什么后端，分分钟全栈得了！！！

下面看一下更常规的写法，首先我们需要配置下返回视图的前缀、后缀, 在 application.yml配置文件中添加如下配置


   
   
  1. spring:
  2.  mvc:
  3.  view:
  4.  prefix: /
  5.  suffix: .html

然后我们的静态网页，放在资源文件的static目录下，下面是我们实际的项目截图，index.html为我们需要返回的静态网页

接下来就是我们的服务接口


   
   
  1. /**
  2.  * 返回视图
  3.  *
  4.  * @return
  5.  */
  6. @GetMapping(path = "view")
  7. public String viewRsp() {
  8.  return "index";
  9. }

注意下上面的接口，没有 @ResponseBody注解，表示这个接口返回的是一个视图，会从static目录下寻找名为 index.html（前缀路径和后缀是上面的application.yml中定义）的网页返回

实测case如下

5. 图片返回

图片返回与前面的又不太一样了，上面介绍的几种case中，要么是返回文本，要么返回视图，而返回图片呢，更多的是返回图片的字符数组，然后告诉浏览器这是个图片，老哥你按照图片渲染

直接返回二进制流，上面在介绍文本返回的两种方式中，有个直接通过 HttpServletResponse向输出流中写数据的方式，我们这里是不是可以直接这么用呢？

下面给出一个从网络下载图片并返回二进制流的实际case


   
   
  1. /**
  2.  * 返回图片
  3.  */
  4. @GetMapping(path = "img")
  5. public void imgRsp(HttpServletResponse response) throws IOException {
  6.  response.setContentType("image/png");
  7.  ServletOutputStream outStream = response.getOutputStream();
  9.  String path = "https://spring.hhui.top/spring-blog/imgs/info/info.png";
  10.  URL uri = new URL(path);
  11.  BufferedImage img = ImageIO.read(uri);
  12.  ImageIO.write(img, "png", response.getOutputStream());
  13.  System.out.println("--------");
  14. }

注意下上面的实例case，首先设置了返回的 ContentType，然后借助 ImateIO来下载图片（个人不太建议这种写法，很容易出现403；这里演示主要是为了简单...），并将图片写入到输出流

实例演示如下

III 小结

1. 返回数据小结

本篇博文主要介绍了几种常见数据格式的返回使用姿势，本文更多的是一种使用方式的实例case演示，并没有涉及到底层的支持原理，也没有过多的提及如何设置响应头，web交互中常见的cookies/session也没有说到，这些将作为下篇的内容引入，恳请关注

下面做一个简单的小结

返回纯数据

  • 添加 @ResponseBody注解，则表示我们返回的是数据，而不需要进行视图解析渲染；

  • 如果一个controller中全部都是返回数据，不会返回视图时，我们可以在添加 @RestController注解，然后这个类中的接口都不需要添加 @ResponseBody注解了

  • 返回视图时，我们会根据接口返回的字符串，结合定义的前缀，后缀，到资源路径的static目录下寻找对应的静态文件返回

  • 可以直接通过向 HttpServletResponse的输出流中写数据的方式来返回数据，如返回图片常用这种case

2. 更多web系列博文

IV. 其他

0. 项目

  • 工程：https://github.com/liuyueyi/spring-boot-demo

  • 项目: https://github.com/liuyueyi/spring-boot-demo/blob/master/spring-boot/207-web-response

1. 一灰灰Blog

尽信书则不如，以上内容，纯属一家之言，因个人能力有限，难免有疏漏和错误之处，如发现bug或者有更好的建议，欢迎批评指正，不吝感激

下面一灰灰的个人博客，记录所有学习和工作中的博文，欢迎大家前去逛逛

  • 一灰灰Blog个人博客 https://blog.hhui.top

  • 一灰灰Blog-Spring专题博客 http://spring.hhui.to

一灰灰blog
关注
SpringBoot2.x系列教程（三十七）SpringBoot web之网站图标（Favicon）配置
程序新视界
02-01 5320
正常情况下，每个网站都会有一个对应的网站图标（Favicon），在浏览器访问网站时，对应的浏览器标签上会出现对应的图标。如下图百度的图标： 对此Spring Boot项目也提供了支持，但不同版本有所区别，在最新版本中的使用，网络上大多数文章已经失效，本篇文章带大家看一下Spring Boot 2.x版本中的使用情况。 Spring Boot不同版本对Favicon的支持 在早些版本中Spring...
【SpringBoot】45、SpringBoot中整合JWT实现Token验证（注解篇）
Asurplus
02-28 21万+
前言 上篇文章，我们已经在 SpringBoot 中整合了 JWT 并实现了 Token 验证，那我们在实际应用中就会发现，如果每个 视图层（controller）都手动验证 token，代码就会显得特别臃肿，本篇文章主要为了解决该问题。 如果对整合 JWT 还不熟悉的朋友，可以先看看我的这篇博客：【SpringBoot】四十四、SpringBoot中整合JWT实现Token验证 自定义注解 1、创建自定义注解 package com.asurplus.common.annotation; import
Spring Boot 返回Content-Type解决方案
01-20
背景 前端同学需要Content-Type 字段返回，根据文件的类型不同返回不同的类型；还有就是直接打开一个下载链接，对于Chrome这样的浏览器其实支持自适应预览的效果。https://tool.oschina.net/commons/ 这里的链接中有好多好多的Content-type的类型！拿到这个问题，之前的伙伴有写了几个if else 判断图片、文档等等，但是支持不是很全面、谁知道之后还有什么样的格式类型返回呢？if else 不能从根本上解决问题。ps:作为程序员我也不想这么累，这种肯定有一种解决方案存在的。 解决方案 RestTemplate获取文件的contentType 这篇文
Spring Boot 静态资源处理，原来如此！
朱小厮的博客
11-21 816
点击上方“朱小厮的博客”，选择“设为星标”后台回复”加群“加入公众号专属技术群来源：rrd.me/faAmu做web开发的时候，我们往往会有很多静态资源，如html、图片、css等。那如何向前端返回静态资源呢？以前做过web开发的同学应该知道，我们以前创建的web工程下面会有一个webapp的目录，我们只要把静态资源放在该目录下就可以直接访问。但是，基于Spring boot的工程并没有这个目录，...
【Spring Boot 3】【Web】返回图片
最新发布
又言又语
09-01 1051
本文介绍开发 Spring Boot Web 应用时如何返回图片给前端显示。
SpringBoot接口返回图片
zekeTao的博客
12-28 1万+
使用 ResponseEntity 返回结果，设置HttpHeader中的content-type，如：image/png @RequestMapping(method = RequestMethod.GET) public ResponseEntity getFile(@RequestParam long id) { Result result = fileSe...
springboot返回图片
han1396735592的博客
08-23 898
springboot 返回照片
spring boot 返回图片流
钟健的博客
03-22 8万+
spring boot 返回图片流 一、返回BufferedImage 由于spring mvc不支持返回BufferedImage ，所以增加图片转换器 @Configuration public class WebMvcConfig implements WebMvcConfigurer { /** * 增加图片转换器 * @param converters */ @Override public void extendMessageConver
Springboot系列教程汇总
Java笔记虾
03-12 3274
Springboot 系列（一）Spring Boot 入门 Springboot 系列（二）Spring Boot 配置文件 Springboot 系列（三）Spring Boot 自动配置 Springboot 系列（四）Spring Boot 日志框架 Springboot 系列（五）Spring Boot web 开发之静态资源和模版 Springb...
【SpringBoot】44、SpringBoot中整合JWT实现Token验证（整合篇）
热门推荐
Asurplus
02-28 21万+
什么是JWT？ Json web token (JWT)，是为了在网络应用环境间传递声明而执行的一种基于 JSON 的开放标准（(RFC 7519)，该 token 被设计为紧凑且安全的，特别适用于分布式站点的单点登录（SSO）场景。JWT 的声明一般被用来在身份提供者和服务提供者间传递被认证的用户身份信息，以便于从资源服务器获取资源，也可以增加一些额外的其它业务逻辑所必须的声明信息，该token也可直接被用于认证，也可被加密。 为什么需要JWT? 当我们开发前后端分离项目时，要求我们对用户会话状态要进行一
【SpringBoot】43、SpringBoot中整合RabbitMQ实现延时队列（延时插件篇）
Asurplus
02-21 21万+
一、介绍 1、什么是延时队列？ 延时队列即就是放置在该队列里面的消息是不需要立即消费的，而是等待一段时间之后取出消费 2、适用场景 （1）商城订单超时未支付，取消订单 （2）使用权限到期前十分钟提醒用户 （3）收益项目，投入后一段时间后产生收益 二、实现方式 从以上场景中，我们可以看出，延时队列的主要功能就是在指定的时间之后做指定的事情，那么，我们思考有哪些工具我们可以使用？ 1、Redis 监听过期 Key 可以参考我的博客【SpringBoot】三十五、SpringBoot整合Redis监听Ke
Springboot通过图片路径形式获取图片
08-19
主要介绍了Springboot通过图片路径形式获取图片,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
springboot 接口返回图片
shuaiqijiejie的博客
10-03 7321
使用springboot接口获取图片url地址，浏览器可直接访问
springboot在restcontroller下返回文本类型
qq_29439685的博客
03-28 1万+
最近本人做一个接口，接口需要用post application/x-www-form-urlencoded发送请求，返回类型是text/plain，刚开始的思路毫无思路，于是在网上找到thymeleaf，其作为springboot组成组件，可以在controller模式下返回文本类型，即在html中打开，可是使用过后发现其对接口post请求无法做出正确的相应，后面解决方式是利用了ResponseE...
Spring Boot 返回图片、音视频等流数据（多种方式）
youpccc的博客
04-18 1365
Java架构进阶面试及知识点文档笔记这份文档共498页，其中包括Java集合，并发编程，JVM，Dubbo,Redis，Spring全家桶，MySQL，Kafka等面试解析及知识点整理Java分布式高级面试问题解析文档其中都是包括分布式的面试问题解析，内容有分布式消息队列，Redis缓存，分库分表，微服务架构，分布式高可用，读写分离等等！互联网Java程序员面试必备问题解析及文档学习笔记Java架构进阶视频解析合集《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》
SpringBoot接口中如何直接返回图片数据
坚持学习永不言弃
09-19 1185
加了上面的配置后发现问题仍没有解决，报错仍是406，怀疑配置没有生效，于是决定走源码查看原因。**总结：**实现一个方案的过程中碰到了各种各样的奇怪问题，最好的方式是先网上找资料快速解决问题，如果无法解决，再通过自己走源码的方式从根本原因上寻找出现问题的原因，解决问题最复杂的地方是定位问题，问题定位了，解决便不再是难题。最近在做涉及到分享推广的业务，需要由业务员分享二维码进入推广页面，由于是新项目，前期预算和用量都有限，没有搭建对象存储服务，所以决定使用后台服务动态生成二维码图片直接图片数据并返回。
图文并茂：解析Spring Boot Controller返回图片的三种方式
todoitbo的博客
05-10 1万+
本文将深入探讨在Spring Boot中如何处理并返回图片格式的数据，包括使用Base64编码、byte数组和Resource对象三种方式。我们将详细解析每种方式的实现原理、优缺点以及适用场景，帮助读者选择最适合自己项目需求的图片返回方式。
springBoot接口中直接返回图片数据
黄杨路打字员
07-03 8673
起因 最近在做涉及到分享推广的业务，需要由业务员分享二维码进入推广页面，由于是新项目，前期预算和用量都有限，没有搭建对象存储服务，所以决定使用后台服务动态生成二维码图片直接图片数据并返回。 首先是二维码的生成，决定使用google的zxing，毕竟google的东西还是不错的，maven添加依赖如下： <!-- https://mvnrepository.com/artifact/com.g...
springboot项目返回图片
qq_40798764的博客
09-10 492
/** * 返回图片 * @param images * @return */ @ApiOperation(value = "获取图片", httpMethod = "GET", notes = "获取图片") @RequestMapping(value = "/getPhoto", produces = MediaType.IMAGE_JPEG_VALUE) public byte[] getPhot...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

一灰灰blog

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值