理解 django.contrib.staticfiles

最新推荐文章于 2025-04-10 01:58:04 发布

weixin_34402090

最新推荐文章于 2025-04-10 01:58:04 发布

阅读量422

点赞数

文章标签： python 开发工具运维

原文链接：https://my.oschina.net/dancing/blog/162000

版权

2019独角兽企业重金招聘Python工程师标准>>>

Django 1.3 包含了一个新的 APPdjango.contrib.staticfiles来帮助开发者管理渲染页面所需的 JS、CSS 等静态文件。

在 1.3 之前，所有的静态文件都是用MEDIA_URL和MEDIA_ROOT来控制的。为了和用户上传的文件作区分，staticfiles的使我们可以将静态文件分配到 APP 目录或任意你指定的目录，分发 APP 时就更为方便了。

django.contrib.staticfiles 文档

MEDIA_XXX 和 STATIC_XXX 配置项的区别

MEDIA_XXX配置项用来管理用户上传的文件。通常经由FileFields字段上传，它们保存在settings.MEDIA_ROOT指定的目录下，通过settings.MEDIA_URL指定的路径访问；
STATIC_XXX配置项用来管理静态资源文件。CSS / JS文件、png/jpg图片等 app 提供的静态资源。它们通过manage.py collectstatic命令汇集到settings.STATIC_ROOT目录，并通过settings.STATIC_URL指定的路径访问。

使用 staticfiles

在 Django 1.3 中，staticfiles默认是启用的。如果是从 1.3 之前的代码迁移过来，启用代码如下：

INSTALLED_APPS += ('django.contrib.staticfiles',) TEMPLATE_CONTEXT_PROCESSORS += ('django.core.context_processors.static',)

STATIC_ROOT 配置项

STATIC_ROOT被用来指定执行manage.py collectstatic时静态文件存放的路径。在生产环境下，集中存放静态资源有用利于使用 Lighttpd / Nginx 托管静态资源。为了方便调试，通常设置如下：

SITE_ROOT = os.path.dirname(os.path.abspath(__file__)) SITE_ROOT = os.path.abspath(os.path.join(SITE_ROOT, '../')) STATIC_ROOT = os.path.join(SITE_ROOT, 'collectedstatic')

STATIC_URL 配置项

在 Django 模板中，我们可以引用{{ STATIC_URL }}变量避免把路径写死。通常设置如下：

STATIC_URL = '/static/'

ADMIN_MEDIA_PREFIX 配置项

ADMIN_MEDIA_PREFIX必须为如下设置，以便staticfiles能够正确的找到django.contrib.admin的静态资源：

ADMIN_MEDIA_PREFIX = STATIC_URL + 'admin/'

在模板中使用 STATIC_URL

<link rel="stylesheet" href="{{ STATIC_URL }}css/core.css">

开发环境访问静态资源

设置 urls.py

from django.contrib.staticfiles.urls import staticfiles_urlpatterns urlpatterns += staticfiles_urlpatterns()

注意：无须对上面的代码使用if settings.DEBUG:判断，staticfiles_urlpatterns()函数会自己处理。

静态资源的存放和查找

开发环境下staticfiles查找静态资源的顺序取决于STATICFILES_FINDERS配置项，STATICFILES_FINDERS缺省设置如下：

("django.contrib.staticfiles.finders.FileSystemFinder", "django.contrib.staticfiles.finders.AppDirectoriesFinder")

django.contrib.staticfiles.finders.FileSystemFinder用来从STATICFILES_DIRS指定的路径中查找额外的静态文件；
django.contrib.staticfiles.finders.AppDirectoriesFinder是从INSTALLED_APPS列表内的 APP 所在包的static目录中查找资源文件。

发布环境访问静态资源

首先应该执行manage.py collectstatic命令把所有 APP （包括django.contrib.admin）的静态资源收集到STATIC_ROOT指定的目录
接着，我们需要配置lighttpd/nginx服务器，将/static/路径指向STATIC_ROOT目录，提供静态资源的服务。详细细节请参考：Serving static files in production