django路由转发

Posted 2021-01-31 navysummer

一、路由转发

通常，我们会在每个app里，各自创建一个urls.py路由模块，然后从根路由出发，将app所属的url请求，全部转发到相应的urls.py模块中。

例如，下面是Django网站本身的URLconf节选。 它包含许多其它URLconf：

from django.conf.urls import include, url

urlpatterns = [
    # ... 忽略 ...
    url(r‘^community/‘, include(‘django_website.aggregator.urls‘)),
    url(r‘^contact/‘, include(‘django_website.contact.urls‘)),
    # ... 忽略 ...
]

路由转发使用的是include()方法，需要提前导入，它的参数是转发目的地路径的字符串，路径以圆点分割。

注意，这个例子中的正则表达式没有包含$（字符串结束匹配符），但是包含一个末尾的斜杠。 每当Django 遇到include()（来自django.conf.urls.include()）时，它会去掉URL中匹配的部分并将剩下的字符串发送给include的URLconf做进一步处理，也就是转发到二级路由去。

另外一种转发其它URL模式的方式是使用一个url()实例的列表。 例如，下面的URLconf：

from django.conf.urls import include, url

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

extra_patterns = [
    url(r‘^reports/$‘, credit_views.report),
    url(r‘^reports/(?P<id>[0-9]+)/$‘, credit_views.report),
    url(r‘^charge/$‘, credit_views.charge),
]

urlpatterns = [
    url(r‘^$‘, main_views.homepage),
    url(r‘^help/‘, include(‘apps.help.urls‘)),
    url(r‘^credit/‘, include(extra_patterns)),
]

在此示例中，/credit/reports/URL将由credit_views.report()视图处理。这种做法，相当于把二级路由模块内的代码写到根路由模块里一起了，不是很推荐。

再看下面的URLconf：

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

urlpatterns = [
    url(r‘^(?P<page_slug>[w-]+)-(?P<page_id>w+)/history/$‘, views.history),
    url(r‘^(?P<page_slug>[w-]+)-(?P<page_id>w+)/edit/$‘, views.edit),
    url(r‘^(?P<page_slug>[w-]+)-(?P<page_id>w+)/discuss/$‘, views.discuss),
    url(r‘^(?P<page_slug>[w-]+)-(?P<page_id>w+)/permissions/$‘, views.permissions),
]

上面的路由写得不好，我们可以改进它，只需要声明共同的路径前缀一次，并将后面的部分分组转发：

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

urlpatterns = [
    url(r‘^(?P<page_slug>[w-]+)-(?P<page_id>w+)/‘, include([
        url(r‘^history/$‘, views.history),
        url(r‘^edit/$‘, views.edit),
        url(r‘^discuss/$‘, views.discuss),
        url(r‘^permissions/$‘, views.permissions),
    ])),
]

这样就优雅多了，也清爽多了，但前提是你要理解这种做法。

二、捕获参数

被转发的URLconf会收到来自父URLconf捕获的所有参数，看下面的例子：

# In settings/urls/main.py
from django.conf.urls import include, url

urlpatterns = [
    url(r‘^(?P<username>w+)/blog/‘, include(‘foo.urls.blog‘)),
]

# In foo/urls/blog.py
from django.conf.urls import url
from . import views

urlpatterns = [
    url(r‘^$‘, views.blog.index),
    url(r‘^archive/$‘, views.blog.archive),
]

在上面的例子中，捕获的"username"变量将被传递给include()指向的URLconf，再进一步传递给对应的视图。

三、嵌套参数

正则表达式允许嵌套参数，Django将解析它们并传递给视图。当反查时，Django将尝试填满所有外围捕获的参数，并忽略嵌套捕获的参数。 考虑下面的URL模式，它带有一个可选的page参数：

from django.conf.urls import url

urlpatterns = [
    url(r‘blog/(page-(d+)/)?$‘, blog_articles),                  # bad
    url(r‘comments/(?:page-(?P<page_number>d+)/)?$‘, comments),  # good
]

两个模式都使用嵌套的参数，其解析方式是：例如blog/page-2/将匹配page-2/并带有两个位置参数blog_articles和2。第二个comments的模式将匹配page_number并带有一个值为2的关键字参数comments/page-2/。这个例子中外围参数是一个不捕获的参数(?:...)。

blog_articles视图需要最外层捕获的参数来反查，在这个例子中是comments或者没有参数，而page-2/可以不带参数或者用一个page_number值来反查。

四、向视图传递额外的参数

URLconfs具有一个钩子（hook），允许你传递一个Python字典作为额外的关键字参数给视图函数。

像这样：

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

urlpatterns = [
    url(r‘^blog/(?P<year>[0-9]{4})/$‘, views.year_archive, {‘foo‘: ‘bar‘}),
]

在上面的例子中，对于/blog/2005/请求，Django将调用views.year_archive(request, year=‘2005‘, foo=‘bar‘)。理论上，你可以在这个字典里传递任何你想要的传递的东西。但是要注意，URL模式捕获的命名关键字参数和在字典中传递的额外参数有可能具有相同的名称，这会发生冲突，要避免。

五、传递额外的参数给include()

类似上面，也可以传递额外的参数给include()。参数会传递给include指向的urlconf中的每一行。

例如，下面两种URLconf配置方式在功能上完全相同：

配置一：

# main.py
from django.conf.urls import include, url

urlpatterns = [
    url(r‘^blog/‘, include(‘inner‘), {‘blogid‘: 3}),
]

# inner.py
from django.conf.urls import url
from mysite import views

urlpatterns = [
    url(r‘^archive/$‘, views.archive),
    url(r‘^about/$‘, views.about),
]

配置二：

# main.py
from django.conf.urls import include, url
from mysite import views

urlpatterns = [
    url(r‘^blog/‘, include(‘inner‘)),
]

# inner.py
from django.conf.urls import url

urlpatterns = [
    url(r‘^archive/$‘, views.archive, {‘blogid‘: 3}),
    url(r‘^about/$‘, views.about, {‘blogid‘: 3}),
]

注意，只有当你确定被include的URLconf中的每个视图都接收你传递给它们的额外的参数时才有意义，否则其中一个以上视图不接收该参数都将导致错误异常。