URL配置(URLconf)就像Django 所支撑网站的目录。它的本质是URL与要为该URL调用的视图函数之间的映射表。
一、URLconf配置
1、基本格式
1from django.conf.urls import url 2 3urlpatterns = [ 4 url(正则表达式, views视图函数,参数,别名), 5]
注意:Django 2.0版本中的路由系统已经替换成下面的写法:
1from django.urls import path 2 3urlpatterns = [ 4 path('articles/2003/', views.special_case_2003), 5 path('articles/<int:year>/', views.year_archive), 6 path('articles/<int:year>/<int:month>/', views.month_archive), 7 path('articles/<int:year>/<int:month>/<slug:slug>/', views.article_detail), 8]
2、参数说明
- 正则表达式:一个正则表达式字符串
- views视图函数:一个可调用对象,通常为一个视图函数或一个指定视图函数路径的字符串
- 参数:可选的要传递给视图函数的默认参数(字典形式)
- 别名:一个可选的name参数
二、正则表达式详解
1、基本配置
位置参数:
1from django.conf.urls import url 2 3from . import views 4 5urlpatterns = [ 6 url(r'^articles/2003/$', views.special_case_2003), 7 url(r'^articles/([0-9]{4})/$', views.year_archive), 8 url(r'^articles/([0-9]{4})/([0-9]{2})/$', views.month_archive), 9 url(r'^articles/([0-9]{4})/([0-9]{2})/([0-9]+)/$', views.article_detail), 10]
2、注意事项
- urlpatterns中的元素按照书写顺序从上往下逐一匹配正则表达式,一旦匹配成功则不再继续。
- 若要从URL中捕获一个值,只需要在它周围放置一对圆括号(分组匹配)。
- 不需要添加一个前导的反斜杠,因为每个URL 都有。例如,应该是^articles 而不是 ^/articles。
- 每个正则表达式前面的'r' 是可选的但是建议加上。
3、补充说明
1# 是否开启URL访问地址后面不为/跳转至带有/的路径的配置项 2APPEND_SLASH=True
Django settings.py配置文件中默认没有 APPEND_SLASH 这个参数,但 Django 默认这个参数为 APPEND_SLASH = True。 其作用就是自动在网址结尾加'/'。
例子:
1from django.conf.urls import url 2from app01 import views 3 4urlpatterns = [ 5 url(r'^blog/$', views.blog), 6]
访问 http://www.example.com/blog 时,默认将网址自动转换为 http://www.example/com/blog/ 。
如果在settings.py中设置了 APPEND_SLASH=False,此时我们再请求 http://www.example.com/blog 时就会提示找不到页面。
三、分组命名匹配
1、基本配置
上面的示例使用简单的正则表达式分组匹配(通过圆括号)来捕获URL中的值并以位置参数形式传递给视图。
在更高级的用法中,可以使用分组命名匹配的正则表达式组来捕获URL中的值并以关键字参数形式传递给视图。
在Python的正则表达式中,分组命名正则表达式组的语法是(?P<name>pattern),其中name是组的名称,pattern是要匹配的模式。
下面是以上URLconf 使用命名组的重写(关键字参数):
1from django.conf.urls import url 2 3from . import views 4 5urlpatterns = [ 6 url(r'^articles/2003/$', views.special_case_2003), 7 url(r'^articles/(?P<year>[0-9]{4})/$', views.year_archive), 8 url(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/$', views.month_archive), 9 url(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/(?P<day>[0-9]{2})/$', views.article_detail), 10]
相当于按以下方式调用视图函数:
views.month_archive(request, year="2017", month="12")
2、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等等 —— 都将路由到相同的函数。
注意:捕获的参数永远都是字符串。
**3、**视图函数中指定默认值
1# urls.py中 2from django.conf.urls import url 3 4from . import views 5 6urlpatterns = [ 7 url(r'^blog/$', views.page), 8 url(r'^blog/page(?P<num>[0-9]+)/$', views.page), 9] 10 11# views.py中,可以为num指定默认值 12def page(request, num="1"): 13 pass
在上面的例子中,两个URL模式指向相同的view - views.page - 但是第一个模式并没有从URL中捕获任何东西。
如果第一个模式匹配上了,page()函数将使用其默认参数num=“1”,如果第二个模式匹配,page()将使用正则表达式捕获到的num值。
4、include其他的URLconfs
1#At any point, your urlpatterns can “include” other URLconf modules. This 2#essentially “roots” a set of URLs below other ones. 3 4#For example, here’s an excerpt of the URLconf for the Django website itself. 5#It includes a number of other URLconfs: 6 7 8from django.conf.urls import include, url 9 10urlpatterns = [ 11 url(r'^admin/', admin.site.urls), 12 url(r'^blog/', include('blog.urls')), # 可以包含其他的URLconfs文件 13]
四、传递额外的参数给视图函数(了解)
URLconfs 具有一个钩子,让你传递一个Python 字典作为额外的参数传递给视图函数。
django.conf.urls.url() 函数可以接收一个可选的第三个参数,它是一个字典,表示想要传递给视图函数的额外关键字参数。
例如:
1from django.conf.urls import url 2from . import views 3 4urlpatterns = [ 5 url(r'^blog/(?P<year>[0-9]{4})/$', views.year_archive, {'foo': 'bar'}), 6]
在这个例子中,对于/blog/2005/请求,Django 将调用views.year_archive(request, year='2005', foo='bar')。
这个技术在Syndication 框架中使用,来传递元数据和选项给视图。
五、命名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。
举个简单的例子:
1url(r'^home', views.home, name='home'), # 给我的url匹配模式起名为 home 2url(r'^index/(\d*)', views.index, name='index'), # 给我的url匹配模式起名为index
这样:在模板里面可以这样引用:
{% url 'home' %}
在views函数中可以这样引用:
1from django.urls import reverse 2 3reverse("index", args=("2018", ))
例子:
1# 考虑下面的URLconf: 2from django.conf.urls import url 3 4from . import views 5 6urlpatterns = [ 7 # ... 8 url(r'^articles/([0-9]{4})/$', views.year_archive, name='news-year-archive'), 9 # ... 10] 11 12# 根据这里的设计,某一年nnnn对应的归档的URL是/articles/nnnn/。 13# 你可以在模板的代码中使用下面的方法获得它们: 14<a href="{% url 'news-year-archive' 2012 %}">2012 Archive</a> 15 16<ul> 17{% for yearvar in year_list %} 18<li><a href="{% url 'news-year-archive' yearvar %}">{{ yearvar }} Archive</a></li> 19{% endfor %} 20</ul> 21 22# 在Python 代码中,这样使用: 23from django.urls import reverse 24from django.shortcuts import redirect 25 26def redirect_to_year(request): 27 # ... 28 year = 2006 29 # ... 30 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。
举个例子:
1# project中的urls.py 2from django.conf.urls import url, include 3 4urlpatterns = [ 5 url(r'^app01/', include('app01.urls', namespace='app01')), 6 url(r'^app02/', include('app02.urls', namespace='app02')), 7] 8 9# app01中的urls.py 10from django.conf.urls import url 11from app01 import views 12 13app_name = 'app01' 14urlpatterns = [ 15 url(r'^(?P<pk>\d+)/$', views.detail, name='detail') 16] 17 18# app02中的urls.py 19from django.conf.urls import url 20from app02 import views 21 22app_name = 'app02' 23urlpatterns = [ 24 url(r'^(?P<pk>\d+)/$', views.detail, name='detail') 25]
现在,我的两个app中 url名称重复了,我反转URL的时候就可以通过命名空间的名称得到我当前的URL。
语法:
'命名空间名称:URL名称'
模板中使用:
{% url 'app01:detail' pk=12 pp=99 %}
views中的函数中使用:
v = reverse('app01:detail', kwargs={'pk':11})
这样即使app中URL的命名相同,我也可以反转得到正确的URL了。
七、总结
- 动态路由
urls.py中通过正则表达式的分组匹配,捕获用户访问的url中的值,传递给视图函数
分组匹配:
相当于给视图函数传递 位置参数
分组命名匹配:
相当于给视图函数传递 关键字参数
- name
防止将url硬编码到我们的业务逻辑代码中,给url起别名
通过别名,反向找到 url
在views.py中:
from django.urls import reverse
具体的url = reverse('url别名')
例子:
1# urls.py 2urlpatterns = [ 3 url(r'^admin/', admin.site.urls), 4 url(r'^publisher_list/$', views.publisher_list, name="aaa"), 5] 6 7# views.py 8class EditPublisher(views.View): 9 def get(self, request, edit_id): 10 publisher_obj = models.Publisher.objects.get(id=edit_id) 11 return render(request, "edit_publisher.html", {"obj": publisher_obj}) 12 13 def post(self, request, edit_id): 14 new_name = request.POST.get("name888") 15 # 去数据库修改出版社名字 16 obj = models.Publisher.objects.get(id=edit_id) 17 obj.name = new_name 18 obj.save() 19 return redirect(reverse('aaa')) 20 21<--!publisher_list.html--> 22<table class="table table-bordered"> 23 <thead> 24 <tr> 25 <th>#</th> 26 <th>id</th> 27 <th>出版社名称</th> 28 <th>操作</th> 29 </tr> 30 </thead> 31 <tbody> 32 {% for publisher in publisher_list %} 33 <tr> 34 <td>{{ forloop.counter }}</td> 35 <td>{{ publisher.id }}</td> 36 <td>{{ publisher.name }}</td> 37 <td> 38 <a href="/edit_publisher/{{ publisher.id }}/" class="btn btn-info">编辑</a> 39 <a href="/delete_publisher/" class="btn btn-danger">删除</a> 40 </td> 41 </tr> 42 {% endfor %} 43 </tbody> 44</table> 45 46<--!edit_publisher.html--> 47<form class="form-horizontal" action="" method="post"> 48 <input type="text" name="id" value="{{ obj.id }}" style="display: none"> 49 <div class="form-group"> 50 <label for="inputEmail3" class="col-sm-2 control-label">出版社名称</label> 51 <div class="col-sm-10"> 52 <input type="text" class="form-control" name="name888" value="{{ obj.name }}" id="inputEmail3" 53 placeholder="新名称"> 54 </div> 55 </div> 56 57 <div class="form-group"> 58 <div class="col-sm-offset-2 col-sm-10"> 59 <button type="submit" class="btn btn-default">提交</button> 60 </div> 61 </div> 62</form>