Django 路由系统

Django 路由系统

URL配置(URLconf)就像Django所支撑网站的目录。它的本质是URL与要为该URL调用的视图函数之间的映射表。

我们就是以这种方式告诉Django,遇到哪个URL的时候,要对应执行哪个函数。

URLconf配置

基本格式

from django.conf.urls import url

urlpatterns = [
     url(regex, view, kwargs, 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),
]

参数说明:

  • regex,正则表达式:一个正则表达式字符串
  • views,视图:一个可调用对象,通常为一个视图函数
  • kwargs,参数:可选的要传递给视图函数的默认参数(字典形式)
  • name,别名:一个可选的name参数

注意:
Django 2.0版本中的路由系统是下面的写法(官方文档):

from django.urls import path,re_path
from . import views

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),
]

2.0版本中re_path和1.11版本的url是一样的用法。

正则表达式详解

基本配置

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。 其作用就是自动在网址结尾加'/'。

其效果就是:

我们定义了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的正则表达式中,分组命名正则表达式组的语法是(?Ppattern),其中name是组的名称,pattern是要匹配的模式

from django.conf.urls import url
from . import views

urlpatterns = [
    url(r'^articles/2003/$', views.special_case_2003),
    url(r'^articles/(?P<year>[0-9]{4})/$', views.year_archive),
    url(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/$', views.month_archive),
    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 更加明晰且不容易产生参数顺序问题的错误,但是有些开发人员则认为分组命名组语法太丑陋、繁琐。

至于究竟应该使用哪一种,你可以根据自己的喜好来决定。

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等等 —— 都将路由到相同的函数。

捕获的参数永远都是字符串

视图函数中指定默认值

可以在视图函数中指定默认值,如果没有从URL截获内容,将使用默认值,否则使用URL中的内容。

include其他的URLconfs

可以将同类型的URLconfs放入一个文件中,再用include引入,便于管理。

from django.conf.urls import url, include
from django.contrib import admin

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'', include('app01.urls')),
]

传递额外的参数给视图函数

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')。
当传递额外参数的字典中的参数和URL中捕获值的命名关键字参数同名时,函数调用时将使用的是字典中的参数,而不是URL中捕获的参数。

命名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。当修改URLconf中的regex时,其他代码不需要改变。

  1. 普通url

    1. 命名

      url(r'^publisher_list/', views.publisher_list, name='publisher'),
      
    2. 使用

      视图中使用:

      ​ 1.from django.urls import reverse

      ​ reverse('publisher') ——》 ‘/app01/publisher_list/’

      模板中使用:

      ​ {% url 'publisher' %} ——》 ‘/app01/publisher/’

  2. 使用分组

    ​ url(r'^blog/(\d{4})/([1-9]{2})/$', views.blog, name='blog')

    ​ 视图中使用

    ​ reverse('blog',args=('2018','12')) ‘/blog/2018/12/'

    ​ 模板中使用

  3. 使用命名分组

    ​ url(r'^blog/(?P\d{4})/(?P[1-9]{2})/$', views.blog, name='blog')

    ​ 视图中使用

    ​ reverse('blog',args=('2018','12')) ‘/blog/2018/12/'

    ​ reverse('blog', kwargs={'month': '12', 'year': '2018'})

    ​ 模板中使用

    ​ {% url 'blog' '2018' '12' %} ——》 ‘/blog/2018/12/'

    ​ {% url 'blog' year='2018' month='12' %} ——》 ‘/blog/2018/12/'

    ​ {% url 'blog' month='12' year='2018' %} ——》 ‘/blog/2018/12/'

命名空间模式

即使不同的APP使用相同的URL名称,URL的命名空间模式也可以让你唯一反转命名的URL。

举个例子:

project中的urls.py

from django.conf.urls import url, include

urlpatterns = [
    url(r'', include('app01.urls', namespace='app01')),
    url(r'', include('app02.urls', namespace='app02'))
]

app01中的urls.py

from django.conf.urls import url
from app01 import views

urlpatterns = [
    url(r'^index/(?P<year>\d{4})/(?P<month>\d{2})/$', views.index, name='index'),
]

app01中的urls.py

from django.conf.urls import url
from app02 import views

urlpatterns = [
    url(r'^index/(?P<year>\d{4})/(?P<month>\d{2})/$', views.index, name='index'),
]

现在,我的两个app中 url名称重复了,我反转URL的时候就可以通过命名空间的名称得到我当前的URL。

语法:

'命名空间名称:URL名称'

使用app01中的index
视图中

reverse('app01:index', args=('2018', '19'))
reverse('app01:index', kwargs={'year': 2018, 'month': 45})

模板中

{% url  'app01:index' '2018' '12' %}
{% url  'app01:index' year='2018' month='12' %}
{% url  'app01:index' month='18' year='1200' %}

这样即使app中URL的命名相同,我也可以反转得到正确的URL了。

posted @ 2019-08-03 16:16  写bug的日子  阅读(85)  评论(0编辑  收藏  举报