广受好评的Django教程现已更新至3.1版本,进行了全面细致的修订,添加了重要内容,更深入更丰富,恳请大家继续支持,衷心感谢!

URL路由基础

阅读: 47205     评论:12

URL是Web服务的入口,用户通过浏览器发送过来的任何请求,都是发送到一个指定的URL地址,然后被响应。

Django奉行DRY主义,提倡使用简洁、优雅的URL,没有.php.cgi这种后缀,更不会单独使用0、2097、1-1-1928、00这样无意义的东西。

一、概述

URL路由在Django项目中的体现就是urls.py文件,这个文件可以有很多个,但绝对不会在同一目录下。实际上Django提倡项目有个根urls.py,各app下分别有自己的一个urls.py,既集中又分治,是一种解耦的模式。

随便新建一个Django项目,默认会自动为我们创建一个/project_name/urls.py文件,并且自动包含下面的内容,这就是项目的根URL:

"""dj_test URL Configuration

The `urlpatterns` list routes URLs to views. For more information please see:
    https://docs.djangoproject.com/en/2.0/topics/http/urls/
Examples:
Function views
    1. Add an import:  from my_app import views
    2. Add a URL to urlpatterns:  path('', views.home, name='home')
Class-based views
    1. Add an import:  from other_app.views import Home
    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
Including another URLconf
    1. Import the include() function: from django.urls import include, path
    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
"""
from django.contrib import admin
from django.urls import path

urlpatterns = [
    path('admin/', admin.site.urls),
]

前面一堆帮助性的文字,我们不用管,关键是默认导入了path方法和admin模块,然后有一条指向admin后台的url路径。

我们自己要编写的url路由,基本也是这个套路。

二、Django如何处理请求

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

  1. 决定要使用的根URLconf模块。通常,这是ROOT_URLCONF设置的值,但是如果传入的HttpRequest对象具有urlconf属性(由中间件设置),则其值将被用于代替ROOT_URLCONF设置。也就是说你可以自定义项目入口url是哪个文件!
  2. 加载该模块并寻找可用的urlpatterns。 它是django.urls.path()或者django.urls.re_path()实例的一个列表。
  3. 依次匹配每个URL模式,在与请求的URL相匹配的第一个模式停下来。也就是说,url匹配是从上往下的短路操作,所以url在列表中的位置非常关键。
  4. 导入并调用匹配行中给定的视图,该视图是一个简单的Python函数(被称为视图函数),或基于类的视图。 视图将获得如下参数:
  5. 一个HttpRequest 实例。
  6. 如果匹配的表达式返回了未命名的组,那么匹配的内容将作为位置参数提供给视图。
  7. 关键字参数由表达式匹配的命名组组成,但是可以被django.urls.path()的可选参数kwargs覆盖。
  8. 如果没有匹配到任何表达式,或者过程中抛出异常,将调用一个适当的错误处理视图。(比如403,比如无任何反应)

三、简单示例

先看一个例子:

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. urlpatterns是个列表,每个元素都是path()re_path() 的实例
  2. 要捕获一段url中的值,需要使用尖括号,而不是之前的圆括号;
  3. 可以转换捕获到的值为指定类型,比如例子中的int。默认情况下,捕获到的结果保存为字符串类型,不包含/这个特殊字符;
  4. 匹配模式的最开头不需要添加/,因为默认情况下,每个url都带一个最前面的/,既然大家都有的部分,就不用浪费时间特别写一个了。
  5. 每个匹配模式都建议以斜杠结尾

匹配例子:

  • /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"

请思考:

第一问:/articles/2005/March/会匹配那一条?第三条?它那一条都不匹配!因为月份有个int转换器,March无法被转换为整数,所以无法匹配。

第二问:那么如果我去掉第三条的int转换器呢,让它变成path('articles/<year>/<month>/', views.month_archive),呢?/articles/2005/March/会成功匹配!

第三问:如果只保留第三条path,其它的都删除,那么/articles/2003/会匹配上吗?不会!因为默认的匹配方式是exact完全相同,而不是include子串包含。

第四问:如果我将第一条和第二条换个位置,那么/articles/2003/会匹配哪个?它会匹配'articles/<int:year>/',因为短路机制。

第五问:我能不能写一个path('articles/year<int:year>/month<int:month>/', views.another_month_archive),这样的path?当然可以!但是这么不优雅!

第六问:path最后的斜杠和我们在浏览器中最后是否输入斜杠之间是什么关系?记住,path最后有斜杠,则url输入最后可以有也可以没有斜杠,但是path最后没有斜杠,则url输入最后也不能有斜杠。

提示:每当urls.py文件被第一次加载的时候,urlpatterns里的表达式们都将被预先编译,这会大大提高系统处理路由的速度。

四、path转换器

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

  • str:匹配任何非空字符串,但不含斜杠/,如果你没有专门指定转换器,默认使用该转换器
  • int:匹配0和正整数,返回一个int类型
  • slug:可理解为注释、后缀、附属等概念,是url拖在最后的一部分解释性字符。该转换器匹配任何ASCII字符以及连接符和下划线,比如building-your-1st-django-site
  • uuid:匹配一个uuid格式的对象。为了防止冲突,规定必须使用破折号,所有字母必须小写,例如075194d3-6885-417e-a8a8-6c931e272f00。返回一个UUID对象;
  • path:匹配任何非空字符串,重点是可以包含路径分隔符’/‘。这个转换器可以帮助你匹配整个url而不是一段一段的url字符串。要区分path转换器和path()方法

五、自定义path转换器

对于更复杂的匹配需求,你可能需要自定义你自己的path转换器。

path转换器其实就是一个类,包含下面的成员和属性:

  • 类属性regex:一个字符串形式的正则表达式属性;
  • to_python(self, value) 方法:一个用来将匹配到的字符串转换为你想要的那个数据类型,并传递给视图函数。如果转换失败,它必须弹出ValueError异常;
  • to_url(self, value)方法:将Python数据类型转换为一段url的方法,上面方法的反向操作。如果转换失败,也会弹出ValueError异常。

例如,新建一个converters.py文件,与urlconf同目录,写个下面的类:

class FourDigitYearConverter:
    regex = '[0-9]{4}'

    def to_python(self, value):
        return int(value)

    def to_url(self, value):
        return '%04d' % value

写完类后,在URLconf 中使用register_converter注册它,如下所示,注册了一个yyyy:

from django.urls import register_converter, path

from . import converters, views

register_converter(converters.FourDigitYearConverter, 'yyyy')

urlpatterns = [
    path('articles/2003/', views.special_case_2003),
    path('articles/<yyyy:year>/', views.year_archive),
    ...
]

六、使用正则表达式

Django2.0的urlconf虽然改‘配置方式’了,但它依然向老版本兼容。而这个兼容的办法,就是用re_path()方法。re_path()方法在骨子里,根本就是以前的url()方法,只不过导入的位置变了。下面是一个例子,对比一下Django1.11时代的语法,有什么太大的差别?

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()方法不同的在于三点:

  • 捕获URL中的参数使用的是正则捕获,语法是 (?P<name>pattern) ,其中 name 是组名,pattern 是要匹配的模式。
  • year中匹配不到10000等非四位数字,这是正则表达式决定的
  • 传递给视图的所有参数都是字符串类型。而不像path()方法中可以指定转换成某种类型。在视图中接收参数时一定要小心。

七、匹配部分

请求的URL被看做是一个普通的Python字符串,URLconf在其上查找并匹配。进行匹配时将不包括GET或POST请求方式的参数以及域名。

例如,在https://www.example.com/myapp/的请求中,URLconf将查找myapp/

https://www.example.com/myapp/?page=3的请求中,URLconf也将查找myapp/

URLconf不检查使用何种HTTP请求方法,所有请求方法POST、GET、HEAD等都将路由到同一个URL的同一个视图。在视图中,才根据具体请求方法的不同,进行不同的处理。

八、指定视图参数的默认值

有一个小技巧,我们可以指定视图参数的默认值。 下面是一个URLconf和视图的示例:

# URLconf
from django.urls import path

from . import views

urlpatterns = [
    path('blog/', views.page),
    path('blog/page<int:num>/', views.page),
]

# 视图 (blog/views.py)
def page(request, num=1):
    # Output the appropriate page of blog entries, according to num.
    ...

在上面的例子中,两个URL模式指向同一个视图views.page。但是第一个模式不会从URL中捕获任何值。 如果第一个模式匹配,page()函数将使用num参数的默认值"1"。 如果第二个模式匹配,page()将使用捕获的num值。


 第二章:视图层 路由转发 

评论总数: 12


点击登录后方可评论

user_image

自定义错误页面 得再settings.py文件中,将DEBUG = True 更改为 DEBUG = False



user_image



user_image

path('blog/page<int:num>/', views.page),这里应该是 path('blog/<int:num>/', views.page),



user_image

自定义错误界面要在setting中把DEBUG改为False,然后再下面的port中加入['*']



user_image

请问一下 404.html 文件放在那个路径下面,我换了好几个地方都无法正确显示自己设置的错误界面



user_image

在app目录下新建一个template目录,里面再新建一个app目录,再在这个app目录里面新建html文件。参考投票应用。



user_image

左侧的目录,动就动,不动就不动,你这样看着头都晕啊



user_image

在django2.0中,URL中捕获的参数为字符串类型, 不全部是字符串了. 刘大大,注释一下哈~



user_image

为何 url(r'^blog/page(?P<num>[0-9]+)/$' 我按这样规则写 在视图函数中,def page(request, num="1"),num接收不到数据 如果不给num赋初值,还会报错说没有给num赋值 请问该如何解决



user_image

信息太少,无法准确回答。但从字面上看,url路由没写全,后面关联的是哪个视图函数呢?是没贴出来还是真没写?是不是views.page?



user_image

博主,这个地方应该是400吧?



user_image

handler404 = views.page_not_found这种是请求不成功,系统自动返回一个错误页面。 question = get_object_or_404(Question, pk=question_id)这种是手动处理转到错误页面。 如果视图类比较多,推荐用第一种写法?