django 路由系统
程序员文章站
2022-03-26 12:19:29
django 路由系统 [TOC] 路由是什么? Django 1.11版本 URLConf官方文档 基本格式: 示例: 参考官方文档 2.0版本中re_path和1.11版本的url是一样的用法。 正则表达式 详解 补充说明 分组 命名分组 (建议使用命名分组) 小结 指定默认值 include其 ......
django 路由系统
路由是什么?
url配置(urlconf)就像django所支撑网站的目录。它的本质是url与要为该url调用的视图函数之间的映射表。 我们就是以这种方式告诉django,遇到哪个url的时候,要对应执行哪个函数。
- 基本格式:
from django.conf.urls import url urlpatterns = [ url(正则表达式, views视图,参数,别名), ] """ 正则表达式:一个正则表达式字符串 views视图:一个可调用对象,通常为一个视图函数 参数:可选的要传递给视图函数的默认参数(字典形式) 别名:一个可选的name参数 """
示例:
#django 1.11版本写法 from django.conf.urls import url from . import views urlpatterns = [ url(r'^articles/2019/$', views.special_case_2019), #只能匹配到一个,静态路由 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), ] #django 2.0版本写法 from django.urls import path,re_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), ]
- 2.0版本中re_path和1.11版本的url是一样的用法。
正则表达式 详解
#注意事项 1 urlpatterns中的元素按照书写顺序从上往下逐一匹配正则表达式,一旦匹配成功则不再继续。 2 若要从url中捕获一个值,只需要在它周围放置一对圆括号(分组匹配)。 3 不需要添加一个前导的反斜杠,因为每个url 都有。例如,应该是^articles 而不是 ^/articles。 4 每个正则表达式前面的'r' 是可选的但是建议加上。 5 每个表达式应该都要开始符,与结束符,让逻辑更严谨 如 ^articles/$
- 补充说明
# 是否开启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(r'^blog/([0-9]{4})/$', views.blogs), —— 》 分组 将捕获的参数按位置传参传递给视图函数 #参数是 str类型 # views.py中,获取分组参数 def page(request,num): print(num) #传的是int参数 num类型就是int 一个分组要对应有一个参数来接收传参 return httpresponse('ok')
命名分组 (建议使用命名分组)
url(r'^blog/(?p<year>[0-9]{4})/$', views.blogs), —— 》 命名分组 将捕获的参数按关键字传参传递给视图函数 #参数类型 str 这里的?p<year> 中的year 视图函数也要用相同的名来获取 year # views.py中,获取分组参数 def page(request,year): print(year) #名字 要与分组名一一对应 return httpresponse('ok')
- 小结
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), #没有传参数,使用默认值 num = '1' url(r'^blog/page(?p<num>[0-9]+)/$', views.page),#传参,且 num = '0-9'任意一个数,会替换掉 num = '1' ] # views.py中,可以为num指定默认值 def page(request, num="1"): pass 在上面的例子中,两个url模式指向相同的view - views.page - 但是第一个模式并没有从url中捕获任何东西。 如果第一个模式匹配上了,page()函数将使用其默认参数num=“1”,如果第二个模式匹配,page()将使用正则表达式捕获到的num值。
include其他的urlconfs
在实际的开发环境中,我们可能需开发多个功能,有多个app以功能分划分,需要用到路由分发,根urls负责把不同的,页面请求, 分发到对应的app下的urls中,来执行响应程序.
- 根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。
- url匹配模式命名
#静态路由 url(r'^home', views.home, name='home'), # 给我的url匹配模式起名为 home #动态分组 路由 url(r'^index/(\d*)', views.index, name='index'), # 给我的url匹配模式起名为index ##动态命名分组 路由 url(r'^index/(?p<num>[0-9]{4})/(?p<month>\d{2})', views.index, name='index'), # 给我的url匹配模式起名为index
- 模板中引用反向解析
#静态 {% url 'home' %} #获取url匹配模式名为home 的完整路径 #动态分组 {% url 'index' 2019 %} #空格后面加参数,多个参数用空格隔开,参数个数与分组数一致 #动态命名分组 {% url 'index' 2019 12 %} #顺序不能错 位置传参 #或 {% url 'index' month=12 year=2019 %} #顺序没有要求
- 在views函数中引用反向解析
#静态 from django.urls import reverse reverse('home') #获取url匹配模式名为home 的完整路径 #动态分组 reverse("index", args=('2018', )) #一个分组的话,后面必须跟个逗号('2018',) 多个分组对应多个参数,写在2018,后面就行('2018','06') 位置传参 #动态命名分组 reverse("index", args=('2018','12' )) #顺序不能错 位置传参 #或 reverse("index", kwargs={'year':'2018', 'month':'12'})
- 总结: 反向解析就是根据 url 的别名 获取到完整的url路径,不管url路径怎么修改,还是能正常获取到完整的url路径
命名空间模式
即使不同的app使用相同的url名称,url的命名空间模式也可以让你唯一反转命名的url。
举个例子: project中的urls.py
from django.conf.urls import url, include #导入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,'pp':99})
- 这样即使app中url的命名相同,我也可以反转得到正确的url了。