Django框架之路由層彙總

lzl_121 發表於 2021-06-10

一 Django中路由的作用

URL配置(URLconf)就像Django 所支撐網站的目錄。它的本質是URL與要為該URL呼叫的檢視函式之間的對映表;你就是以這種方式告訴Django,對於客戶端發來的某個URL呼叫哪一段邏輯程式碼對應執行

典型的例子:

1
2
3
4
5
6
from django.urls import path

urlpatterns = [
path('articles', views.special),
]
articles這個路由對應著檢視函式中special這個方法,瀏覽器輸入這個連結,就會響應到special這個函式來執行

二 簡單的路由配置

1
2
3
4
5
from django.conf.urls import url

urlpatterns = [
url(正規表示式, views檢視函式,引數,別名),
]
  • 正規表示式:一個正規表示式字串
  • views檢視函式:一個可呼叫物件,通常為一個檢視函式或一個指定檢視函式路徑的字串
  • 引數:可選的要傳遞給檢視函式的預設引數(字典形式)
  • 別名:一個可選的name引數
1
2
3
4
5
6
7
8
9
from django.urls import path,re_path
from app01 import views

urlpatterns = [
re_path(r'^articles/2003/$', views.special_case_2003),
re_path(r'^articles/([0-9]{4})/$', views.year_archive),
re_path(r'^articles/([0-9]{4})/([0-9]{2})/$', views.month_archive),
re_path(r'^articles/([0-9]{4})/([0-9]{2})/([0-9]+)/$', views.article_detail),
]

注意:

  • 若要從URL 中捕獲一個值,只需要在它周圍放置一對圓括號。
  • 不需要新增一個前導的反斜槓,因為每個URL 都有。例如,應該是^articles 而不是 ^/articles
  • 每個正規表示式前面的’r’ 是可選的但是建議加上。它告訴Python 這個字串是“原始的” —— 字串中任何字元都不應該轉義
  • urlpatterns中的元素按照書寫順序從上往下逐一匹配正規表示式,一旦匹配成功則不再繼續

示例:

1
2
3
4
5
6
7
8
9
 '''
一些請求的例子:
/articles/2005/03/ 請求將匹配列表中的第三個模式。Django 將呼叫函式views.month_archive(request, '2005', '03')。
/articles/2005/3/ 不匹配任何URL 模式,因為列表中的第三個模式要求月份應該是兩個數字。
/articles/2003/ 將匹配列表中的第一個模式不是第二個,因為模式按順序匹配,第一個會首先測試是否匹配。請像這樣自由插入一些特殊的情況來探測匹配的次序。
/articles/2003 不匹配任何一個模式,因為每個模式要求URL 以一個反斜線結尾。
/articles/2003/03/03/ 將匹配最後一個模式。Django 將呼叫函式views.article_detail(request, '2003', '03', '03')。

'''

APPEND_SLASH

1
2
# 是否開啟URL訪問地址後面不為/跳轉至帶有/的路徑的配置項
APPEND_SLASH=True

Django settings.py配置檔案中預設沒有 APPEND_SLASH 這個引數,但 Django 預設這個引數為 APPEND_SLASH = True。 其作用就是自動在網址結尾加’/‘。

其效果就是:

我們定義了urls.py:

1
2
3
4
5
6
from django.conf.urls import url
from app01 import views

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

訪問 http://www.example.com/blog 時,預設將網址自動轉換為 http://www.example/com/blog/

如果在settings.py中設定了 APPEND_SLASH=False,此時我們再請求 http://www.example.com/blog 時就會提示找不到頁面。

三 有名分組

1
2
3
4
5
6
import re
ret=re.search('(?P<year>[0-9]{4})/([0-9]{2})','2012/12')
print(ret.group())
print(ret.group(1))
print(ret.group(2))
print(ret.group('year'))

上面的示例使用簡單的、沒有命名的正規表示式組(通過圓括號)來捕獲URL 中的值並以位置 引數傳遞給檢視。在更高階的用法中,可以使用命名的正規表示式組來捕獲URL 中的值並以關鍵字 引數傳遞給檢視。

在Python 正規表示式中,命名正規表示式組的語法是(?P<name>pattern),其中name 是組的名稱,pattern 是要匹配的模式。

下面是以上URLconf 使用命名組的重寫:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
from django.urls import path,re_path

from app01 import views

urlpatterns = [
re_path(r'^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<day>[0-9]{2})/$', views.article_detail),
]
#捕獲到的資料都是str型別
#檢視函式裡可以指定預設值
url('blog/$', views.blog),
url('blog/?(?P<num>[0-9]{1})', views.blog),
def blog(request,num=1):
print(num)
return HttpResponse('ok')

這個實現與前面的示例完全相同,只有一個細微的差別:捕獲的值作為關鍵字引數而不是位置引數傳遞給檢視函式。例如:

1
2
3
4
5
'''
/articles/2005/03/ 請求將呼叫views.month_archive(request, year='2005', month='03')函式,而不是views.month_archive(request, '2005', '03')。
/articles/2003/03/03/ 請求將呼叫函式views.article_detail(request, year='2003', month='03', day='03')。

'''

在實際應用中,這意味你的URLconf 會更加明晰且不容易產生引數順序問題的錯誤 —— 你可以在你的檢視函式定義中重新安排引數的順序。當然,這些好處是以簡潔為代價;

四 路由分發

Django1.1版本的分發

1
2
3
4
5
6
7
8
9
10
#主urls
from django.urls import path,re_path,include
from app01 import views
from app01 import urls
urlpatterns = [
  # re_path(r'^app01/',include('app01.urls')),#行
  # re_path(r'^app01/&',include('app01.urls')),#不行
  # path('app01/',include('app01.urls')),#行 
  #path('app01/', include(urls)),
]

在app01裡建立一個urls

1
2
3
4
5
from django.urls import path,re_path
from app01 import views
urlpatterns = [
re_path(r'^test/(?P<year>[0-9]{2})/$',views.url_test),
]

五 反向解析

在使用Django 專案時,一個常見的需求是獲得URL 的最終形式,以用於嵌入到生成的內容中(檢視中和顯示給使用者的URL等)或者用於處理伺服器端的導航(重定向等)。人們強烈希望不要硬編碼這些URL(費力、不可擴充套件且容易產生錯誤)或者設計一種與URLconf 毫不相關的專門的URL 生成機制,因為這樣容易導致一定程度上產生過期的URL。

在需要URL 的地方,對於不同層級,Django 提供不同的工具用於URL 反查:

  • 在模板中:使用url 模板標籤。
  • 在Python 程式碼中:使用from django.urls import reverse函式

urls.py

1
2
3
4
5
from django.urls import path,re_path
from app01 import views
urlpatterns = [
re_path(r'^test/(?P<year>[0-9]{2})/(?P<month>[0-9]{2})/$',views.url_test,name='test'),
]

html

1
<a href="{% url 'test' 10 23 %}">哈哈</a>

檢視函式中:

1
2
3
4
5
6
7
from django.shortcuts import render, HttpResponse,redirect,reverse
def url_test(request,year,month):
print(year)
print(month)
url=reverse('test',args=(10,20))
print(url)
return HttpResponse('ok')

總結:

1
2
3
4
5
6
1 在html程式碼裡
{% url "別名" 引數 引數%}

2 在檢視函式中:
  2.1 url=reverse('test')
  2.2 url=reverse('test',args=(10,20))

當命名你的URL 模式時,請確保使用的名稱不會與其它應用中名稱衝突。如果你的URL 模式叫做comment,而另外一個應用中也有一個同樣的名稱,當你在模板中使用這個名稱的時候不能保證將插入哪個URL。在URL 名稱中加上一個字首,比如應用的名稱,將減少衝突的可能。我們建議使用myapp-comment 而不是comment

六 名稱空間

名稱空間(英語:Namespace)是表示識別符號的可見範圍。一個識別符號可在多個名稱空間中定義,它在不同名稱空間中的含義是互不相干的。這樣,在一個新的名稱空間中可定義任何識別符號,它們不會與任何已有的識別符號發生衝突,因為已有的定義都處於其它名稱空間中。

由於name沒有作用域,Django在反解URL時,會在專案全域性順序搜尋,當查詢到第一個name指定URL時,立即返回

我們在開發專案時,會經常使用name屬性反解出URL,當不小心在不同的app的urls中定義相同的name時,可能會導致URL反解錯誤,為了避免這種事情發生,引入了名稱空間。

建立一個app02:python manage.py startapp app02

urls.py

1
2
3
4
5
from django.urls import path,re_path,include
urlpatterns = [
path('app01/', include('app01.urls')),
path('app02/', include('app02.urls'))
]

app01 的urls.py

1
2
3
4
5
from django.urls import path,re_path
from app01 import views
urlpatterns = [
re_path(r'index/',views.index,name='index'),
]

app02 的urls.py

1
2
3
4
5
6
7
from django.urls import path, re_path, include
from app02 import views

urlpatterns = [
re_path(r'index/', views.index,name='index'),

]

app01的檢視函式

1
2
3
4
def index(request):
url=reverse('index')
print(url)
return HttpResponse('index app01')

app02的檢視函式

1
2
3
4
def index(request):
url=reverse('index')
print(url)
return HttpResponse('index app02')

這樣都找index,app01和app02找到的都是app02的index

如何處理?在路由分發的時候指定名稱空間

總urls.py在路由分發時,指定名稱空間

1
2
3
4
5
6
path('app01/', include(('app01.urls','app01'))),
path('app02/', include(('app02.urls','app02')))
url(r'app01/',include('app01.urls',namespace='app01')),
url(r'app02/',include('app02.urls',namespace='app02'))
url(r'app01/',include(('app01.urls','app01'))),
url(r'app02/',include(('app02.urls','app02')))

在檢視函式反向解析的時候,指定是那個名稱空間下的

1
2
3
4
url=reverse('app02:index')
print(url)
url2=reverse('app01:index')
print(url2)

在模版裡:

1
<a href="{% url 'app02:index'%}">哈哈</a>

七 django2.0版的path

django2.0的re_path和1.0的url一樣

思考情況如下:

1
2
3
4
5
6
urlpatterns = [  
re_path('articles/(?P<year>[0-9]{4})/', year_archive),
re_path('article/(?P<article_id>[a-zA-Z0-9]+)/detail/', detail_view),
re_path('articles/(?P<article_id>[a-zA-Z0-9]+)/edit/', edit_view),
re_path('articles/(?P<article_id>[a-zA-Z0-9]+)/delete/', delete_view),
]

考慮下這樣的兩個問題:

第一個問題,函式 year_archive 中year引數是字串型別的,因此需要先轉化為整數型別的變數值,當然year=int(year) 不會有諸如如TypeError或者ValueError的異常。那麼有沒有一種方法,在url中,使得這一轉化步驟可以由Django自動完成?

第二個問題,三個路由中article_id都是同樣的正規表示式,但是你需要寫三遍,當之後article_id規則改變後,需要同時修改三處程式碼,那麼有沒有一種方法,只需修改一處即可?

在Django2.0中,可以使用 path 解決以上的兩個問題。

基本示例

這是一個簡單的例子:

1
2
3
4
5
6
7
8
9
10
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>/', views.article_detail),
  # path才支援,re_path不支援
  path('order/<int:year>',views.order),
]

基本規則:

  • 使用尖括號(<>)從url中捕獲值。
  • 捕獲值中可以包含一個轉化器型別(converter type),比如使用 <int:name> 捕獲一個整數變數。若果沒有轉化器,將匹配任何字串,當然也包括了 / 字元。
  • 無需新增前導斜槓。

以下是根據 2.0官方文件 而整理的示例分析表:(跟上面url的匹配關係)

image-20200924181029872

path轉化器

文件原文是Path converters,暫且翻譯為轉化器。

Django預設支援以下5個轉化器:

  • str,匹配除了路徑分隔符(/)之外的非空字串,這是預設的形式
  • int,匹配正整數,包含0。
  • slug,匹配字母、數字以及橫槓、下劃線組成的字串。
  • uuid,匹配格式化的uuid,如 075194d3-6885-417e-a8a8-6c931e272f00。
  • path,匹配任何非空字串,包含了路徑分隔符(/)(不能用?)

註冊自定義轉化器

對於一些複雜或者複用的需要,可以定義自己的轉化器。轉化器是一個類或介面,它的要求有三點:

  • regex 類屬性,字串型別

  • to_python(self, value) 方法,value是由類屬性 regex 所匹配到的字串,返回具體的Python變數值,以供Django傳遞到對應的檢視函式中。

  • to_url(self, value) 方法,和 to_python 相反,value是一個具體的Python變數值,返回其字串,通常用於url反向引用。

例子:

1
2
3
4
5
6
class FourDigitYearConverter:  
regex = '[0-9]{4}'
def to_python(self, value):
return int(value)
def to_url(self, value):
return '%04d' % value

使用register_converter 將其註冊到URL配置中:

1
2
3
4
5
6
7
8
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),
...
]