Django路由系统
URL配置(URLconf)就像Django所支撑网站的目录。它的本质是URL与要为该URL调用的视图函数之间的映射表。
其实就是你定义的使用那个URL调用那段代码的关系对应表。
一、URLconf配置
基本格式:
from django.conf.urls import url urlpatterns = [ url(正则表达式, views视图函数,参数,别名), ]
参数说明:
- 正则表达式:一个正则表达式字符串
- views视图函数:一个可调用对象,通常为一个视图函数或一个指定视图函数路径的字符串
- 参数:可选的要传递给试图函数的默认参数(字典形式)
- 别名:一个可选的name参数
注意:
在Django2.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), ]
二、正则表达式详解
1.基础匹配原则
from django.conf.urls import url from django.contrib import admin from app01 import views urlpatterns = [ url(r'^blog/2017/12/',views.blog_list), url(r'^blog/(\d{4})/([0-5]{2})/', views.blog_list), url(r'^blog/(\d{4}/[7-9]/$)', views.blog_list), url(r'^admin/', admin.site.urls), ] #注意正则表达式的用法
注意事项:
- urlpatterns中的元素按照书写顺序从上往下逐一匹配正则表达式,一旦匹配成功则不再继续。
- 如要从URL中捕获一个值,只需要在它周围放置一对圆括号(分组匹配)。
- 不需要添加一个前导反斜杠,因为每个URL都有。例如,应该是^admin/而不是^/admin/
- 每个正则表达式前面的“r”是可选的但是建议加上
- 在边界view函数的时候,要接受多个参数
request每个函数都要有,*args表示接收多个位置参数,**kwargs表示接收多个关键字参数
这样就可以获取参数:
补充说明:
# 是否开启URL访问地址后面不为/跳转至带有/的路径的配置项 APPEND_SLASH=True
Django settings.py配置文件中默认没有 APPEND_SLASH 这个参数,但 Django 默认这个参数为 APPEND_SLASH = True。 其作用就是自动在网址结尾加'/'。
要记住的是正则的时候分组(加括号)可以获取参数,分组命名可以更精确的获取参数。
2.分组命名匹配
(1)基础用法
上面的示例使用简单的正则表达式分组匹配(通过圆括号)来捕捉URL中的值并以位置参数形式传递给视图。
在更高级的用法中,可以使用分组名名匹配的正则表达式组来捕获URL中的值并以关键字参数的形式传递给视图。
在Python的正则表达式中,分组命名正则表达式组的语法是(?P<name>patter),其中name是组的名称,patter是要匹配的模式。
from django.conf.urls import url from django.contrib import admin from app01 import views urlpatterns = [ url(r'^blog/2017/12/',views.blog_list), url(r'^blog/(?P<year>\d{4})/(?P<month>[0-5]{2})/', views.blog_list), url(r'^blog/(?P<year>\d{4}/?P<month>[7-9]/$)', views.blog_list), url(r'^admin/', admin.site.urls), ]
这个实现与前面的示例完全相同,只有一个细微的差别:捕获的值作为关键字参数而不是位置参数传递给视图函数。
同样的也可以获取参数:
这样就可以精准的获取参数。
(2)URLconf匹配的位置
URLconf在请求的URL上查找,将它当作一个普通Python字符串。不包括GET和POST参数以及域名。
例如请求以上两个URL所得到的结果是一样的,请求的对象还是没变。
之前讲过,?前面是页面,?后面是参数,参数与参数之间使用&隔开
(3)捕获的参数永远都是字符串
每个URLconf中捕获的参数都作为一个普通的Python字符串传递给视图,无论表达式使用的是什么匹配方式。
def blog_list(request,**kwargs): print(type(kwargs.get("year"))) return HttpResponse("OK") #结果 <class 'str'>
传递到视图函数views.year_archive()
中的year
参数永远是一个字符串类型。这一点在之后项目中获取参数的时候要注意。
(4)试图函数中指定默认值
def blog_list(request,year=2018,month=1): print(year) print(month) return HttpResponse("OK") #结果 2017 05
(5)include其它的URLconf
可以将项目的URL指向它下面的APP,这样就可以做到进一步分化。
在项目的urls中这样指定:
from django.conf.urls import url,include from app01 import urls as urls_app01 #注意取别名,不然不知道指向那个url from app02 import urls as urls_app02 urlpatterns = [ url(r'^app01/', include(urls_app01)), #直接指向app url(r'^app02/', include(urls_app02)) ]
两个app分别指向自己的views,记得导入的时候导入的名称:
最终结果:
下面是文件示意图:
3.传递额外的参数给视图函数
URLconf具有一个钩子,让你传递一个Python字典作为额外的参数传递给视图函数。
例如:
from django.conf.urls import url from . import views urlpatterns = [ url(r'^blog/(?P<year>[0-9]{4})/$', views.year_archive, {'foo': 'bar'}), ]
在最后的页面中可以把foo出去来,不过这种用法非常少
4.命名URL和URL反向解析
在使用Django 项目时,一个常见的需求是获得URL的最终形式,以用于嵌入到生成的内容中(视图中和显示给用户的URL等)或者用于处理服务器端的导航(重定向等)。
人们强烈希望不要硬编码这些URL(费力、不可扩展且容易产生错误)或者设计一种与URLconf 毫不相关的专门的URL 生成机制,因为这样容易导致一定程度上产生过期的URL。
换句话讲,需要的是一个DRY 机制。除了其它有点,它还允许设计的URL 可以自动更新而不用遍历项目的源代码来搜索并替换过期的URL。
获取一个URL 最开始想到的信息是处理它视图的标识(例如名字),查找正确的URL 的其它必要的信息有视图参数的类型(位置参数、关键字参数)和值。
Django 提供一个办法是让URL 映射是URL 设计唯一的地方。你填充你的URLconf,然后可以双向使用它:
- 根据用户/浏览器发起的URL 请求,它调用正确的Django 视图,并从URL 中提取它的参数需要的值。
- 根据Django 视图的标识和将要传递给它的参数的值,获取与之关联的URL。
第一种方式是我们在前面的章节中一直讨论的用法。第二种方式叫做反向解析URL、反向URL 匹配、反向URL 查询或者简单的URL 反查。
在需要URL 的地方,对于不同层级,Django 提供不同的工具用于URL 反查:
- 在模板中:使用url模板标签。
- 在Python 代码中:使用django.core.urlresolvers.reverse() 函数。
- 在更高层的与处理Django 模型实例相关的代码中:使用get_absolute_url() 方法。
上面说了一大堆,你可能并没有看懂。(那是官方文档的生硬翻译)。
咱们简单来说就是可以给我们的URL匹配规则起个名字,一个URL匹配模式起一个名字。
这样我们以后就不需要写死URL代码了,只需要通过名字来调用当前的URL。
url(r'^home', views.home, name='home'), # 给我的url匹配模式起名为 home url(r'^index/(\d*)', views.index, name='index'), # 给我的url匹配模式起名为index
这样:在模板里面可以这样引用:
{% url 'home' %}
这样不论home本身的URL地址如何更改都能反向解析,这样就能够做到动态生成。
在views函数中可以这样引用:
from django.urls import reverse reverse("index", args=("2018", ))
5.命名空间
当一个项目下面有两个APP分别是app01和app02的时候,每个app下面都有自己的路由系统和视图系统。
为了让我们能够找到每个视图,我们会使用include路由分发技术,就像下面这样:
url(r'app01/',include(app01.urls)) url(r'app02/',include(app02.urls))
这样如果每个app下面都有视图函数index,我们在查找的时候,就应该是这样:
127.0.0.1/app01/index
127.0.0.1/app02/index
这样就不会出问题了。这就是路由分发include
下面接着说,命名空间,这个和路由分发有非常强烈的联系。
如果我们两个app下面都有一个index视图函数,name都是n1,那么在进行反向查找的时候,
系统如何知道是那个app了此时就要用到命名空间:
url(r'app01/',include(app01.urls,app01)) url(r'app02/',include(app02.urls,app02))
这样在反向查找的时候就可以这样:
reverse('app01:n1')
project中的urls.py
from django.conf.urls import url, include urlpatterns = [ url(r'^a/', include('app01.urls', namespace='author-polls')), url(r'^b/', include('app01.urls', namespace='publisher-polls')), ]
app中的urls.py
from django.conf.urls import url from app01 import views app_name = 'app01' urlpatterns = [ url(r'^(?P<pk>\d+)/$', views.detail, name='detail') ]
模板中引用:
{% url 'app01:detail' pk=12 pp=99 %}
views中的函数中引用
v = reverse('app01:detail', kwargs={'pk':11})