ResponseEntity方式 spring boot文件下载

本文比较了ResponseEntity<byte[]>和ResponseEntity<InputStreamResource>在Java中作为HTTP响应体的不同,讨论了应用场景和资源管理。前者适合已处理的文件下载,后者用于服务端处理后的内容返回,需注意资源关闭以防止泄漏。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

ResponseEntity<byte[]>和ResponseEntity<InputStreamResource>有以下区别:

ResponseEntity<byte[]>:表示响应体是字节数组。适用于将字节数组作为文件内容直接返回给客户端浏览器进行下载。字节数组可以直接转换为文件内容,客户端可以根据响应的Content-Type进行下载处理。

ResponseEntity<InputStreamResource>:表示响应体是输入流资源。适用于需要在服务端进行一些处理,如读取文件、加密等,然后将处理后的输入流封装为InputStreamResource对象返回给客户端。客户端可以使用输入流进行进一步处理,例如保存到本地文件或进行其他操作。

选择使用哪种返回值类型取决于你的具体需求和场景。
如果你的文件下载逻辑在服务端已经处理完毕,且可以直接将文件内容封装为字节数组返回给客户端,那么选择ResponseEntity<byte[]>更合适。
如果你需要在服务端进行一些额外的处理,然后将处理后的输入流返回给客户端,那么选择ResponseEntity<InputStreamResource>更合适。

需要注意的是,在使用ResponseEntity<InputStreamResource>时,需要注意及时关闭输入流,以避免资源泄漏。

@GetMapping("/download")
public ResponseEntity<InputStreamResource> downloadFile(@RequestParam("fileName") String fileName) throws IOException {
    MediaType mediaType = MediaTypeUtils.getMediaTypeForFileName(this.servletContext, fileName);
    System.out.println("fileName: " + fileName);
    System.out.println("mediaType: " + mediaType);
 
    File file = new File(UPLOADED_FOLDER + fileName);
    InputStreamResource resource = new InputStreamResource(new FileInputStream(file));
 
    return ResponseEntity.ok()
            .header(HttpHeaders.CONTENT_DISPOSITION, "attachment;filename=" + file.getName())
            .contentType(mediaType)
            .contentLength(file.length())
            .body(resource);
}


/*在返回ResponseEntity之前,使用try-with-resources语句块或显式地调用close()方法来关闭FileInputStream对象,以确保资源被正确释放。
例如,在try块结束后添加一个finally块,并在其中调用fileInputStream.close()来关闭输入流:
*/
try {
        fileInputStream = new FileInputStream(file);
        resource = new InputStreamResource(fileInputStream);
    } finally {
        if (fileInputStream != null) {
            fileInputStream.close();
        }
    }

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值