Spring中如何通过HTTP接口返回tar.gz格式文件

根因说明 #

• 当前你注释了gzip压缩逻辑，返回的是未压缩的.tar文件，并非目标.tar.gz格式
• 未配置正确的响应头参数，调用端无法识别正确的文件名和格式

代码修改步骤 #

1. 调整接口定义 #

修改接口的produces配置，增加多格式兼容，同时调整相关注解描述：

//GET: Endpoint for OPA to retrieve on the fly gzipped tarball for Bundles
@ApiOperation(value = "获取实时生成的gzip压缩tar格式bundle包", nickname = "getBundle", notes="", response = Resource.class)
@ApiResponses(value = {
    @ApiResponse(code = 200, message = "Bundle.tar.gz请求处理成功", response = Resource.class),
    @ApiResponse(code = 404, message = "未找到请求的Bundle.tar.gz")
})
@GetMapping(value = "/policyadmin/bundle", produces = {"application/gzip", "application/x-gzip", "application/tar+gzip"})
ResponseEntity<?> getBundle();

2. 修改接口实现逻辑 #

放开gzip压缩逻辑，新增响应头配置，指定返回文件名为.tar.gz后缀：

public ResponseEntity<?> getBundle(){
    BundleService bundleService = new BundleService();
    List<File> fileList = new ArrayList<>();

    List<String> implementationIds = policyService.getImplementationIdListForBundle(EnvironmentType.DEV, PlatformEngineType.REGO);
    List<PolicyImplementation> implementationList = policyService.getImplementationsForBundle(implementationIds);
    fileList = bundleService.createImplementationFiles(implementationList);
    
    // 生成tar文件
    bundleService.createTarBall(fileList);
    File tarball = new File("./policyadmin/bundleDirectory/bundle.tar");
    // 放开gzip压缩逻辑，生成tar.gz文件
    File gzippedTarball = bundleService.gzipTarBall();
    
    // 校验gzip文件是否存在且可读
    if (!gzippedTarball.exists() || !gzippedTarball.canRead()) {
        return new ResponseEntity<>(HttpStatus.NOT_FOUND);
    }
    
    Resource tarGzResource = new FileSystemResource(gzippedTarball);
    
    // 配置响应头
    HttpHeaders headers = new HttpHeaders();
    // 指定文件名，确保调用端拿到的是.tar.gz后缀
    headers.add(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"bundle.tar.gz\"");
    headers.add(HttpHeaders.CONTENT_LENGTH, String.valueOf(gzippedTarball.length()));

    // 用完可删除临时文件，避免磁盘占用
    // bundleService.deleteTarball(tarball);
    // bundleService.deleteGzFile(gzippedTarball);
    
    // 返回gzip后的资源
    return new ResponseEntity<>(tarGzResource, headers, HttpStatus.OK);
}

其他优化建议 #

• 临时文件使用后及时删除，避免磁盘空间占用
• 若bundle包体积较小，可直接将压缩流写入响应输出流，无需落盘生成本地文件，性能更高
• 可增加tar.gz文件完整性校验逻辑，确认文件生成正常后再返回给调用方

内容的提问来源于stack exchange，提问作者Ronan Byrne