Django 路由层
一 Django中路由的作用
URL配置(URLconf)就像Django 所支撑网站的目录。它的本质是URL与要为该URL调用的视图函数之间的映射表;你就是以这种方式告诉Django,对于客户端发来的某个URL调用哪一段逻辑代码对应执行
典型的例子:
from django.urls import path urlpatterns = [ path('articles', views.special), ] articles这个路由对应着视图函数中special这个方法,浏览器输入这个链接,就会响应到special这个函数来执行
二 简单的路由配置
from django.conf.urls import url urlpatterns = [ url(正则表达式, views视图函数,参数,别名), ]
- 正则表达式:一个正则表达式字符串
- views视图函数:一个可调用对象,通常为一个视图函数或一个指定视图函数路径的字符串
- 参数:可选的要传递给视图函数的默认参数(字典形式)
- 别名:一个可选的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 这个字符串是“原始的” —— 字符串中任何字符都不应该转义
- urlpatterns中的元素按照书写顺序从上往下逐一匹配正则表达式,一旦匹配成功则不再继续
示例:
''' 一些请求的例子: /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')。 '''
APPEND_SLASH
# 是否开启URL访问地址后面不为/跳转至带有/的路径的配置项 APPEND_SLASH=True
Django settings.py配置文件中默认没有 APPEND_SLASH 这个参数,但 Django 默认这个参数为 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 时就会提示找不到页面。
三 有名分组
import re ret=re.search('(?P<year>[0-9]{4})/([0-9]{2})','2012/12') print(ret.group()) print(ret.group(1)) print(ret.group(2)) print(ret.group('year'))
上面的示例使用简单的、没有命名的正则表达式组(通过圆括号)来捕获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), ]
#捕获到的数据都是str类型
#视图函数里可以指定默认值
url('blog/$', views.blog),
url('blog/?(?P<num>[0-9]{1})', views.blog),
def blog(request,num=1):
print(num)
return HttpResponse('ok')
这个实现与前面的示例完全相同,只有一个细微的差别:捕获的值作为关键字参数而不是位置参数传递给视图函数。例如:
''' /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 会更加明晰且不容易产生参数顺序问题的错误 —— 你可以在你的视图函数定义中重新安排参数的顺序。当然,这些好处是以简洁为代价;
四 路由分发
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), ]
# 在urls.py中: from django.urls import path, re_path from app01 import views # 路由配置: 路径--------->视图函数 urlpatterns = [ path('admin/', admin.site.urls), # 无名分组:捕获的值作为位置参数传递给视图函数 re_path(r'^articles/([0-9]{4})/$', views.year_archive), # year_archive(request,'2009') re_path(r'^articles/([0-9]{4})/([0-9]{2})/$', views.month_archive), # month_archive(request,'2009','12') re_path(r'^articles/([0-9]{4})/([0-9]{2})/([0-9]+)/$', views.article_detail), # month_archive(request,'2009','12','1'),# month_archive(request,'2009','12','13') # 有名分组:捕获的值作为关键字参数传递给视图函数 re_path(r'^articles/(?P<year>[0-9]{4})/$', views.year_archive), # month_archive(request, year='2005') re_path(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/$', views.month_archive), # month_archive(request, year='2005', month='03') re_path(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/(?P<day>[0-9]{2})/$', views.article_detail), # month_archive(request, year='2003', month='03', day='03') ] ## 分发 # 在urls.py中: from django.urls import path, re_path, include urlpatterns = [ path('admin/', admin.site.urls), # 分发 re_path(r"^app01/", include("app01.urls")), re_path(r"^app02/", include("app02.urls")), re_path(r"^", include("app01.urls")), ] ## 分发 from django.conf.urls import url from django.conf.urls import include from django.contrib import admin from api import views api_urlpatterns = [ url(r'login/', views.LoginApi.as_view()), url(r'auth/', views.AuthApi.as_view()), url(r'jwt_auth/', views.JwtAuth.as_view()) ] urlpatterns = [ url(r'^admin/', admin.site.urls), url(r'api/', include(api_urlpatterns)), ]
五 反向解析
在使用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 %}">哈哈</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
。
# 在urls.py中: from django.urls import path, re_path, include from app01 import views urlpatterns = [ path('admin/', admin.site.urls), # 反向解析 path('login.html/', views.login, name="Log"), re_path(r'^articles/([0-9]{4})/$', views.year_archive, name='news-year-archive'), re_path(r'^articles/(?P<year>[0-9]{4})/$', views.year_archive, name='news-year'), ] # 在模板中:注意参数 """ <form action="{% url 'Log' %}" method="post"></form> <a href="{% url 'news-year-archive' 2012 %}">2012 Archive</a> <ul> {% for yearvar in year_list %} <li><a href="{% url 'news-year-archive' yearvar %}">{{ yearvar }} Archive</a></li> {% endfor %} </ul> <!--多个参数--> <a href="{% url "n4" i1 i2 %}">编辑</a> """ # 在views.py中: from django.urls import reverse from django.shortcuts import render, HttpResponse, redirect def redirect_to_year(request): # 无参 url = reverse('Log') print(url) # 有参 year = 2006 url88 = reverse('news-year-archive', args=(year,)) url99 = reverse('news-year', kwargs={'year':2008}) return HttpResponse('OK')
六 名称空间
命名空间(英语:Namespace)是表示标识符的可见范围。一个标识符可在多个命名空间中定义,它在不同命名空间中的含义是互不相干的。这样,在一个新的命名空间中可定义任何标识符,它们不会与任何已有的标识符发生冲突,因为已有的定义都处于其它命名空间中。
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'%}">哈哈</a>
# 在urls.py中: from django.urls import path, re_path, include, url urlpatterns = [ path('admin/', admin.site.urls), # 分发 re_path(r"^app01/", include("app01.urls")), re_path(r"^", include("app01.urls")), # 两个应用中,URL 模式名字一样时: re_path(r"^app01/", include(("app01.urls", "app01"))), re_path(r"^app02/", include(("app02.urls", "app02"))), ] # 模板中 { % url 'app01:index' %} { % url 'app02:index' pk = item.id %} 带参数的 # app01中的urls.py from django.urls import path, re_path from app01 import views urlpatterns = [ re_path("index/", views.index, name="index") ] # app02中的urls.py from django.urls import path, re_path from app02 import views urlpatterns = [ re_path("index/", views.index, name="index") ] # app01中的views.py from django.shortcuts import render, HttpResponse, redirect from django.urls import reverse def index(reqeust): return redirect(reverse("app01:index")) # app02中的views.py from django.shortcuts import render, HttpResponse from django.urls import reverse def index(reqeust): return redirect(reverse("app02:index")) ##注意 # 'Specifying a namespace in include() without providing an app_name ' """ 方法1:在proj/urls.py中修改 """ urlpatterns = [ # url(r'^rbac/', include('rbac.urls', namespace='rbac')), url(r'^rbac/', include(('rbac.urls', 'rbac'), namespace='rbac')), ] """ 方法2:在rbac/urls.py中 添加 app_name='rbac' """ app_name = 'rbac' urlpatterns = [ url(r'^role/list/$', role.role_list, name='role_list'), # rbac:role_list ... ] """ 'ForeignKey' object has no attribute 'rel' """ self.remote_field = rel # return SearchGroupRow(title, field_object.rel.model.objects.filter(**db_condition), self, request.GET) return SearchGroupRow(title, field_object.remote_field.model.objects.filter(**db_condition), self, request.GET)
七 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反向引用。
# urls.py: from django.urls import register_converter, path from app01 import yearconvert,views #使用register_converter 将其注册到URL配置中: register_converter(yearconvert.FourDigitYearConverter, 'yyyy') urlpatterns = [ path('articles/<yyyy:year>/', views.year_archive), ] #app01.yearconvert.py: class FourDigitYearConverter: regex = '[0-9]{4}' #规则 def to_python(self, value): return int(value) # 在这转换了类型 def to_url(self, value): return '%04d' % value #app01.views.py: from django.shortcuts import render,HttpResponse,redirect def year_archive(request,year): print(year,type(year)) return HttpResponse('ok')