Django路由(URL)

  URL配置(URLconf)就像Django所支撐網站的目錄。它的本質是URL與要爲該URL調用的視圖函數之間的映射表。web

咱們就是以這種方式告訴Django,遇到哪一個URL的時候,要對應執行哪一個函數。正則表達式

 

URLconf配置django

 

 基本格式:瀏覽器

from django.conf.urls import url

urlpatterns = [
     url(正則表達式, views視圖,參數,別名),
]

 

 示例:服務器

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),
]

 參數說明app

  正則表達式:一個正則表達式字符串函數

  views視圖: 一個可調用對象,一般爲一個視圖函數工具

  參數 : 可選的要傳給視圖函數的默認參數(字典形式)網站

  別名: 一個可選的name參數編碼

  注意; Django2.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'^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中的元素按照書寫順序從上往下逐一匹配正則表達式,一旦匹配成功則再也不繼續。
  2. 若要從URL中捕獲一個值,只須要在它周圍放置一對圓括號(分組匹配)。
  3. 不須要添加一個前導的反斜槓,由於每一個URL 都有。例如,應該是^articles 而不是 ^/articles。
  4. 每一個正則表達式前面的'r' 是可選的可是建議加上

 

 補充說明 

# 是否開啓URL訪問地址後面不爲/ 跳轉至帶有/的路徑的配置項(便可以不用在url末尾加上'/')
127.0.0.1:8000/home ------>127.0.01:8000/home/
若不加,Django依然會查詢倆遍,最終仍是會跳轉到...home/

APPEND_SLASH=True(若不設置,默認爲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),
]

訪問 http://www.example.com/blog 時,默認將網址自動轉換爲 http://www.example/com/blog/ 。

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

 

分組命名匹配

上面的示例使用簡單的正則表達式分組匹配(經過圓括號)來捕獲URL中的值並以位置參數形式傳遞給視圖。

 

在更高級的用法中,可使用分組命名匹配的正則表達式組來捕獲URL中的值並以關鍵字參數形式傳遞給視圖。

 

在Python的正則表達式中,分組命名正則表達式組的語法是(?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),
]

  這個實現與前面的示例徹底相同,只有一個細微差異: 捕獲的值做爲關鍵字參數而不是位置參數傳給視圖.

  例如: 針對URL/articles/2017/12至關於按如下方式調用視圖函數:

 

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

 

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

  至於究竟應該使用哪種,你能夠根據本身的喜愛來決定.

 

 URLconf匹配的位置 

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

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

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

URLconf 不檢查請求的方法。換句話講,全部的請求方法 —— 同一個URL的POSTGETHEAD等等 —— 都將路由到相同的函數。

 

 捕獲的參數永遠都是字符串

  每一個在URLconf中捕獲的參數都做爲一個普通的Python字符串傳遞給視圖,不管正則表達式使用的是什麼匹配方式。例如,下面這行URLconf 中:

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

傳遞到視圖函數views.year_archive() 中的year參數永遠是一個字符串類型。

 

  視圖函數中指定默認值

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

 

 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文件,
                 從當前url請求中獲取到與 blog相匹配的字段,而後跳轉到blog
                 文件下的urls文件,即重新的url中獲取須要匹配的字段.便是路由
                 的分發.
]

  

 

 

  

 

 傳遞額外的參數給視圖函數

 URLconfs具備一個'鉤子',讓你傳遞一個字典做爲額外的參數傳遞給視圖函數.

  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')。
當傳遞額外參數的字典中的參數和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 模型實例相關的代碼中:使用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

 

 

 命名空間模式

  即便不一樣的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名稱'

  views中的函數中使用

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

  這樣即便appURL的命名相同,我也能夠反轉獲得正確的URL了.

相關文章
相關標籤/搜索