Django设置路由分发规则

2023-10-13 19:55:34

（一）复习
创建项目（django-admin startproject XXX）
创建应用（python manage.py startapp XXX）
配置应用、模板、数据库、静态资源、媒体资源
内置指令（30个，必须了解每个指令的具体作用）
（二）路由
路由称为URL (Uniform Resource Locator- 统一资源定位符)，也可以称为URLconf， 是对可以从互联网上得到的资源位置和访问方法的一种简洁表示，是互联网上标准资源的地址。互联网上每个文件都有一个唯一的路由，用于指出网站文件的路径位置。简单地说，路由可视为我们常说的网址，每个网址代表不同的网页。

二、新课讲授
（一）设置路由分发规则
一个完整的路由包含：路由地址、视图函数（或者视图类）、路由变量和路由命名。其中基本的信息必须有：路由地址和视图函数（或者视图类），路由地址即我们常说的网址；视图函数（或者视图类）即项目应用（App）的views.py文件所定义的函数或类；路由变量和路由命名是路由的变量和命名设置，使路由具有动态变化和命名引用功能。（动态变化是指一个路由地址按照某个规律演变多种不同的路由地址：命名引用是指在视图、模型等其他项目文件使用路由命名生成相应的路由地址）

在默认情况下，设置路由地址是在项目同名的文件夹的urls.py文件里实现，这也是由配置文件settings.py的ROOT_URLCONF决定，以项目babies为例，配置属性ROOT_URLCONF指向babies文件夹的urls.py，如下图所示：

一个项目中可能设有多个项目应用（App），而babies文件夹的urls.py是定义项目所有路由地址的总入口，如果项目中所有路由地址都在babies文件夹的urls.py中定义，当项目功能规模越来越大的时候，babies文件夹的urls.py定义的路由地址就会越来越多，从而造成难以管理的问题。

为了更好区分各个项目应用（App）的路由地址，我们在babies文件夹的urls.py中分别为每个项目应用（App）定义一条路由入口。首先在每个项目应用（App）的文件夹里创建urls.py文件，然后将新建的urls.py添加到babies文件夹的urls.py，添加方法由Django内置函数path和include实现。

1、创建应用的路由文件（子路由） - urls.py
每个应用（App）均创建一个路由文件urls.py，目前没有什么具体内容，只写一条语句，定义一个空列表urlpatterns：

urlpatterns = [

]
Django设置路由分发规则

 

（2）创建commodity应用的路由文件

Django设置路由分发规则

 

3）创建shopper应用的路由文件

Django设置路由分发规则

 

2、配置项目的路由文件（主路由） - urls.py

（1）定义项目的路由集合

  • 使项目的urls.py的urlpatterns指向每个应用的urls.py，具体配置如下：
    Django设置路由分发规则

 

（2）主路由文件代码说明
babies文件夹的urls.py定义了5条路由信息，分别是Admin站点管理、首页地址（项目应用index的urls.py） 、商品信息（项目应用commodity的urls.py） 、购物车信息（项目应用shopper的urs.py）和媒体资料。其中， Admin站点管理在创建项目时己自动生成，一般情况下无须更改。整个babies文件夹的urls.py的代码说明如下：

from django.contrib import admin：导入内置Admin功能模块。
from django.urls import path,include：导入Django的路由函数模块。
urlpatterns：代表整个项目的路由集合，以列表格式表示，每个元素代表一条路由信息。
path（'admin/'， 'admin.site.urls'）：设定Admin管理系统的路由信息。'admin/'代表127.0.0.1:8000/admin的路由地址，admin后面的斜杠是路径分隔符，其作用等同于计算机中文件目录的斜杠符号； admin.site.urls指向内置Admin功能所自定义的路由信息，可以在Python目录Lib\site-packages\django\contrib\admin\sites.py中找到具体的定义过程。

Django设置路由分发规则

 

path('', include(('index.urls', 'index'), namespace='index'))：路由地址为"/"，即 127.0.0.1:8000，通常是网站的首页；路由函数include是将该路由地址分发给项目应用index的urls.py处理。（说明：include((pattern_list，app_namespace)，namespace=None) app_namespace：应用命名空间；namespace：实例命名空间）
path('commodity', include(('commodity.urls', 'commodity'), namespace='commodity'))：路由地址为"/commodity"，即127.0.0.1:8000/commodity，这是商品详细和商品列表页面；路由函数include是将该路由地址分发给项目应用commodity的urls.py处理。
path('shopper', include(('shopper.urls', 'shopper'), namespace='shopper'))：路由地址为 "/shopper"，即127.0.0.1:8000/shopper，这是购物车、个人中心、用户注册等页面；路由函数include是将该路由地址分发给项目应用shopper的urls.py处理。
re_path('media/(?P<path>.*)', serve, {'document_root': settings.MEDIA_ROOT}, name='media')：路由地址为"/media/xxx"，即127.0.0.1:8000/media/xxx，这是媒体定义的路由地址，路由函数re_path表示允许在路由地址里面设置正则表达式。
3、路由设计模式的工作原理
从babies文件夹的urls.py定义的路由信息得知，每个项目应用（App）的路由地址交给项目应用的urls.py自行管理，这是路由的分发规则，使路由按照一定的规则进行分类管理。整个路由设计模式的工作原理说明如下：

当运行babies项目时， Django从babies文件夹的urls.py找到各个项目应用（App）的urls.py，然后读取每个项目应用（App）的urls.py定义的路由信息，从而生成完整的路由列表。
用户在浏览器*问某个路由地址时，Django就会收到该用户的请求信息。
Django从当前请求信息中获取路由地址，并在路由列表里匹配相应的路由信息，再执行路由信息所指向的视图函数（或视图类），从而完成整个请求响应过程。

（二）路由分发详解
1、路由函数include的参数说明
从上面看到，我们设置项目路由分发功能的时候，除了使用内置函数path和include之外，还在路由中设置了参数namespace，该参数是可选参数，是Django设置路由的命名空间。

路由函数include设有参数arg和namespace，参数arg指向项目应用App的urls.py文件，其数据格式以元组或字符串表示；可选参数namespace是路由的命名空间。

若要对路由设置参数namespace，则参数arg必须以元组格式表示，并且元组的长度必须为2。以路由path('', include(('index.urls', 'index'), namespace='index'))为例，参数arg为('index.urls', 'index')，参数的每个元素说明如下：

第一个元素为项目应用的urls.py文件，比如('index.urls','index')的“index.urls”，这是代表项目应用index的urls.py文件。
第二个元素可以自行命名，但不能为空，一般情况下是以项目应用的名称进行命名，如('index.urls','index')的“index”是以项目应用index进行命名的。
如果路由设置参数namespace并且参数arg为字符串或元组长度不足2的时候，比如我们将首页的路由分发设为path('', include(('index.urls'), namespace='index'))，当运行项目的时候，Django就会提示错误信息，如下图所示。
Django设置路由分发规则

 将路由函数include的第一个参数设置为二值元组，再启动项目就没有错误。
Django设置路由分发规则

 

2、路由函数include的作用
路由函数include的作用是将当前路由分配到某个项目应用的urls.py文件，而项目应用的urls.py文件可以设置多条路由，这种情况类似计算机上的文件夹A，并且该文件夹下包含多个子文件夹，而`Django的命名空间namespace相当于对文件夹A进行命名。

假设项目路由设计为：在babies文件夹的urls.py定义3条路由，每条路由都使用路由函数include，并分别命名为A、B、C，每条路由对应某个项目应用的urls.py文件，并且每个项目应用的urls.py文件里定义若干条路由。

根据上述的路由设计模式，将babies文件夹的urls.py视为计算机上的D盘，在D盘下有3个文件夹，分别命名为A、B、C，每个项目应用的urls.py所定义的若干条路由可视为这3个文件夹里面的文件。在这种情况下，Django的命名空间namespace等同于文件夹A、B、C的文件名。

三个命名空间：index、commodity、shopper
Django设置路由分发规则

 三个命名空间对应的三个文件夹：index、commodity、shopper
Django设置路由分发规则

 

Django的命名空间namespace可以为我们快速定位某个项目应用的urls.py，再结合路由命名name就能快速地从项目应用的urls.py找到某条路由的具体信息，这样就能有效管理整个项目的路由列表。有关路由函数include的定义过程，可以在Python安装目录下找到源码（Lib\site-packages\django\urls\conf.py）进行解读。
（三）设置商城的路由地址
我们已在babys文件夹的urls.py分别为项目应用index、shopper和commodity设置路由分发功能，本节将会在项目应用index、shopper和commodity的urls.py定义网站首页、商品列表页、商品详细页、购物车页面、个人中心页面和用户登录注册页面的路由地址。

1、index应用的配置
（1）编写index应用的视图views.py
Django设置路由分发规则

 

  • indexView为视图函数的名称

  • index.html对应模板文件夹下的一个模板文件

  • 目前index.html只显示一条信息“母婴商城首页”
    Django设置路由分发规则

 

render()用于渲染模板页面

（2）配置index应用的路由urls.py
在路由模式列表里添加一个路由，指向上面定义的视图函数 - indexView

（1）第一个参数为空字符串，这是设置具体的路由地址，由于babies文件夹的urls.py的路由分发为path('', include(('index.urls', 'index'), namespace='index')) ， 即代表网址127.0.0.1:8000，而index的urls.py定义的路由地址index设为空字符串，那么路由地址index的网址为127.0.0.1:8000。
（2）第二个参数为indexView，这是指向项目应用index的views.py的某个视图函数或视图类，当用户在浏览器访问127.0.0.1:8000的时候， Django将接收到一个HTTP请求，从该请求中获取路由地址并与自身的路由列表进行匹配，如果路由地址匹配成功， Django将HTTP请求交给路由地址指向的某个视图函数或视图类进行业务处理。
（3）第三个参数为name='index’，这是函数path的可选参数，该参数是命名路由地址。实际开发中必须为每个路由地址进行命名，可以在视图或模板中使用路由名称生成相应的路由地址。
（3）测试index应用的路由配置
启动项目，访问http://127.0.0.1:8000
Django设置路由分发规则

 

  • 修改index应用的路由
    Django设置路由分发规则
  • 启动项目，访问http://127.0.0.1:8000，出现路径不匹配问题

 Django设置路由分发规则

 访问http://127.0.0.1:8000/index就没有问题
Django设置路由分发规则

 主路由与子路由的路径拼接问题
Django设置路由分发规则

 

  • 看路径匹配列表第2项：index index，没有斜杠分隔符
  • 要在主路由与子路由的路径之间产生一个斜杠分隔符，有两种处理方式：在主路由路径后加斜杠，或在子路由路径前加斜杠
  • 第一种处理方式的效果
    Django设置路由分发规则

 

  • 第二种处理方式的效果
    Django设置路由分发规则
  • 第二种处理方式有个警告，系统不建议采用这种在子路由路径前加斜杠的处理方式
  • 修改代码

 Django设置路由分发规则

 

2、commodity应用的配置

（1）编写commodity应用的视图views.py

Django设置路由分发规则

 

from django.http import HttpResponse
from django.shortcuts import render

# Create your views here.
def commodityView(request):
    return render(request, "commodity.html")

def detailView(request, id):
    print('id: {}'.format(id))
    return HttpResponse('<h3>商品编号：' + str(id) + '</h3>')

2）编写commodity应用的路由urls.py

  • 在路由模式列表里添加两个路由，指向上面定义的视图函数 - commodityView与detailView
    Django设置路由分发规则

 

from django.urls import path

from commodity.views import commodityView, detailView

urlpatterns = [
    path('.html', commodityView, name='commodity'),
    path('/detail/<int:id>.html', detailView, name='detail')
]

上述代码分别定义了商品列表页的路由地址commodity和商品详细页的路由地址detail，路由地址的定义说明如下：

（1）项目应用commodity的urls.py路由空间是path('commodity', include(('commodity.urls', 'commodity'), namespace='commodity'))，因此路由commodity为127.0.0.1:8000/commodity.html，路由detail为127.0.0.1:8000/commodity/detail/2.html。
（2）路由detail设置了路由变量id，该变量以整数型表示，它可以代表1、2、3 等整数，变量id对应商品信息表的主键id，通过改变变量id的数值可以查看不同商品的详情。
（3）路由地址的末端设置了“.html” ，这是一种伪静态URL技术，可将网址设置为静态网址，用于SEO (Search Engine Optimization)搜索引擎的爬取，如百度、谷歌等。此外，在末端设置“.html”是为变量id设置终止符，假如末端没有设置“.html” ，并且路由变量为字符串类型，在浏览器上输入无限长的字符串，路由也能正常访问。
（4）路由commodity和detail的业务逻辑处理分别指向项目应用commodity的views.py定义的视图函数commodityView和detailView.
（3）测试commodity应用的路由配置
启动项目，访问http://127.0.0.1:8000/commodity.html
Django设置路由分发规则

 访问http://127.0.0.1:8000/commodity/detail/2.html
Django设置路由分发规则

 查看控制台输出信息
Django设置路由分发规则

 

3、shopper应用的配置

  • 编写三个页面shopper.html、login.html、shopcart.html
    Django设置路由分发规则

 

（1）编写shopper应用的视图views.py

Django设置路由分发规则

 

（2）编写shopper应用的路由urls.py

Django设置路由分发规则

 

from django.urls import path

from shopper.views import shopperView, loginView, logoutView, shopcartView

urlpatterns = [
    path('.html', shopperView, name='shopper'),
    path('/login.html', loginView, name='login'),
    path('/logout.html', logoutView, name='logout'),
    path('/shopcart.html', shopcartView, name='shopcart')
]

上述代码定义了4条路由地址，每个路由所对应的功能说明如下：

（1）路由shopper代表个人中心页,它的路由空间是path('shopper', include(('shopper.urls' 'shopper')，namespace='shopper')，因此路由地址为127.0.0.1:8000/shopper.html，个人中心页的业务逻辑由项目应用shopper的views.py定义的视图函数shopperView实现。
（2）路由login代表用户登录注册页，路由地址为127.0.0.1:8000/shopper/login.html，它的业务逻辑由项目应用shopper的views.py定义的视图函数loginView实现。
（3）路由logout实现个人中心的用户注销功能，路由地址为127.0.0.1:8000/shopper/logout.html，它的业务逻辑由项目应用shopper的views.py定义的视图函数logoutView实现。
（4）路由shopcart代表购物车信息页，路由地址为127.0.0.1:8000/shopper/shopcart.html 它的业务逻辑由项目应用shopper的views.py定义的视图函数shopcartView实现。

（3）测试shopper应用的路由配置

  • 启动项目，访问http://127.0.0.1:8000/shopper.html
    Django设置路由分发规则

     访问http://127.0.0.1:8000/shopper/login.html
    Django设置路由分发规则

     访问http://127.0.0.1:8000/shopper/shopcart.html
    Django设置路由分发规则

     访问http://127.0.0.1:8000/shopper/logout.html
    Django设置路由分发规则

     

上一篇：Django与python和 djangorestframework 版本


下一篇：2021.1.5日总结（考研倒计时：353）