django.contrib.staticfiles.urls模块的作用和用处详解

发布时间：2023-12-24 00:55:14

django.contrib.staticfiles.urls 模块提供了一个默认的 URL 配置，用于处理静态文件的服务。

在 Django 中，静态文件包括 CSS、JavaScript、图像和其他一些文件，它们在一个网站中一般不会被修改。这些文件可以通过 Django 的静态文件处理机制进行访问和加载。

django.contrib.staticfiles.urls 模块中的主要函数是 static，它返回一个 URL 模式，用于处理静态文件的访问。它的原型如下:

static(prefix, view=django.views.static.serve, **kwargs)

- prefix: 静态文件 URL 的前缀。例如，如果设置为 'static/'，那么所有的静态文件 URL 会被形如 http://example.com/static/ 的 URL 前缀所匹配。

- view: 用于处理静态文件的视图函数。默认情况下，使用 django.views.static.serve 函数来提供静态文件的服务。你也可以指定自己的视图函数。

- kwargs: 其他的选项参数。

使用 django.contrib.staticfiles.urls 模块时，需要将其添加到 Django 项目的 URL 配置中。例如，在项目的 urls.py 文件中，可以这样添加静态文件的 URL 配置:

from django.contrib.staticfiles.urls import static
from django.conf import settings
from django.conf.urls.static import static as static_url

urlpatterns = [
    # ... 其他 URL 配置 ...
] + static(settings.STATIC_URL, document_root=settings.STATIC_ROOT) + static_url(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)

上面的代码中，static(settings.STATIC_URL, document_root=settings.STATIC_ROOT) 添加了处理静态文件的 URL 配置，static_url(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT) 添加了处理媒体文件的 URL 配置（如果项目中有媒体文件的话）。

其中，settings.STATIC_URL 是静态文件 URL 的前缀，settings.STATIC_ROOT 是存放静态文件的路径，MEDIA_URL 和 MEDIA_ROOT 分别是媒体文件的 URL 前缀和存放路径。

下面是一个使用例子：

假设我们有一个 Django 项目，其中有一个名为 myapp 的应用程序。在该应用程序中，有一个静态文件夹 static，其中有一个名为 style.css 的样式文件。我们需要将这个静态文件提供给用户访问。

首先在 myapp 下创建一个 static 文件夹，并在其中创建一个 style.css 文件。在 style.css 文件中添加以下内容:

body {
    background-color: lightblue;
}

然后，在 Django 项目的 urls.py 文件中添加静态文件的 URL 配置:

from django.contrib.staticfiles.urls import static
from django.conf import settings
from django.conf.urls import url, include

urlpatterns = [
    url(r'^', include('myapp.urls')),
] + static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)

接下来，在 myapp 中创建一个 urls.py 文件，并在其中添加以下内容:

from django.conf.urls import url
from . import views

urlpatterns = [
    url(r'^$', views.index, name='index'),
]

在 myapp 的 views.py 文件中，添加以下内容:

from django.shortcuts import render

def index(request):
    return render(request, 'myapp/index.html')

最后，在 myapp 下创建一个 templates/myapp/index.html 文件，并在其中添加以下内容:

<!DOCTYPE html>
<html>
<head>
    <link rel="stylesheet" type="text/css" href="{% static 'style.css' %}">
</head>
<body>
    <h1>Hello, World!</h1>
</body>
</html>

这样，我们就完成了使用 django.contrib.staticfiles.urls 模块来处理静态文件的配置。当用户访问根 URL ('/') 时，会显示一个带有背景颜色的 'Hello, World!' 文本。这个背景颜色来自于我们提供的 style.css 样式文件。

总结:

django.contrib.staticfiles.urls 模块提供了处理静态文件的默认 URL 配置。通过添加静态文件的 URL 配置，我们可以在 Django 项目中提供静态文件的访问和加载。在项目的 urls.py 文件中使用 static 函数来进行静态文件的 URL 配置。通过设置静态文件的 URL 前缀和路径，我们可以方便地处理静态文件的访问。静态文件的 URL 配置不仅仅限于静态文件，还可以用于处理媒体文件的访问。