Django的路由系統(tǒng)

官方文檔:
URL配置(URLconf)就像Django 所支撐網(wǎng)站的目錄。它的本質(zhì)是URL與要為該URL調(diào)用的視圖函數(shù)之間的映射表。
你就是以這種方式告訴Django，對于這個URL調(diào)用這段代碼，對于那個URL調(diào)用那段代碼。

  • Django路由系統(tǒng)匹配URL路徑的時候是從上到下按照注冊順序來的
  • Django的路由系統(tǒng)只匹配URL路徑，不匹配域名、端口、URL參數(shù)

URLconf配置

基本格式

from django.conf.urls import url

urlpatterns = [
     url(正則表達(dá)式, views視圖函數(shù)，參數(shù)，別名),
]

參數(shù)說明:

  • 正則表達(dá)式:一個正則表達(dá)式字符串
  • views視圖函數(shù):一個可以調(diào)用的對象,通常為一個視圖函數(shù)或一個指定視圖函數(shù)路徑的字符串
  • 參數(shù):可選的要傳遞給視圖函數(shù)的默認(rèn)參數(shù)(字典形式)
  • 別名: 一個可選的name參數(shù)

正則表達(dá)式詳解

基本配置

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. urlpatterns中的元素按照書寫順序從上往下逐一匹配正則表達(dá)式，一旦匹配成功則不再繼續(xù)。
  2. 若要從URL中捕獲一個值，只需要在它周圍放置一對圓括號（分組匹配）。
  3. 不需要添加一個前導(dǎo)的反斜杠，因為每個URL 都有。例如，應(yīng)該是^articles 而不是 ^/articles。
  4. 每個正則表達(dá)式前面的'r' 是可選的但是建議加上。
    補充說明 
# 是否開啟URL訪問地址后面不為/跳轉(zhuǎn)至帶有/的路徑的配置項
APPEND_SLASH=True

Django settings.py配置文件中默認(rèn)沒有 APPEND_SLASH 這個參數(shù)，但 Django 默認(rèn)這個參數(shù)為 APPEND_SLASH = True。 其作用就是自動在網(wǎng)址結(jié)尾加'/'。

其效果就是：

我們定義了urls.py：

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

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

分組命名匹配

在更高級的用法中，可以使用分組命名匹配的正則表達(dá)式組來捕獲URL中的值并以關(guān)鍵字參數(shù)形式傳遞給視圖。在Python的正則表達(dá)式中，分組命名正則表達(dá)式組的語法是(?P<name>pattern)，其中name是組的名稱，pattern是要匹配的模式。

下面是以上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),
]

這個實現(xiàn)與前面的示例完全相同，只有一個細(xì)微的差別：捕獲的值作為關(guān)鍵字參數(shù)而不是位置參數(shù)傳遞給視圖函數(shù)。
例如，針對url /articles/2017/12/相當(dāng)于按以下方式調(diào)用視圖函數(shù)：

views.month_archive(request, year="2017", month="12")

在實際應(yīng)用中，使用分組命名匹配的方式可以讓你的URLconf 更加明晰且不容易產(chǎn)生參數(shù)順序問題的錯誤，但是有些開發(fā)人員則認(rèn)為分組命名組語法太丑陋、繁瑣。

至于究竟應(yīng)該使用哪一種，你可以根據(jù)自己的喜好來決定。
URLconf匹配的位置
URLconf 在請求的URL 上查找，將它當(dāng)做一個普通的Python 字符串。不包括GET和POST參數(shù)以及域名。

例如，https://www.example.com/myapp/請求中，URLconf 將查找myapp/。

在https://www.example.com/myapp/?page=3請求中，URLconf 仍將查找myapp/。

URLconf 不檢查請求的方法。換句話講，所有的請求方法 —— 同一個URL的POST、GET、HEAD等等 —— 都將路由到相同的函數(shù)。
捕獲的參數(shù)永遠(yuǎn)都是字符串
每個在URLconf中捕獲的參數(shù)都作為一個普通的Python字符串傳遞給視圖，無論正則表達(dá)式使用的是什么匹配方式。例如，下面這行URLconf 中：
url(r'^articles/(?P<year>[0-9]{4})/$', views.year_archive)
傳遞到視圖函數(shù)views.year_archive()中的year 參數(shù)永遠(yuǎn)是一個字符串類型。
視圖函數(shù)中指定默認(rèn)值

# 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指定默認(rèn)值
def page(request, num="1"):
    pass

在上面的例子中，兩個URL模式指向相同的view - views.page - 但是第一個模式并沒有從URL中捕獲任何東西。

如果第一個模式匹配上了，page()函數(shù)將使用其默認(rèn)參數(shù)num=“1”,如果第二個模式匹配，page()將使用正則表達(dá)式捕獲到的num值
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文件
]

傳遞額外的參數(shù)給視圖函數(shù)
URLconfs 具有一個鉤子，讓你傳遞一個Python 字典作為額外的參數(shù)傳遞給視圖函數(shù)。

django.conf.urls.url() 函數(shù)可以接收一個可選的第三個參數(shù)，它是一個字典，表示想要傳遞給視圖函數(shù)的額外關(guān)鍵字參數(shù)。

例如：

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 將調(diào)用views.year_archive(request, year='2005', foo='bar')。
這個技術(shù)在Syndication 框架中使用，來傳遞元數(shù)據(jù)和選項給視圖.

命名URL和URL反向解析

在使用Django 項目時，一個常見的需求是獲得URL的最終形式，以用于嵌入到生成的內(nèi)容中（視圖中和顯示給用戶的URL等）或者用于處理服務(wù)器端的導(dǎo)航（重定向等）。
人們強烈希望不要硬編碼這些URL（費力、不可擴展且容易產(chǎn)生錯誤）或者設(shè)計一種與URLconf 毫不相關(guān)的專門的URL 生成機制，因為這樣容易導(dǎo)致一定程度上產(chǎn)生過期的URL。
換句話講，需要的是一個DRY 機制。除了其它有點，它還允許設(shè)計的URL 可以自動更新而不用遍歷項目的源代碼來搜索并替換過期的URL。
獲取一個URL 最開始想到的信息是處理它視圖的標(biāo)識（例如名字），查找正確的URL 的其它必要的信息有視圖參數(shù)的類型（位置參數(shù)、關(guān)鍵字參數(shù)）和值。
Django 提供一個辦法是讓URL 映射是URL 設(shè)計唯一的地方。你填充你的URLconf，然后可以雙向使用它：

  • 根據(jù)用戶/瀏覽器發(fā)起的URL 請求，它調(diào)用正確的Django 視圖，并從URL 中提取它的參數(shù)需要的值。

  • 根據(jù)Django 視圖的標(biāo)識和將要傳遞給它的參數(shù)的值，獲取與之關(guān)聯(lián)的URL。
    第一種方式是我們在前面的章節(jié)中一直討論的用法。第二種方式叫做反向解析URL、反向URL 匹配、反向URL 查詢或者簡單的URL 反查。
    在需要URL 的地方，對于不同層級，Django 提供不同的工具用于URL 反查：

  • 在模板中：使用url模板標(biāo)簽。

  • 在Python 代碼中：使用

  • django.core.urlresolvers.reverse() 函數(shù)。
    在更高層的與處理Django 模型實例相關(guān)的代碼中：使用get_absolute_url() 方法。
    上面說了一大堆，你可能并沒有看懂。（那是官方文檔的生硬翻譯）。

咱們簡單來說就是可以給我們的URL匹配規(guī)則起個名字，一個URL匹配模式起一個名字。

這樣我們以后就不需要寫死URL代碼了，只需要通過名字來調(diào)用當(dāng)前的URL。

舉個簡單的例子：

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

這樣：

在模板里面可以這樣引用：
{% url 'home' %}
在views函數(shù)中可以這樣引用：

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'),
    # ...
]

根據(jù)這里的設(shè)計，某一年nnnn對應(yīng)的歸檔的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,)))

如果出于某種原因決定按年歸檔文章發(fā)布的URL應(yīng)該調(diào)整一下，那么你將只需要修改URLconf 中的內(nèi)容。

在某些場景中，一個視圖是通用的，所以在URL 和視圖之間存在多對一的關(guān)系。對于這些情況，當(dāng)反查URL 時，只有視圖的名字還不夠。

注意：

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

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

在URL 名稱中加上一個前綴，比如應(yīng)用的名稱，將減少沖突的可能。我們建議使用myapp-comment 而不是comment。

命名空間模式

即使不同的APP使用相同的URL名稱，URL的命名空間模式也可以讓你唯一反轉(zhuǎn)命名的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')
]

現(xiàn)在，我的兩個app中 url名稱重復(fù)了，我反轉(zhuǎn)URL的時候就可以通過命名空間的名稱得到我當(dāng)前的URL。

語法：

'命名空間名稱:URL名稱'

模板中使用：
{% url 'app01:detail' pk=12 pp=99 %}

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容