Spring MVC: จะส่งคืนรูปภาพใน @ResponseBody ได้อย่างไร

ฉันได้รับข้อมูลภาพ (ตามbyte[]) จากฐานข้อมูล จะคืนรูปภาพนี้ได้@ResponseBodyอย่างไร?

แก้ไข

ฉันทำได้โดยไม่@ResponseBodyใช้HttpServletResponseพารามิเตอร์ method:

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

การใช้งาน@ResponseBodyร่วมกับorg.springframework.http.converter.ByteArrayHttpMessageConverterตัวแปลงที่ลงทะเบียนเป็น @Sid กล่าวว่าใช้งานไม่ได้สำหรับฉัน :(

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

หากคุณกำลังใช้รุ่น Spring 3.1 หรือใหม่กว่าคุณสามารถระบุ "ผลิต" ใน@RequestMappingคำอธิบายประกอบ ตัวอย่างด้านล่างใช้ได้กับฉันนอกกรอบ ไม่จำเป็นต้องมี register converter หรืออะไรอย่างอื่นถ้าคุณเปิดใช้งาน 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);
}

ด้วย Spring 4.1 ขึ้นไปคุณสามารถส่งคืนอะไรได้มาก (เช่นรูปภาพ, PDF, เอกสาร, ไห, zips และอื่น ๆ ) โดยไม่ต้องพึ่งพาอะไรเพิ่มเติม ตัวอย่างเช่นต่อไปนี้อาจเป็นวิธีการส่งคืนรูปโปรไฟล์ของผู้ใช้จาก 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()));
}

สิ่งที่ควรทราบ:

• ResponseEntity ด้วย InputStreamResource เป็นชนิดส่งคืน

• การสร้างสไตล์ตัวสร้าง ResponseEntity

ด้วยวิธีนี้คุณไม่ต้องกังวลเกี่ยวกับการลงทะเบียนอัตโนมัติใน HttpServletResponse ขว้าง IOException หรือคัดลอกข้อมูลสตรีมรอบ ๆ

นอกจากนี้ในการลงทะเบียน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);
}

โดยใช้ 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);
}

และหมายเหตุประกอบ mvc ในไฟล์ 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>

นอกเหนือจากคำตอบสองสามข้อที่นี่แล้วยังมีตัวชี้สองสามตัว (Spring 4.1)

ในกรณีที่คุณไม่มีตัวแปลงข้อความที่กำหนดค่าไว้ใน WebMvcConfig ResponseEntityของคุณ@ResponseBodyทำงานได้ดี

ถ้าคุณทำเช่นคุณมีMappingJackson2HttpMessageConverterการกำหนดค่า (เช่นฉัน) โดยใช้ผลตอบแทนResponseEntityorg.springframework.http.converter.HttpMessageNotWritableException

วิธีแก้ปัญหาการทำงานเพียงอย่างเดียวในกรณีนี้คือการตัด a 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;
}

ในกรณีนี้ให้ rememeber กำหนดค่า messageconverters อย่างถูกต้อง (และเพิ่ม a ByteArrayHttpMessageConverer) ใน WebMvcConfig ของคุณเช่น:

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

ในบริบทแอปพลิเคชันของคุณจะประกาศ 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> 

นอกจากนี้ในวิธีการจัดการตั้งประเภทเนื้อหาที่เหมาะสมสำหรับการตอบสนองของคุณ

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



}

ทำงานให้ฉัน

ฉันลองดูอันนี้ก่อน:

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

เปลี่ยนประเภทสื่อเป็นรูปแบบภาพที่คุณเคยมี

มันใช้ได้กับฉันใน Spring 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();
        }

}

ไม่ใช่คำตอบที่เหมาะกับฉันดังนั้นฉันจึงพยายามทำเช่นนั้น:

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คำอธิบายประกอบบนวิธีการของฉัน

คุณควรระบุประเภทสื่อในการตอบกลับ ฉันกำลังใช้คำอธิบายประกอบแบบ @GetMapping กับผลิตผล = MediaType.IMAGE_JPEG_VALUE @RequestMapping จะทำงานเหมือนเดิม

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

หากไม่มีประเภทสื่อก็ยากที่จะคาดเดาสิ่งที่ส่งคืนจริง (รวมถึงใครก็ตามที่อ่านโค้ด ไบต์ [] ไม่เฉพาะเจาะจง วิธีเดียวที่จะระบุประเภทสื่อจาก byte [] คือการดมกลิ่นและคาดเดา

การให้ประเภทสื่อเป็นวิธีปฏิบัติที่ดีที่สุด

นี่คือวิธีที่ฉันทำกับ 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() );
}

ในฤดูใบไม้ผลิ 4 เป็นเรื่องง่ายมากที่คุณไม่จำเป็นต้องทำการเปลี่ยนแปลงใด ๆ ในถั่ว ทำเครื่องหมายประเภทที่ส่งคืนของคุณเป็น @ResponseBody เท่านั้น

ตัวอย่าง:-

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

ฉันคิดว่าคุณอาจต้องใช้บริการในการจัดเก็บการอัปโหลดไฟล์และรับไฟล์นั้น ตรวจสอบรายละเอียดเพิ่มเติมได้จากที่นี่

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

}