Django路由系统详解：从URLconf到Path转化器

一、Django中路由的作用

URL配置（URLconf）构成了Django支撑网站的核心目录结构。其本质在于建立URL字符串与对应视图函数之间的映射关系表。

通过这种配置方式，开发者明确指示Django：当请求特定URL时，应执行对应的代码逻辑；请求另一URL时，则执行另一段代码。

from django.conf.urls import url

urlpatterns = [
   url(正则表达式, views视图函数，参数，别名),
]

自Django 2.0版本起，路由系统采用了新的配置写法（参考官方文档）：

from django.urls import path

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是一个函数，包含四个参数：第一个参数接收正则表达式字符串；第二个参数接收视图函数的内存地址；第三个参数用于传递默认参数字典；第四个参数指定路由的别名。

正则表达式：一个定义匹配规则的正则表达式字符串。

views视图函数：一个可调用对象，通常指向具体的视图函数，或者指定视图函数路径的字符串。

参数：可选传递的默认参数字典，用于传递给视图函数。

别名：可选的name参数，用于反向解析URL。

简单的路由配置

from django.urls import path,re_path

from app01 import views

urlpatterns = [
re_path(r'^articles/2003/$', views.special_case_2003),
re_path(r'^articles/([0-9]{4})/$', views.year_archive),
re_path(r'^articles/([0-9]{4})/([0-9]{2})/$', views.month_archive),
re_path(r'^articles/([0-9]{4})/([0-9]{2})/([0-9]+)/$', views.article_detail),
]

1、urlpatterns列表中的元素按书写顺序从上至下逐一匹配正则表达式，一旦匹配成功即停止后续匹配。

2、若需从URL中捕获数值，只需在正则表达式中使用一对圆括号进行分组匹配。

3、正则表达式无需添加前导反斜杠，因为每个URL本身已包含路径前缀。例如，应使用^articles而非^/articles。

4、每个正则表达式前的'r'为可选标识，但建议保留以避免转义字符带来的潜在问题。

一些请求的例子

注意：

# 控制是否开启URL访问地址末尾非/自动跳转至带/路径的配置项

APPEND_SLASH=True

Django的settings.py配置文件中默认未显式包含APPEND_SLASH参数，但系统默认其值为APPEND_SLASH = True。该设置的作用是自动在网址末尾追加'/'。

其具体效果表现为：

我们在urls.py中定义了相关路由：

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

urlpatterns = [
    url(r'^blog/$', views.blog),
]

当访问 http://www.example.com/blog 时，系统默认会将网址自动转换为 http://www.example/com/blog/ 。

若在settings.py中设置APPEND_SLASH=False，此时再次请求 http://www.example.com/blog 则会提示页面未找到。

二、路由的分组

上述示例使用了简单的、未命名的正则表达式组（通过圆括号）来捕获URL中的值，并以位置参数形式传递给视图。在更高级的应用场景中，可以使用命名的正则表达式组来捕获URL中的值，并以关键字参数形式传递给视图。在Python正则表达式中，命名正则表达式组的语法为(?P<name>pattern)，其中name是组的名称，pattern是要匹配的模式。以下是上述URLconf使用命名组的重写版本：

from django.urls import path,re_path

from app01 import views

urlpatterns = [
re_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<day>[0-9]{2})/$', views.article_detail),
]

此实现与前面的示例功能完全一致，唯一的细微差别在于：捕获的值作为关键字参数而非位置参数传递给视图函数。例如：

/articles/2005/03/ 请求将调用views.month_archive(request, year='2005', month='03')函数，而不是views.month_archive(request, '2005', '03')。 /articles/2003/03/03/ 请求将调用函数views.article_detail(request, year='2003', month='03', day='03')。 conclusion：

路由的无名分组

url(r'^test2/(\d+)/(\w+)$', views.test2),

无名分组解析出几个值，视图函数就必须接收几个值（以位置参数形式传入）。

路由的有名分组

url(r'^test3/(?P<id>\d+)/(?P<name>\w+)$', views.test3),

有名分组解析出几个值，视图函数就必须接收几个值（按关键字传入，参数顺序可以打乱）。

有名分组和无名分组不能混合使用。

三、路由分发

Django1.1版本的分发方式

from django.conf.urls import url,include

#主urls
from django.urls import path,re_path,include
from app01 import views
from app01 import urls
urlpatterns = [ 
　　# re_path(r'^app01/',include('app01.urls')),#行
　　# re_path(r'^app01/&',include('app01.urls')),#不行
　　# path('app01/',include('app01.urls')),#行　
　　#path('app01/', include(urls)),
]

在app01应用目录下创建一个urls文件

from django.urls import path,re_path
from app01 import views
urlpatterns = [
  re_path(r'^test/(?P<year>[0-9]{2})/$',views.url_test),
]

四、反向解析

在使用Django项目时，常见需求是获取URL的最终形式，以便嵌入到生成的内容中（如视图中显示给用户的URL）或用于处理服务器端导航（如重定向等）。强烈建议避免硬编码这些URL（这既费力又不可扩展且易出错），也不应设计与URLconf无关的专门URL生成机制，因为这容易导致URL过期。

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

在模板中：使用url模板标签。

在Python代码中：使用from django.urls import reverse()函数

urls.py

from django.urls import path,re_path
from app01 import views
urlpatterns = [
  re_path(r'^test/(?P<year>[0-9]{2})/(?P<month>[0-9]{2})/$',views.url_test,name='test'),
]

html

<a href="{% url 'test' 10 23 %}" rel="external nofollow" >哈哈</a>

视图函数中：

from django.shortcuts import render, HttpResponse,redirect,reverse
def url_test(request,year,month):
  print(year)
  print(month)
  url=reverse('test',args=(10,20))
  print(url)
  return HttpResponse('ok')

conclusion：

1 在html代码里{% url "别名" 参数 参数%}

2 在视图函数中：

2.1 url=reverse('test')

2.2 url=reverse('test',args=(10,20))

当命名你的URL模式时，请确保使用的名称不会与其他应用中的名称冲突。如果你的URL模式名为comment，而另一个应用中也有同名，当在模板中使用该名称时，无法保证插入的是哪个URL。建议在URL名称前加上应用名称前缀，如myapp-comment，以减少冲突可能性。

五、名称空间

命名空间（Namespace）用于表示标识符的可见范围。一个标识符可在多个命名空间中定义，其在不同命名空间中的含义互不相干。这样，在新命名空间中可定义任何标识符，它们不会与已有标识符发生冲突，因为已有定义处于其他命名空间中。由于name属性没有作用域，Django在反解URL时，会在项目全局顺序搜索，一旦找到第一个name指定的URL便立即返回。在开发项目中，我们经常使用name属性反解URL。若不小心在不同app的urls中定义了相同的name，可能导致URL反解错误。为避免此类问题，引入了命名空间机制。

project的urls.py:

urlpatterns = [
re_path(r'^admin/', admin.site.urls),
re_path(r'^app01/', include("app01.urls",namespace="app01")),
re_path(r'^app02/', include("app02.urls",namespace="app02")),
]

app01.urls:

urlpatterns = [ re_path(r'^index/', index,name="index"), ]

app02.urls:

urlpatterns = [ re_path(r'^index/', index,name="index"), ]

app01.views

from django.core.urlresolvers import reverse def index(request): return HttpResponse(reverse("app01:index"))

app02.views

from django.core.urlresolvers import reverse def index(request): return HttpResponse(reverse("app02:index"))

六、django2.0版的path

django2.0的re_path和1.0的url功能一致

思考情况如下：

urlpatterns = [ 
  re_path('articles/(?P<year>[0-9]{4})/', year_archive), 
  re_path('article/(?P<article_id>[a-zA-Z0-9]+)/detail/', detail_view), 
  re_path('articles/(?P<article_id>[a-zA-Z0-9]+)/edit/', edit_view), 
  re_path('articles/(?P<article_id>[a-zA-Z0-9]+)/delete/', delete_view), 
]

考虑下这样的两个问题：

第一个问题，函数 year_archive 中year参数是字符串类型的，因此需要先转化为整数类型的变量值，当然year=int(year) 不会有诸如如TypeError或者ValueError的异常。那么有没有一种方法，在url中，使得这一转化步骤可以由Django自动完成？

第二个问题，三个路由中article_id都是同样的正则表达式，但是你需要写三遍，当之后article_id规则改变后，需要同时修改三处代码，那么有没有一种方法，只需修改一处即可？

在Django2.0中，可以使用 path 解决以上的两个问题。

基本示例

这是一个简单的例子：

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>/', views.article_detail), 
　　# path才支持，re_path不支持
　　path('order/<int:year>',views.order),
]

基本规则：

• 使用尖括号(<>)从url中捕获值。
• 捕获值中可以包含一个转化器类型（converter type），比如使用 <int:name> 捕获一个整数变量。若果没有转化器，将匹配任何字符串，当然也包括了 / 字符。
• 无需添加前导斜杠。

以下是根据 2.0官方文档 而整理的示例分析表：(跟上面url的匹配关系)

path转化器

文档原文是Path converters，暂且翻译为转化器。

Django默认支持以下5个转化器：

• str,匹配除了路径分隔符（/）之外的非空字符串，这是默认的形式
• int,匹配正整数，包含0。
• slug,匹配字母、数字以及横杠、下划线组成的字符串。
• uuid,匹配格式化的uuid，如 075194d3-6885-417e-a8a8-6c931e272f00。
• path,匹配任何非空字符串，包含了路径分隔符（/）（不能用？）

注册自定义转化器

对于一些复杂或者复用的需要，可以定义自己的转化器。转化器是一个类或接口，它的要求有三点：

• regex 类属性，字符串类型
• to_python(self, value) 方法，value是由类属性 regex 所匹配到的字符串，返回具体的Python变量值，以供Django传递到对应的视图函数中。
• to_url(self, value) 方法，和 to_python 相反，value是一个具体的Python变量值，返回其字符串，通常用于url反向引用。

比如：

class FourDigitYearConverter: 
  regex = '[0-9]{4}' 
  def to_python(self, value): 
    return int(value) 
  def to_url(self, value): 
    return '%04d' % value

使用register_converter 将其注册到URL配置中：

from django.urls import register_converter, path 
from . import converters, views 
register_converter(converters.FourDigitYearConverter, 'yyyy') 
urlpatterns = [ 
  path('articles/2003/', views.special_case_2003), 
  path('articles/<yyyy:year>/', views.year_archive), 
  ... 
]

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持本站。