Spring Boot如何在GET响应中同时返回字符串与ZIP文件

嘿，咱们来解决这个问题！HTTP协议里一个响应只能有一个主体内容，所以没法直接把字符串和ZIP文件同时塞进ResponseEntity的body里，但我们有几个靠谱的解决方案，看看哪个适合你的场景：

这种方式最简单，适合字符串内容比较短的场景（比如操作结果提示、状态信息）。后端在返回ZIP文件的同时，添加一个自定义响应头来携带字符串信息。

后端代码示例：

@GetMapping("/export-with-message")
public ResponseEntity<Resource> exportWithMessage() throws IOException {
    // 假设你已经获取到要返回的ZIP文件资源
    Resource zipFile = new FileSystemResource(new File("path/to/your/target.zip"));
    
    // 需要返回的字符串信息
    String responseMsg = "SQL查询执行完成，共导出50条数据";
    
    return ResponseEntity.ok()
            // 设置文件下载的Content-Disposition头
            .header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + zipFile.getFilename() + "\"")
            // 添加自定义头携带字符串，注意编码避免特殊字符问题
            .header("X-Export-Message", URLEncoder.encode(responseMsg, StandardCharsets.UTF_8.toString()))
            .body(zipFile);
}

小贴士：因为HTTP响应头不能直接包含中文或特殊字符，所以要用URLEncoder.encode编码，前端拿到后再解码。

Angular 4前端处理示例：

this.http.get('/your-api-path/export-with-message', { 
  responseType: 'blob', 
  observe: 'response' // 要获取完整响应（包括头信息）
})
.subscribe(response => {
  // 从响应头取出字符串并解码
  const encodedMsg = response.headers.get('X-Export-Message');
  const message = decodeURIComponent(encodedMsg);
  console.log('后端返回的信息：', message);
  
  // 处理ZIP文件下载逻辑
  const blob = new Blob([response.body], { type: 'application/zip' });
  const downloadUrl = window.URL.createObjectURL(blob);
  const link = document.createElement('a');
  link.href = downloadUrl;
  link.download = 'export-data.zip'; // 或者从响应头获取文件名
  document.body.appendChild(link);
  link.click();
  // 清理资源
  window.URL.revokeObjectURL(downloadUrl);
  document.body.removeChild(link);
});

如果你的字符串需要和ZIP里的内容一起被用户保存（比如查询参数说明、导出统计），可以把字符串写入一个文本文件，然后和原内容一起打包成新的ZIP返回。

后端代码示例：

@GetMapping("/export-zip-with-info")
public ResponseEntity<Resource> exportZipWithInfo() throws IOException {
    // 创建临时目录存放要打包的文件
    Path tempDir = Files.createTempDirectory("export-temp");
    
    // 1. 创建包含字符串信息的文本文件
    String infoContent = "SQL查询语句：SELECT * FROM user WHERE status = 1\n导出时间：2024-05-20\n共导出50条数据";
    Path infoFile = tempDir.resolve("export-info.txt");
    Files.write(infoFile, infoContent.getBytes(StandardCharsets.UTF_8));
    
    // 2. 把原ZIP文件复制到临时目录（假设原ZIP路径是original.zip）
    Path originalZip = Paths.get("path/to/original.zip");
    Files.copy(originalZip, tempDir.resolve(originalZip.getFileName()));
    
    // 3. 打包临时目录下的所有文件
    ByteArrayOutputStream baos = new ByteArrayOutputStream();
    try (ZipOutputStream zos = new ZipOutputStream(baos)) {
        Files.walk(tempDir)
             .filter(path -> !Files.isDirectory(path))
             .forEach(path -> {
                 ZipEntry entry = new ZipEntry(tempDir.relativize(path).toString());
                 try {
                     zos.putNextEntry(entry);
                     Files.copy(path, zos);
                     zos.closeEntry();
                 } catch (IOException e) {
                     e.printStackTrace();
                 }
             });
    }
    
    // 转换为Resource对象
    ByteArrayResource zipResource = new ByteArrayResource(baos.toByteArray());
    
    // 清理临时目录
    FileUtils.deleteDirectory(tempDir.toFile());
    
    return ResponseEntity.ok()
            .header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"export-with-info.zip\"")
            .contentType(MediaType.APPLICATION_OCTET_STREAM)
            .body(zipResource);
}

用户下载ZIP后，解压就能看到包含信息的export-info.txt，同时还有原来的文件内容，体验很直观。

如果你的ZIP文件体积很小，可以把它转换成Base64编码，和字符串一起封装成JSON返回。但要注意：Base64会让文件体积增大约30%，大文件用这种方式会严重影响性能，所以只适合小文件场景。

后端代码示例：

@GetMapping("/export-as-json")
public ResponseEntity<Map<String, Object>> exportAsJson() throws IOException {
    Resource zipFile = new FileSystemResource(new File("path/to/small-file.zip"));
    byte[] fileBytes = Files.readAllBytes(zipFile.getFile().toPath());
    String base64Zip = Base64.getEncoder().encodeToString(fileBytes);
    
    String message = "导出成功，文件已生成";
    Map<String, Object> response = new HashMap<>();
    response.put("message", message);
    response.put("zipBase64", base64Zip);
    
    return ResponseEntity.ok(response);
}

Angular 4前端处理示例：

this.http.get('/your-api-path/export-as-json')
.subscribe(response => {
  console.log('后端提示：', response.message);
  
  // 解码Base64并生成ZIP文件
  const byteChars = atob(response.zipBase64);
  const byteNumbers = new Array(byteChars.length);
  for (let i = 0; i < byteChars.length; i++) {
    byteNumbers[i] = byteChars.charCodeAt(i);
  }
  const byteArray = new Uint8Array(byteNumbers);
  const blob = new Blob([byteArray], { type: 'application/zip' });
  
  // 后续下载逻辑和方案1一致
});

一般来说，方案1和方案2是最常用的，优先根据你的业务需求选择——如果只是简单的状态提示，用方案1；如果需要用户留存字符串信息，用方案2就很合适。

内容的提问来源于stack exchange，提问作者Logan Wlv