接口返回文件流用什么对象接收 java

原创

mob64ca12ed7b35 2024-12-11 07:52:59 ©著作权

©著作权归作者所有：来自51CTO博客作者mob64ca12ed7b35的原创作品，请联系作者获取转载授权，否则将追究法律责任

Java 接口返回文件流的实现

在工作中，我们常常需要通过接口获取文件流。本文将教会你如何在 Java 中实现这一过程。我们将逐步讲解该如何操作，并提供代码示例。

整体流程

在开始之前，我们需要先了解整个流程。以下是一个简单的流程图，展示了从请求接口到接收文件流的步骤：

erDiagram
    A[用户请求] -->|发送HTTP请求| B[接口返回文件流]
    B -->|接收文件流| C[处理文件流]

步骤	动作描述
1	用户发起 HTTP 请求
2	服务器接口处理请求并返回文件流
3	客户端接收文件流
4	处理接收到的文件流

实现步骤

1. 创建接口并实现文件流返回

首先，我们需要创建一个接口，它将会返回文件流。这里使用 @GetMapping 注解代表我们将使用 GET 请求来获取文件流。

@RestController
@RequestMapping("/api/files")
public class FileController {

    @GetMapping("/download")
    public ResponseEntity<Resource> downloadFile() {
        // 这里是我们要返回的文件路径
        Path filePath = Paths.get("path/to/your/file.txt");
        
        // 创建一个输入流对象
        InputStreamResource resource = new InputStreamResource(new FileInputStream(filePath.toFile()));
        
        // 设置响应头，表明返回的是下载文件
        return ResponseEntity.ok()
                .header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + filePath.getFileName() + "\"")
                .contentType(MediaType.APPLICATION_OCTET_STREAM)
                .contentLength(filePath.toFile().length())
                .body(resource);
    }
}

2. 发送HTTP请求以获取文件流

我们需要创建一个客户端来发送 HTTP 请求并接收文件流。在这里我们使用 RestTemplate。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.io.InputStreamResource;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Service;
import org.springframework.web.client.RestTemplate;

import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;

@Service
public class FileService {

    @Autowired
    private RestTemplate restTemplate;

    public void downloadFile() {
        String url = "http://localhost:8080/api/files/download"; // 你的接口URL
        ResponseEntity<InputStreamResource> response = restTemplate.getForEntity(url, InputStreamResource.class);

        try (InputStream inputStream = response.getBody().getInputStream();
             OutputStream outputStream = new FileOutputStream("downloaded_file.txt")) { // 输出到本地文件
             
            byte[] buffer = new byte[1024]; // 创建一个缓冲区
            int bytesRead;
            // 循环读取数据
            while ((bytesRead = inputStream.read(buffer)) != -1) {
                outputStream.write(buffer, 0, bytesRead); // 写入数据
            }
            System.out.println("文件下载成功!");
        } catch (Exception e) {
            e.printStackTrace(); // 打印异常
        }
    }
}