WhiteNoise 使用教程

WhiteNoise 使用教程

whitenoiseRadically simplified static file serving for Python web apps项目地址:https://gitcode.com/gh_mirrors/wh/whitenoise

项目介绍

WhiteNoise 是一个用于简化 Python Web 应用程序静态文件服务的开源项目。通过几行配置，WhiteNoise 允许您的 Web 应用程序直接服务其自身的静态文件，使其成为一个自包含的单元，可以在任何地方部署，无需依赖 Nginx、Amazon S3 或其他外部服务。特别适用于 Heroku、OpenShift 等 PaaS 提供商。WhiteNoise 设计为与 CDN 配合使用，以确保高流量站点也能从其简单性中受益。

项目快速启动

安装 WhiteNoise

首先，通过 pip 安装 WhiteNoise：

pip install whitenoise

配置 WhiteNoise

对于 Django 应用

在 settings.py 文件中添加以下配置：

MIDDLEWARE = [
    'whitenoise.middleware.WhiteNoiseMiddleware',
    # 其他中间件
]

STATICFILES_STORAGE = 'whitenoise.storage.CompressedManifestStaticFilesStorage'

对于其他 WSGI 应用

假设你有一个 WSGI 应用 MyWSGIApp，你可以这样配置：

from whitenoise import WhiteNoise
from my_project import MyWSGIApp

application = MyWSGIApp()
application = WhiteNoise(application, root="/path/to/static/files")
application.add_files("/path/to/more/static/files", prefix="more-files/")

应用案例和最佳实践

使用 CDN

为了提高性能，建议将 WhiteNoise 与 CDN 结合使用。以下是一个简单的配置示例：

# settings.py
STATIC_URL = 'https://your-cdn-url.com/static/'

最佳实践

• 压缩内容：WhiteNoise 自动处理 gzip 和 Brotli 格式的压缩内容。
• 缓存头设置：WhiteNoise 会为不会更改的内容设置远期缓存头。
• 正确处理 Accept-Encoding 和 Vary 头：确保内容以最佳方式提供给客户端。

典型生态项目

Django

WhiteNoise 与 Django 集成非常紧密，提供了一些自动配置功能，使得在 Django 项目中使用 WhiteNoise 变得非常简单。

Flask

虽然 WhiteNoise 不是专门为 Flask 编写的，但由于 Flask 使用标准的 WSGI 协议，因此可以很容易地与 WhiteNoise 集成。

其他 WSGI 应用

WhiteNoise 可以与任何 WSGI 兼容的应用程序一起使用，只需将其包装在 WhiteNoise 实例中并指定静态文件的位置即可。

通过以上步骤，您可以快速启动并使用 WhiteNoise 项目，简化您的静态文件服务流程。

whitenoiseRadically simplified static file serving for Python web apps项目地址:https://gitcode.com/gh_mirrors/wh/whitenoise