1. URL路由基础
对于高质量的Web应用来讲,使用简洁、优雅的URL设计模式非常有必要。Django框架允许设计人员自由地设计URL模式,而不用受到框架本身的约束。对于URL路由来讲,其主要实现了Web服务的入口。用户通过浏览器发送过来的任何请求,都会解析到一个指定的URL地址上去,进而得到服务器端的响应,这是一个基本流程。
在Django项目中,配置URL路由通过目录中的urls.py文件来完成。虽然在一个Django项目中可以配置有多个urls.py文件(因为一个项目可以包含若干个App),但这些urls.py文件绝对不能放在同一目录下。一般情况下,在Django项目根目录下需要配置一个urls.py(根路由)文件,然后在每个App下分别定义一个自己的urls.py,这样就相当于是一种比较先进的解耦模式。
归根结底,URL路由就是相当于路径和视图函数之间的一个对应关系,起到了一个中间媒介的作用,URL路由原理如图4.1所示。
在图4.1中,客户端用户发来的HTTP请求经过URL路由映射处理后,会发送到相应的View视图处理函数进行处理,View视图函数处理完成后,再通过HttpResponse对象返回具体信息到客户端进行显示。
一个urls.py文件的通用基本格式可参考下面的代码。
【代码4-1】
01 from django.contrib import admin
02 from django.urls import path
03
04 urlpatterns = [
05 path('admin/', admin.site.urls),
06 path('hello/', views.hello),
07 ...
08 ]
【代码分析】
在第01行代码中,通过调用django.contrib模块导入了admin(管理员)对象,这是一个Django框架自带的管理员模块。
在第02行代码中,通过调用django.urls模块导入了path(路径)对象,这是一个负责URL路由配置的模块。
在第04~08行代码中,通过urlpatterns对象定义了一个数组。其中,第05、06行代码通过path对象定义了具体的路径配置信息。通常,用户自定义的路由配置代码都是在这里完成的。
2. Django如何处理请求
在Django框架中,当客户端用户发出一个页面请求时,URL路由基本会按照下面的逻辑(算法)执行操作。
(1)决定要使用的根URLconf模块。通常情况下,这是由ROOT_URLCONF所设置的值。但是,如果传入的HttpRequest对象具有urlconf属性(由中间件设置),则其值将被用于代替ROOT_URLCONF参数所设置的值。这也就是说,设计人员可以自行指定自定义项目的入口文件urls.py。
(2)加载这个URLconf模块并寻找可用的urlpatterns路由模式,它是django.urls.path()实例或django.urls.re_path()实例的一个列表。
(3)依次匹配每个URL模式,在找到与请求的URL模式相匹配的第一个模式上停止。这也就是说,URL模式匹配是从上往下的短路操作,因此每个URL在列表中的位置是比较关键的。
(4)继续导入并调用匹配行中给定的视图,该视图是一个简单的Python函数(被称为视图函数)或者是一个基于类的视图。另外,该视图将获得如下3类参数:
- 一个HttpRequest对象实例。
- 如果匹配的表达式返回了未命名的组,那么匹配的内容将作为位置参数提供给视图。
- 关键字参数由表达式匹配的命名组所组成,但是可以被django.urls.path()实例或django.urls.re_path()实例的可选参数kwargs覆盖。
(5)如果没有匹配到任何表达式,或者过程中抛出异常,将调用一个适当的错误处理视图。
一个关于URLconf模块的代码实例如下所示。
【代码4-2】
01 from django.urls import path
02
03 from . import views
04
05 urlpatterns = [
06 path('articles/2023/', views.special_case_2023),
07 path('articles/<int:year>/', views.year_archive),
08 path('articles/<int:year>/<int:month>/', views.month_archive),
09 path('articles/<int:year>/<int:month>/<slug:slug>/', views.article_detail),
10 ...
11 ]
【代码分析】
在第05~11行代码中,定义的就是urlpatterns数组列表,每一个列表项都是path()或re_path()的实例。具体说明如下:
- 在第06行代码中,将路径'articles/2023/'解析为视图views.special_case_2023,且路径'articles/2023/'的年份(2023)为固定的。
- 在第07行代码中,将路径'articles/<int:year>/'解析为视图views.year_archive,且路径中的年份(<int:year>)为任意的。
- 在第08行代码中,将路径'articles/<int:year>/<int:month>/'解析为视图views.month_archive,且路径中的年份(<int:year>)和月份(<int:month>)均为任意的。
- 在第09行代码中,将路径'articles/<int:year>/<int:month>/<slug:slug>/'解析为视图views.article_detail,且路径中新增了slug类型转换器。
在这段路径解析代码中,有以下5点要重点说明:
- 要捕获一段URL中的值,需要使用尖括号(< >)。
- 可以将捕获到的值转换为指定类型,比如上面代码中的int类型(整型)。
- 默认情况下,捕获到的结果保存为字符串类型,但是不包含"/"这个特殊字符的。
- 匹配模式的最开头不需要添加特殊字符"/",因为默认情况下的每个URL地址的最前面都会带有这个特殊字符的。
- 每个匹配模式都建议以特殊字符"/"结尾。
下面,基于【代码4-2】讲解几个典型的、针对URL地址进行模式匹配的示例。具体内容如下:
(1)"/articles/2023/":匹配第06行代码,并调用views.special_case_2023(request)视图。
(2)"/articles/2023":无匹配结果,因为最后少了一个斜杠(/),而列表中的所有模式都以斜杠(/)结尾。
(3)"/articles/2050/":匹配第07行代码,并调用views.year_archive(request)视图。
(4)"/articles/2023/12/":匹配第08行代码,并调用views.month_archive(request, year=2023, month=12)视图。
本文节选自《Django 5企业级Web应用开发实战(视频教学版)》,获出版社和作者授权发布。