本文旨在指导开发者如何在 Spring Boot 应用中实现从 Google Cloud Storage (GCS) Bucket 下载文件的功能。内容涵盖必要的准备工作，包括配置身份验证、创建服务账号，以及设置环境变量，并提供关键代码示例，帮助你快速构建可靠的文件下载 API。
前期准备：GCP 身份验证
在 Spring Boot 应用中访问 GCP 资源，首先需要进行身份验证。GCP 提供了多种身份验证方式，其中最常用的是使用服务账号。
-
创建服务账号：
- 登录到 Google Cloud Platform 控制台 (IAM & Admin -> Service Accounts)。
- 点击 "CREATE SERVICE ACCOUNT" 创建一个新的服务账号。
- 填写服务账号名称、ID 和描述。
- 授予服务账号适当的权限。为了下载 GCS Bucket 中的文件，你需要授予该服务账号 Storage Object Viewer 或 Storage Object Admin 角色。 Storage Object Viewer 角色允许服务账号读取 Bucket 中的对象，而 Storage Object Admin 角色允许服务账号对 Bucket 中的对象进行更广泛的操作，包括读取、写入和删除。根据你的应用需求选择合适的角色。
- 完成服务账号创建。
-
下载服务账号密钥 (JSON)：
- 在创建的服务账号页面，点击 "KEYS" 标签。
- 点击 "ADD KEY" -> "Create new key"。
- 选择 JSON 格式并下载密钥文件。 这个 JSON 文件包含了服务账号的私钥，用于应用程序的身份验证。请妥善保管此文件，避免泄露。
-
设置 GOOGLE_APPLICATION_CREDENTIALS 环境变量：
在运行 Spring Boot 应用之前，需要设置 GOOGLE_APPLICATION_CREDENTIALS 环境变量，指向下载的 JSON 密钥文件的路径。
-
Linux/macOS:
export GOOGLE_APPLICATION_CREDENTIALS="/path/to/your/service-account-key.json"
-
Windows:
$env:GOOGLE_APPLICATION_CREDENTIALS="C:\path\to\your\service-account-key.json"
确保在启动 Spring Boot 应用之前设置好此环境变量。 如果没有正确设置环境变量，应用程序将无法通过 GCP 身份验证，从而无法访问 GCS Bucket 中的文件。
-
Spring Boot 代码示例
以下是一个简单的 Spring Boot 控制器示例，用于从 GCS Bucket 下载文件：
import com.google.cloud.storage.Blob;
import com.google.cloud.storage.BlobId;
import com.google.cloud.storage.Storage;
import com.google.cloud.storage.StorageOptions;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.io.ByteArrayResource;
import org.springframework.http.HttpHeaders;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;
import java.io.IOException;
@RestController
public class FileDownloadController {
@Value("${gcp.bucket.name}")
private String bucketName;
@GetMapping("/download/{fileName}")
public ResponseEntity downloadFile(@PathVariable String fileName) throws IOException {
Storage storage = StorageOptions.getDefaultInstance().getService();
BlobId blobId = BlobId.of(bucketName, fileName);
Blob blob = storage.get(blobId);
if (blob == null) {
return ResponseEntity.notFound().build();
}
byte[] content = blob.getContent();
ByteArrayResource resource = new ByteArrayResource(content);
HttpHeaders headers = new HttpHeaders();
headers.add(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + fileName + "\"");
return ResponseEntity.ok()
.headers(headers)
.contentLength(content.length)
.body(resource);
}
} 代码解释：
- @Value("${gcp.bucket.name}"): 从 application.properties 或 application.yml 文件中读取 GCS Bucket 的名称。你需要配置 gcp.bucket.name 属性。
- StorageOptions.getDefaultInstance().getService(): 使用默认的身份验证方式（即通过 GOOGLE_APPLICATION_CREDENTIALS 环境变量）创建 Storage 对象。
- BlobId.of(bucketName, fileName): 创建 BlobId 对象，用于指定要下载的文件在 GCS Bucket 中的位置。
- storage.get(blobId): 从 GCS Bucket 中获取文件内容。
- HttpHeaders: 设置响应头，包括 Content-Disposition，用于指定下载的文件名。
- ByteArrayResource: 将文件内容转换为 ByteArrayResource，以便作为响应体返回。
application.properties 示例：
gcp.bucket.name=your-bucket-name
注意事项
-
依赖： 确保你的 pom.xml 文件中包含 Google Cloud Storage 的依赖：
com.google.cloud google-cloud-storage 异常处理： 在实际应用中，需要添加适当的异常处理机制，例如处理 IOException 等异常。
安全性： 请务必妥善保管服务账号密钥，避免泄露。
权限控制： 根据实际需求，为服务账号授予最小必要的权限。
总结
通过本文的教程，你应该能够成功地在 Spring Boot 应用中实现从 GCP Bucket 下载文件的功能。 记住，正确的身份验证配置是关键，确保 GOOGLE_APPLICATION_CREDENTIALS 环境变量设置正确，并且服务账号拥有足够的权限。 此外，请根据实际情况调整代码，并添加适当的异常处理和安全措施。
