路由配置系統(URLconf)
URL配置(URLconf)就像Django所支撐網站的目錄。
它的本質是URL與要為該URL調用的視圖函數之間的映射表。
你就是以這種方式告訴Django,對於URL(1)調用代碼(1), 對於URL(2)調用代碼(2)
urlpatterns = [
url(正則表達式, views視圖函數, 參數, 別名),
]
參數說明:
一個正則表達式字符串
一個可調用對象,通常為一個視圖函數或一個指定視圖函數路徑的字符串
可選的要傳遞給視圖函數的默認參數(字典形式)
一個可選的name參數
1. URLconf的正則字符串參數
1.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), ]
註意:
- 一旦匹配成功則不再繼續。若要從URL中捕獲一個值,只需要在它周圍放置一對圓括號。
- 不需要添加一個前導的反斜杠,因為每個URL都有。例如,應該是【^articles】,而不是【^/articles】。
- 每個正則表達式前面的“r”,是可選的,但是建議加上。
一些請求的例子:
/articles/2005/3/: 不需要匹配任何URL,因為列表中第三個模式要求月份應該是兩個數字。 /articles/2003/: 將匹配列表中第一個模式,不是第二個。因為模式按順序匹配,第一個會首先測試是否匹配。 /artic/2005/03/: 請求將匹配列表中的第三個模式。Django將調用函數views.month_archive(request, "2005", "03")
1.2 有名分組
上面的示例使用簡單的,沒有命名的正則表達式組(通過圓括號)來捕獲URL中的值並以位置參數傳遞給視圖。
在更高級的用法中,可以使用命名的正則表達式組來捕獲URL中的值並以關鍵字參數傳遞給視圖。
在Python正則表達式中,命名正則表達式組的做法是【(?P[name]pattern)】, 其中【name】是組的名稱,【pattern】是要匹配的模式。
下面是以上URL使用命名組的重寫:
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), ]
這個實現與前面的示例完全相同,只有一個細微的差別:
捕獲的值作為關鍵字參數而不是位置參數傳遞給視圖函數,例如:
/articles/2005/03: 請求將調用views.month_archive(request, year="2005", month="03")函數 /articles/2003/03/03: 請求將調用函數views.article_detail(request, year="2003", month="03", day="03")
在實際應用中,這意味著你的URLconf會更加明晰且不容易產生參數順序問題的錯誤——你可以在你的視圖函數定義中重新安排參數的順序。
當然,這些好處是以簡潔為代價:有些開發人員認為命名組語法醜陋而繁瑣。
1.3 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.4 捕獲的參數永遠是字符串
每個捕獲的參數都作為一個普通的Python字符串傳遞給視圖,無論正則表達式使用的是什麽匹配方式。
例如,下面這行URLconf中:
ulr(r"^articles/(?P<year>[0-9]{4})/$", views.year_archive),
views.year_archive()的year參數將是一個字符串
1.5 指定視圖參數的默認值
有一個方便的小技巧是指定視圖參數的默認值。
下面是一個URLconf和視圖的示例:
from django.conf.urls import url form . import views urlpatterns = [ url(r"^blog/$", views.page), url(r"^blog/page(?P<num>[0-9]+)/$", view.page), ] #view(in blog/views.py) def page(request, num="1"): ···
在上面的例子中,兩個URL模式指向同一個視圖【views.page】——但是第一個模式不會從URL中捕獲任何值。如果第一個模式匹配,【page()】函數將會使用【num】參數的默認值"1"。
如果第二個模式匹配,【page()】將使用正則表達式捕獲的【num】值。
1.6 including中其他的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‘)), ]
2. 傳遞額外的選項給視圖函數
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將調用view.year_archive(request, year="2005", foo="bar")。
這個技術在Syndication框架中使用,來傳遞元數據和選項給視圖。
路由配置系統(URLconf)