1. 程式人生 > >Django - - 基礎 - - Django的路由系統

Django - - 基礎 - - Django的路由系統

模板

  • Django的路由系統
    • URLconf配置
    • 正則表示式詳解
    • 分組命名匹配
    • 傳遞額外的引數給檢視函式(瞭解)
    • 命名URL和URL反向解析
    • 名稱空間模式

1, Django的路由系統

1.1 URLconf配置

1.1.1 基本格式

from django.conf.urls import url

urlpatterns = [
     url(正則表示式, views檢視函式,引數,別名),
]
from django.urls import 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),
]

1.1.2 引數說明

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

1.2 正則表示式詳解

1.2.1 基本配置

from django.conf.urls import url

from . import views

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

1.2.2 注意事項

  • urlpatterns中的元素按照書寫順序從上往下逐一匹配正則表示式,一旦匹配成功則不再繼續。
  • 若要從URL中捕獲一個值,只需要在它周圍放置一對圓括號(分組匹配)。
  • 不需要新增一個前導的反斜槓,因為每個URL 都有。例如,應該是^articles 而不是 ^/articles。
  • 每個正則表示式前面的'r' 是可選的但是建議加上。

1.2.3 補充說明

# 是否開啟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),
]

1.3. 分組命名匹配

  • 上面的示例使用簡單的正則表示式分組匹配(通過圓括號)來捕獲URL中的值並以位置引數形式傳遞給檢視。
  • 在更高階的用法中,可以使用分組命名匹配的正則表示式組來捕獲URL中的值並以關鍵字引數形式傳遞給檢視。
  • 在Python的正則表示式中,分組命名正則表示式組的語法是(?P
  • 下面是以上URLconf 使用命名組的重寫:
from django.conf.urls import url

from . import views

urlpatterns = [
    url(r'^articles/2003/$', views.special_case_2003),
    url(r'^articles/(?P<year>[0-9]{4})/$', views.year_archive),
    url(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/$', views.month_archive),
    url(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/(?P<day>[0-9]{2})/$', views.article_detail),
]
  • 這個實現與前面的示例完全相同,只有一個細微的差別:捕獲的值作為關鍵字引數而不是位置引數傳遞給檢視函式。
  • 例如,針對url /articles/2017/12/相當於按以下方式呼叫檢視函式:
views.month_archive(request, year="2017", month="12")
  • 在實際應用中,使用分組命名匹配的方式可以讓你的URLconf 更加明晰且不容易產生引數順序問題的錯誤,但是有些開發人員則認為分組命名組語法太醜陋、繁瑣。

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

1.3.1 URLconf匹配的位置

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

  • 例如,http://www.example.com/myapp/ 請求中,URLconf 將查詢myapp/。

  • 在http://www.example.com/myapp/?page=3 請求中,URLconf 仍將查詢myapp/。

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

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

  • 每個在URLconf中捕獲的引數都作為一個普通的Python字串傳遞給檢視,無論正則表示式使用的是什麼匹配方式。例如,下面這行URLconf 中:
url(r'^articles/(?P<year>[0-9]{4})/$', views.year_archive),
  • 傳遞到檢視函式views.year_archive() 中的year 引數永遠是一個字串型別。

1.3.3 檢視函式中指定預設值

# 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值。

1.3.4 include其他的URLconfs

#At any point, your urlpatterns can “include” other URLconf modules. This
#essentially “roots” a set of URLs below other ones.

#For example, here’s an excerpt of the URLconf for the Django website itself.
#It includes a number of other URLconfs:


from django.conf.urls import include, url

urlpatterns = [
   url(r'^admin/', admin.site.urls),
   url(r'^blog/', include('blog.urls')),  # 可以包含其他的URLconfs檔案
]

1.4 傳遞額外的引數給檢視函式(瞭解)

  • URLconfs 具有一個鉤子,讓你傳遞一個Python 字典作為額外的引數傳遞給檢視函式。
  • django.conf.urls.url() 函式可以接收一個可選的第三個引數,它是一個字典,表示想要傳遞給檢視函式的額外關鍵字引數。
  • 例如:
from django.conf.urls import url
from . import views

urlpatterns = [
    url(r'^blog/(?P<year>[0-9]{4})/$', views.year_archive, {'foo': 'bar'}),
]
  • 在這個例子中,對於/blog/2005/請求,Django 將呼叫views.year_archive(request, year='2005', foo='bar')。
  • 這個技術在Syndication 框架中使用,來傳遞元資料和選項給檢視。

1.5 命名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 模型例項相關的程式碼中:使用get_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=("2018", ))
  • 例子:
  • 考慮下面的URLconf:
from django.conf.urls import url

from . import views

urlpatterns = [
    # ...
    url(r'^articles/([0-9]{4})/$', views.year_archive, name='news-year-archive'),
    # ...
]
  • 根據這裡的設計,某一年nnnn對應的歸檔的URL是/articles/nnnn/。

  • 你可以在模板的程式碼中使用下面的方法獲得它們:

<a href="{% url 'news-year-archive' 2012 %}">2012 Archive</a>

<ul>
{% for yearvar in year_list %}
<li><a href="{% url 'news-year-archive' yearvar %}">{{ yearvar }} Archive</a></li>
{% endfor %}
</ul>
  • 在Python 程式碼中,這樣使用:
from django.urls import reverse
from django.shortcuts import redirect

def redirect_to_year(request):
    # ...
    year = 2006
    # ...
    return redirect(reverse('news-year-archive', args=(year,)))
  • 如果出於某種原因決定按年歸檔文章釋出的URL應該調整一下,那麼你將只需要修改URLconf 中的內容。

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

  • 注意:

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

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

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

1.6 名稱空間模式

  • 即使不同的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})