Python之路--Django--路由系统

时间 2019-11-17

原文原文链接

1、路由系统简介

　　URL配置(URLconf)就像Django 所支撑网站的目录。它的本质是URL与要为该URL调用的视图函数之间的映射表。你就是以这种方式告诉Django，对于这个URL调用这段代码，对于那个URL调用那段代码。web

2、基本配置

Django 2.0版本中的路由系统已经替换成下面的写法（官方文档）：正则表达式

from django.urls import path urlpatterns = [ path(正则表达式, views视图函数，参数，别名), ]

参数说明：django

正则表达式：一个正则表达式字符串
views视图函数：一个可调用对象，一般为一个视图函数或一个指定视图函数路径的字符串
参数：可选的要传递给视图函数的默认参数（字典形式）
别名：一个可选的name参数

一、正则表达式详解

from django.conf.urls import path

from . import views

urlpatterns = [
    path(r'^articles/2003/$', views.special_case_2003),
    path(r'^articles/([0-9]{4})/$', views.year_archive),
    path(r'^articles/([0-9]{4})/([0-9]{2})/$', views.month_archive),
    path(r'^articles/([0-9]{4})/([0-9]{2})/([0-9]+)/$', views.article_detail),
]

注意事项：浏览器

urlpatterns中的元素按照书写顺序从上往下逐一匹配正则表达式，一旦匹配成功则再也不继续。
若要从URL中捕获一个值，只须要在它周围放置一对圆括号（分组匹配）。
不须要添加一个前导的反斜杠，由于每一个URL 都有。例如，应该是^articles 而不是 ^/articles。
每一个正则表达式前面的'r' 是可选的可是建议加上。

　　Django settings.py配置文件中默认没有 APPEND_SLASH 这个参数，但 Django 默认这个参数为 APPEND_SLASH = True。其做用就是自动在网址结尾加'/'。服务器

# 是否开启URL访问地址后面不为/跳转至带有/的路径的配置项
APPEND_SLASH=True

其效果就是：app

咱们定义了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的正则表达式中，分组命名正则表达式组的语法是(?P<name>pattern)，其中name是组的名称，pattern是要匹配的模式。下面是以上URLconf 使用命名组的重写：工具

from django.conf.urls import path from . import views urlpatterns = [ path(r'^articles/2003/$', views.special_case_2003), path(r'^articles/(?P<year>[0-9]{4})/$', views.year_archive), path(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/$', views.month_archive), path(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等等 —— 都将路由到相同的函数。

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

　　每一个在URLconf中捕获的参数都做为一个普通的Python字符串传递给视图，不管正则表达式使用的是什么匹配方式。例如，下面这行URLconf 中：

path(r'^articles/(?P<year>[0-9]{4})/$', views.year_archive),

传递到视图函数views.year_archive() 中的year 参数永远是一个字符串类型。

视图函数中指定默认值:

# urls.py中
from django.conf.urls import path from . import views urlpatterns = [ path(r'^blog/$', views.page), path(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:

#At any point, your urlpatterns can “include” other URLconf modules. This #essentially “roots” a set of URLs below other ones.

#For example, here’s an excerpt of the URLconf for the Django website itself. #It includes a number of other URLconfs:


from django.conf.urls import include, path urlpatterns = [ path(r'^admin/', admin.site.urls), path(r'^blog/', include('blog.urls')),  # 能够包含其余的URLconfs文件
]

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

　　URLconfs 具备一个钩子，让你传递一个Python 字典做为额外的参数传递给视图函数。django.conf.urls.url() 函数能够接收一个可选的第三个参数，它是一个字典，表示想要传递给视图函数的额外关键字参数。例如:

from django.conf.urls import path from . import views urlpatterns = [ path(r'^blog/(?P<year>[0-9]{4})/$', views.year_archive, {'foo': 'bar'}), ]

　　在这个例子中，对于/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。

举个简单的例子：

path(r'^home', views.home, name='home'),           # 给个人url匹配模式起名为 home
path(r'^index/(\d*)', views.index, name='index'),  # 给个人url匹配模式起名为 index

这样，在模板里面能够这样引用：

{% url 'home' %}

在views函数中能够这样引用：

from django.urls import reverse reverse("index", args=("2018", ))

例子：
考虑下面的URLconf：

from django.conf.urls import path from . import views urlpatterns = [ # ...
    path(r'^articles/([0-9]{4})/$', views.year_archive, name='news-year-archive'), # ...
]

根据这里的设计，某一年nnnn对应的归档的URL是/articles/nnnn/。

你能够在模板的代码中使用下面的方法得到它们：

<a href="{% url 'news-year-archive' 2012 %}">2012 Archive</a>

<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应该调整一下，那么你将只须要修改URLconf 中的内容。

　　在某些场景中，一个视图是通用的，因此在URL 和视图之间存在多对一的关系。对于这些状况，当反查URL 时，只有视图的名字还不够。

注意：

　　为了完成上面例子中的URL 反查，你将须要使用命名的URL 模式。URL 的名称使用的字符串能够包含任何你喜欢的字符。不仅限制在合法的Python 名称。当命名你的URL 模式时，请确保使用的名称不会与其它应用中名称冲突。若是你的URL 模式叫作comment，而另一个应用中也有一个一样的名称，当你在模板中使用这个名称的时候不能保证将插入哪一个URL。

　　在URL 名称中加上一个前缀，好比应用的名称，将减小冲突的可能。咱们建议使用myapp_comment 而不是comment。

四、命名空间模式

即便不一样的APP使用相同的URL名称，URL的命名空间模式也可让你惟一反转命名的URL。

举个例子：

project中的urls.py

from django.conf.urls import path, include urlpatterns = [ path(r'^app01/', include('app01.urls', namespace='app01')), path(r'^app02/', include('app02.urls', namespace='app02')), ]

app01中的urls.py

from django.conf.urls import path from app01 import views app_name = 'app01' urlpatterns = [ path(r'^(?P<pk>\d+)/$', views.detail, name='detail') ]

app02中的urls.py

from django.conf.urls import path from app02 import views app_name = 'app02' urlpatterns = [ path(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})

这样即便app中URL的命名相同，我也能够反转获得正确的URL了。