Django如何处理请求¶
当用户从Django支持的站点请求页面时,这是系统遵循的算法,以确定要执行的Python代码:
- Django确定要使用的根URLconf模块。通常,这是
ROOT_URLCONF
设置的值,但如果传入HttpRequest
对象具有urlconf
属性(由中间件设置),则将使用其值代替ROOT_URLCONF
设置。 - Django加载Python模块并查找变量
urlpatterns
。这应该是Python列表django.urls.path()
和/或django.urls.re_path()
实例。 - Django按顺序运行每个URL模式,并在匹配请求的URL的第一个模式停止。
- 一旦其中一个URL模式匹配,Django就会导入并调用给定的视图,这是一个简单的Python函数(或基于类的视图)。视图传递以下参数:
- 一个例子
HttpRequest
。 - 如果匹配的URL模式未返回任何命名组,则来自正则表达式的匹配将作为位置参数提供。
- 关键字参数由路径表达式匹配的任何命名部分组成,由或者 可选
kwargs
参数中指定的任何参数覆盖 。django.urls.path()
django.urls.re_path()
- 一个例子
- 如果没有URL模式匹配,或者在此过程中的任何点期间引发异常,Django将调用适当的错误处理视图。请参阅下面的错误处理
实例:
from django.urls import path from . import views urlpatterns = [ path('articles/2003/', views.special_case_2003), path('articles/<int:year>/', views.year_archive), path('articles/<int:year>/<int:month>/', views.month_archive), path('articles/<int:year>/<int:month>/<slug:slug>/', views.article_detail), ]
笔记:
- 要从URL捕获值,请使用尖括号。
- 捕获的值可以选择包括转换器类型。例如,用于
<int:name>
捕获整数参数。如果未包含转换器/
,则匹配除字符之外的任何字符串。 - 没有必要添加前导斜杠,因为每个URL都有。例如,它
articles
不是/articles
。
示例请求:
- 请求
/articles/2005/03/
与列表中的第三个条目匹配。Django会调用该函数 。views.month_archive(request, year=2005,month=3)
/articles/2003/
将匹配列表中的第一个模式,而不是第二个模式,因为模式是按顺序测试的,第一个是第一个要通过的测试。随意利用订单插入这样的特殊情况。在这里,Django会调用该函数views.special_case_2003(request)
/articles/2003
不匹配任何这些模式,因为每个模式都要求URL以斜杠结尾。/articles/2003/03/building-a-django-site/
将匹配最终模式。Django会调用该函数 。views.article_detail(request,year=2003, month=3, slug="building-a-django-site")
路径转换器¶
默认情况下,以下路径转换器可用:
str
- 匹配除路径分隔符之外的任何非空字符串'/'
。如果转换器未包含在表达式中,则这是默认值。int
- 匹配零或任何正整数。返回一个int。slug
- 匹配由ASCII字母或数字组成的任何slug字符串,以及连字符和下划线字符。例如,building-your-1st-django-site
。uuid
- 匹配格式化的UUID。要防止多个URL映射到同一页面,必须包含短划线并且字母必须为小写。例如,075194d3-6885-417e-a8a8-6c931e272f00
。返回一个UUID
实例。path
- 匹配任何非空字符串,包括路径分隔符'/'
。这使您可以匹配完整的URL路径,而不仅仅是URL路径的一部分str
。
注册自定义路径转换器¶
对于更复杂的匹配要求,您可以定义自己的路径转换器。
转换器是一个包含以下内容的类:
- 一个
regex
class属性,作为字符串。 - 甲方法,它处理匹配的字符串转换成要传递到视图函数的类型。如果它不能转换给定值,它应该提高。
to_python(self,value)
ValueError
- 一种方法,用于处理将Python类型转换为要在URL中使用的字符串。
to_url(self, value)
例如:
class FourDigitYearConverter: regex = '[0-9]{4}' def to_python(self, value): return int(value) def to_url(self, value): return '%04d' % value
使用register_converter()
以下命令在URLconf中注册自定义转换器类 :
from django.urls import path, register_converter from . import converters, views register_converter(converters.FourDigitYearConverter, 'yyyy') urlpatterns = [ path('articles/2003/', views.special_case_2003), path('articles/<yyyy:year>/', views.year_archive), ... ]
使用正则表达式¶
如果路径和转换器语法不足以定义URL模式,则还可以使用正则表达式。为此,请使用 re_path()
而不是path()
。
在Python正则表达式中,命名正则表达式组的语法是(?P<name>pattern)
,组name
的名称,并且 pattern
是要匹配的模式。
这是前面的示例URLconf,使用正则表达式重写:
from django.urls import path, re_path from . import views urlpatterns = [ path('articles/2003/', views.special_case_2003), re_path(r'^articles/(?P<year>[0-9]{4})/$', views.year_archive), re_path(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/$', views.month_archive), re_path(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/(?P<slug>[w-]+)/$', views.article_detail), ]
这完成了与前一个示例大致相同的事情,除了:
- 匹配的确切网址稍微受限制。例如,年份10000将不再匹配,因为年份整数被限制为恰好四位数。
- 无论正则表达式匹配什么类型,每个捕获的参数都将作为字符串发送到视图。
从使用切换path()
到 re_path()
反之亦然,特别重要的是要注意视图参数的类型可能会发生变化,因此您可能需要调整视图。
使用未命名的正则表达式组¶
除了命名组语法之外,例如(?P<year>[0-9]{4})
,您还可以使用较短的未命名组,例如([0-9]{4})
。
不特别推荐这种用法,因为它更容易在匹配的预期含义和视图的参数之间意外引入错误。
在任何一种情况下,建议在给定的正则表达式中仅使用一种样式。当两种样式混合使用时,将忽略任何未命名的组,并且只将命名组传递给视图函数。
传递额外选项来查看功能¶
URLconfs有一个钩子,允许您将额外的参数作为Python字典传递给视图函数。
该path()
函数可以采用可选的第三个参数,该参数应该是传递给视图函数的额外关键字参数的字典。
例如:
from django.urls import path from . import views urlpatterns = [ path('blog/<int:year>/', views.year_archive, {'foo': 'bar'}), ]
在这个例子中,对于请求/blog/2005/
,Django将调用 。views.year_archive(request, year=2005, foo='bar')
在联合框架中使用此技术 将元数据和选项传递给视图。
处理冲突
可以使用URL模式捕获命名关键字参数,并在其额外参数字典中传递具有相同名称的参数。发生这种情况时,将使用字典中的参数而不是URL中捕获的参数。
将额外选项传递给include()
¶
同样,您可以传递额外的选项,include()
并且包含的URLconf中的每一行都将传递额外的选项。
例如,这两个URLconf集在功能上是相同的:
设置一个:
# main.py from django.urls import include, path urlpatterns = [ path('blog/', include('inner'), {'blog_id': 3}), ] # inner.py from django.urls import path from mysite import views urlpatterns = [ path('archive/', views.archive), path('about/', views.about), ]
设置二:
# main.py from django.urls import include, path from mysite import views urlpatterns = [ path('blog/', include('inner')), ] # inner.py from django.urls import path urlpatterns = [ path('archive/', views.archive, {'blog_id': 3}), path('about/', views.about, {'blog_id': 3}), ]
请注意,无论行的视图是否实际接受这些选项为有效,额外选项将始终传递到包含的URLconf中的每一行。因此,只有在您确定所包含的URLconf中的每个视图都接受您传递的额外选项时,此技术才有用。