Django系列教程(7)——路由配置URLConf

devtools/2025/3/14 6:32:13/

目录

URLconf是如何工作的?

path和re_path方法

更多URL配置示例

URL的命名及reverse()方法

使用命名URL

硬编码URL - 不建议

URL指向基于类的视图(View)

通过URL传递额外的参数

小结


Django的项目文件夹和每个应用(app)目录下都有urls.py文件,它们构成了Django的路由配置系统(URLconf)。服务器收到用户请求后,会根据用户请求的url地址和urls.py里配置的url-视图映射关系,去调用执行相应的视图函数或视图类,最后由视图返回给客户端数据。

一个优美的URL不仅层次分明、逻辑清晰,而且便于搜索引擎收录。一个糟糕的URL不仅可读性差,而且易造成程序冲突。本章小编我将给大家详细介绍下如何在Django项目开发中进行路由配置。

URLconf是如何工作的?

假如我们有一个blog的博客应用,你需要编写两个视图函数,一个用于展示文章列表,一个用于展示文章详情,你的urls.pyviews.py正常情况下应如下所示:

# blog/urls.py
from django.urls import path
from . import viewsurlpatterns = [path('blog/', views.index),path('blog/articles/<int:id>/', views.article_detail),
]# blog/views.py
def index(request):# 展示所有文章def article_detail(request, id):# 展示某篇具体文章

那么上面这段代码是如何工作的呢?

  • 当用户在浏览器输入/blog/时,URL收到请求后会调用视图views.py里的index方法,展示所有文章
  • 当用户在浏览器输入/blog/article/<int:id>/时,URL不仅调用了views.py里的article_detail方法,而且还把参数文章id通过<>括号的形式传递给了视图。int这里代表只传递整数,传递的参数名字是id。

在上述代码中,我们通过urlpatterns列表的url-视图映射关系列表起了决定性作用,起到了任务调度的作用。

注意:注意当你配置URL时,别忘了把你的应用(blog)的urls加入到项目的URL配置里(mysite/urls.py), 如下图所示:

from django.urls import include, pathurlpatterns = [path('', include('blog.urls')),...
]

path和re_path方法

写个URL很简单,但如何通过URL把参数传递给给视图view是个技术活。Django提供了两种设计URL的方法: pathre_path,它们均支持向视图函数或类传递参数。path是正常参数传递,re_path是采用正则表达式regex匹配。pathre_path传递参数方式如下:

  • path方法:采用双尖括号<变量类型:变量名><变量名>传递,例如<int:id><slug:slug><username>

  • re_path方法: 采用命名组(?P<变量名>表达式)的方式传递参数。

下例中,我们分别以pathre_path 定以了两个urls,它们是等效的,把文章的id(整数类型)传递给了视图。re_path里引号前面的小写r表示引号里为正则表达式, ^代表开头,$代表以结尾,\d+代表正整数。

# blog/urls.py
from django.urls import path, re_path
from . import viewsurlpatterns = [path('blog/articles/<int:id>/', views.article_detail, name = 'article_detail'),re_path(r'^blog/articles/(?P<id>\d+)/$', views.article_detail, name='article_detail'),
]# blog/views.py
def article_detail(request, id):# 展示某篇文章

在使用pathre_path方法设计urls需注意:

  • url中的参数名要用尖括号,而不是圆括号;
  • 匹配模式的最开头不需要添加斜杠/,但建议以斜杠结尾;
  • 使用re_path时不一定总是以$结尾,有时不能加。比如下例中把blog.urls通过re_path加入到项目urls中时就不能以$结尾,因为这里的blog/并不是完整的url,只是一个开头而已。
from django.urls import include, re_pathurlpatterns = [re_path(r'^blog/', include('blog.urls')),...
]

更多URL配置示例

path支持匹配的数据类型只有str,intsluguuid四种。一般来说re_path更强大,但写起来更复杂一些,我们来看看更多案例。

# 示例一,PATH
from django.urls import path
from . import viewsurlpatterns = [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),
]# 示例二:RE_PATH,与上例等同
from django.urls import path, re_path
from . import viewsurlpatterns = [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),
]

同样以博客为例,如果你希望设计不同的urls分别对应负责增删改查操作的视图函数或类,你可以按如下设计:

# blog/urls.py
from django.urls import path, re_path
from . import views# app_name = 'blog' # 命名空间,后面会用到。
urlpatterns = [path('blog/articles/', views.article_list, name = 'article_list'),path('blog/articles/create/', views.article_create, name = 'article_create'),path('blog/articles/<int:id>/', views.article_detail, name = 'article_detail'),path('blog/articles/<int:id>/update/', views.article_update, name = 'article_update'),path('blog/articles/<int:id>/delete/', views.article_update, name = 'article_delete'),
]

URL的命名及reverse()方法

你注意到没?在上述博客示例中,我们中还给每个URL取了一个名字,比如 article_listarticle_create。这个名字大有用处,相当于给每个URL取了个全局变量的名字。它可以让你能够在Django的任意处,尤其是模板内显式地引用它。假设你需要在模板中通过链接指向一篇具体文章,下面那种方式更好?

使用命名URL

{% for article in articles %}<a href="{% url 'article_detail' article.id %}">{{ article.title }}</a>
{% endfor %}

url是个模板标签,其作用是对命名的url进行方向解析,动态生成链接。

注意:命名的url里有几个参数,使用url模板标签反向生成动态链接时,就需要向它传递几个参数。比如我们的命名urlarticle_detail里有整数型id这个参数,我们在模板中还需要传递article.id

硬编码URL - 不建议

{% for article in articles %}<a href="blog/articles/{{ article.id }}">{{ article.title }}</a>
{% endfor %}

如果你还没意识到方法1的好处,那么想想吧,假设老板让你把全部模板链接由blog/articles/id改为blog/article/id, 那种方法更快?更改所有html文件里的链接,还是只改URL配置里的一个字母?

那么问题来了。假设不同的app(比如news和blog)里都有article_detail这个命名URL, 我们怎么避免解析冲突呢? 这时我们只需要在blog/urls.py加上app_name='blog'这个命名空间即可,然后在模板中以blog:article_detail使用即可。

{% for article in articles %}<a href="{% url 'blog:article_detail' article.id %}">{{ article.title }}</a>
{% endfor %}

可惜的是命名的URL一般只在模板里使用,不能直接在视图里使用。如果我们有了命名的URL,我们如何把它转化成常规的URL在视图里使用呢?

Django提供的reverse()方法很容易实现这点。它在视图中可以对命名urls进行反向解析,生成动态链接。

from django.urls import reverse# output blog/articles/id
reverse('blog:article_detail', args=[id]) 

URL指向基于类的视图(View)

目前pathre_path都只能指向视图view里的一个函数或方法,而不能直接指向一个基于类的视图(Class based view)。Django提供了一个额外as_view()方法,可以将一个类伪装成方法。这点在当你使用Django自带的类视图或自定义的类视图时非常重要。

具体使用方式如下:

# blog/urls.py
from django.urls import path, re_path
from . import viewsurlpatterns = [# path('blog/articles/', views.article_list, name = 'article_list'),path('blog/articles/', views.ArticleList.as_view(), name='article_list'),
]# View (in blog/views.py)
from django.views.generic import ListView
from .views import Articleclass ArticleList(ListView):queryset = Article.objects.filter(date__lte=timezone.now()).order_by('date')[:5]context_object_name = 'article_list‘template_name = 'blog/article_list.html'

如果你对基于类的视图还比较困惑,没有关系,我们后面会做详细介绍。

通过URL传递额外的参数

在你配置URL时,你还可以通过字典的形式传递额外的参数给视图, 而不用把这个参数写在链接里。如下面案例所示:

# blog/urls.py
from django.urls import path, re_path
from . import viewsurlpatterns = [path('', views.ArticleList.as_view(), name='article_list', {'blog_id': 3}),
]

小结

本章我们讲解了如何使用pathre_path方法进行url配置,并详细介绍了什么命名的urls以及如何使用url模板标签和 reverse方法对命名urls进行反向解析。下篇文章中我们将正式介绍视图的编写,欢迎阅读。


http://www.ppmy.cn/devtools/166950.html

相关文章

spring boot+vue项目(免费)

医院管理系统项目地址&#xff1a; https://github.com/WangJingBo1234/hospital_manager 如果可以的话&#xff0c;麻烦大家在github上给我点个星&#xff0c;好人一生平安&#xff01;&#xff01;&#xff01; 该项目技术栈&#xff1a; 后端spring boot整合jwt&#xff0…

程序代码篇---STM32串口通信

文章目录 前言1. 头文件和全局变量2. 串口1初始化函数3. 串口1发送字节函数4. 串口1发送字符串函数5. 串口1发送数字函数6. 重定义fputc函数7. 串口数据解析函数8. 串口2中断服务程序总结 前言 本次将介绍一个基于STM32微控制器的串口通信实现&#xff0c;包含了串口的初始化、…

【算法】数据结构

⭐️个人主页&#xff1a;小羊 ⭐️所属专栏&#xff1a;Linux 很荣幸您能阅读我的文章&#xff0c;诚请评论指点&#xff0c;欢迎欢迎 ~ 目录 持续更新中...数组、链表点击消除环形链表环形链表 II 栈、队列树图 持续更新中… 数组、链表 点击消除 AB5 点击消除 这个题很…

OSPF的LSA详解(报文分析+具体例子)

OSPF LSA 要点掌握: 名称 携带的内容 作用 传播的范围 由谁产生 LSA报头格式 所有的LSA都有相同的报文头 LS age&#xff1a;LSA产生后所经过的时间&#xff0c;以秒为单位。LSA在本路由器的LSDB中会随时间老化&#xff08;每秒钟加1&#xff09;&#xff0c;但在网络的…

中级软件设计师2004-2024软考真题合集下载

中级软件设计师2004-2024软考真题合集下载 &#x1f31f; 资源亮点&#x1f3af; 适用人群&#x1f4a1; 资源使用指南&#x1f4cc; 资源获取方式 &#x1f31f; 资源亮点 「中级软件设计师历年真题及答案解析&#xff08;2004-2024&#xff09;」 是全网最全、最新的备考资料…

【每日学点HarmonyOS Next知识】tab拦截、组件方法做参数、自定义组件链式调用、多次观察者监听、横竖屏切换

1、HarmonyOS Tab组件里的tabBar点击如何拦截&#xff0c;根据情况判断是否允许切换tab&#xff1f; Tab组件里的tabBar点击如何拦截&#xff0c;根据情况判断是否允许切换tab 暂时没有tabBar点击拦截功能实现&#xff0c;可以使用TabsController自定义页签以及并在其中添加事…

LangGraph 构建的工作流调用数据库的时候怎么添加重试机制

在工作流许多使用场景中&#xff0c;我们可能希望我们的节点具有自定义的重试策略&#xff0c;例如在调用API、查询数据库或调用LLM等情况下。这里我给大家介绍一种方式叫 RetryPolicy。 from langgraph.pregel import RetryPolicy RetryPolicy()RetryPolicy(initial_interval…

聊一聊测试过程中接口不通的原因排查

目录 一、 确认网络连通性 二、DNS 解析问题 三、客户端请求配置 四、 服务端状态检查 五、 查看日志 六、 接口逻辑与参数 七、 使用工具辅助排查 八、 环境与依赖问题 九、高级场景排查 十、其他方式 在我们进行接口测试时&#xff0c;大概率会遇到接口调不通的情况…