Django 路由配置详解:从 URLconf 到 Path 转换器

周末不加班
周末不加班
发布时间:2026-10-13| 6人浏览过
原创

本文深入解析 Django 路由机制,涵盖 URLconf 映射原理、正则表达式与有名分组的用法差异、路由分发与命名空间解决冲突策略,以及 Django 2.0 引入的 path 函数和自定义转化器。通过代码示例说明如何优化 URL 结构并实现反向解析,帮助开发者构建清晰、可维护的 Web 应用路由系统。

Django路由配置基础

一 Django中路由的作用

URL配置(URLconf)构成了Django网站的结构目录。其核心在于建立URL与对应视图函数之间的映射关系,通过这种配置,开发者明确指示Django在接收到特定客户端请求时,应调用哪段业务逻辑代码进行处理。

典型的例子:


from django.urls import path

urlpatterns = [
  path('articles', views.special),
]

当路由配置为articles时,它对应视图函数中的special方法。用户在浏览器访问该链接,系统便会响应并执行special函数。

或者

URL配置(URLconf)如同网站的目录结构,本质是URL与视图函数的映射表。通过这种方式,开发者告知Django针对不同的URL调用相应的代码段,实现请求与处理逻辑的精准匹配。


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

参数说明:

包含四个关键部分:一个正则表达式字符串用于匹配URL;一个可调用对象,通常为视图函数或指定视图路径的字符串;可选的默认参数字典,用于传递给视图函数;以及一个可选的name参数,用于命名该路由。

二 简单的路由配置


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

注意:

  • 若需从URL中捕获特定值,只需在正则表达式中使用一对圆括号包裹目标部分。
  • 无需在正则表达式前添加前导反斜杠,因为每个URL本身已包含路径前缀。例如,应使用^articles而非^/articles。
  • 正则表达式前的'r'为可选字符,但强烈建议添加。它标识该字符串为“原始字符串”,确保Python不会对字符串内的任何字符进行转义处理,避免正则语法冲突。

示例:

一些请求的例子:

  • /articles/2005/03/ 请求将匹配列表中的第三个模式。Django 将调用函数views.month_archive(request, '2005', '03')。
  • /articles/2005/3/ 不匹配任何URL 模式,因为列表中的第三个模式要求月份应该是两个数字。
  • /articles/2003/ 将匹配列表中的第一个模式不是第二个,因为模式按顺序匹配,第一个会首先测试是否匹配。请像这样自由插入一些特殊的情况来探测匹配的次序。
  • /articles/2003 不匹配任何一个模式,因为每个模式要求URL 以一个反斜线结尾。

/articles/2003/03/03/ 将匹配最后一个模式。Django 将调用函数views.article_detail(request, '2003', '03', '03')。

有名分组与参数传递

三 有名分组

上述示例采用简单的无名正则表达式组(圆括号)来捕获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')。

在实际应用中,这意味你的URLconf 会更加明晰且不容易产生参数顺序问题的错误 —— 你可以在你的视图函数定义中重新安排参数的顺序。当然,这些好处是以简洁为代价;

路由分发与反向解析

四 路由分发


#主urls
from django.urls import path,re_path,include
from app01 import views

urlpatterns = [

  # re_path(r'^app01/',include('app01.urls')),#行
  # re_path(r'^app01/&',include('app01.urls')),#不行
  # path('app01/',include('app01.urls')),#行
  # path('app01',include('app01.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')

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

2 在视图函数中:

2.1 url=reverse('test')

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

当命名你的URL 模式时,请确保使用的名称不会与其它应用中名称冲突。如果你的URL 模式叫做comment,而另外一个应用中也有一个同样的名称,当你在模板中使用这个名称的时候不能保证将插入哪个URL。在URL 名称中加上一个前缀,比如应用的名称,将减少冲突的可能。我们建议使用myapp-comment 而不是comment。

命名空间解决冲突

六 名称空间

命名空间(英语:Namespace)是表示标识符的可见范围。一个标识符可在多个命名空间中定义,它在不同命名空间中的含义是互不相干的。这样,在一个新的命名空间中可定义任何标识符,它们不会与任何已有的标识符发生冲突,因为已有的定义都处于其它命名空间中。

由于name没有作用域,Django在反解URL时,会在项目全局顺序搜索,当查找到第一个name指定URL时,立即返回

我们在开发项目时,会经常使用name属性反解出URL,当不小心在不同的app的urls中定义相同的name时,可能会导致URL反解错误,为了避免这种事情发生,引入了命名空间。

创建一个app02:python manage.py startapp app02

总urls.py


from django.urls import path,re_path,include
urlpatterns = [
  path('app01/', include('app01.urls')),
  path('app02/', include('app02.urls'))
]

app01 的urls.py


from django.urls import path,re_path
from app01 import views
urlpatterns = [
  re_path(r'index/',views.index,name='index'),
]

app02 的urls.py


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

urlpatterns = [
  re_path(r'index/', views.index,name='index'),

]

app01的视图函数


def index(request):
  url=reverse('index')
  print(url)
  return HttpResponse('index app01')

app02的视图函数


def index(request):
  url=reverse('index')
  print(url)
  return HttpResponse('index app02')

这样都找index,app01和app02找到的都是app02的index

如何处理?在路由分发的时候指定名称空间

总urls.py在路由分发时,指定名称空间


 path('app01/', include(('app01.urls','app01'))),
 path('app02/', include(('app02.urls','app02')))

url(r'app01/',include('app01.urls',namespace='app01')),
 url(r'app02/',include('app02.urls',namespace='app02'))

 url(r'app01/',include(('app01.urls','app01'))),
 url(r'app02/',include(('app02.urls','app02')))

在视图函数反向解析的时候,指定是那个名称空间下的


 url=reverse('app02:index')
 print(url)
 url2=reverse('app01:index')
 print(url2)

在模版里:


<a href="{% url 'app02:index'%}" rel="external nofollow" >哈哈</a>

Django 2.0 Path与转化器

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

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

免责声明:本文内容仅供参考,不代表本站观点。转载或引用请注明出处。

Python 相关产品和应用

全部下载
Selenium

Selenium

4.51.0 · Windows

用于浏览器自动化和 Web 测试的 Python 工具。

scikit-learn

scikit-learn

1.9.1 · Windows

常用 Python 机器学习算法与模型评估工具库。

Black

Black

26.10.1 · Windows

强调一致性的 Python 自动代码格式化工具。

Ruff

Ruff

0.17.1 · macOS

由 Rust 编写的高速 Python 代码检查和格式化工具。

pytest

pytest

9.1.1 · Windows

简洁而强大的 Python 自动化测试框架。

FastAPI

FastAPI

0.146.0 · Windows

高性能 Python API 框架,支持类型提示和自动接口文档。

Flask

Flask

3.1.3 · Windows

轻量灵活的 Python Web 应用框架。

Django

Django

6.1.2 · Windows

成熟的 Python Web 框架,适合构建内容站点和业务系统。

Spyder

Spyder

6.1.7 · Windows

面向科学计算与数据分析的 Python 集成开发环境。

SciPy

SciPy

1.18.1 · Windows

面向科学、工程和技术计算的 Python 算法库。