Spring MVC: How to return an image from controller?

Question

I'm trying to return an image like this.

 @RequestMapping(value = "admin/image/{userId}")
public ResponseEntity<byte[]> getPhoto(@PathVariable int userId) throws IOException {
    UserDB userDB = UserDBService.getUserWithId(userId);
    if (userDB != null) {
        try {
            byte[] image;
            try {
                String path = ApplicationPropertiesConstants.SAFESITE_DOCUMENTS_DIRECTORY + userDB.getSite().getId() + "\\342.png";
                InputStream is = new FileInputStream(path);
                BufferedImage img = ImageIO.read(is);
                ByteArrayOutputStream bos = new ByteArrayOutputStream();
                ImageIO.write(img, "png", bos);
                final HttpHeaders headers = new HttpHeaders();
                headers.setContentType(MediaType.IMAGE_PNG);

                return new ResponseEntity<byte[]>(IOUtils.toByteArray(is), headers, HttpStatus.CREATED);
            } catch (FileNotFoundException e) {
                image = org.apache.commons.io.FileUtils.readFileToByteArray(new File("dfd"));
            }

            return null;
        } catch (IOException ignored) {
        }
    }
    return null;
}

Although when I access the url the image doesn't display.

Any idea why this is happening? Do I need to use Apache Tiles? Currently I'm using jstlView.

<bean id="viewResolver" class="org.springframework.web.servlet.view.UrlBasedViewResolver">
    <property name="viewClass" value="org.springframework.web.servlet.view.JstlView" />
    <property name="prefix" value="/WEB-INF/jsp/" />
    <property name="suffix" value=".jsp" />
</bean>

If you have an `InputStream` anyway you can return a `ResponseEntity` with the body being `new InputStreamResource(inputStream)`. — a better oliver, Nov 26 '15 at 12:50
If you use `byte[]` you should set the content length header. The correct status is `HttpStatus.OK` btw. — a better oliver, Nov 26 '15 at 13:00
I'm not sure what you mean by the body being new InputStreamResource(inputStream) — OneTwo, Nov 26 '15 at 13:02
`new ResponseEntity<>(new InputStreamResource(is), headers, HttpStatus.OK);` — a better oliver, Nov 26 '15 at 13:03

score 4 · Accepted Answer · answered Nov 26 '15 at 12:52

4

Get your image file and write it to the response.

@RequestMapping(value = "/getImage", method = RequestMethod.GET)
  public void showImage(HttpServletResponse response) throws Exception {

    ByteArrayOutputStream jpegOutputStream = new ByteArrayOutputStream();

    try {
      BufferedImage image = //CALL_OR_CREATE_YOUR_IMAGE_OBJECT;
      ImageIO.write(image, "jpeg", jpegOutputStream);
    } catch (IllegalArgumentException e) {
      response.sendError(HttpServletResponse.SC_NOT_FOUND);
    }

    byte[] imgByte = jpegOutputStream.toByteArray();

    response.setHeader("Cache-Control", "no-store");
    response.setHeader("Pragma", "no-cache");
    response.setDateHeader("Expires", 0);
    response.setContentType("image/jpeg");
    ServletOutputStream responseOutputStream = response.getOutputStream();
    responseOutputStream.write(imgByte);
    responseOutputStream.flush();
    responseOutputStream.close();
  }

answered Nov 26 '15 at 12:52

javasenior

1,786
2
22
26

Ok this worked thanks. If I know wanted to do the same but would return a file of any type (as a download link), how would I go about doing this? – OneTwo Nov 26 '15 at 13:13
For return any file like image, pdf or download link you must set headers. Eg: download link String mimeType = "application/octet-stream"; response.setContentType(mimeType); response.setHeader("Content-Disposition", String.format("inline; filename=\"" + file.getName() +"\"")); – javasenior Nov 26 '15 at 13:17
Pdf link response.setContentType("application/pdf"); response.setHeader("content-disposition", "inline;filename=" + "form.pdf"); – javasenior Nov 26 '15 at 13:23

score 2 · Answer 2 · answered Nov 26 '15 at 12:42

2

It doesn't work this way, you need something like

@RequestMapping(...)
void getImage(...) {
  response.setContentType(mimeType);
  response.setHeader("Content-Disposition", String.format("inline; filename=\"" + file.getName() +"\""));
  response.setContentLength((int)file.length());
  InputStream inputStream = new BufferedInputStream(new FileInputStream(file));
  FileCopyUtils.copy(inputStream, response.getOutputStream());
}

answered Nov 26 '15 at 12:42

Jaiwo99

9,687
3
36
53

People have definitely done it my way (returning a byte array) http://www.jadebaboon.com/wp/return-image-as-responsebody/ – OneTwo Nov 26 '15 at 12:45
Or see here http://stackoverflow.com/questions/5690228/spring-mvc-how-to-return-image-in-responsebody – OneTwo Nov 26 '15 at 12:47
1

@OneTwo sure, i see your problem, you should use `return new ResponseEntity(bos.toByteArray(), headers, HttpStatus.CREATED);` – Jaiwo99 Nov 26 '15 at 13:11

score 0 · Answer 3 · answered Sep 15 '17 at 03:44

0

}

response.setContentType("text/plain");
response.setHeader("Content-Disposition", "attachment;filename=EDC-"+ title + ".txt");
ServletOutputStream out = response.getOutputStream();
out.print(myString.trim());
out.flush();
out.close();

answered Sep 15 '17 at 03:44

user8612465

1

Please add some details and explanation so it can help others – Souvik Ghosh Sep 15 '17 at 04:10

Spring MVC: How to return an image from controller?

3 Answers3