上传单个文件

Sub-Store 使用指南

Sub-Store 是一款基于云的存储服务，支持多种语言和多云存储系统，以下是使用 Sub-Store 的步骤指南,帮助您快速上手和高效管理云存储。

安装 Sub-Store Client

安装 Sub-Store Client 库,以便通过代码进行操作。

pip install substore-client

初始化 Sub-Store 客户端

配置您的云存储账户信息，创建一个 config.json 文件,包含您的账户密钥。

{
    "access_key": "your-access-key",
    "secret_key": "your-secret-key",
    "provider": "s3",  // 根据您的存储系统配置
    "region": "your-region"
}

初始化 Sub-Store 客户端：

from substore_client import SubStoreClient
client = SubStoreClient.from_config("path/to/config.json")

或直接传入参数：

client = SubStoreClient(
    access_key="your-access-key",
    secret_key="your-secret-key",
    provider="s3",
    region="your-region"
)

上传文件

使用 upload_file 方法上传单个文件，upload_dir 方法上传整个目录。

    # 处理上传完成后的文件对象
    pass
# 上传整个目录
client.upload_dir("local/directory", "my-key", recursive=True)

下载文件

使用 download_file 下载单个文件或 download_dir 下载整个目录。

# 下载单个文件
with client.download_file("file-id", "my-key", "local/file.txt") as file_obj:
    # 处理下载内容
    pass
# 下载整个目录
client.download_dir("directory-id", "my-key", "local/directory")

管理文件

删除文件或目录,列出文件列表。

# 删除文件
client.delete_file("file-id", "my-key")
# 删除目录
client.delete_dir("directory-id", "my-key")
# 列出文件
files = client.list_files("bucket-name", "my-key", filter={"Prefix": "myfolder"})
# 或列出目录
folders = client.list_directories("bucket-name", "my-key")

文件锁机制

获取和释放文件锁,防止并发修改。

# 获取锁
lock = client.acquire_lock("file-id", "my-key")
try:
    # 操作文件
    pass
finally:
    client.release_lock(lock)

多云存储配置

支持多云存储系统，修改配置文件或代码中指定 provider。

# 示例：使用 GCS
client = SubStoreClient(
    access_key="your-access-key",
    secret_key="your-secret-key",
    provider="gcs",
    region="your-region"
)

监控和日志

集成日志记录库,实时监控文件操作。

import logging
logging.basicConfig(level=logging.INFO)
logger = logging.getLogger(__name__)
@client.log_start("my-session")
def upload_file():
    logger.info("开始上传文件")
    # 上传逻辑
    logger.info("上传完成")

安全措施

使用 JWT 或 OAuth 2. 进行身份验证,加密存储密钥。

# 使用 JWT 授权
client.auth("token-string")
# 加密密钥
client.encrypt_key("secret-key", "key-id")

高级功能

启用版本控制,配置分片上传大小。

# 启用版本控制
client.enable_versioning("bucket-name", "my-key")
# 分片上传
client.upload_file("large-file.tar.gz", "my-key", part_size=5 * 1024 * 1024)

扩展功能

记录文件信息到数据库,生成短链接。

# 记录上传信息
client.upload_file("file.txt", "my-key", metadata={"file_name": "file.txt"})
# 生成短链接
short_url = client.generate_short_link("file-id", "my-key")

故障排除

• 认证失败：检查账户信息是否正确,日志中可能有详细错误信息。
• 上传/下载失败：检查网络连接,确保云存储区域可达。
• 权限问题：确认文件或目录的权限设置是否正确。

示例代码

以下是一个简单的 Python 脚本示例，演示上传、删除和列出文件。

from substore_client import SubStoreClient
# 初始化客户端
client = SubStoreClient(
    access_key="your-access-key",
    secret_key="your-secret-key",
    provider="s3",
    region="us-east-1"
)
try:
    # 上传文件
    client.upload_file("example.txt", "my-upload-key")
    # 下载文件
    with client.download_file("file-id", "my-upload-key", "downloaded.txt") as file:
        content = file.read()
        print(content)
    # 列出文件
    files = client.list_files("my-bucket", "my-upload-key")
    for file in files:
        print(f"File: {file['Key']}, Size: {file['Size']}")
finally:
    # 关闭连接
    client.close()

文档和支持

Sub-Store 提供详细的文档和社区支持,遇到问题时可以参考官方文档或社区求助。

通过以上步骤，您可以快速上手 Sub-Store,高效管理云存储任务。