Django路由控制URL详解

URL是Web服务的入口,用户通过浏览器发送过来的任何请求,都是发送到一个指定的URL地址,然后被响应。在Django项目中编写路由,就是向外暴露我们接收哪些URL的请求,除此之外的任何URL都不被处理,也没有返回。通俗地理解,不恰当的形容,URL路由是你的Web服务对外暴露的API。Django奉行DRY主义,提倡使用简洁、优雅的URL。

1. 概述

要设计应用程序的URL,可以创建一个非正式的称为URLconf(URL配置)的Python模块。此模块是纯Python代码,是URL路径表达式与Python函数(您的视图)之间的映射。该映射可以根据需要缩短或缩短。它可以引用其他映射。并且,因为它是纯Python代码,所以它可以动态构造。Django还提供了一种根据活动语言翻译URL的方法。

2. django如何处理请求

当用户请求一个页面时,Django根据下面的逻辑执行操作:

1.决定要使用的根URLconf模块。通常,这是ROOT_URLCONF设置的值,但是如果传入的HttpRequest对象具有urlconf属性(由中间件设置),则其值将被用于代替ROOT_URLCONF设置。通俗的讲,就是你可以自定义项目入口url是哪个文件!

2.加载该模块并寻找可用的urlpatterns。 它是django.conf.urls.url()实例的一个列表。

3.依次匹配每个URL模式,在与请求的URL相匹配的第一个模式停下来。也就是说,url匹配是从上往下的短路操作,所以url在列表中的位置非常关键。

4.导入并调用匹配行中给定的视图,该视图是一个简单的Python函数(被称为视图函数),或基于类的视图。 视图将获得如下参数:

(1)一个HttpRequest 实例。

(2)如果匹配的正则表达式返回了没有命名的组,那么正则表达式匹配的内容将作为位置参数提供给视图。

(3)关键字参数由正则表达式匹配的命名组组成,但是可以被django.conf.urls.url()的可选参数kwargs覆盖。

5.如果没有匹配到正则表达式,或者过程中抛出异常,将调用一个适当的错误处理视图。

3. 转换器

3.1 path转换器

在django2.0 以上的版本中,默认使用的是path转换器:

from django.urls import 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),

]

注意:

1.要捕获一段url中的值,需要使用尖括号,而不是之前的圆括号;

2.可以转换捕获到的值为指定类型,比如例子中的int。默认情况下,捕获到的结果保存为字符串类型,不包含/这个特殊字符;

3.匹配模式的最开头不需要添加/,因为默认情况下,每个url都带一个最前面的/,既然大家都有的部分,就不用浪费时间特别写一个了。

匹配例子:

●/articles/2005/03/ 将匹配第三条,并调用views.month_archive(request, year=2005, month=3);

●/articles/2003/匹配第一条,并调用views.special_case_2003(request);

●/articles/2003将一条都匹配不上,因为它最后少了一个斜杠,而列表中的所有模式中都以斜杠结尾;

●/articles/2003/03/building-a-django-site/ 将匹配最后一个,并调用views.article_detail(request, year=2003, month=3, slug="building-a-django-site"

默认情况下,Django内置下面的路径转换器:

●str:匹配任何非空字符串,但不含斜杠/,如果你没有专门指定转换器,那么这个是默认使用的;

●int:匹配0和正整数,返回一个int类型

●slug:可理解为注释、后缀、附属等概念,是url拖在最后的一部分解释性字符。该转换器匹配任何ASCII字符以及连接符和下划线,比如’ building-your-1st-django-site‘;

●uuid:匹配一个uuid格式的对象。为了防止冲突,规定必须使用破折号,所有字母必须小写,例如’075194d3-6885-417e-a8a8-6c931e272f00‘ 。返回一个UUID对象;

●path:匹配任何非空字符串,重点是可以包含路径分隔符’/‘。这个转换器可以帮助你匹配整个url而不是一段一段的url字符串。

3.2 re_path转换器(老版的url)

Django2.0的url虽然改‘配置’了,但它依然向老版本兼容。而这个兼容的办法,就是用re_path()方法代替path()方法。re_path()方法在骨子里,根本就是以前的url()方法,只不过导入的位置变了。

from django.urls import path, re_path

from . import views

urlpatterns = [

    path('articles/2003/', views.special_case_2003),

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

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

    re_path(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/(?P<slug>[\w-]+)/$', views.article_detail),

]

与path()方法不同的在于两点:

●year中匹配不到10000等非四位数字,这是正则表达式决定的

●传递给视图的所有参数都是字符串类型。而不像path()方法中可以指定转换成某种类型。在视图中接收参数时一定要小心。

3.3 有名分组

上面的示例使用简单的、没有命名的正则表达式组(通过圆括号)来捕获URL 中的值并以位置 参数传递给视图。在更高级的用法中,可以使用命名的正则表达式组来捕获URL 中的值并以关键字 参数传递给视图。 在Python 正则表达式中,命名正则表达式组的语法是(?Ppattern),其中name 是组的名称,pattern 是要匹配的模式。 下面是以上URLconf 使用命名组的重写:

from django.urls import path,re_path

from app01 import views

urlpatterns = [

re_path(r'^articles/2003/$', views.special_case_2003),

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

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

re_path(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/(?P<day>[0-9]{2})/$', views.article_detail),

]

这个实现与前面的示例完全相同,只有一个细微的差别:捕获的值作为关键字参数而不是位置参数传递给视图函数。例如:

/articles/2005/03/ 请求将调用views.month_archive(request, year='2005', month='03')函数,而不是views.month_archive(request, '2005', '03')。

/articles/2003/03/03/ 请求将调用函数views.article_detail(request, year='2003', month='03', day='03')。

3.4 路由分发

通常,我们会在每个app里,各自创建一个urls.py路由模块,然后从根路由出发,将app所属的url请求,全部转发到相应的urls.py模块中。

例如,下面是Django网站本身的URLconf节选。 它包含许多其它URLconf:

from django.conf.urls import include, url

urlpatterns = [

    # ... 忽略 ...

    re_path(r'^community/', include('django_website.aggregator.urls')),

    re_path(r'^contact/', include('django_website.contact.urls')),

    # ... 忽略 ...

]

路由转发使用的是include()方法,需要提前导入,它的参数是转发目的地路径的字符串,路径以圆点分割。

注意,这个例子中的正则表达式没有包含$(字符串结束匹配符),但是包含一个末尾的斜杠。 每当Django 遇到include()(来自django.conf.urls.include())时,它会去掉URL中匹配的部分并将剩下的字符串发送给include的URLconf做进一步处理,也就是转发到二级路由去。

另外一种转发其它URL模式的方式是使用一个url()实例的列表。 例如,下面的URLconf:

from django.conf.urls import include, url

from apps.main import views as main_views

from credit import views as credit_views

extra_patterns = [

    re_path(r'^reports/$', credit_views.report),

    re_path(r'^reports/(?P<id>[0-9]+)/$', credit_views.report),

    re_path(r'^charge/$', credit_views.charge),

]

urlpatterns = [

    re_path(r'^$', main_views.homepage),

    re_path(r'^help/', include('apps.help.urls')),

    re_path(r'^credit/', include(extra_patterns)),

]

在此示例中,/credit/reports/URL将由credit_views.report()视图处理。这种做法,相当于把二级路由模块内的代码写到根路由模块里一起了,不是很推荐。

再看下面的URLconf:

from django.conf.urls import url

from . import views

urlpatterns = [

    re_path(r'^(?P<page_slug>[\w-]+)-(?P<page_id>\w+)/history/$', views.history),

    re_path(r'^(?P<page_slug>[\w-]+)-(?P<page_id>\w+)/edit/$', views.edit),

    re_path(r'^(?P<page_slug>[\w-]+)-(?P<page_id>\w+)/discuss/$', views.discuss),

    re_path(r'^(?P<page_slug>[\w-]+)-(?P<page_id>\w+)/permissions/$', views.permissions),

]

上面的路由写得不好,我们可以改进它,只需要声明共同的路径前缀一次,并将后面的部分分组转发:

from django.conf.urls import include, url

from . import views

urlpatterns = [

    re_path(r'^(?P<page_slug>[\w-]+)-(?P<page_id>\w+)/', include([

        re_path(r'^history/$', views.history),

        re_path(r'^edit/$', views.edit),

        re_path(r'^discuss/$', views.discuss),

        re_path(r'^permissions/$', views.permissions),

    ])),

]

3.5 反向解析

在使用Django 项目时,一个常见的需求是获得URL 的最终形式,以用于嵌入到生成的内容中(视图中和显示给用户的URL等)或者用于处理服务器端的导航(重定向等)。人们强烈希望不要硬编码这些URL(费力、不可扩展且容易产生错误)或者设计一种与URLconf 毫不相关的专门的URL 生成机制,因为这样容易导致一定程度上产生过期的URL。 在需要URL 的地方,对于不同层级,Django 提供不同的工具用于URL 反查:

1.在模板中:使用url 模板标签。

2.在Python 代码中:使用from django.urls import reverse()函数 urls.py:

from django.conf.urls import url

from . import views

urlpatterns = [

#...

re_path(r'^articles/([0-9]{4})/$', views.year_archive, name='news-year-archive'),

#...

]

在模板中:

<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.http import HttpResponseRedirect

def redirect_to_year(request):

# ...

year = 2006

# ...

return HttpResponseRedirect(reverse('news-year-archive', args=(year,))) # 同redirect("/path/")

当命名你的URL 模式时,请确保使用的名称不会与其它应用中名称冲突。如果你的URL 模式叫做comment,而另外一个应用中也有一个同样的名称,当你在模板中使用这个名称的时候不能保证将插入哪个URL。在URL 名称中加上一个前缀,比如应用的名称,将减少冲突的可能。我们建议使用myapp-comment 而不是comment。

3.6 名称空间

命名空间(英语:Namespace)是表示标识符的可见范围。一个标识符可在多个命名空间中定义,它在不同命名空间中的含义是互不相干的。这样,在一个新的命名空间中可定义任何标识符,它们不会与任何已有的标识符发生冲突,因为已有的定义都处于其它命名空间中。 由于name没有作用域,Django在反解URL时,会在项目全局顺序搜索,当查找到第一个name指定URL时,立即返回 我们在开发项目时,会经常使用name属性反解出URL,当不小心在不同的app的urls中定义相同的name时,可能会导致URL反解错误,为了避免这种事情发生,引入了命名空间。

project的urls.py:

urlpatterns = [

re_path(r'^admin/', admin.site.urls),

re_path(r'^app01/', include("app01.urls",namespace="app01")),

re_path(r'^app02/', include("app02.urls",namespace="app02")),

]

app01.urls:

urlpatterns = [

re_path(r'^index/', index,name="index"),

]

app02.urls:

urlpatterns = [

    re_path(r'^index/', index,name="index"),

]

app01.views

from django.core.urlresolvers import reverse

def index(request):

    return HttpResponse(reverse("app01:index"))

app02.views

from django.core.urlresolvers import reverse

def index(request):

    return HttpResponse(reverse("app02:index"))

附:

^ 指定起始字符或字符串,放进【】代表否定

$ 指定终止字符

/ 对应原来的字符

【。。。】 括号中表示一个字符的格式设置

\d 任何一个数字字符

\D 非数字的字符

\w 任何一个字符【a-zA-Z0-9】

\W 非任何一个字符【^a-zA-Z0-9】

? 代表前面一个字符样式可以重复出现0次或1次

* 可以重复出现0次或0次以上

+ 可以重复出现1次或1次以上

{m} 大括号中间数字m,代表前一个字符出现m次

{m,n} 代表前一个字符可以出现m-n次

| 或,

(...) 小括号中间匹配,或取出成为一个参数

(?P<name>) 同上,但是指定此参数名称那么


©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,569评论 4 363
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,499评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,271评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,087评论 0 209
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,474评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,670评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,911评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,636评论 0 202
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,397评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,607评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,093评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,418评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,074评论 3 237
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,092评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,865评论 0 196
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,726评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,627评论 2 270

推荐阅读更多精彩内容