django URLconf调度程序

路由的编写方式是Django2.0和1.11最大的区别所在，Django官方迫于压力和同行的影响，不得不将原来的正则匹配表达式，改为更加简单的path表达式，但依然通过re_path()方法保持对1.x版本的兼容

URL是web服务的入口，用户通过浏览器发送过来的任何请求，都会发送到一个指定的URL地址，然后被响应

在Django项目中编写路由，就是向外暴露我们接收哪些URL的请求，django奉行DRY主义，提倡使用简洁、优雅的URL，没有.php这种后缀，它可以让你随心所欲的设计你的URL，不受框架束缚。

1、概述

URL路由在django项目中的体现就是urls.py文件，这个文件可以有很多个，但不能在同一目录下，实际上django提倡项目有个根urls.py，每个app下分别有自己的urls.py，集中又分治，是一种解耦的模式

在新建一个django项目后，默认会自动为我们创建一个urls.py文件，它会默认创建一个admin后台的URL

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

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

2、Django如何处理请求

当用户请求一个页面时，django根据下面的逻辑执行操作：

（1）决定要使用的根URLconf模块，通常这是ROOT_URLCONF设置的值，但是如果传入的HttpRequest对象具有urlconf属性（由中间件设置），则其值将被用于代替ROOT_URLCONF设置，通俗的讲就是你可以自定义项目入口url是哪个文件

（2）加载该模块并寻找可用的urlpatterns，它是django.urls.path()或django.urls.re_path实例的一个列表

（3）依次匹配每个URL模式，在与亲求的URL相匹配的第一个模式停下来，也就是说，url匹配是从上往下的短路操作，所以url在列表中的位置非常关键

（4）导入并调用匹配行中给定的视图，该视图是一个简单的python函数django中被称为视图函数，或基于类的视图，视图讲获得如下参数：

• 一个HttpRequest实例
• 如果匹配的表达式返回了未命名的组，那么匹配的内容讲作为位置参数提供给视图
• 关键字参数由表达式匹配的命名组组成，但是可以被django.urls.path()的可选参数kwargs覆盖

（5）如果没有匹配到任何表达式，或者过程中抛出异常，讲调用一个适当的错误处理视图

3、path转换器

下面是一个简单的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('articles/<int:year>/<int:month>/<slug:slug>/', views.article_detail),
]

注意：

• 要捕获一段url中的值，需要使用尖括号
• 可用转换捕获到的值为指定类型，如例子中的int，默认情况下捕获到的结果保存为字符串类型，不包含/这个特殊字符
• 匹配模式的开头不需要添加斜杠“/”，因为默认情况下，每个url都带一个最前面的“/"

上面示例匹配例子：

• /articles/2005/03/ 将匹配第三条，并调用views.month_archive(request,year=2005,month=3)
• /articles/2003/ 将匹配第一条，并调用views.special_case_2004(request)
• /articles/2003 将一条都匹配不上，因为它最后少了一个斜杠，而每个模式都要求URL以斜杠结尾
• /articles/2003/03/building-a-django-site/ 将匹配最后一个，并调用views.article_detail(request,year=2003,month=3,slug="building-a-django-site")

每当urls.py文件被第一次加载的时候，urlpatterns里的表达式都将被预编译，这会大大提高系统处理路由的速度。

默认情况下，Django内置下面的路径转换器：

• str：匹配任何非空字符串，但不含斜杠/，如果你没有指定转换器，那么这个是默认使用的
• int：匹配零和正整数，返回一个int类型
• slug：匹配由ASCII字母或数字组成的任何slug字符串，以及连接符和下划线，如：building-your-1st-django-site
• uuid：匹配一个uuid格式的对象，为防止冲突，规定必须使用破折号，所有字母必须为小写，如：075194d3-6885-417e-a8a8-6c931e272f00 返回一个UUID对象
• path：匹配任何非空字符串，重点是可以包含路径分隔符‘/’，这个转换器可以帮助你匹配整个url

4、自定义path转换器

对于更复杂的匹配要求，可以自定义路径转换器

自定义转换器必须是一个包含以下内容的类：

• regex的类属性，一个字符串形式的正则表达式属性
• to_python(self,value)方法，一个用来将匹配到的字符串转换为你想要的那个数据类型，并传递给视图函数，如转换失败则valueError异常
• to_url(self,value)方法，将python数据类型转换为一段urld 方法，上面方法的反向操作

例如：新建一个converters.py文件，与urlconf属同一个目录，写入下面的类：

class FourDigitYearConverter:
    regex = '[0-9]{4}'

    def to_python(self, value):
        return int(value)

    def to_url(self, value):
        return '%04d' % value

写完类后，在URLconf中使用register_converter()注册自定义转换器类并使用它：

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),
    ...
]

5、使用正则表达式

django2.0的URL虽然改‘配置’了，但它依然向老版本兼容，而这个兼容的方法就是用re_path()方法代替path()方法，re_path()方法根本就是以前的url()方法，只不过导入的位置变了

在python正则表达式中，命名正则表达式的语法是（?P<name>pattern），name是组的名称，而pattern是要匹配的模式

这是上面的示例，使用正则表达式重写：

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),
]

与上面path()方法不同的在于两点：

year中匹配不到10000等非四位数字，这是正则表达式决定的

传递给视图的所有参数都是字符串类型，而path()方法可以指定转换成某种类型，在视图中接收参数时一定要小心

请求的URL被看做是一个普通的python字符串，URLconf在其中查找并匹配，进行匹配是将不包括GET或POST方式的参数及域名，URLconf不检查使用何种HTTP请求方法，所有请求方法POST、GET、HEAD等都将路由到同一个视图，在视图中才根据具体请求方法的不同，进行不同的处理。

6、指定视图参数的默认值

有一个方便的小技巧，我们可以指定视图参数的默认值，下面是一个URLconf和视图的示例：

# URLconf
from django.urls import path

from . import views

urlpatterns = [
    path('blog/', views.page),
    path('blog/page<int:num>/', views.page),
]

# View (in blog/views.py)
def page(request, num=1):
    # Output the appropriate page of blog entries, according to num.
    ...

在上面的例子中，两个URL模式指向同一个视图views.page，但是第一个模式不会从URL中捕获任何值，如果第一个模式匹配，page()函数将使用num参数的默认值1，如果第二个模式匹配，page()讲使用捕获的num值

7、自定义错误页面

当django找不到与请求匹配的URL时，或者当抛出一个异常时，将调用一个错误处理视图，django默认的自带的错误视图包括400、403、404、和500，分别表示请求错误、拒绝服务、页面不存在和服务器错误，他们分别位于：

handler400 —— django.conf.urls.handler400
handler403 —— django.conf.urls.handler403
handler404 —— django.conf.urls.handler404
handler500 —— django.conf.urls.handler500

这些值可以在根URLconf中设置，在其他app中的二级URLconf中设置这些变量无效

django有内置的HTML模版，用于返回错误页面给用户，但是这些页面很简陋，通常我们都自定义错误页面

首先在根URLconf中额外增加下面的条目，并导入views模块：

from django.contrib import admin
from django.urls import path
from app import views

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

# 增加的条目
handler400 = views.bad_request
handler403 = views.permission_denied
handler404 = views.page_not_found
handler500 = views.error

然后在app/views.py文件中增加四个处理视图：

def bad_request(request):
    return render(request, '400.html')

def permission_denied(request):
    return render(request, '403.html')

def page_not_found(request):
    return render(request, '404.html')

def error(request):
    return render(request, '500.html')

再根据自己的需求，创建对应的400、403、404、500的HTML四个页面文件就可以了

8、路由转发

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

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

from django.urls import include, path

urlpatterns = [
    # ... snip ...
    path('community/', include('aggregator.urls')),
    path('contact/', include('contact.urls')),
    # ... snip ...
]

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

每当django遇到include()时，它会去掉URL中匹配到的部分并将剩下的字符串发送给include的URLconf做进一步处理，也就是转发到二级路由去

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

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/ URL将由credit_views.report()视图处理，这种做法，相当于把二级路由模块内的代码写到根路由模块里了，不是很推荐。

再看另外一个URLconf示例：

from django.urls import path
from . import views

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

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

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

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

这样就优雅多了，但需要理解这种做法。

9、捕获参数

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

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

urlpatterns = [
    path('<username>/blog/', include('foo.urls.blog')),
]

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

urlpatterns = [
    path('', views.blog.index),
    path('archive/', views.blog.archive),
]

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

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

URLconfs具有一个钩子（hook），允许你传递一个python字典作为额外的关键字参数给视图函数，像下面的这样：

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模式捕获的命名关键字参数和在字典中传递的额外参数有可用具有相同的名称，这会发生冲突，要避免。

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

类似上面的例子，也可以传递额外的参数给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}),
]

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

12、反向解析URL

在实际的django项目中，经常需要获取某条URL，为生成的内容配置URL链接，比如，我要在页面上展示一列文件列表，每个条目都是一个超级链接，点击就进入该文章的详细页面。

现在我们的URLconf是这么配置的：

path('post/<int:pk>/'，views.some_view),

在前端中，这就需要为HTML的<a>标签的href属性提供一个诸如http://www.xxx.com/post/3/的值。其中的域名部分，Django会帮你自动添加无须关心，我们关注的是post/3/。

此时，一定不能硬编码URL为post/3/，那样费时、不可伸缩，而且容易出错。试想，如果哪天，因为某种原因，需要将urlconf中的表达式改成entry/<int:pk>/，为了让链接正常工作，必须修改对应的herf属性值，于是你去项目里将所有的post/3/都改成entry/3/吗？显然这是不现实的！

我们需要一种安全、可靠、自适应的机制，当修改URLconf中的代码后，无需在项目源码中大范围搜索、替换失效的硬编码URL。

为了解决这个问题，Django提供了一种解决方案，只需在URL中提供一个name参数，并赋值一个你自定义的、好记的、直观的字符串。

通过这个name参数，可以反向解析URL、反向URL匹配、反向URL查询或者简单的URL反查。

在需要解析URL的地方，对于不同层级，Django提供了不同的工具用于URL反查：

• 在模板语言中：使用url模板标签。(也就是写前端网页时）
• 在Python代码中：使用reverse()函数。（也就是写视图函数等情况时）
• 在更高层的与处理Django模型实例相关的代码中：使用get_absolute_url()方法。(也就是在模型model中)

 先看下面的URLconf示例：

from django.urls import path

from . import views

urlpatterns = [
    #...
    path('articles/<int:year>/', views.year_archive, name='news-year-archive'),
    #...
]

2019年对应的归档URL是/articles/2019/，可以在模版的代码中使用下面的方法获得它们：

<a href="{% url 'news-year-archive' 2012 %}">2012 Archive</a>
{# Or with the year in a template context variable: #}
<ul>
{% for yearvar in year_list %}
<li><a href="{% url 'news-year-archive' yearvar %}">{{ yearvar }} Archive</a></li>
{% endfor %}
</ul>

或者在python代码中这样使用：

在视图函数中使用HttpResponseRedirect重定向，然后通过reverse反向解析name别名的URL和参数

from django.http import HttpResponseRedirect
from django.urls import reverse

def redirect_to_year(request):
    # ...
    year = 2006
    # ...
    return HttpResponseRedirect(reverse('news-year-archive', args=(year,)))

其中，起到核心作用的是我们通过name='news-year-archive'为那条URL起了一个可以被引用的名称。

URL名称name使用的字符串可以包含任何你喜欢的字符，但是过度的放纵有可能带来重名的冲突，比如两个不同的app，在各自的URLconf中为某一条URL取了相同的name，这就会带来麻烦，为了解决这个问题，又引出了下面的命名空间。

13、URL命名空间

URL命名空间可以保证反查到唯一的URL，即使不同的APP使用相同的URL名称

第三方应用始终使用带有命名空间的URL是一个很好的做法，类似地，它还允许你在一个应用有多个实例部署的情况下反查URL，通俗的将，因为一个应用的多个实例共享相同的命名URL，命名空间提供了一种区分这些命名URL的方法。

实现命名空间的做法很简单，在URLconf文件中添加app_name = ‘polls’和namespace = 'author-polls'这种类似的定义。

以前面的polls应用的两个实例为例：‘publisher-polls’和‘author-polls’

假如我们已经在创建和显示投票时考虑了实例命名空间的问题，namespace指定命名空间名，代码如下：

urls.py

from django.urls import include, path

urlpatterns = [
    path('author-polls/', include('polls.urls', namespace='author-polls')),
    path('publisher-polls/', include('polls.urls', namespace='publisher-polls')),
]

polls/urls.py

from django.urls import path

from . import views

app_name = 'polls'
urlpatterns = [
    path('', views.IndexView.as_view(), name='index'),
    path('<int:pk>/', views.DetailView.as_view(), name='detail'),
    ...
]

如果当前的APP实例时其中的一个，列如我们正在渲染实例'author-pools'中的detail视图，'polls:index'将解析到'author-polls'实例的index视图。

根据以上设置，在基于类的视图的方法中，可以使用下面的查询：

reverse('polls:index', current_app=self.request.resolver_match.namespace)

并在模版中使用：

{% url 'polls:index' %}

如果没有当前APP实例，例如如果我们在站点的其他地方渲染一个页面，'pools:index‘将解析到polls注册的最后一个APP实例空间，因为没有默认的实例（命名空间为'pools'的实例），将使用注册的polls的最后一个实例，这是将'publisher-polls'，因为它是在urlpatterns中最后一个声明的。

14、URL命名空间和include的URLconf

可以通过两种方式指定include的URLconf的应用名称空间

第一种：在include的URLconf模块中设置与urlpatterns属性相同级别的app_name属性，必须将实际模块或模块的字符串引用传递到include()，而不是urlpatterns本身的列表。

polls/urls.py

from django.urls import path

from . import views

app_name = 'polls'
urlpatterns = [
    path('', views.IndexView.as_view(), name='index'),
    path('<int:pk>/', views.DetailView.as_view(), name='detail'),
    ...
]

urls.py：

from django.urls import include, path

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

此时，polls.urls中定义的URL将具有应用名称空间polls

第二种：include一个包含嵌套命名空间输的对象，格式如下：

(<list of path()/re_path() instances>, <application namespace>)

实例如下：

from django.urls import include, path

from . import views

polls_patterns = ([
    path('', views.IndexView.as_view(), name='index'),
    path('<int:pk>/', views.DetailView.as_view(), name='detail'),
], 'polls')

urlpatterns = [
    path('polls/', include(polls_patterns)),
]

这将include指定的URL模式到给定的APP命名空间，可以使用include()的namespace参数指定APP实例命名空间，如果未指定，则APP实例命名空间默认为URLconf的APP命名空间。