Django的路由

Django处理HTTP请求的流程

  1. 确定URLconf的根配置位置,通常URL根配置在ROOT_URLCONF中设置。如果请求的HttpRequest对象包含urlconf属性,则按照urlconf属性查找URLconf。
  2. 加载配置信息,在配置信息中查找urlpatterns。
  3. 按顺序检索urlpatterns中的所有URL模式字符串,并定位在第一个与URL匹配的URL模式字符串。
  4. 当检索到匹配的URL模式字符串后,调用对应的视图方法,并传递以下参数给视图方法:
  • 一个HttpRequest对象实例。
  • 如果匹配的URL模式字符串包含未命名的组,那么匹配的信息会作为位置参数传递给视图。
    -路径表达式中的命名部分组成了视图的关键字参数,以上关键字参数会被django.urls.path()或者django.urls.re_path()的kwargs覆盖。

5.如果在URLconf中没有找到任何匹配的模式字符串,或者出现其他任何错误,Django将会调用一个用于处理错误信息的视图。

URLconf示例

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('artivles/<int:year>/<int:month>/<slug:slug>/', views.article_detail)
]

代码分析:

  • 函数path的第一个参数是一个URL模式字符串,用于匹配URL,类似正则表达式。
  • 函数path的第二个参数是用于处理URL请求的视图函数。
  • 使用尖括号提取URL中的参数,如<int:year>。
  • 使用类型转化器对参数类型进行转换,如int:会将从URL中捕获的值转换为数值类型,如果没有指定类型转换器,如<year>,则任何不包含斜杠(/)的字符串都会被提取。
  • URL模式字符串不需要以/开头。

应用场景:

  • 发送向/articles/2005/03/的请求将会与第三个URL模式字符串匹配成功,匹配成功后调用views.month_archive(request, year=2005,month=3)。
  • 发送向/articles/2003/的请求将会与第一个URL模式字符串匹配成功而不是第二个,因为Django在第一次匹配成功后停止后续URL检验,本例匹配成功后调用views.special_case_2003(request)。
  • 发送向/articles/2003的请求不会与任何URL模式字符串匹配成功,因为每个URL模式字符串都要求以/结尾。
  • 发送向/articles/2003/03/building-a-django-site/的请求将会与最后一个URL模式字符串匹配成功,匹配成功后调用views.article_detail(request, year=2003, month=3, slug="building-a-django-site")。

URL参数类型转化器

  • str:匹配任意非空字符串,但是不能匹配URL分隔符“/”。这是默认的URL参数转换器。
  • int:匹配任意大于等于0的整数。
  • slug:匹配任意slug字符串,slug字符串可以包含ASCII字母、数字、连字符“-”和下画线“_”。
  • uuid:匹配UUID字符串(字符串中的字母必须为小写),例如075194d3-6885-417e-a8a8-6c931e272f00。
  • path:匹配任意非空字符串,包括URL分隔符斜杠(/)。它允许匹配完整的URL而不是URL的一个片段。

自定义URL参数类型转化器

自定义参数类型转换器包括以下部分:

  • 一个regex属性,属性值为正则表达式。
  • 一个to_python(self, value)方法,该方法用于将匹配的URL参数转换为指定类型,当类型转换失败后抛出ValueError异常。
  • 一个to_url(self, value)方法,该方法用于将Python类型转换为类型转换器字符串。

下面是一个用于捕获日期年的类型转换器:

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 register_converter, path

from . import views
from .converters.FourDigitYearConverter import *

register_converter(FourDigitYearConverter, 'yyyy')

app_name = 'polls'
urlpatterns = [
    path('<yyyy:year>/', views.get_year, name='detail'),
]

创建测试视图:

def get_year(request, year):
    return HttpResponse(str(year))

此时目录结构如下:


image.png

启动Web服务,访问URL,效果如下图所示:


image.png

使用正则表达式

使用正则表达式匹配URL,此时需要使用re_path()方法而不是path()。
Python的正则表达式支持对分组进行命名,语法格式为(?P<name>pattern),其中,name为分组名,pattern为匹配的正则表达式
使用正则表达式对前面的URLconf进行重写:

from django.urls import path, re_path
from .import views

urlpatterns = [
    path(r'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),
]

虽然可以使用未命名的正则表达式,例如使用([0-9]{4})替代(?P<year>[0-9]{4}),但是为了防止出现意外错误,推荐对分组进行命名。
需要注意的是,不要将命名正则表达式与未命名正则表达式混合使用,这样会造成未命名正则表达式丢失。

正则表达式可以嵌套使用,如:

re_path(r'comments/(?:page-(?P<page_number>\d+)/)?$', comments)

导入其他URLconf

为每一个应用程序写一套独立的URLconf,而URLconf根模块通过使用include()方法将其他URLconf引用进来。
下面是URLconf根模块mysite/urls.py:

from django.contrib import admin
from django.urls import include, path

urlpatterns = [
    path('polls/', include('polls.urls')),
    path('admin/', admin.site.urls),
]

当Django遇到include()方法时,匹配工作跳转到被引用的URLconf进行验证。
使用include()方法还可以引用其他URL模式列表,例如:

from django.urls import include, path

from apps.main import views as main_views
from credit import views as credit_views

extra_patterns = [
    path('reports/', credit_views.report),
    path('reports/<int:id>/', credit_views.report),
    path('charge/', credit_views.charge),
]

urlpatterns = [
    path('', main_views.homepage),
    path('help/', include('apps.help.urls')),
    path('credit/', include(extra_patterns)),
]

此时访问/credit/reports/将会调用credit_views.report()视图方法。这样做的好处是,当一个应用程序中多条URL的前缀相同时,如在本例中extra_patterns中的URL都是以credit开头,可以简化URL模式字符串。
最后,当多个url模式字符串拥有相同的前缀时还可以对url前缀进行提取,例如:

urlpatterns = [
    path('<page_slug>-<page_id>/history/', views.history),
    path('<page_slug>-<page_id>/edit/', views.edit)
    path('<page_slug>-<page_id>/discuss/', view.discuss)
    path('<page_slug>-<page_id>/permissions/', views.permissions),
]

前面这些url都包含'<page_slug>-<page_id>/'前缀,则可以通过include方法修改为:

urlpatterns = [
    path('<page_slug>-<page_id>/', include([
        path('history/', views.history),
        path('edit/', views.edit),
        path('discuss/', view.discuss),
        path('permissions/', views.permissions),
    ])),
]

向视图传递额外参数

可以使用path()方法的第三个参数向视图传递额外参数,例如:

from django.urls import path
from . import views

urlpatterns = [
    path('blog/<int:year>/', views.year_archive. {'foo': 'bar'}),
]

也可以向include()方法传递额外参数。
配置一:

# main.py
form 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
form django.urls import include, path
from mysite import views

urlpatterns = [
    path('blog/', include('inner'), {'blog_id': 3}),
]

# inner.py
from django.urls import path


urlpatterns = [
    path('archive/', views.archive, {'blog_id': 3}),
    path('about/', views.about, {'blog_id': 3}),
]

此时,额外参数{'blog_id': 3}将会被传递给每一个被引用的URL。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 官方文档:URL配置(URLconf)就像Django 所支撑网站的目录。它的本质是URL与要为该URL调用的视图...
    Pope_Li阅读 357评论 0 0
  • 一 Django中路由的作用 URL配置(URLconf)就像Django 所支撑网站的目录。它的本质是URL与要...
    乔治大叔阅读 373评论 0 1
  • python django官方文档地址:https://docs.djangoproject.com/zh-han...
    漓江塔塔主阅读 1,313评论 0 0
  • URL是Web服务的入口,用户通过浏览器发送过来的任何请求,都是发送到一个指定的URL地址,然后被响应。在Djan...
    汪菲宇阅读 745评论 0 0
  • Django路由系统 URL调度器Django 允许自由地设计你的URL,不受框架束缚。Django认为,对于高质...
    免跪姓黄阅读 338评论 0 2