喵喵爱编程

这个屌丝很懒，什么也没留下！

热门标签

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

作者：喵喵爱编程 | 2024-07-17 23:19:40

踩

responseentity展示图片

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门，即可获取！

该方法的缺点是它对潜在更改的鲁棒性不强。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 getSupportedMediaTypes() {

List list = new ArrayList();

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_注释对方法进行注释。