Django的路由系统
Django的路由系统
路由系统(urls.py)
URL配置(URLconf)就像Django 所支撑网站的目录。它的本质是URL与要为该URL调用的视图函数之间的映射表。
你就是以这种方式告诉Django,对于这个URL调用这段代码,对于那个URL调用那段代码。
URLconf配置
基本格式
- from django.conf.urls import url
- urlpatterns = [
- url(正则表达式, views视图函数,参数,别名),
- ]
注意:
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),
- ]
参数说明:
- 正则表达式
一个正则表达式字符串 - views视图函数
一个可调用对象,通常为一个视图函数或一个指定视图函数路径的字符串 - 参数
可选的要传递给视图函数的默认参数(字典形式) - 别名
一个可选的name参数
正则表达式详解
基本配置
- 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),
注意事项
- urlpatterns中的元素按照书写顺序从上往下逐一匹配正则表达式,一旦匹配成功则不再继续。
- 若要从URL中捕获一个值,只需要在它周围放置一对圆括号(分组匹配)。
- 不需要添加一个前导的反斜杠,因为每个URL 都有。例如,应该是^articles 而不是 ^/articles。
- 每个正则表达式前面的'r' 是可选的但是建议加上。
补充说明
- # 是否开启URL访问地址后面不为/跳转至带有/的路径的配置项
- APPEND_SLASH=True
Django settings.py配置文件中默认没有 APPEND_SLASH 这个参数,但 Django 默认这个参数为 APPEND_SLASH = True。 其作用就是自动在网址结尾加'/'。
例如:
- urlpatterns = [
- url(r'^blog/$', views.blog),
- ]
- APPEND_SLASH = True
- 访问http://www.example.com/blog/
成功访问 - 访问http://www.example.com/blog
自动将网址变成http://www.example.com/blog/,访问成功
- 访问http://www.example.com/blog/
- APPEND_SLASH = False
- 访问http://www.example.com/blog/
成功访问 - 访问http://www.example.com/blog
成功失败,报错
- 访问http://www.example.com/blog/
分组命名匹配
上面的示例使用简单的正则表达式分组匹配(通过圆括号)来捕获URL中的值并以位置参数形式传递给视图。
在更高级的用法中,可以使用分组命名匹配的正则表达式组来捕获URL中的值并以关键字参数形式传递给视图。
在Python的正则表达式中,分组命名正则表达式组的语法是(?P<name>pattern)
,其中name
是组的名称,pattern
是要匹配的模式。
传参数的两种方式
分组匹配 --> 相当于给视图函数传递位置参数
分组命名匹配 --> 相当于给视图函数传递关键字参数
- 通过位置参数传递
url(r'^book/([0-9]{2,4})/([a-zA-Z]{2})/$', views.book)
这种方式只能通过顺序访问传递的参数 - 通过字典形式传递
url(r'^book/(?P<year>[0-9]{2,4})/(?P<title>[a-zA-Z]{2})/$', views.book)
可以通过自定义的变量名传递
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等等 —— 都将路由到相同的函数。
捕获的参数永远都是字符串
每个在URLconf中捕获的参数都作为一个普通的Python字符串传递给视图,无论正则表达式使用的是什么匹配方式。例如,下面这行URLconf 中:
url(r'^articles/(?P<year>[0-9]{4})/$', views.year_archive),
传递到视图函数views.year_archive()
中的year
参数永远是一个字符串类型。
视图函数中指定默认值
- # 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模式指向相同的view - views.page - 但是第一个模式并没有从URL中捕获任何东西。
- 如果第一个模式匹配上了,page()函数将使用其默认参数num=“1”
- 如果第二个模式匹配,page()将使用正则表达式捕获到的num值。
include其他的URLconfs
一些比较大的项目中有多个APP,为了便于开发和区分模块功能,常常在不同的APP中使用不同的url和views。
- from django.conf.urls import include, url
- urlpatterns = [
- url(r'^admin/', admin.site.urls),
- url(r'^blog/', include('blog.urls')), # 可以包含其他的URLconfs文件
- ]
命名URL和URL反向解析
可以给我们的URL匹配规则起个名字,一个URL匹配模式起一个名字。
这样我们以后就不需要写死URL代码了,只需要通过名字来调用当前的URL。
本质上就是给url匹配模式起别名,然后用过别名拿到具体的URL路径
- 怎么起别名?
在url匹配模式中,定义name="别名"- url(r'^home', views.home, name='home'), #给我的url匹配模式起名为 home
- url(r'^index/(\d*)', views.index, name='index'), # 给我的url匹配模式起名为index
- 如何使用?
-
在模板语言里面使用:
{% url "别名" %}
--> 得到具体的URL路径- {% url 'home' %}
-
在视图中如何使用:
from django.urls import reverse
reverse("别名") --> 得到具体的URL路径- from django.urls import reverse
- reverse("index", args=("2018", ))
-
- 如何传参数?
-
模板语言中:
{% url "别名" 2018 "nb" %}
-
视图函数中
传位置参数:
reverse("别名", args=(2018, "nb"))
传关键字参数:
reverse("别名" kwargs={"year": 2018, "title": "nb"})
-
注意:
为了完成上面例子中的URL 反查,你将需要使用命名的URL 模式。URL 的名称使用的字符串可以包含任何你喜欢的字符。不只限制在合法的Python 名称。
当命名你的URL 模式时,请确保使用的名称不会与其它应用中名称冲突。如果你的URL 模式叫做comment,而另外一个应用中也有一个同样的名称,当你在模板中使用这个名称的时候不能保证将插入哪个URL。
在URL 名称中加上一个前缀,比如应用的名称,将减少冲突的可能。我们建议使用myapp-comment 而不是comment。
命名空间模式
为了防止不同的app下面的url匹配模式有重复的别名
project中的urls.py:
- from django.conf.urls import url, include
- from app01 import urls as app01_urls
- from app02 import urls as app02_urls
- # 在APP比较多时使用命名空间,能够在不同的命名空间中使用相同的链接名
- url(r'^car/', include(app01_urls, namespace='car')),
- url(r'^house/', include(app02_urls, namespace='house'))
- from django.conf.urls import url
- from app01 import views
- urlpatterns = [
- # url(r'^book/(?P<year>[0-9]{2,4})/(?P<title>[a-zA-Z]{2})/$', views.book),
- url(r'^book/(?P<year>[0-9]{2,4})/(?P<title>[a-zA-Z]{2})/$', views.book, name="book"),
- # 原先的url形式
- # url(r'^home/', views.home)
- # 给url起别名
- # url(r'^home/', views.home, name="car_home")
- # 有命名空间时,别名可以重复
- url(r'^home/', views.home, name="home")
- ]
- from django.conf.urls import url
- from app02 import views
- urlpatterns = [
- # 原先的url形式
- # url(r'^home/', views.home),
- # 起别名
- # url(r'^home/', views.home, name="house_home"),
- # 有命名空间时,别名可以重复
- url(r'^home/', views.home, name="home"),
- ]
现在,我的两个app中 url名称重复了,我反转URL的时候就可以通过命名空间的名称得到我当前的URL。
语法:
'命名空间名称:URL名称'
模板中使用:
{% url 'app01:detail' pk=12 pp=99 %}
- {#不用别名时在HTML中的链接#}
- {#<a href="/house/home/">买房找我</a>#}
- {#使用别名时在HTML中的链接#}
- {#<a href="{% url 'house_home' %}">买房找我</a>#}
- {#存在命名空间时使用别名#}
- <a href="{% url 'house:home' %}">买房找我</a>
- {#别名下使用参数#}
- {#<a href="{% url 'book' 2018 'bb' %}">book参数</a>#}
views中的函数中使用
v = reverse('app01:detail', kwargs={'pk':11})
这样即使app中URL的命名相同,可以反转得到正确的URL了。
参考链接:http://www.cnblogs.com/liwenzhou/p/8271147.html