Supabase Storage 云存储服务完全指南

Supabase Storage 云存储服务完全指南

【免费下载链接】storageS3 compatible object storage service that stores metadata in Postgres项目地址: https://gitcode.com/gh_mirrors/st/storage

项目概述

Supabase Storage 是一个开源的可扩展、轻量级对象存储服务，专为现代应用开发设计。该项目采用多协议支持架构，将元数据存储在PostgreSQL数据库中，同时支持与S3兼容存储服务集成。

核心特性

• 多协议支持：兼容HTTP/REST、TUS可恢复上传、S3 API和Iceberg REST Catalog
• 元数据管理：使用PostgreSQL作为元数据存储后端
• 权限控制：基于PostgreSQL行级安全策略实现授权规则
• 高性能设计：极致的轻量级和高性能架构

系统架构解析

Supabase Storage 采用分层架构设计，确保系统的可扩展性和可靠性：

该架构分为三个主要层次：

前端层：包含用户仪表盘和客户端库，提供友好的用户界面和开发者工具。

中间件层：由Kong API网关和Storage API服务器组成，负责请求路由、认证鉴权和业务逻辑处理。

后端存储层：支持多种S3兼容存储服务，如AWS S3和Backblaze B2，实现数据持久化存储。

快速开始

环境准备

确保系统已安装Node.js 14.0或更高版本，然后克隆项目代码：

git clone https://gitcode.com/gh_mirrors/st/storage cd storage

依赖安装与配置

安装项目依赖：

npm install

配置环境变量：

cp .env.sample .env && cp .env.test.sample .env.test

基础设施启动

使用Docker Compose启动本地开发环境：

npm run infra:restart

此命令将启动PostgreSQL数据库和PostgREST服务。

开发服务器启动

运行开发服务器：

npm run dev

服务器将在 http://localhost:5000/ 启动运行。

基础操作示例

创建存储桶

使用以下命令创建名为"avatars"的存储桶：

curl --location --request POST 'http://localhost:5000/bucket' \ --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoic2VydmljZV9yb2xlIiwiaWF0IjoxNjEzNTMxOTg1LCJleHAiOjE5MjkxMDc5ODV9.th84OKK0Iz8QchDyXZRrojmKSEZ-OuitQm_5DvLiSIc' \ --header 'Content-Type: application/json' \ --data-raw '{ "name": "avatars" }'

查询存储桶列表

获取所有存储桶信息：

curl --location --request GET 'http://localhost:5000/bucket' \ --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoic2VydmljZV9yb2xlIiwiaWF0IjoxNjEzNTMxOTg1LCJleHAiOjE5MjkxMDc5ODV9.th84OKK0Iz8QchDyXZRrojmKSEZ-OuitQm_5DvLiSIc'

开发工作流

代码格式化

项目使用Prettier进行代码格式化：

npm run format

代码检查

运行代码质量检查：

npm run lint

测试执行

运行完整的测试套件：

npm test

生成测试覆盖率报告：

npm run test:coverage

高级功能

数据库迁移管理

运行数据库迁移：

npm run migration:run

文档导出

导出项目文档：

npm run docs:export

技术栈说明

Supabase Storage 基于以下核心技术构建：

• 后端框架：Fastify - 高性能Node.js Web框架
• 数据库：PostgreSQL - 关系型数据库
• 对象存储：AWS S3 SDK - 提供S3兼容存储支持
• 文件上传：TUS协议 - 支持可恢复的文件上传
• 监控指标：Prometheus客户端 - 收集和暴露应用指标

部署与生产环境

构建生产版本

编译TypeScript代码并构建生产版本：

npm run build

启动生产服务器

运行生产环境服务器：

npm start

项目结构

项目采用模块化设计，主要包含以下核心模块：

• HTTP层：处理API请求和路由
• 存储协议：支持S3、TUS、Iceberg等多种协议
• 内部服务：包含认证、数据库、队列等核心组件
• 测试套件：完整的单元测试和集成测试

通过这种分层架构和模块化设计，Supabase Storage 提供了一个既灵活又强大的对象存储解决方案，能够满足从简单文件存储到复杂企业级应用的各种需求。

【免费下载链接】storageS3 compatible object storage service that stores metadata in Postgres项目地址: https://gitcode.com/gh_mirrors/st/storage