Spring MVC How to return image in ResponseBody

Question

I m getting image data  as byte    from DB  How to return this image in  ResponseBody    EDIT  I did it without  ResponseBody using HttpServletResponse as method parameter    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         Using  ResponseBody with registered org springframework http converter ByteArrayHttpMessageConverter converter as  Sid said doesn t work for me       ResponseBody  RequestMapping   photo2   public byte   testphoto   throws IOException       InputStream in   servletContext getResourceAsStream   images no image jpg        return IOUtils toByteArray in

User · Answer

Non of the answers worked for me  so I ve managed to do it like that   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 lt  gt  fileContent  headers  HttpStatus OK     Setting Content-Disposition header I was able to download the file with the  ResponseBody annotation on my method

User · Answer

By using Spring 3 1 x and 3 2 x  this is how you should do it   The controller method    RequestMapping   photo2   public  ResponseBody byte   testphoto   throws IOException       InputStream in   servletContext getResourceAsStream   images no image jpg        return IOUtils toByteArray in       And the mvc annotation in servlet-context xml file    lt mvc annotation-driven gt       lt mvc message-converters gt           lt bean class  org springframework http converter ByteArrayHttpMessageConverter  gt               lt property name  supportedMediaTypes  gt                   lt list gt                       lt value gt image jpeg lt  value gt                       lt value gt image png lt  value gt                   lt  list gt               lt  property gt           lt  bean gt       lt  mvc message-converters gt   lt  mvc annotation-driven gt

User · Answer

In spring 4 it s very easy you don t need to make any changes in beans  Only mark your return type to  ResponseBody   Example -   RequestMapping value     image  id        public  ResponseBody     byte   showImage  PathVariable Integer id                     byte   b             Do your logic and return                            return b

User · Answer

I think you maybe need a service to store file upload and get that file  Check more detail from here  1  Create a Storage Sevice   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  Create Rest Controller to upload and get file   Controller public class UploadController     Autowired StorageService storageService   List lt String gt  files   new ArrayList lt String gt       PostMapping   post   public ResponseEntity lt String gt  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 lt List lt String gt  gt  getListFiles Model model        List lt String gt  fileNames   files              stream   map fileName - gt  MvcUriComponentsBuilder                      fromMethodName UploadController class   getFile   fileName  build   toString                 collect Collectors toList          return ResponseEntity ok   body fileNames       GetMapping   files  filename        ResponseBody public ResponseEntity lt Resource gt  getFile  PathVariable String filename        Resource file   storageService loadFile filename       return ResponseEntity ok                header HttpHeaders CONTENT DISPOSITION   attachment  filename       file getFilename                        body file

User · Answer

if you are using Spring version of 3 1 or newer you can specify  produces  in  RequestMapping annotation  Example below works for me out of box  No need of register converter or anything else if you have web mvc enabled   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

User · Answer

In your application context declare a AnnotationMethodHandlerAdapter and registerByteArrayHttpMessageConverter    lt bean class  org springframework web servlet mvc annotation AnnotationMethodHandlerAdapter  gt     lt property name  messageConverters  gt       lt util list gt         lt bean id  byteArrayMessageConverter  class  org springframework http converter ByteArrayHttpMessageConverter   gt       lt  util list gt     lt  property gt   lt  bean gt     also in the handler method set appropriate content type for your response

User · Answer

In addition to a couple of answers here a few pointers  Spring 4 1    Incase you don t have any messageconverters configured in your WebMvcConfig  having ResponseEntity inside your  ResponseBody works well   If you do  i e  you have a MappingJackson2HttpMessageConverter configured  like me  using the ResponseEntity returns a org springframework http converter HttpMessageNotWritableException   The only working solution in this case is to wrap a byte   in the  ResponseBody as follows    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      In this case do rememeber to configure the messageconverters properly  and add a ByteArrayHttpMessageConverer  in your WebMvcConfig  like so    Override public void configureMessageConverters List lt HttpMessageConverter lt   gt  gt  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 lt MediaType gt  getSupportedMediaTypes         List lt MediaType gt  list   new ArrayList lt MediaType gt         list add MediaType IMAGE JPEG       list add MediaType IMAGE PNG       list add MediaType APPLICATION OCTET STREAM       return list

User · Answer

It s work for me in Spring 4    RequestMapping value     image  id    method   RequestMethod GET  public void findImage  PathVariable  id   String id  HttpServletResponse resp            final Foto anafoto    lt find object gt          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

User · Answer

With Spring 4 1 and above  you can return pretty much anything  such as pictures  pdfs  documents  jars  zips  etc  quite simply without any extra dependencies  For example  the following could be a method to return a user s profile picture from MongoDB GridFS    RequestMapping value    user avatar  userId    method   RequestMethod GET   ResponseBody public ResponseEntity lt InputStreamResource gt  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          The things to note    ResponseEntity with InputStreamResource as a return type ResponseEntity builder style creation   With this method you dont have to worry about autowiring in the HttpServletResponse  throwing an IOException or copying stream data around

User · Answer

In addition to registering a ByteArrayHttpMessageConverter  you may want to use a ResponseEntity instead of  ResponseBody  The following code works for me     RequestMapping   photo2   public ResponseEntity lt byte   gt  testphoto   throws IOException       InputStream in   servletContext getResourceAsStream   images no image jpg         final HttpHeaders headers   new HttpHeaders        headers setContentType MediaType IMAGE PNG        return new ResponseEntity lt byte   gt  IOUtils toByteArray in   headers  HttpStatus CREATED

User · Answer

You should specify the media type in the response  I m using a  GetMapping annotation with produces   MediaType IMAGE JPEG VALUE   RequestMapping will work the same    GetMapping value   current chart  produces   MediaType IMAGE JPEG VALUE   ResponseBody public byte   getChart         return          Without a media type  it is hard to guess what is actually returned  includes anybody who reads the code  browser and of course Spring itself   A byte   is just not specific  The only way to determine the media type from a byte   is sniffing and guessing around   Providing a media type is just best practice

User · Answer

I prefere this one   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        Change the media type to what ever image format you have

User · Answer

RequestMapping value     get-image  method   RequestMethod GET  public ResponseEntity lt byte   gt  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 lt byte   gt  b  headers  HttpStatus CREATED          Worked For Me

User · Answer

This is how I do it with Spring Boot and 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

[spring-mvc] Spring MVC: How to return image in @ResponseBody?

Examples related to spring-mvc