第1章 Django的路由系统
URL配置(URLconf)就像Django所支撑网站的目录,它的本质是URL与要为该URL调用的视图函数之间的映射表,通过它告诉Django哪个URL调用哪段代码。
1.1 URLconf配置
1.1.1 基本格式:
from django.conf.urls import url urlpatterns = [ url(正则表达式, views视图函数, 参数, name="别名"), ]
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), ]
1.1.2 参数说明
- 正则表达式:一个正则表达式字符串
- views视图函数:一个可调用对象,通常为一个视图函数或一个指定视图函数路径的字符串
- 参数:可选的要传递给视图函数的默认参数(字典形式)
- 别名:一个可选的name参数
1.2 正则表达式详解
1.2.1 基本配置
from django.conf.urls import url from . import views urlpatterns = [ url(r'^articles/2003/$', views.special_case_2003), url(r'^articles/([0-9]{4})/$', views.year_archive), url(r'^articles/([0-9]{4})/([0-9]{2})/$', views.month_archive), url(r'^articles/([0-9]{4})/([0-9]{2})/([0-9]+)/$', views.article_detail), ]
1.2.2 注意事项
- urlpatterns中的元素按照书写顺序从上往下逐一匹配正则表达式,一旦匹配成功则不再继续。
- 若要从URL中捕获一个值,只需要在它周围放置一对圆括号(分组匹配)。
- 不需要添加一个前导的反斜杠,因为每个URL 都有。例如应该是^articles 而不是 ^/articles。
- 每个正则表达式前面的'r' 是可选的但是建议加上。
1.2.3 补充说明
# 是否开启URL访问地址后面不为/跳转至带有/的路径的配置项 APPEND_SLASH=True
Django settings.py配置文件中默认没有 APPEND_SLASH 这个参数,但 Django 默认这个参数为APPEND_SLASH = True,其作用就是自动在网址结尾加'/'。例如:
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时就会提示找不到页面。
1.3 分组命名匹配
上面的示例使用简单的正则表达式分组匹配(通过圆括号)来捕获URL中的值并以位置参数形式传递给视图。
在更高级的用法中可以使用分组命名匹配的正则表达式组来捕获URL中的值并以关键字参数形式传递给视图。
在Python的正则表达式中,分组命名正则表达式组的语法是( P<name>pattern)或(pattern),其中name是组的名称,pattern是要匹配的模式。
# 以上URLconf 使用命名组的重写 from django.conf.urls import url from . import views # 带?P(分组命名匹配)和不带?P(分组匹配)的两种方式不能混用 urlpatterns = [ url(r'^articles/2003/$', views.special_case_2003), # url(r'^articles/([0-9]{4})/$', views.year_archive), url(r'^articles/(?P<year>[0-9]{4})/$', views.year_archive), # url(r'^articles/([0-9]{4})/([0-9]{2})/$', views.month_archive), url(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/$', views.month_archive), # url(r'^articles/([0-9]{4})/([0-9]{2})/([0-9]{2})/$', views.article_detail), url(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/(?P<day>[0-9]{2})/$', views.article_detail), ]
这个实现与前面的示例完全相同,只有一个细微的差别:捕获的值作为关键字参数而不是位置参数传递给视图函数。例如针对url /articles/2017/12/相当于按以下方式调用视图函数:
views.month_archive(request, year="2017", month="12")
在实际应用中,使用分组命名匹配的方式可以让你的URLconf 更加明晰且不容易产生参数顺序问题的错误,但是有些人认为分组命名组语法太丑陋、繁琐。
1.3.1 URLconf匹配的位置
URLconf 在请求的URL上查找,将它当做一个普通的Python 字符串,不包括GET和POST参数以及域名。例如:
http://www.example.com/myapp/ 请求中URLconf 将查找myapp/;
在http://www.example.com/myapp/?page=3 请求中URLconf 仍将查找myapp/。
URLconf 不检查请求的方法,所有的请求方法(同一个URL的POST、GET、HEAD等等)都将路由到相同的函数。
1.3.2 捕获的参数永远都是字符串
每个在URLconf中捕获的参数都作为一个普通的Python字符串传递给视图,无论正则表达式使用的是什么匹配方式。
url(r'^articles/(?P<year>[0-9]{4})/$', views.year_archive), # 传递到视图函数views.year_archive() 中的year 参数永远是一个字符串类型。
1.3.3 视图函数中指定默认值
# urls.py中 from django.conf.urls import url from . import views urlpatterns = [ url(r'^blog/$', views.page), url(r'^blog/page(?P<num>[0-9]+)/$', views.page), ] # views.py中,可以为num指定默认值 def page(request, num="1"): pass
在上面的例子中两个URL模式指向相同的views.page,但是第一个模式并没有从URL中捕获任何东西。如果第一个模式匹配上了,page()函数将使用其默认参数num=“1”;如果第二个模式匹配,page()将使用正则表达式捕获到的num值。
1.3.4 include其他的URLconfs
【目录结构】:
app01/ urls.py views.py app02/ urls.py views.py mysite/ urls.py templates/ car_index.html house_index.html
【示例】:app01中的urls.py
from django.contrib import admin from django.conf.urls import url from . import views urlpatterns = [ url(r'^home/([0-9]{2,4})/([a-zA-Z]{3})/$', views.home), ]
【示例】:app01中的views.py
from django.shortcuts import HttpResponse, render, redirect def home(request, arg1, arg2): print(arg1) print(arg2) return render(request, "car_index.html")
【示例】:app02中的urls.py
from django.contrib import admin from django.conf.urls import url from . import views urlpatterns = [ url(r'^home/([0-9]{2,4})/([a-zA-Z]{3})/$', views.home), ]
【示例】:app01中的views.py
from django.shortcuts import HttpResponse, render, redirect def home(request, arg1, arg2): print(arg1) print(arg2) return render(request, "hourse_index.html")
【示例】:mysite中的urls.py
from django.contrib import admin from django.conf.urls import url, include from app01 import views, urls as app01_urls from app02 import views, urls as app02_urls urlpatterns = [ url(r'^car/', include(app01_urls)), # 可以通过工程下的urls引入app下的urls,方便分组 url(r'^house/', include(app02_urls)), # 可以通过工程下的urls引入app下的urls,方便分组 ]
【示例】:templates中的car_index.html
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>卖车主页</title> </head> <body> <h1>这是卖车主页</h1> </body> </html>
【示例】:templates中的house_index.html
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>卖房主页</title> </head> <body> <h1>这是卖房主页</h1> </body> </html>
【运行结果】:
1.4 传递额外的参数给视图函数
URLconfs 具有一个钩子,可以传递一个Python 字典作为额外的参数传递给视图函数。
Django.conf.urls.url() 函数可以接收一个可选的第三个参数,它是一个字典,表示想要传递给视图函数的额外关键字参数。
from django.conf.urls import url from . import views urlpatterns = [ url(r'^blog/(?P<year>[0-9]{4})/$', views.year_archive, {'foo': 'bar'}), ]
在这个例子中对于/blog/2005/请求,Django 将调用views.year_archive(request, year='2005', foo='bar')。这个技术在Syndication 框架中使用用来传递元数据和选项给视图。
1.5 命名URL和URL反向解析
获取一个URL 最开始想到的信息是处理它视图的标识(例如名字),查找正确的URL 的其它必要的信息有视图参数的类型(位置参数、关键字参数)和值。Django 提供一个办法是让URL 映射是URL 设计唯一的地方。你填充你的URLconf,然后可以双向使用它:
- 根据用户/浏览器发起的URL 请求,调用正确的Django 视图并从URL 中提取参数需要的值。
- 根据Django 视图的标识和将要传递给它的参数的值,获取与之关联的URL。
在需要URL的地方对于不同层级,Django 提供不同的工具用于URL 反查:
- 在模板中:使用url模板标签。
- 在Python 代码中:使用core.urlresolvers.reverse() 函数。
- 在更高层的与处理Django 模型实例相关的代码中:使用get_absolute_url() 方法。
简单来说:命名URL和反向解析URL本质上就是给url匹配模式起别名,然后用别名取到具体的URL路径。
注意:使用命名的URL模式时,URL的名称使用的字符串可以包含任何字符,不只限制在合法的Python 名称。
url(r'^home', views.home, name='home'), # 给我的url匹配模式起名为 home url(r'^index/(\d*)', views.index, name='index'), # 给我的url匹配模式起名为index
在templates里面可以这样引用:
{% url 'home' %}
在views函数中可以这样引用:
from django.urls import reverse reverse("index", args=("2018", ))
【示例】:
from django.conf.urls import url from . import views urlpatterns = [ # ... url(r'^articles/([0-9]{4})/$', views.year_archive, name='news-year-archive'), # ... ]
在模板的代码使用:
<a href="{% url 'news-year-archive' 2012 %}">2012 Archive</a> # 2012作为参数传入 <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路径 return redirect(reverse('news-year-archive', kwargs={"year": 2018})) # 传关键字参数
以后修改 ^articles/ 的名称都不会影响程序的使用,为了避免冲突可以在URL名称中加上一个前缀(建议使用应用的名称)将减少冲突的可能。
注意:当命名URL 模式时请确保使用的名称不会与其它应用中名称冲突,否则不能保证将插入哪个URL。
1.6 命名空间模式
在不同的命名空间中可以使用相同的命名URL名称。
【语法】:
'命名空间名称:URL名称'
模板中使用:
{% url 'app01:detail' pk=12 pp=99 %}
views中的函数中使用:
v = reverse('app01:detail', kwargs={'pk':11})
这样即使app中URL的命名相同也可以解析得到正确的URL了。
【示例】:
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。
第2章 参考资料
