python 阿里oss 下载

原创

mob64ca12db7156 2024-09-28 05:37:36 ©著作权

文章标签 下载文件 Access Python 文章分类 Python 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12db7156的原创作品，请联系作者获取转载授权，否则将追究法律责任

使用 Python 从阿里云 OSS 下载文件

在现代应用开发中，文件存储与管理是一个不可或缺的模块。阿里云的对象存储服务（OSS）提供了一种高效、灵活的方式来存储和管理大量的非结构化数据。本文将介绍如何使用 Python 从阿里云 OSS 下载文件，并附带代码示例。

阿里云 OSS 简介

阿里云 OSS 是一个海量且安全的云存储服务，尤其适用于存储图片、视频、大数据备份等。通过简单的 API 调用，我们可以方便地进行文件的上传、下载、删除等操作。

环境准备

在进行下载操作之前，您需要完成以下准备工作：

创建阿里云账户 - 如果还没有账户，请前往 [阿里云官网]( 注册。
获取 Access Key - 在阿里云控制台的 “Access Key 管理” 中，创建新的 Access Key。
安装 Python SDK - 使用阿里云提供的 Python SDK，可以简化操作流程。您可以通过 pip 安装：
```
pip install aliyun-oss2
```

使用 Python 从 OSS 下载文件

设置连接参数

在开始下载之前，需要首先设置连接参数，包括 Access Key ID、Access Key Secret、bucket 名称和文件的路径等。

import oss2

# 设置 Access Key ID 和 Access Key Secret
access_key_id = 'your_access_key_id'
access_key_secret = 'your_access_key_secret'
bucket_name = 'your_bucket_name'
endpoint = '  # 替换成实际的 endpoint

# 创建 OSS 连接
auth = oss2.Auth(access_key_id, access_key_secret)
bucket = oss2.Bucket(auth, endpoint, bucket_name)

下载文件

接下来，我们可以使用 get_object_to_file 方法下载文件。这里的 object_name 是您在 OSS 中的文件路径，local_file_name 是您希望保存到本地的文件路径。

def download_file(object_name, local_file_name):
    try:
        bucket.get_object_to_file(object_name, local_file_name)
        print(f"文件 {object_name} 下载成功，保存为 {local_file_name}")
    except oss2.exceptions.NoSuchKey:
        print(f"文件 {object_name} 不存在。")
    except Exception as e:
        print(f"下载文件时发生错误: {e}")

# 使用示例
download_file('example_folder/example_file.txt', 'local_example_file.txt')

处理下载文件的错误

在实际的操作中，下载文件时可能会遇到一些错误，比如文件不存在、权限不足等。下面的代码示例展示了如何处理这些异常。

def safe_download_file(object_name, local_file_name):
    try:
        bucket.get_object_to_file(object_name, local_file_name)
        return True
    except oss2.exceptions.NoSuchKey:
        print(f"错误: 文件 {object_name} 不存在。")
    except oss2.exceptions.ParameterError as pe:
        print(f"参数错误: {pe}")
    except oss2.exceptions.ServiceUnavailableError:
        print("服务不可用，请稍后再试。")
    except Exception as e:
        print(f"下载过程中出现异常: {e}")
    return False

# 使用示例
if safe_download_file('example_folder/example_file.txt', 'local_example_file.txt'):
    print("文件安全下载。")
else:
    print("文件下载失败。")

下载进度监控

在下载大型文件时，了解下载进度是非常重要的。您可以通过实现 oss2.callbacks.ProgressCallback 来实现下载的进度监控，代码示例如下：

class ProgressUpdater(oss2.callbacks.ProgressCallback):
    def __init__(self, total_size):
        self.total_size = total_size
        self.downloaded = 0
        
    def callback(self, downloaded):
        self.downloaded += downloaded
        print(f"下载进度: {self.downloaded / self.total_size:.2%}")

def download_with_progress(object_name, local_file_name):
    total_size = bucket.head_object(object_name).content_length
    updater = ProgressUpdater(total_size)
    bucket.get_object_to_file(object_name, local_file_name, progress_callback=updater)
    
# 使用示例
download_with_progress('example_folder/large_file.zip', 'local_large_file.zip')

旅行图

下面的旅程图展示了下载文件的完整过程：

journey
    title 下载文件从阿里云 OSS
    section 开始
      定义 Access Key ID 和 Secret: 5: 阿里云
      连接到 OSS: 5: 阿里云
    section 下载文件
      指定文件路径: 5: 用户
      执行下载操作: 5: 用户
    section 结束
      验证文件是否存在: 5: 系统
      下载成功与否: 5: 系统