如何在Nestjs中实现文件上传至Google Cloud Storage
NestJS 接入 Google Cloud Storage 实现文件上传完整指南
一、实现Google Cloud与Nestjs服务端的连接
前置依赖安装
执行以下命令安装所需依赖:
- GCS官方SDK:
npm install @google-cloud/storage - Nest文件上传处理依赖:
npm install @nestjs/platform-express multer - TypeScript类型定义(可选):
npm install -D @types/multer @types/node
身份与客户端配置
- 先在Google Cloud控制台创建对应项目的服务账号,下载JSON格式的密钥文件,放置到项目根目录,务必将密钥文件路径加入
.gitignore避免提交到代码仓库 - 在项目
.env文件中添加以下配置参数:GCP_PROJECT_ID=你的Google Cloud项目ID GCS_KEY_FILE_PATH=./你的服务账号密钥文件名.json GCS_BUCKET_NAME=你提前创建的GCS存储桶名称 - 确保在根模块导入全局配置模块:
// app.module.ts import { Module } from '@nestjs/common'; import { ConfigModule } from '@nestjs/config'; @Module({ imports: [ConfigModule.forRoot({ isGlobal: true })], }) export class AppModule {} - 创建可注入的GCS客户端实例,统一管理连接:
// gcs.provider.ts import { Storage } from '@google-cloud/storage'; import { ConfigService } from '@nestjs/config'; export const GCS_PROVIDER = 'GCS_STORAGE'; export const gcsProvider = { provide: GCS_PROVIDER, useFactory: (configService: ConfigService) => { return new Storage({ projectId: configService.get('GCP_PROJECT_ID'), keyFilename: configService.get('GCS_KEY_FILE_PATH'), }); }, inject: [ConfigService], }; - 封装GCS模块供业务模块引用:
// gcs.module.ts import { Module } from '@nestjs/common'; import { gcsProvider } from './gcs.provider'; @Module({ providers: [gcsProvider], exports: [gcsProvider], }) export class GcsModule {}
完成以上步骤后,Nest服务启动时会自动初始化GCS客户端,完成与Google Cloud服务的连接。
二、实现客户端文件上传至Google Cloud
编写上传接口逻辑
在业务模块中导入GcsModule后,直接在控制器中注入GCS客户端实现上传能力:
// upload.controller.ts import { Controller, Post, UseInterceptors, UploadedFile, Inject } from '@nestjs/common'; import { FileInterceptor } from '@nestjs/platform-express'; import { ConfigService } from '@nestjs/config'; import { GCS_PROVIDER } from './gcs.provider'; import { Storage } from '@google-cloud/storage'; @Controller('upload') export class UploadController { private readonly gcsBucket: string; constructor( @Inject(GCS_PROVIDER) private readonly gcsStorage: Storage, private readonly configService: ConfigService ) { this.gcsBucket = this.configService.get('GCS_BUCKET_NAME'); } @Post() @UseInterceptors(FileInterceptor('file')) async uploadFile(@UploadedFile() file: Express.Multer.File) { // 生成唯一文件名避免覆盖原有文件 const fileName = `${Date.now()}-${file.originalname.replace(/\s+/g, '-')}`; const bucket = this.gcsStorage.bucket(this.gcsBucket); const gcsFile = bucket.file(fileName); // 上传文件缓冲区到GCS await gcsFile.save(file.buffer, { contentType: file.mimetype, // 可选配置:开启文件公开访问权限,不需要公开可删除该参数 public: true, }); // 返回文件访问信息 return { fileName, mimeType: file.mimetype, size: file.size, // 公开文件直接返回访问链接,私有文件可生成签名URL返回 url: `https://storage.googleapis.com/${this.gcsBucket}/${fileName}` }; } }
补充说明
注意:生产环境如果部署在Google Cloud生态内(如GCE、Cloud Run、GKE等),不需要手动配置服务账号密钥,平台会自动注入身份凭证,直接删除
keyFilename参数即可。
超过10MB的大文件建议使用流式上传替代缓冲区上传,调用GCS SDK的createWriteStream方法实现,避免服务端内存溢出。
内容的提问来源于stack exchange,提问作者alice
相关产品推荐
相关产品推荐

