Spring Boot 返回图片、音视频等流数据（多种方式）

最新推荐文章于 2025-02-27 07:57:23 发布

lakernote

最新推荐文章于 2025-02-27 07:57:23 发布

阅读量8.5k

点赞数 8

本文链接：https://blog.csdn.net/abu935009066/article/details/112770486

版权

Spring Boot 专栏收录该内容

44 篇文章

订阅专栏

文章目录

前言

项目开发中，会经常遇到需要下载的功能，即后台返回图片、音视频这类的文件流，记录下多种实现方式。

HttpServletResponse
HttpMessageConverter
ResponseEntity
Resource

HttpServletResponse

图像下载的最基本方法是直接针对响应对象实现：

@RequestMapping(value = "/image-manual-response", method = RequestMethod.GET)
public void getImageAsByteArray(HttpServletResponse response) throws IOException {
    InputStream in = servletContext.getResourceAsStream("/WEB-INF/images/image-example.jpg");
    response.setContentType(MediaType.IMAGE_JPEG_VALUE);
    IOUtils.copy(in, response.getOutputStream());
}

发出以下请求将在浏览器中呈现图像：

http://localhost:8080/spring-mvc-xml/image-manual-response.jpg

由于来自org.apache.commons.io包的IOUtils，实现非常简单明了。

缺点：

该方法的缺点是它对潜在更改的鲁棒性不强。MIME类型是硬编码的，更改转换逻辑或外部化图像位置需要更改代码。

HttpMessageConverter

用*@ResponseBody*注释来注释控制器方法
根据控制器方法的返回类型注册适当的消息转换器（例如，将ByteArray正确转换为图像文件所需的ByteArrayHttpMessageConverter）

配置

为了展示转换器的配置，我们将使用内置的ByteArrayHttpMessageConverter，只要方法返回*byte []*类型，它就会转换一条消息。

该ByteArrayHttpMessageConverter默认情况下注册，但配置是类似于其他任何内置或自定义转换器。

应用消息转换器bean要求在Spring MVC上下文中注册一个适当的MessageConverter bean并设置它应处理的媒体类型。

可以使用Java配置注册消息转换器：

@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
    converters.add(byteArrayHttpMessageConverter());
}

@Bean
public ByteArrayHttpMessageConverter byteArrayHttpMessageConverter() {
    ByteArrayHttpMessageConverter arrayHttpMessageConverter = new ByteArrayHttpMessageConverter();
    arrayHttpMessageConverter.setSupportedMediaTypes(getSupportedMediaTypes());
    return arrayHttpMessageConverter;
}

private List<MediaType> getSupportedMediaTypes() {
    List<MediaType> list = new ArrayList<MediaType>();
    list.add(MediaType.IMAGE_JPEG);
    list.add(MediaType.IMAGE_PNG);
    list.add(MediaType.APPLICATION_OCTET_STREAM);// 实际文件
    return list;
}

上述结构部分将寄存器ByteArrayHttpMessageConverter用于图像/ JPEG和图像/ PNG响应的内容类型。

实现

现在，我们可以实现处理媒体请求的方法。如上所述，您需要使用*@ResponseBody批注标记控制器方法，并使用byte []*作为返回类型：

@RequestMapping(value = "/image-byte-array", method = RequestMethod.GET)
public @ResponseBody byte[] getImageAsByteArray() throws IOException {
    InputStream in = servletContext.getResourceAsStream("/WEB-INF/images/image-example.jpg");
    return IOUtils.toByteArray(in);
}

要测试该方法，请在浏览器中发出以下请求：

http://localhost:8080/spring-mvc-xml/image-byte-array.jpg

从优点上说，该方法对HttpServletResponse一无所知*，转换过程是高度可配置的，从使用可用的转换器到指定自定义转换器。响应的内容类型不必进行硬编码，而是根据请求路径后缀.jpg*进行协商。

这种方法的缺点是您需要显式实现从数据源（本地文件，外部存储等）中检索图像的逻辑，并且无法控制响应的标头或状态码。

ResponseEntity

您可以将图像以byte []的形式包装在Response Entity中返回。Spring MVC ResponseEntity不仅可以控制HTTP响应的主体，还可以控制标头和响应状态代码。按照这种方法，您需要将方法的返回类型定义为ResponseEntity <byte []>，并在方法主体中创建返回的ResponseEntity对象。

@RequestMapping(value = "/image-response-entity", method = RequestMethod.GET)
public ResponseEntity<byte[]> getImageAsResponseEntity() {
    HttpHeaders headers = new HttpHeaders();
    InputStream in = servletContext.getResourceAsStream("/WEB-INF/images/image-example.jpg");
    byte[] media = IOUtils.toByteArray(in);
    headers.setCacheControl(CacheControl.noCache().getHeaderValue());
    
    ResponseEntity<byte[]> responseEntity = new ResponseEntity<>(media, headers, HttpStatus.OK);
    return responseEntity;
}

使用ResponseEntity可使您为给定请求配置响应代码。

如果图像没有被发现（显式设置响应代码是在特殊事件例如面对尤其有用FileNotFoundException异常）或已损坏（IOException的）。在这些情况下，只需在适当的catch块中设置响应代码，例如新的ResponseEntity <>（空，标头，HttpStatus.NOT_FOUND）。

另外，如果您需要在响应中设置一些特定的标头，则该方法比通过方法接受的HttpServletResponse对象设置标头更直接。它使方法签名清晰而集中。

Resource

最后，您可以以Resource对象的形式返回图像。

该资源接口是抽象访问底层资源的接口。它是在Spring中引入的，它可以替代标准java.net.URL类。它允许轻松访问不同类型的资源（本地文件，远程文件，类路径资源），而无需编写明确检索它们的代码。

要使用此方法，应将方法的返回类型设置为Resource，并且需要使用@ResponseBody注释对方法进行注释。

实现

@ResponseBody
@RequestMapping(value = "/image-resource", method = RequestMethod.GET)
public Resource getImageAsResource() {
   return new ServletContextResource(servletContext, "/WEB-INF/images/image-example.jpg");
}

或者，如果我们想更好地控制响应头：

@RequestMapping(value = "/image-resource", method = RequestMethod.GET)
@ResponseBody
public ResponseEntity<Resource> getImageAsResource() {
    HttpHeaders headers = new HttpHeaders();
    Resource resource = 
      new ServletContextResource(servletContext, "/WEB-INF/images/image-example.jpg");
    return new ResponseEntity<>(resource, headers, HttpStatus.OK);
}