Spring MVC: Como retornar uma imagem no @ResponseBody?

142

Estou recebendo dados de imagem (as byte[]) do DB. Como retornar esta imagem em@ResponseBody ?

EDITAR

Eu fiz isso sem @ResponseBodyusar HttpServletResponsecomo parâmetro de método:

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

Usar @ResponseBodycom org.springframework.http.converter.ByteArrayHttpMessageConverterconversor registrado como o @Sid disse não funciona para mim :(.

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

Respostas:

97

se você estiver usando o Spring versão 3.1 ou mais recente, poderá especificar "produz" na @RequestMappinganotação. O exemplo abaixo funciona para mim imediatamente. Não há necessidade de conversor de registro ou qualquer outra coisa se você tiver o web mvc ativado ( @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);
}
michal.kreuzman
fonte
78

Com o Spring 4.1 e superior, você pode retornar praticamente qualquer coisa (como fotos, pdfs, documentos, jarros, zíperes etc.) de maneira simples, sem dependências extras. Por exemplo, o seguinte poderia ser um método para retornar a foto do perfil de um usuário do 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()));
}

As coisas a serem observadas:

  • ResponseEntity com InputStreamResource como um tipo de retorno

  • Criação de estilo do construtor ResponseEntity

Com esse método, você não precisa se preocupar com a fiação automática no HttpServletResponse, lançando uma IOException ou copiando dados de fluxo.

Jaymes Bearden
fonte
1
Isto lança a seguinte exceção, como você está serialização MyInputStream ?: Não foi possível conteúdo de gravação: No serializer encontrada para a classe com.mongodb.gridfs.GridFSDBFile $ MyInputStream
Nestor Ledon
Embora isso seja principalmente um exemplo do que você poderia fazer, o Mongo-Java-Driver 3.0.3 com GridFsDBFile.getInputStream () não retorna uma classe anônima chamada MyInputStream. Gostaria de verificar suas versões - talvez atualizar?
precisa saber é o seguinte
4
Eu gosto de como isso transmite o arquivo em vez de copiar tudo na memória. Veja também stackoverflow.com/questions/20333394/…
Wim Deblauwe
60

Além de registrar um ByteArrayHttpMessageConverter, você pode usar um em ResponseEntityvez de @ResponseBody. O código a seguir funciona para mim:

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

Usando o Spring 3.1.xe 3.2.x, é assim que você deve fazer:

O método do controlador:

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

E a anotação mvc no arquivo servlet-context.xml:

<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>
Peymankh
fonte
13

Além de algumas respostas, aqui estão algumas dicas (Primavera 4.1).

Caso você não tenha nenhum conversor de mensagens configurado no seu WebMvcConfig, ResponseEntityo @ResponseBodyfuncionamento interno é bom.

Se sim, ou seja, você tem um MappingJackson2HttpMessageConverter configurado (como eu) usando os ResponseEntityretornos a org.springframework.http.converter.HttpMessageNotWritableException.

A única solução de trabalho nesse caso é envolver um byte[]no@ResponseBody seguinte maneira:

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

Nesse caso, lembre-se de configurar os ByteArrayHttpMessageConvererconversores de mensagens corretamente (e adicione a ) no seu WebMvcConfig, da seguinte maneira:

@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;
}
s.ijpma
fonte
6

No contexto do seu aplicativo, declare AnnotationMethodHandlerAdapter e 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> 

também no método manipulador, defina o tipo de conteúdo apropriado para sua resposta.

Sid
fonte
@jsinghfoss consulte a resposta superior.
Peymankh #
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);



}

Trabalhou Para Mim.

Vivex
fonte
5

Eu prefiro este:

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

Altere o tipo de mídia para qualquer formato de imagem que você tenha.

Tarion
fonte
1
Boa chamada em ResourceLoader, mas a construção de um caminho de entrada externa como no seu exemplo é uma má idéia: cwe.mitre.org/data/definitions/22.html
qerub
3

É um trabalho para mim na primavera 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();
        }

}
Furetto
fonte
2

Como nenhuma das respostas funcionou para mim, consegui fazer o seguinte:

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

Definindo o Content-Dispositioncabeçalho Consegui baixar o arquivo com a @ResponseBodyanotação no meu método.

Paulius Matulionis
fonte
2

Você deve especificar o tipo de mídia na resposta. Estou usando uma anotação @GetMapping com produz = MediaType.IMAGE_JPEG_VALUE. @RequestMapping funcionará da mesma maneira.

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

Sem um tipo de mídia, é difícil adivinhar o que realmente é retornado (inclui quem lê o código, o navegador e, é claro, o próprio Spring). Um byte [] simplesmente não é específico. A única maneira de determinar o tipo de mídia de um byte [] é farejar e adivinhar.

Fornecer um tipo de mídia é apenas uma prática recomendada

coseos
fonte
Funciona para mim no Spring Boot 2.x. Obrigado por compartilhar.
attacomsian 02/09/19
1

É assim que eu faço com Spring Boot e 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() );
}
Wim Deblauwe
fonte
0

Na primavera 4, é muito fácil você não precisar fazer alterações nos feijões. Marque apenas o seu tipo de retorno como @ResponseBody.

Exemplo:-

@RequestMapping(value = "/image/{id}")
    public @ResponseBody
    byte[] showImage(@PathVariable Integer id) {
                 byte[] b;
        /* Do your logic and return 
               */
        return b;
    }
Ankit Katiyar
fonte
1
O problema que recebo com isso é que o tipo de conteúdo não está definido corretamente.
ETL
0

Eu acho que você talvez precise de um serviço para armazenar o upload de arquivos e obter esse arquivo. Verifique mais detalhes em aqui

1) Crie um serviço de armazenamento

@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) Crie o Rest Controller para fazer upload e obter arquivo

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

}

Long Nguyen
fonte