Django路由系统

发表于 更新于 分类于 ， ， Changyan： 本文字数： 2.5k 阅读时长 ≈ 9 分钟

简洁优雅的URL结构是高质量Web应用程序的象征。Django允许开发人员设计任何形式的URL，这在早期的网站中是不可想象的。早期的网站通常会有很长的一串URL，而且通常U虹还会包括一些无用信息，如.aspx、.php等。
为了给应用程序设计URL，开发人员需要开发一个Python模块，这个模块就是URL的配置信息，通常我们将这个配置模块叫作URLconf.。这个模块是一个纯粹的Python脚本，它包含了URL表达式与Python方法之间的映射，这里的Python方法就是Django应用中的视图方法。前面示例中的mysite/urls.py和polls/urls.py就是两个URLconf实例。

Django处理HTTP请求的流程

当用户发起一个HTTP请求时，Django就会按照以下逻辑对请求进行处理：

  1. 确定URL根配置位置，通常URL根配置在ROOT_URLCONF中设置。
  2. 加载配置信息，在配置信息中查找urlpatterns。
  3. 按顺序检索urlpatterns中的所有URL模式字符串，井定位在第一个与URL匹配的URL模式字符串。
  4. 当检索到匹配的URL模式字符串后，调用对应的视图方法，并传递以下参数给视图方法：
    • 一个HttpRequest对象实例。
    • 如果匹配的URL模式字符串不包含任何组，那么匹配的信息会作为位置参数传递给视图。
    • 如果URL模式字符串中的参数给定了参数名，那么匹配的信息会作为命名参数传递给视图。
  5. 如果在URLconf中没有找到任何匹配的URL模式字符串，或者出现其他任何错误，Django将会调用一个用于处理错误信息的视图。

URLconf 示例

下面是一个URLconf 的简单示例。

1
2
3
4
5
6
7
8
9
10
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),
]

示例解读：

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

应用场景：

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

URL参数类型转化器

前面提到可以使用int对捕捉到的URL参数进行类型转换，下面是Django支持的所有类型转换器。

  • str：匹配任意非空字符串，但是不能匹配URL分隔符“／”。这是默认的URL参数转换器。
  • int：匹配任意大于等于0的整数。
  • slug：匹配任意slug字符串，slug字符串可以包含任意ASCII字符、数字、连字符“－”和下画线”_”
  • uuid：匹配UUID字符串（字符串中的字母必须为小写字－母），例如：075l94d3-6885-4l7e-a8a8-6c93le272tDO。
  • path：匹配任意非空字符串，包括URL分隔符“／”。这允许匹配完整的URL而不是URL的一个片段。

自定义URL参数类型转化器

对于更加复杂的URL场景，开发人员可以开发自定义参数类型转换器，自定义参数类型转换器包括以下几部分：

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

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

1
2
3
4
5
6
7
8
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。

1
2
3
4
5
6
7
8
9
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'),
]

创建视图：

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

此时目录结构如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
polls/
    __init__. py
    admin.py
apps.py
converters/
    __init__.py
    FourDigitYearConverter.py
    migrations/
        __init__.py
    statics/
    templates/
    models.py
    tests.py
views.py

启动Web 服务

访问URL:127.0.0.1:8000/polls/2017/即可看到页面输出：2017

使用正则表达式

与Django1.x一样，Django2.0仍然可以使用正则表达式匹配URL，此时需要使用re_path()方法而不是path()。
Python的正则表达式支持对分组进行命名，语法格式为：(?P<name>pattern)，其中name为分组名，pattern为匹配的正则表达式。
使用正则表达式对前面的URLconf进行重写效果如下：

1
2
3
4
5
6
7
8
9
10
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),
]

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

1
re_path(r’comments/(?P<page－number>\d+)/)?$’, comments)

导入其他URLconf

对于现代Web 应用程序来说，一个工程下通常会包含多个应用程序，每个应用程序包含很多URL ，如果将这些URL都写在URLconf 根模块中，那么URLconf 将会变得非常脚肿，不利于维护。对于这种情况，常用的解决办法就是为每一个应用程序写一套独立的URLconf，而URLconf根模块通过使用include()方法将其他URLconf引用进来。
下面是Polls 网站的mysite/urls.py:

1
2
3
4
5
6
from django.contrib import admin
from django.urls import include, path
urlpatterns = [
    path('polls/', include('polls.urls')),
    path('admin/', admin.site.urls),
]

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

1
2
3
4
5
6
7
8
9
10
11
12
13
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/', creditviews.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_pattems 中的URL 都是以credit 开头，可以简化URL 模式字符串。

向视图传递额外参数

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

1
2
3
4
5
from django.urls import path
from . import views
urlpatterns = [
	path ("blog/<int:year>/", views.year_archive, {'foo':'bar'}),
]

也可以向include()方法传递额外参数，例如：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# main.py
from django.urls import include, path

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

# inner.py
from django.urls import path
from mysite import views

urlpattern = [
	path('archive/', views.archive),
	path('about/', views.about),
]

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

动态生成url

在网页应用中，很多情况下需要动态编写URL，而不是用户直接在浏览器中输入URL，例如网页超链接的URL需要在生成网页时固定好。

用以下URL模式字符串为例，看看如何在Django模板和视图中动态生成URL：

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

  1. 使用url标签在模板中动态生成URL

    1
    2
    3
    4
    5
    6
    7
    {# 使用固定值参数： #}
    <a href="{% url 'new-year-archive' 2012 %}">2012 Archive</a>
    <ul>
    {% for yearvar in year_list %}
    <li><a href = "{% url 'new-year-archive' yearvar %}">{{ yearvar }}Archive</a></li>
    {% endfor %}
    </ul>

  2. 使用reverse()方法在python代码中生成url

    1
    2
    3
    4
    5
    6
    from django.urls import reverse
    from django.http import HttpResponseRedirect

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

URL名字和命名空间

给URL命名，可以方便地在模板或Python代码中使用URL，如前面示例中分别在模板和Python代码中使用了URL的名字'news-year-archive'。
URL命名空间用于将URL进行隔离。应用程序名就可以作用URL的命名空间，例如django.contrib.admin的命名空间就是admin。由于Django的应用程序可以部署多次，所以应用程序的实例名也可以作为命名空间。
使用”命名空间名：URL名“的方式调用URL。命名空间可以嵌套使用如"命名空间名l：命名空间名2:URL名"。

  1. 定义命名空间

    在URLconf模块中使用appname属性声明命名空间，例如：
1
2
3
4
5
6
7
8
from django.urls import path

from . import views

app_name = 'polls'
urlpatterns = [
	...
]

或者直接在urlpatterns中定义命名空间：

1
2
3
4
5
6
7
8
9
10
11
12
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)),
]

上面polls_patterns是一个元组，元组的第一个参数是path()或re_path()列表，第二个参数是URL的namespace。当使用include()方法引用polls_patterns时系统会自动为polls_patterns中的所有URL添加namespace。

  1. 在其他URLconf中使用命名空间

1
2
3
4
5
from django.urls import include, path

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

  1. 在模板文件中使用命名空间

1
{% url 'polls:index' %}

  1. 在python代码中使用命名空间

1
return HttpResponseRedirect(reverse('polls:results', args=(question.id,)))