Spring MVC:@ResponseBodyで画像を返す方法は?


142

byte[]DBから(として)画像データを取得しています。この画像を返す方法は@ResponseBody

編集

メソッドパラメータとして@ResponseBody使用せずにそれを行いましたHttpServletResponse

@RequestMapping("/photo1")
public void photo(HttpServletResponse response) throws IOException {
    response.setContentType("image/jpeg");
    InputStream in = servletContext.getResourceAsStream("/images/no_image.jpg");
    IOUtils.copy(in, response.getOutputStream());
}

@Sidが言ったように@ResponseBody登録org.springframework.http.converter.ByteArrayHttpMessageConverterされたコンバーターで使用しても、私には機能しません:(。

@ResponseBody
@RequestMapping("/photo2")
public byte[] testphoto() throws IOException {
    InputStream in = servletContext.getResourceAsStream("/images/no_image.jpg");
    return IOUtils.toByteArray(in);
}

回答:


97

Springバージョン3.1以降を使用している場合は、@RequestMappingアノテーションに「produces」を指定できます。以下の例は、そのまま使用できます。Web MVCを有効にしている場合は、レジスターコンバーターなどは必要ありません(@EnableWebMvc)。

@ResponseBody
@RequestMapping(value = "/photo2", method = RequestMethod.GET, produces = MediaType.IMAGE_JPEG_VALUE)
public byte[] testphoto() throws IOException {
    InputStream in = servletContext.getResourceAsStream("/images/no_image.jpg");
    return IOUtils.toByteArray(in);
}

78

Spring 4.1以降では、追加の依存関係がなくても、ほとんど何でも(写真、pdf、ドキュメント、jar、zipなど)返すことができます。たとえば、MongoDB GridFSからユーザーのプロフィール写真を返すメソッドは次のようになります。

@RequestMapping(value = "user/avatar/{userId}", method = RequestMethod.GET)
@ResponseBody
public ResponseEntity<InputStreamResource> downloadUserAvatarImage(@PathVariable Long userId) {
    GridFSDBFile gridFsFile = fileService.findUserAccountAvatarById(userId);

    return ResponseEntity.ok()
            .contentLength(gridFsFile.getLength())
            .contentType(MediaType.parseMediaType(gridFsFile.getContentType()))
            .body(new InputStreamResource(gridFsFile.getInputStream()));
}

注意事項:

  • 戻り値の型としてInputStreamResourceを持つResponseEntity

  • ResponseEntityビルダースタイルの作成

このメソッドを使用すると、HttpServletResponseでの自動配線、IOExceptionのスロー、またはストリームデータのコピーについて心配する必要はありません。


1
これにより次の例外がスローされます。MyInputStreamをどのようにシリアル化しますか?:コンテンツを書き込めませんでした:クラスcom.mongodb.gridfs.GridFSDBFile $ MyInputStreamのシリアライザーが見つかりません
Nestor Ledon

これは主に実行可能なことの例ですが、GridFsDBFile.getInputStream()を使用したMongo-Java-Driver 3.0.3は、MyInputStreamという匿名クラスを返しません。私はあなたのバージョンをチェックします-おそらくアップデートですか?
Jaymes Bearden 2015

4
全体をメモリにコピーするのではなく、ファイルをストリーミングする方法が好きです。stackoverflow.com/questions/20333394/…
Wim Deblauwe

60

の登録に加えてByteArrayHttpMessageConverter、のResponseEntity代わりにを使用したい場合があり@ResponseBodyます。次のコードは私のために働きます:

@RequestMapping("/photo2")
public ResponseEntity<byte[]> testphoto() throws IOException {
    InputStream in = servletContext.getResourceAsStream("/images/no_image.jpg");

    final HttpHeaders headers = new HttpHeaders();
    headers.setContentType(MediaType.IMAGE_PNG);

    return new ResponseEntity<byte[]>(IOUtils.toByteArray(in), headers, HttpStatus.CREATED);
}

16

Spring 3.1.xおよび3.2.xを使用すると、次のようになります。

コントローラメソッド:

@RequestMapping("/photo2")
public @ResponseBody byte[] testphoto() throws IOException {
    InputStream in = servletContext.getResourceAsStream("/images/no_image.jpg");
    return IOUtils.toByteArray(in);
}

そして、servlet-context.xmlファイルのmvcアノテーション:

<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>

13

ここでいくつかの回答に加えて、いくつかのポインタ(Spring 4.1)があります。

WebMvcConfigでメッセージコンバーターが構成されていない場合は、ResponseEntity内部が適切に@ResponseBody機能しています。

そうした場合、つまり、MappingJackson2HttpMessageConverter(私と同じように)構成済みの場合、を使用してResponseEntity戻りますorg.springframework.http.converter.HttpMessageNotWritableException

この場合の唯一の有効な解決策byte[]@ResponseBody、次のようにをラップすることです。

@RequestMapping(value = "/get/image/{id}", method=RequestMethod.GET, produces = MediaType.IMAGE_PNG_VALUE)
public @ResponseBody byte[] showImageOnId(@PathVariable("id") String id) {
    byte[] b = whatEverMethodUsedToObtainBytes(id);
    return b;
}

この場合、次のようにWebMvcConfigでメッセージコンバーターを適切に構成する(そしてを追加するByteArrayHttpMessageConverer)ように注意してください。

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

@Bean
public MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter() {
    ObjectMapper objectMapper = new ObjectMapper();
    objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
    objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
    MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
    converter.setObjectMapper(objectMapper);
    return converter;
}

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

6

アプリケーションコンテキストで、AnnotationMethodHandlerAdapterとregisterByteArrayHttpMessageConverterを宣言します。

<bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
  <property name="messageConverters">
    <util:list>
      <bean id="byteArrayMessageConverter" class="org.springframework.http.converter.ByteArrayHttpMessageConverter"/>
    </util:list>
  </property>
</bean> 

また、ハンドラメソッドで、応答に適切なコンテンツタイプを設定します。


@jsinghfossが上位の回答を参照しています。
Peymankh 2012年

6
 @RequestMapping(value = "/get-image",method = RequestMethod.GET)
public ResponseEntity<byte[]> getImage() throws IOException {
    RandomAccessFile f = new RandomAccessFile("/home/vivex/apache-tomcat-7.0.59/tmpFiles/1.jpg", "r");
    byte[] b = new byte[(int)f.length()];
    f.readFully(b);
    final HttpHeaders headers = new HttpHeaders();
    headers.setContentType(MediaType.IMAGE_PNG);


    return new ResponseEntity<byte[]>(b, headers, HttpStatus.CREATED);



}

私のために働いた。


5

私はこれを好む:

private ResourceLoader resourceLoader = new DefaultResourceLoader();

@ResponseBody
@RequestMapping(value = "/{id}",  produces = "image/bmp")
public Resource texture(@PathVariable("id") String id) {
    return resourceLoader.getResource("classpath:images/" + id + ".bmp");
}

メディアタイプを、使用している画像フォーマットに変更します。


1
良い呼び出しですがResourceLoader、例のように外部入力からパス名を作成するのは悪い考えです:cwe.mitre.org/data/definitions/22.html
qerub

3

それは春4の私のための仕事です。

@RequestMapping(value = "/image/{id}", method = RequestMethod.GET)
public void findImage(@PathVariable("id") String id, HttpServletResponse resp){

        final Foto anafoto = <find object>
        resp.reset();
        resp.setContentType(MediaType.IMAGE_JPEG_VALUE);
        resp.setContentLength(anafoto.getImage().length);

        final BufferedInputStream in = new BufferedInputStream(new ByteArrayInputStream(anafoto.getImageInBytes()));

        try {
            FileCopyUtils.copy(in, resp.getOutputStream());
            resp.flushBuffer();
        } catch (final IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }

}

2

どの答えも私にとってはうまくいかなかったので、私はそれをなんとかすることができました:

HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.parseMediaType("your content type here"));
headers.set("Content-Disposition", "attachment; filename=fileName.jpg");
headers.setContentLength(fileContent.length);
return new ResponseEntity<>(fileContent, headers, HttpStatus.OK);

Content-Dispositionヘッダーを設定する@ResponseBodyメソッドに注釈が付いたファイルをダウンロードできました。


2

応答でメディアタイプを指定する必要があります。@GetMappingアノテーションをプロデュース= MediaType.IMAGE_JPEG_VALUEで使用しています。@RequestMappingは同じように機能します。

@GetMapping(value="/current/chart",produces = MediaType.IMAGE_JPEG_VALUE)
@ResponseBody
public byte[] getChart() {
    return ...;
}

メディアタイプがないと、実際に何が返されるのかを推測するのは困難です(コード、ブラウザー、そしてもちろんSpring自体を読み取る人を含みます)。byte []は特定ではありません。byte []からメディアタイプを判別する唯一の方法は、傍受して推測することです。

メディアタイプを提供することはベストプラクティスです


Spring Boot 2.xで動作します。共有していただきありがとうございます。
attacomsian

1

これは私がSpring BootとGuavaでそれをする方法です:

@RequestMapping(value = "/getimage", method = RequestMethod.GET, produces = MediaType.IMAGE_JPEG_VALUE)
public void getImage( HttpServletResponse response ) throws IOException
{
    ByteStreams.copy( getClass().getResourceAsStream( "/preview-image.jpg" ), response.getOutputStream() );
}

0

春4では、Beanを変更する必要がないのは非常に簡単です。戻り値の型を@ResponseBodyにマークするだけです。

例:-

@RequestMapping(value = "/image/{id}")
    public @ResponseBody
    byte[] showImage(@PathVariable Integer id) {
                 byte[] b;
        /* Do your logic and return 
               */
        return b;
    }

1
これで発生する問題は、コンテンツタイプが正しく設定されていないことです。
ETL

0

ファイルのアップロードを保存してそのファイルを取得するサービスが必要になると思います。詳しくはこちらから

1)ストレージサービスを作成する

@Service
public class StorageService {

Logger log = LoggerFactory.getLogger(this.getClass().getName());
private final Path rootLocation = Paths.get("upload-dir");

public void store(MultipartFile file) {
    try {
        Files.copy(file.getInputStream(), this.rootLocation.resolve(file.getOriginalFilename()));
    } catch (Exception e) {
        throw new RuntimeException("FAIL!");
    }
}

public Resource loadFile(String filename) {
    try {
        Path file = rootLocation.resolve(filename);
        Resource resource = new UrlResource(file.toUri());
        if (resource.exists() || resource.isReadable()) {
            return resource;
        } else {
            throw new RuntimeException("FAIL!");
        }
    } catch (MalformedURLException e) {
        throw new RuntimeException("FAIL!");
    }
}

public void deleteAll() {
    FileSystemUtils.deleteRecursively(rootLocation.toFile());
}

public void init() {
    try {
        Files.createDirectory(rootLocation);
    } catch (IOException e) {
        throw new RuntimeException("Could not initialize storage!");
    }
}
}

2)アップロードしてファイルを取得するRest Controllerを作成します

@Controller
public class UploadController {

@Autowired
StorageService storageService;

List<String> files = new ArrayList<String>();

@PostMapping("/post")
public ResponseEntity<String> handleFileUpload(@RequestParam("file") MultipartFile file) {
    String message = "";
    try {
        storageService.store(file);
        files.add(file.getOriginalFilename());

        message = "You successfully uploaded " + file.getOriginalFilename() + "!";
        return ResponseEntity.status(HttpStatus.OK).body(message);
    } catch (Exception e) {
        message = "FAIL to upload " + file.getOriginalFilename() + "!";
        return      ResponseEntity.status(HttpStatus.EXPECTATION_FAILED).body(message);
    }
}

@GetMapping("/getallfiles")
public ResponseEntity<List<String>> getListFiles(Model model) {
    List<String> fileNames = files
            .stream().map(fileName -> MvcUriComponentsBuilder
                    .fromMethodName(UploadController.class, "getFile", fileName).build().toString())
            .collect(Collectors.toList());

    return ResponseEntity.ok().body(fileNames);
}

@GetMapping("/files/{filename:.+}")
@ResponseBody
public ResponseEntity<Resource> getFile(@PathVariable String filename) {
    Resource file = storageService.loadFile(filename);
    return ResponseEntity.ok()
            .header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + file.getFilename() + "\"")
            .body(file);
}

}

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.