知識庫 / Spring / Spring MVC RSS 訂閱

1. 概述

在本教程中，我們將演示如何使用 Spring MVC 框架返回圖像和其他媒體。

我們將討論多種方法，從直接操作 HttpServletResponse開始，然後轉向受益於消息轉換、內容協商和 Spring 的 Resource抽象的方法。 我們將更詳細地研究每種方法，並討論它們的優缺點。

使用 HttpServletResponse 對象

最基本的方式是直接操作 response 對象，並模擬一個純粹的 Servlet 實現。 這種方法通過以下代碼片段進行演示：

@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

該實現相當簡單直接，得益於 IOUtils 及其來自 org.apache.commons.io 包中的功能。然而，這種方法的缺點在於它對潛在變化不夠健壯。 MIME 類型是硬編碼的，轉換邏輯的更改或外部化圖像位置都需要修改代碼。

以下部分討論了一種更靈活的方法。

3. 使用 <em>HttpMessageConverter</em>

前一節討論了一種基本方法，它沒有利用 Spring MVC 框架的消息轉換和內容協商功能。為了啓動這些功能，我們需要：

• 使用 `@ResponseBody` 註解標註控制器方法
• 根據控制器方法的返回類型註冊適當的消息轉換器（例如，使用 `ByteArrayHttpMessageConverter` 以正確地將字節數組轉換為圖像文件）

3.1. 配置

為了展示轉換器的配置，我們將使用內置的 <em >ByteArrayHttpMessageConverter</em>，該轉換器在方法返回 <em >byte[]</em> 類型時，將消息進行轉換。

<em >ByteArrayHttpMessageConverter</em> 默認已註冊，但配置方式與任何其他內置或自定義轉換器類似。

應用消息轉換器 Bean 需要在 Spring MVC 上下文中註冊適當的 <em >MessageConverter</em> Bean，並設置其應處理的媒體類型。 您可以通過 XML 中的 <em >mvc:message-converters</em> 標籤進行定義。

此標籤應定義在 <em >mvc:annotation-driven</em> 標籤內，如以下示例所示：

<mvc:annotation-driven>
    <mvc:message-converters>
        <bean class="org.springframework.http.converter.ByteArrayHttpMessageConverter">
            <property name="supportedMediaTypes">
                <list>
                    <value>image/jpeg</value>
                    <value>image/png</value>
                </list>
            </property>
        </bean>
    </mvc:message-converters>
</mvc:annotation-driven>

上述配置部分將註冊 ByteArrayHttpMessageConverter 以處理 image/jpeg 和 image/png 響應內容類型。如果 mvc 配置中未包含 <mvc:message-converters> 標籤，則將註冊默認的轉換器集。

此外，您可以使用 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;
}

3.2. 實現

現在我們可以實現該方法，用於處理媒體請求。正如上面提到的，您需要使用 @ResponseBody</em/> 標註您的控制器方法，並使用 byte[]</em/> 作為返回類型：

@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

@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;
}

@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);
}