4. Django 路由

最新推荐文章于 2024-06-24 04:04:18 发布

mannixiang

最新推荐文章于 2024-06-24 04:04:18 发布

阅读量194

点赞数

分类专栏： Django基础文章标签： django

本文链接：https://blog.csdn.net/mannixiang/article/details/115404085

版权

Django基础专栏收录该内容

14 篇文章 0 订阅

订阅专栏

本文详细介绍了Django的URL配置，包括URLconf的使用，正则表达式中的分组（无名与有名分组）及其在视图函数中的参数传递，路由的分发机制include，以及反向解析的实现。通过命名空间解决路由别名冲突，确保URL反查的准确性。内容涵盖了Django1.1.x到2.2.x版本的URL配置变化，帮助开发者更好地理解和使用Django路由。

摘要由CSDN通过智能技术生成

Django 路由

版权声明：本博客转载自路飞学城Python全栈开发培训课件，仅用于学习之用，严禁用于商业用途。
欢迎访问路飞学城官网：https://www.luffycity.com/

本节重点

路由（URLconf）简介
正则路径中的分组
路由分发
反向解析
命名空间

1. 路由（URLconf）简介

路由简单的来说就是根据用户请求的 URL 链接来判断对应的处理程序，并返回处理结果，也就是 URL 与 Django 的视图建立映射关系。

Django 路由在 urls.py 配置，urls.py 中的每一条配置对应相应的处理方法。

Django 不同版本 urls.py 配置有点不一样。

1.1 Django1.1.x 版本

url() 方法：普通路径和正则路径均可使用，需要自己手动添加正则首位限制符号。

URLconf配置基本格式：

from django.conf.urls import url # 用 url 需要引入

urlpatterns = [
    url(正则表达式, views视图函数，参数，别名),
]

参数说明：

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

实例：

# Django1.1.x 版本 
from django.conf.urls import url # 用 url 需要引入

urlpatterns = [
  url(r'^admin/$', admin.site.urls),
  url(r'^index/$', views.index), # 普通路径
  url(r'^articles/([0-9]{4})/$', views.articles), # 正则路径
]

注意事项：

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

补充说明：

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

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

其效果就是：

我们定义了urls.py：

from django.conf.urls import url
from app01 import views

urlpatterns = [
        url(r'^blog/$', views.blog),
]

访问 http://www.csdn.com/mannixiang 时，默认将网址自动转换为 http://www.csdn.com/mannixiang/ 。

如果在settings.py中设置了 APPEND_SLASH=False，此时我们再请求 http://www.csdn.com/mannixiang 时就会提示找不到页面。

1.2 Django 2.2.x 之后的版本

path：用于普通路径，不需要自己手动添加正则首位限制符号，底层已经添加。
re_path：用于正则路径，需要自己手动添加正则首位限制符号。

实例：

# Django 2.2.x 之后的版本
from django.urls import re_path # 用re_path 需要引入
urlpatterns = [
  path('admin/', admin.site.urls),
  path('index/', views.index), # 普通路径
  re_path(r'^articles/([0-9]{4})/$', views.articles), # 正则路径
]

总结： Django1.1.x 版本中的 url 和 Django 2.2.x 版本中的 re_path 用法相同。

2. 正则路径中的分组

2.1 正则路径中的无名分组

无名分组按位置传参，一一对应。

views 中除了 request，其他形参的数量要与 urls 中的分组数量一致。

实例：

# urls.py

urlpatterns = [
    path('admin/', admin.site.urls),
    re_path("^index/([0-9]{4})/$", views.index),
]

# views.py
from django.shortcuts import HttpResponse

def index(request，year):
    print(year) # 一个形参代表路径中一个分组的内容，按顺序匹配
    return HttpResponse('菜鸟教程')

2.2 正则路径中的有名分组

语法：

(?P<组名>正则表达式)

有名分组按关键字传参，与位置顺序无关。

views 中除了 request，其他形参的数量要与 urls 中的分组数量一致，并且 views 中的形参名称要与 urls 中的组名对应。

实例：

# urls.py
urlpatterns = [
    path('admin/', admin.site.urls),
    re_path("^index/(?P[0-9]{4})/(?P[0-9]{2})/$", views.index),
]

# views.py
from django.shortcuts import HttpResponse
def index(request, year, month):
    print(year,month) # 一个形参代表路径中一个分组的内容，按关键字对应匹配
    return HttpResponse('菜鸟教程')

在实际应用中，使用有名分组匹配的方式可以让你的URLconf 更加明晰且不容易产生参数顺序问题的错误，但是有些开发人员则认为分组命名组语法太丑陋、繁琐。

至于究竟应该使用哪一种，你可以根据自己的喜好来决定。

2.3 补充说明

URLconf匹配的位置

URLconf 在请求的URL 上查找，将它当做一个普通的Python 字符串。不包括GET和POST参数以及域名。

例如，http://www.csdn.com/mannixiang/ 请求中，URLconf 将查找mannixiang/ 。

在http://www.csdn.com/mannixiang/?page=3 请求中，URLconf 仍将查找mannixiang/ 。

URLconf 不检查请求的方法。换句话讲，所有的请求方法 —— 同一个URL的POST、GET、HEAD等等 —— 都将路由到相同的函数。

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

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

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

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

视图函数中指定默认值

实例：

# urls.py中
from django.conf.urls import url

from . import views

urlpatterns = [
    url(r'^blog/$', views.page),
    url(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值。

3. 路由分发(include)

存在问题：

Django 项目里多个app目录共用一个 urls 容易造成混淆，后期维护也不方便。

解决：

使用路由分发（include），让每个app目录都单独拥有自己的 urls。

步骤：

1、在每个 app 目录里都创建一个 urls.py 文件。
2、在项目名称目录下的 urls 文件里，统一将路径分发给各个 app 目录。

实例：

在项目名称目录下的 urls 文件里，使用incluce进行分发配置：

from django.contrib import admin
from django.urls import path,include # 从 django.urls 引入 include
urlpatterns = [
    path('admin/', admin.site.urls),
    path("app01/", include("app01.urls")),
    path("app02/", include("app02.urls")),
]

在各自 app 目录下，写自己的 urls.py 文件，进行路径跳转：

# app01 目录:
from django.urls import path,re_path 
from app01 import views # 从自己的 app 目录引入 views 
urlpatterns = [ 
    re_path(r'^login/(?P<m>[0-9]{2})/$', views.index, ),
]

# app02 配置：
from django.urls import path,re_path
from app02 import views # 从自己的 app 目录引入views 
urlpatterns = [ 
    re_path("^xxx/(?P[0-9]{4})/$", views.xxx), 
]

在这里插入图片描述

在各自 app 目录下的 views.py 文件中写各自的视图函数。

4. 反向解析

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

这时我们可以利用反向解析，当路由层 url 发生改变，在视图层和模板层动态反向解析出更改后的 url，免去修改的操作。反向解析一般用在模板中的超链接及视图中的重定向。

在需要URL 的地方，对于不同层级，Django 提供不同的工具用于URL 反查：

在模板中：使用url 模板标签。
在Python 代码中：使用django.core.urlresolvers.reverse() 函数。
在更高层的与处理Django 模型实例相关的代码中：使用get_absolute_url() 方法。

4.1 普通路径

在 urls.py 中给路由起别名，name=“路由别名”。

path("login1/", views.login, name="login")

在这里插入图片描述

在 views.py 中，从 django.urls 中引入 reverse，利用 reverse(“路由别名”) 反向解析。

return redirect(reverse("login"))

在这里插入图片描述

在模板 templates 中的 HTML 文件中，利用 {% url “路由别名” %} 反向解析。

<form action="{% url 'login' %}" method="post">

在这里插入图片描述

4.2 正则路径（无名分组）

在 urls.py 中给路由起别名，name=“路由别名”。

re_path(r"^login/([0-9]{2})/$", views.login, name="login")

在这里插入图片描述

在 views.py 中，从 django.urls 中引入 reverse，利用 reverse(“路由别名”，args=(符合正则匹配的参数,)) 反向解析。

return redirect(reverse("login",args=(10,)))

在这里插入图片描述

在模板 templates 中的 HTML 文件中利用 {% url “路由别名” 符合正则匹配的参数 %} 反向解析。

<form action="{% url 'login' 10 %}" method="post">

在这里插入图片描述

4.3 正则路径（有名分组）

在 urls.py 中给路由起别名，name=“路由别名”。

re_path(r"^login/(?P<year>[0-9]{4})/$", views.login, name="login")

在这里插入图片描述

在 views.py 中，从 django.urls 中引入 reverse，利用 reverse(“路由别名”，kwargs={“分组名”:符合正则匹配的参数}) 反向解析。

return redirect(reverse("login",kwargs={"year":3333}))

在这里插入图片描述

在模板 templates 中的 HTML 文件中，利用 {% url “路由别名” 分组名=符合正则匹配的参数 %} 反向解析。

<form action="{% url 'login' year=3333 %}" method="post">

在这里插入图片描述

4.4 补充说明

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

当命名你的URL 模式时，请确保使用的名称不会与其它应用中名称冲突。如果你的URL 模式叫做comment，而另外一个应用中也有一个同样的名称，当你在模板中使用这个名称的时候不能保证将插入哪个URL。

在URL 名称中加上一个前缀，比如应用的名称，将减少冲突的可能。我们建议使用myapp-comment 而不是comment。

5. 命名空间

命名空间（英语：Namespace）是表示标识符的可见范围。

一个标识符可在多个命名空间中定义，它在不同命名空间中的含义是互不相干的。

一个新的命名空间中可定义任何标识符，它们不会与任何重复的标识符发生冲突，因为重复的定义都处于其它命名空间中。

存在问题： 路由别名 name 没有作用域，Django 在反向解析 URL 时，会在项目全局顺序搜索，当查找到第一个路由别名 name 指定 URL 时，立即返回。当在不同的 app 目录下的urls 中定义相同的路由别名 name 时，可能会导致 URL 反向解析错误。

解决： 使用命名空间。

普通路径

定义命名空间（include 里面是一个元组）格式如下：

include(("app名称：urls"，"app名称"))

实例：

path("app01/", include(("app01.urls","app01"))) 
path("app01/", include(("app02.urls","app02")))

在这里插入图片描述

在 app01/urls.py 中起相同的路由别名。

path("login/", views.login, name="login")

在这里插入图片描述

在 views.py 中使用名称空间，语法格式如下：

reverse("app名称：路由别名")

实例：

return redirect(reverse("app01:login")

在这里插入图片描述

在 templates 模板的 HTML 文件中使用名称空间，语法格式如下：

{% url "app名称：路由别名" %}

实例：

<form action="{% url 'app01:login' %}" method="post">

在这里插入图片描述

mannixiang

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
复制链接

分享到 QQ

分享到新浪微博

扫一扫

专栏目录