1. 程式人生 > >Django路由系統

Django路由系統

URL配置(URLconf)就像Django所支撐網站的目錄,它的本質是URL與要為呼叫的檢視函式之間的對映表.

我們就是以這種方式告訴Django,遇到哪個URL的時候,要對應執行哪個函式.

URLconf配置

基本格式:

from django.conf.urls import url

urlpatterns = [
	url(正則表示式, views檢視, 引數, 別名),
]

引數說明:

  • 正則表示式:一個正則表示式字串
  • views檢視:一個可呼叫物件,通常為一個檢視函式
  • 引數:可選的要傳遞給檢視函式的預設引數(字典形式)
  • 別名:一個可選的name引數(反向解析)

注意: Django 2.0版本中的路由系統是下面的寫法(

官方文件):

from django.urls import path, re_path

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:slug>/'
, views.article_detail), ]

2.0版本中的re_path和1.11版本的url是一樣的用法.

正則表示式詳解

基本配置:

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

urlpatterns = [
	url(r'^test/[0-9]{4}/[0-9]{2}/$', views.test),
	url(r'^test/([0-9]{4})/$', views.test),
	url(r'^test/([0-9]{4})/([0-9]{2})/$', views.test),
	url(r'^test/([0-9]{4})/([0-9]{2})/([0-9]{2})/$'
, views.test), ]

注意事項:

  1. urlpatterns列表中的元素按照書寫順序從上往下逐一匹配正則表示式,一旦匹配成功則不再繼續.
  2. 若要從URL中獲取一個值,只需要在它周圍放置一對圓括號(分組匹配).
  3. 不需要在匹配規則前面加斜槓(/),因為每個URL都有,例如應該這樣寫:" ^articles",而不是" ^/articles".
  4. 每個正則表示式前面的"r",是可選的,但建議加上.

補充說明:

是否開啟URL訪問地址後面不為"/“時跳轉至帶有”/"的路徑的配置項:

APPEND_SLASH = True

Django的settings.py檔案中預設沒有APPEND_SLASH這個引數,但此引數預設為開啟狀態,其作用時自動在網址結尾加"/".

分組命名匹配

像上面的示例,使用的是正則表示式分組匹配(通過圓括號)來捕獲URL中的值並以位置引數形式傳遞給檢視.

在更高階的用法中,可以使用分組命名匹配的正則表示式組來捕獲URL中的值,並以關鍵字引數形式傳遞給檢視.

在Python的正則表示式中,分組命名正則表示式組的語法是 (?Ppattern),其中 name 是組的名稱,pattern 是要匹配的模式.

下面是以上(基本配置)URLconf使用命名組的重寫:

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

urlpatterns = [
    url(r'^test/(?P<year>[0-9]{4})/$', views.test),
    url(r'^test/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/$', views.test),
    url(r'^test/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/(?P<day>[0-9]{2})/$', views.test),
]

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

例如,針對 URL /articles/2019/10/ 相當於按以下方式呼叫檢視函式:

views.test(request, year='2019', month='10')

在實際應用中,使用分組命名匹配的方式可以讓你的URLconf更加明晰且不容易產生引數順序問題的錯誤,但是有些開發人員則認為分組命名組語法太醜陋、繁瑣。

至於究竟應該使用哪一種,你可以根據自己的喜好來決定。

URLconf匹配的位置:

URLconf在請求的URL上查詢,將它當作一個普通的Python字串,不包括GET和POST引數以及域名.

例如: URL地址為 https:/ /blog.csdn.net/test/ 的請求中,URLconf將查詢/test/ URL地址為 https:/ /blog.csdn.net/test/?name=zyk 的請求中,URLconf仍將查詢/test/

URLconf不檢查請求的方法。換句話講,所有的請求方法——同一個URL的POST、GET、HEAD等等,都將路由到相同的函式.

捕獲的引數永遠都是字串:

每個在URLconf中捕獲的引數都作為一個普通的Python字串傳遞給檢視,無論正則表示式使用的是什麼匹配的方式。例如,下面這行URLconf中:

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

傳遞給檢視函式 views.test() 中的 year 引數永遠是一個字串型別.

檢視函式中指定預設值
from django.conf.urls import url
from . import views

urlpatterns = [
    url(r'^test/$', views.test),
    url(r'^test/(?P<num>[0-9]+)/$', views.test),
]

在上面的例子中,兩個URL模式指向相同的view(view.test),但是第一個模式並沒有從URL中捕獲任何東西.

如果第一個模式匹配上了,test()函式將使用其預設引數num=‘1’;如果第二個模式匹配上了,test()將使用正則表示式捕獲到的num值.

include其它的URLconfs

指定到別的URLconf檔案進行,例如在預設的urls.py檔案寫如下匹配規則:

from django.conf.urls import url, include
from blog01 import views

urlpatterns = [
    url(r'blog01/', include('blog01.urls')),
]

將所有路徑為 blog01 開頭的URL指向blog01下urls.py檔案中去匹配.

傳遞額外引數給檢視函式

URLconfs具有一個鉤子,可以讓我們傳遞一個Python字典作為額外的引數傳遞給檢視函式.

django.conf.urls.url() 可以接收一個可選的第三個引數,它是一個字典,表示想要傳遞給檢視函式的額外關鍵字引數,如下:

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

urlpatterns = [
    url(r'^test/$', views.test),
    url(r'^test/(?P<year>[0-9]{4})/$', views.test, {'month': '10'}),
]

在這個例子中,對於URL地址為 /test/2019/ 的請求,Django將呼叫views.year_archive(request, year=‘2019’, {‘month’: ‘10’})

當傳遞額外引數的字典中的引數與URL中捕獲值的命名關鍵字引數同名時,函式呼叫將使用字典的引數,而不是URL中捕獲的引數.

命名URL 與 URL反向解析

在使用Django 專案時,一個常見的需求是獲得URL的最終形式,以用於嵌入到生成的內容中(檢視中和顯示給使用者的URL等)或者用於處理伺服器端的導航(重定向等)。

人們強烈希望不要硬編碼這些URL(費力、不可擴充套件且容易產生錯誤)或者設計一種與URLconf 毫不相關的專門的URL 生成機制,因為這樣容易導致一定程度上產生過期的URL。 換句話講,需要的是一個DRY 機制。除了其它有點,它還允許設計的URL 可以自動更新而不用遍歷專案的原始碼來搜尋並替換過期的URL。

獲取一個URL 最開始想到的資訊是處理它檢視的標識(例如名字),查詢正確的URL 的其它必要的資訊有檢視引數的型別(位置引數、關鍵字引數)和值。

Django 提供一個辦法是讓URL 對映是URL 設計唯一的地方。你填充你的URLconf,然後可以雙向使用它:

  • 根據使用者/瀏覽器發起的URL 請求,它呼叫正確的Django 檢視,並從URL 中提取它的引數需要的值。
  • 根據Django 檢視的標識和將要傳遞給它的引數的值,獲取與之關聯的URL。

第一種方式是我們在前面的章節中一直討論的用法。第二種方式叫做反向解析URL、反向URL 匹配、反向URL 查詢或者簡單的URL 反查。

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

  • 在模版中:使用url模版標籤.
  • 在Python程式碼中:使用django.core.urlresolvers.reverse()函式.
  • 在更高層的與處理Django模型例項相關的程式碼中:使用ge t_absolute_url()方法.

上面說了一大堆,你可能並沒有看懂。(那是官方文件的生硬翻譯)。

簡單來說,就是可以給我們的URL匹配規則起個名字,一個URL匹配模式起一個名字.

這樣我們以後就不需要寫死URL程式碼了,只需要通過名字來呼叫當前的URL.

例如:

url(r'^home', views.home, name='home'),  # 給我的url匹配模式起名為 home
url(r'^index/(\d*)', views.index, name='index'),  # 給我的url匹配模式起名為index

在模版中這樣引用:

{% url 'home' %}

在views函式中這樣引用:

from django.urls import reverse
reverse('index', args=('2019',))

圖文示例(在模版中引用): 在這裡插入圖片描述 在這裡插入圖片描述 那上面的例子來說,如果出於某種原因決定按年歸檔文章釋出的URL應該調整一下,那麼你將只需要修改URLconf 中的內容。

在某些場景中,一個檢視是通用的,所以在URL 和檢視之間存在多對一的關係。對於這些情況,當反查URL 時,只有檢視的名字還不夠。

注意: 為了完成上面例子中的URL反查,你將需要使用命名的URL模式。URL的名稱使用的字串可以包含任何你喜歡的字元,不限制在合法的Python名稱.

當命名URL模式時,確保使用的名稱不會與其它應用中的名稱衝突。如果你的URL模式叫做 comment, 而另外一個應用中也有一個同樣的名稱,那麼當你在模版中使用這個名稱時,不能保證將插入哪個URL.

因此,在URL名稱中加上一個字首,比如應用的名稱,將減少衝突的可能。我們建議使用myapp-comment,而不是comment.

名稱空間模式

即使不同的APP使用相同的URL名稱,URL的命名模式也可以讓你唯一反轉命名的URL.

例如:

# project中的urls.py

from django.conf.urls import url, include
 
urlpatterns = [
    url(r'^app01/', include('app01.urls', namespace='app01')),
    url(r'^app02/', include('app02.urls', namespace='app02')),
]
# app01中的urls.py

from django.conf.urls import url
from app01 import views
 
app_name = 'app01'
urlpatterns = [
    url(r'^(?P<pk>\d+)/$', views.detail, name='detail')
]
# app02中的urls.py

from django.conf.urls import url
from app02 import views
 
app_name = 'app02'
urlpatterns = [
    url(r'^(?P<pk>\d+)/$', views.detail, name='detail')
]

現在,我的兩個app中url名稱重複了,我反轉URL的時候就可以通過名稱空間的名稱得到我當前的URL.

語法: “名稱空間名稱:URL名稱”

模版中使用:

{% url 'app01:detail' pk=12 pp=99 %}

views中的函式中使用:

v = reverse('app01:detail', kwargs={'pk': 11})

這樣即使app中URL的命名相同,我也可以反轉得到正確的URL.