url路由配置實質上就是一個url與視圖函數之間的映射表。
官方示例:
from django.urls import path
from . import views
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),
]
基本規則:
- 使用尖括號(
<>)從url中捕獲值。 - 捕獲值中可以包含一個轉化器類型(converter type),比如使用
<int:name>捕獲一個整數變量。若果沒有轉化器,將匹配任何字符串,當然也包括了/字符。 - 無需添加前導斜杠
path和re_path
path() 具有四個參數,兩個必選參數:route 和 view,兩個可選參數:kwargs 和 name
route 是一個匹配 URL 的准則(類似正則表達式)。當 Django 響應一個請求時,它會從 urlpatterns 的第一項開始,按順序依次匹配列表中的項,直到找到匹配的項。這些准則不會匹配 GET 和 POST 參數或域名。例如,URLconf 在處理請求 https://www.example.com/myapp/ 時,它會嘗試匹配 myapp/ 。處理請求 https://www.example.com/myapp/?page=3 時,也只會嘗試匹配 myapp/。
view:當匹配到url時,就會調用它對應的視圖函數,並傳入一個 HttpRequest 對象作為第一個參數。
kwargs:任意個關鍵字參數可以作為一個字典傳遞給目標視圖函數。
name:為url取一個別名,便於在 Django 的任意地方唯一地引用它,尤其是在模板中。這個有用的特性允許你只改一個文件就能全局地修改某個 URL 模式
測試:
urls.py
urlpatterns = [
path('admin/', admin.site.urls), path('test_kwargs',views.test_kwargs,{"kwarg1":1,"kwarg2":2}), path('test_name',views.test_name,name="tn"), path('testname',views.testname), re_path(r're_test',views.test01), ]
views.py
1 from django.shortcuts import render, HttpResponse,redirect 2 3 # Create your views here. 4 def test01(request): 5 return HttpResponse("re_path test") 6 7 def test_kwargs(request,kwarg1,kwarg2): 8 return HttpResponse("test_kwargs:kwarg1+kwarg2="+str(kwarg1+kwarg2)) 9 10 def test_name(request): 11 return HttpResponse("testname") 12 13 def testname(request): 14 return redirect("tn")
re_path的參數和path基本相同,但route參數使用的是正則表達式(?P<name>pattern),而path使用的是轉換器,例如<int:name>
django內置的轉換器有如下幾個:
str- 匹配除路徑分隔符之外的任何非空字符串'/'。如果轉換器未包含在表達式中,則這是默認值。int- 匹配零或任何正整數。返回一個int。slug- 匹配由ASCII字母或數字組成的任何slug字符串,以及連字符和下划線字符。例如,building-your-1st-django-site。uuid- 匹配格式化的UUID。要防止多個URL映射到同一頁面,必須包含短划線並且字母必須為小寫。例如,075194d3-6885-417e-a8a8-6c931e272f00。返回一個UUID實例。path- 匹配任何非空字符串,包括路徑分隔符'/'。這使您可以匹配完整的URL路徑,而不僅僅是URL路徑的一部分str。
我們可以自定義轉換器:
轉化器是一個類或接口,它的要求有三點:
regex 類屬性,字符串類型
to_python(self, value) 方法,value是由類屬性 regex 所匹配到的字符串,返回具體的Python變量值,以供Django傳遞到對應的視圖函數中。
to_url(self, value) 方法,和 to_python 相反,value是一個具體的Python變量值,返回其字符串,通常用於url反向引用。
example:
新建一個MyConverter.py
1 class YearConverter: 2 regex = '[0-9]{4}' 3 def to_python(self, value): 4 return int(value) 5 def to_url(self, value): 6 return '%04d' % value
在urls.py中使用register_converter注冊
1 from django.contrib import admin 2 from django.urls import path,re_path,register_converter 3 from app01 import views,MyConverter 4 5 register_converter(MyConverter.YearConverter, 'yyyy') 6 urlpatterns = [ 7 path('test_my_converter/<yyyy:year>/',views.test_my_converter), 8 ]
在views.py中傳入參數
1 from django.shortcuts import render, HttpResponse,redirect 2 3 # Create your views here. 4 5 def test_my_converter(request,year): 6 return HttpResponse("test_my_converter<br>year:"+str(year))
路由分發
使用include實現路由分發
example:
在項目文件夾下的urls.py
1 from django.urls import path,re_path,include 2 3 urlpatterns = [ 4 re_path(r'app02/',include('app02.urls')), 5 ]
在app02下的urls.py
1 from django.urls import path 2 from app02 import views 3 4 urlpatterns = [ 5 path('test',views.test) 6 ]
在app02下的views.py
from django.shortcuts import HttpResponse # Create your views here. def test(request): return HttpResponse("路由分發")
Namespace
命名空間(英語:Namespace)是表示標識符的可見范圍。一個標識符可在多個命名空間中定義,它在不同命名空間中的含義是互不相干的。這樣,在一個新的命名空間中可定義任何標識符,它們不會與任何已有的標識符發生沖突,因為已有的定義都處於其它命名空間中。
由於name沒有作用域,Django在反解URL時,會在項目全局順序搜索,當查找到第一個name指定URL時,立即返回。
我們在開發項目時,會經常使用name屬性反解出URL,當不小心在不同的app的urls中定義相同的name時,可能會導致URL反解錯誤,為了避免這種事情發生,引入了命名空間。
example:
項目文件夾下的urls.py
1 from django.urls import re_path,include 2 3 urlpatterns = [ 4 re_path(r'app01/',include('app01.urls',namespace='app01')), 5 re_path(r'app02/',include('app02.urls',namespace='app02')) 6 ]
app01下的urls.py
1 from django.urls import path 2 from app01 import views 3 app_name='app01' 4 5 urlpatterns = [ 6 path('test',views.test,name='test') 7 ]
app02下的urls.py
1 from django.urls import path 2 from app02 import views 3 app_name='app02' 4 5 urlpatterns = [ 6 path('test',views.test,name='test') 7 ]
app01下的viewspy
1 from django.shortcuts import HttpResponse 2 from django.urls import reverse 3 # Create your views here. 4 def test(request): 5 return HttpResponse(reverse("app01:test"))
app02下的views.py
1 from django.shortcuts import HttpResponse 2 # from django.core.urlresolvers import reverse 3 from django.urls import reverse 4 # Create your views here. 5 def test(request): 6 return HttpResponse(reverse("app02:test"))
反向解析
在使用Django 項目時,一個常見的需求是獲得URL 的最終形式,以用於嵌入到生成的內容中(視圖中和顯示給用戶的URL等)或者用於處理服務器端的導航(重定向等)。人們強烈希望不要硬編碼這些URL(費力、不可擴展且容易產生錯誤)或者設計一種與URLconf 毫不相關的專門的URL 生成機制,因為這樣容易導致一定程度上產生過期的URL。
在需要URL 的地方,對於不同層級,Django 提供不同的工具用於URL 反查:
在模板中:使用url 模板標簽。
在Python 代碼中:使用from django.urls import reverse()函數
example(在模板中):
<a href="{% url 'app01:test' %}">app01反向解析</a><br/>
<a href="{% url 'app01:test_contain_pattern' 2019 %}">app01反向解析帶參數</a>
example(在python中):
如namespace中所示
注意:
在二級路由(也即app的urls文件中),在urlpatterns后,應該加上app_name='app_name(app名稱)',否則會報錯。
