Django S3Direct 使用指南

Django S3Direct 使用指南

django-s3directDirectly upload files to S3 compatible services with Django.项目地址:https://gitcode.com/gh_mirrors/dj/django-s3direct

项目介绍

Django S3Direct 是一个专为 Django 设计的中间件，它使得用户能够直接上传文件到 Amazon S3 存储桶中，而无需经过 Django 服务器的中转。此项目简化了文件上传流程，尤其是在处理大文件或需要直接对存储桶进行管理的情况下，通过提供前端接口直接与 S3 进行交互，提高了上传效率并减少了服务器的带宽消耗。

项目快速启动

安装

首先，确保你的环境中已安装了 Django 和 boto3，然后通过 pip 安装 django-s3direct：

pip install django-s3direct

配置 Django

在你的 Django 项目的 settings.py 中，添加必要的配置：

INSTALLED_APPS = [
    # ... 其他应用 ...
    's3direct',
]

AWS_ACCESS_KEY_ID = 'your_access_key'
AWS_SECRET_ACCESS_KEY = 'your_secret_key'
AWS_STORAGE_BUCKET_NAME = 'your_bucket_name'

S3DIRECT_REGION = 'your_region'
S3DIRECT_DESTINATION = {
    'my_destination': {
        'key': lambda filename, uuid: f'media/{uuid}/{filename}',
        'bucket': AWS_STORAGE_BUCKET_NAME,
        'acl': 'private',
        'cors': ('AllowedOrigin',),
        'policy': json.dumps({
            "expiration": "2038-01-19T00:00:00Z",
            "conditions": [{"bucket": AWS_STORAGE_BUCKET_NAME}, ["starts-with", "$Key", "media/"]],
        }),
        'signature_version': 's3v4',
    },
}

在模板中使用 S3Direct 的表单：

<form action="{% url 's3direct-upload' %}" method="post" enctype="multipart/form-data">
    {% csrf_token %}
    <input type="file" name="file" />
    <button type="submit">上传至 S3</button>
</form>

别忘了在urls.py中增加相应的url配置：

from django.urls import path, include

urlpatterns = [
    # ...其他URL模式...
    path('s3direct/', include('s3direct.urls')),
]

执行迁移以创建必要的模型（虽然这个库本身可能不需要特定的数据库迁移）。

运行你的 Django 项目

现在，你可以运行你的 Django 开发服务器并测试文件上传功能了。

应用案例和最佳实践

• 多环境配置：根据不同环境（开发、测试、生产）设置不同的 AWS 凭证。
• 安全性增强：利用 S3 直接上传的签名机制，限制谁可以上传以及可以上传的类型和大小。
• 前端集成：结合 React 或 Vue 等现代前端框架，优化用户体验，例如显示上传进度。

典型生态项目

虽然 Django S3Direct 主要用于 Django 生态系统内部，但它与其他前端技术栈的结合也十分常见。例如，在使用 Bootstrap 构建的界面中嵌入 S3Direct 表单，或者在现代化的单页应用程序中通过 AJAX 调用来触发文件上传，这样可以充分利用 S3 直传的优势，同时也保持了用户界面的流畅体验。

---

通过上述步骤，您将能够成功地在您的 Django 项目中集成并使用 django-s3direct，实现高效安全的文件上传至 Amazon S3。

django-s3directDirectly upload files to S3 compatible services with Django.项目地址:https://gitcode.com/gh_mirrors/dj/django-s3direct