Django之路由
Django的路由系统
URL配置(URLconf)就像Django所支撑网站的目录。它的本质是URL与要为该URL调用的视图函数之间的映射表。
我们就是以这种方式告诉Django,遇到哪个URL的时候,要对应执行哪个函数。
基本格式:
from django.conf.urls import url urlpatterns = [ url(正则表达式, views.视图(函数或者类),参数,别名),
]
示例:
from django.conf.urls import url from app01 import views urlpatterns = [ url(r'^press_list/2003/$', views.press_list), url(r'^add_press/([0-9]{4})/$', views.add_press), url(r'^del_press/([0-9]{4})/([0-9]{2})/$', views.del_press), url(r'^edit_press/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/([0-9]+)/$', views.edit-press,name='edit_press'), ]
参数说明:
- 正则表达式:一个正则表达式字符串
- views视图:一个可调用对象,通常为一个视图函数
- 参数:可选的要传递给视图函数的默认参数(字典形式)
- 别名:一个可选的name参数
注意:
Django 2.0版本中的路由系统是下面的写法(官方文档):
from django.urls import path,re_path urlpatterns = [ path('press_list/2003/', views.press_list), path('add_press/<int:year>/', views.add_press), path('del_press/<int:year>/<int:month>/', views.del_press), path('edit_press/<int:year>/<int:month>/<slug:slug>/', views.edit_press), ]
2.0版本中re_path和1.11版本的url是一样的用法。
正则表达式详解
基本配置
from django.conf.urls import url from app01 import views urlpatterns = [ url(r'^press_list/2003/$', views.press_list), url(r'^add_press/([0-9]{4})/$', views.add_press), url(r'^del_press/([0-9]{4})/([0-9]{2})/$', views.del_press), url(r'^edit_press/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/([0-9]+)/$', views.edit-press,name='edit_press'), ]
注意事项
- urlpatterna 中的元素按照书写顺序从上往下来进行正则表达式,一旦匹配成功就寻找对应视图,不在匹配url。
- 若要从URL中捕获一个值,只需要在它周围放置一对圆括号(分组匹配)。
- 不需要添加一个前导的反斜杠,因为每个URL 都有。例如,应该是^press_list而不是 ^/press_list。
- 每个正则表达式前面的'r' 是可选的但是建议加上。
补充说明
# 是否开启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 时就会提示找不到页面。
上面的示例使用简单的正则表达式分组匹配(通过圆括号)来捕获URL中的值并以位置参数形式传递给视图。
在更高级的用法中,可以使用分组命名匹配的正则表达式组来捕获URL中的值并以关键字参数形式传递给视图。
在Python的正则表达式中,分组命名正则表达式组的语法是(?P<name>pattern)
,其中name
是组的名称,pattern
是要匹配的模式。
下面是以上URLconf 使用命名组的重写:
from django.conf.urls import url from app01 import views urlpatterns = [ url(r'^press_list/2003/$', views.press_list), # 正则路由匹配 url(r'^add_press/([0-9]{4})/$', views.add_press), # 分组匹配 url(r'^del_press/([0-9]{4})/([0-9]{2})/$', views.del_press), # 命名分组匹配 url(r'^edit_press/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/([0-9]+)/$', views.edit-press,name='edit_press'), 命名url ]
这个实现与前面的示例完全相同,只有一个细微的差别:捕获的值作为关键字参数而不是位置参数传递给视图函数。
例如,针对URL /del_press/2017/12/相当于按以下方式调用视图函数:
views.del_press(request, year="2017", month="12")
在实际应用中,使用分组命名匹配的方式可以让你的URLconf 更加明晰且不容易产生参数顺序问题的错误,但是有些开发人员则认为分组命名组语法太丑陋、繁琐。
至于究竟应该使用哪一种,你可以根据自己的喜好来决定。
URLconf匹配的位置
URLconf 在请求的URL 上查找,将它当做一个普通的Python 字符串。不包括GET和POST参数以及域名。
例如,http://www.example.com/app01/ 请求中,URLconf 将查找 /app01/
在http://www.example.com/app01/?page=3 请求中,URLconf 仍将查找 /app01/
URLconf 不检查请求的方法。换句话讲,所有的请求方法 —— 同一个URL的POST
、GET
、HEAD
等等 —— 都将路由到相同的函数。
捕获的参数永远都是字符串
每个在URLconf中捕获的参数都作为一个普通的Python字符串传递给视图,无论正则表达式使用的是什么匹配方式。例如,下面这行URLconf 中:
url(r'^press_list/(?P<year>[0-9]{4})/$', views.press-list),
传递到视图函数views.press-list()
中的year
参数永远是一个字符串类型。
视图函数中指定默认值
#1. urls.py中 from django.conf.urls import url from . import views urlpatterns = [
url(r'^index/([0-9]{4})/([0-9]{2})$', views.index), # 分组
url(r'^index/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})$', views.index), # 命名分组
url(r'^index/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})$', views.index,{'ret':'ret'}), # 额外的参数
]
#2.浏览器url输入http://127.0.0.1:8003/index/2018/10 回车
#3. views.py中
def index(request,*args,**kwargs):
print(args,kwargs)
#注释路由2&3 得到==》('2018', '10') {}
#注释路由1$3 得到==》() {'year': '2018', 'month': '10'}
#注释路由1$2 得到==》() {'year': '2018', 'month': '10' , 'ret':'ret'}
return render(request, 'index.html')
注意:当传递额外参数的字典中的参数和URL中捕获值的命名关键字参数同名时,函数调用时将使用的是字典中的参数,而不是URL中捕获的参数。
include其他的URLconfs
from django.conf.urls import include, url urlpatterns = [ url(r'^admin/', admin.site.urls), url(r'^app01/', include('app01.urls')), # 可以包含其他的URLconfs文件 ]
#此时打开需要在网站上加上/app01/的路径。例如:http://127.0.0.1:8003/app01/index/2018/10
命名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 'index' %} {# 有了url命名就可在模板直接用 #}
<a href="{% url 'home' %}">home页面</a> {# 页面在浏览器渲染后点击后寻找名字为‘home’的路由 #}
在views函数中可以这样引用:
from django.urls import reverse reverse("index", args=("2018", )) # 相当于 redirect(reverse("index", args=("2018", ))) ===》 redirect('/index/2018/')
例子:
考虑之前的图书管理系统的URLconf:
from django.conf.urls import url from app01 import views urlpatterns = [ # ... url(r'^articles/([0-9]{4})/$', views.year_archive, name='news-year-archive'), # ... ]
根据这里的设计,某一年nnnn对应的归档的URL是/articles/nnnn/
。
你可以在模板的代码中使用下面的方法获得它们:
<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>
在Python 代码中,这样使用:
from django.urls import reverse from django.shortcuts import redirect def redirect_to_year(request): # ... year = 2006 # ... return redirect(reverse('news-year-archive', args=(year,)))
如果出于某种原因决定按年归档文章发布的URL应该调整一下,那么你将只需要修改URLconf 中的内容。
在某些场景中,一个视图是通用的,所以在URL 和视图之间存在多对一的关系。对于这些情况,当反查URL 时,只有视图的名字还不够。
注意:
为了完成上面例子中的URL 反查,你将需要使用命名的URL 模式。URL 的名称使用的字符串可以包含任何你喜欢的字符。不只限制在合法的Python 名称。
当命名你的URL 模式时,请确保使用的名称不会与其它应用中名称冲突。如果你的URL 模式叫做comment
,而另外一个应用中也有一个同样的名称,当你在模板中使用这个名称的时候不能保证将插入哪个URL。
在URL 名称中加上一个前缀,比如应用的名称,将减少冲突的可能。我们建议使用myapp-comment
而不是comment
。
命名空间模式
即使不同的APP使用相同的URL名称,URL的命名空间模式也可以让你唯一反转命名的URL。
举个例子:
project中的urls.py
from django.conf.urls import url, include urlpatterns = [ url(r'^app01/', include('app01.urls', namespace='app01')), url(r'^app02/', include('app02.urls', namespace='app02')), ]
app01中的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') ]
app02中的urls.py
from django.conf.urls import url from app02 import views app_name = 'app02' urlpatterns = [ url(r'^(?P<pk>\d+)/$', views.detail, name='detail') ]
现在,我的两个app中 url名称重复了,我反转URL的时候就可以通过命名空间的名称得到我当前的URL。
语法:
'命名空间名称:URL名称'
模板中使用:
{% url 'app01:detail' pk=12 pp=99 %}
views中的函数中使用
v = reverse('app01:detail', kwargs={'pk':11})
这样即使app中URL的命名相同,我也可以反转得到正确的URL了。