一、URL配置
URL配置(URLconf)就像Django 所支撐網站的目錄。它的本質是URL與要為該URL調用的視圖函數之間的映射表。
基本格式:
from django.conf.urls import url #循環urlpatterns,找到對應的函數執行,匹配上一個路徑就找到對應的函數執行,就不再往下循環了,並給函數傳一個參數request,和wsgiref的environ類似,就是請求信息的所有內容 urlpatterns = [ url(正則表達式, views視圖函數,參數,別名), ]
注意:
Django 2.0版本中的路由系統已經替換成下面的寫法,但是django2.0是向下兼容1.x版本的語法的(官方文檔):
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), ]
參數說明
- 正則表達式:一個正則表達式字符串
- views視圖函數:一個可調用對象,通常為一個視圖函數或一個指定視圖函數路徑的字符串
- 參數:可選的要傳遞給視圖函數的默認參數(字典形式)
- 別名:一個可選的name參數
二 、正則表達式詳解
上面的示例使用簡單的正則表達式分組匹配(通過圓括號)來捕獲URL中的值並以位置參數形式傳遞給視圖。
在更高級的用法中,可以使用分組命名匹配的正則表達式組來捕獲URL中的值並以關鍵字參數形式傳遞給視圖。
在Python的正則表達式中,分組命名正則表達式組的語法是(?P<name>pattern)
,其中name
是組的名稱,pattern
是要匹配的模式。
下面是以上URLconf 使用命名組的重寫:
from django.conf.urls import url from django.contrib import admin from app01 import views urlpatterns = [ # url(r'^admin/', admin.site.urls),
url(r"",views.home) # 匹配所有,這種一般使用home主頁,寫在項目文件中urls.py文件中就是項目的首頁,寫在應用文件中的urls.py就是應用文件首頁 url(r'^articles/', views.articles), # 正則匹配所有以articles開頭的:例如:articles/,articles/xxx等 url(r'^articles/2001/$', views.articles_2001), # 正則匹配只能是articles/2001/滿足條件 url(r'^articles/[0-9]{4}/$', views.year_archive), # 如果用戶想看2004、2005、2006....等,你要寫一堆的url嗎,是不是在articles后面寫一個正則表達式/d{4}/就行啦 url(r'^articles/([0-9]{4})/([0-9]{2})/$', views.year_month_archive1), # 如果你想拿到用戶輸入的什么年份,並通過這個年份去數據庫里面匹配對應年份的文章,獲取用戶輸入的年份: 分組(位置參數):/(\d{4})/ url(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/$', views.year_month_archive2), # 如果你想拿到用戶輸入的什么年份,並通過這個年份去數據庫里面匹配對應年份的文章,獲取用戶輸入的年份: 分組(關鍵字):/(\d{4})/ url(r'^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/$', views.year_month_archive3, {"foo": "1234"}), # foo是一個額外參數,以字典形式存在,value必須是一個str類型 ]
注意事項
- urlpatterns中的元素按照書寫順序從上往下逐一匹配正則表達式,一旦匹配成功則不再繼續。
- 若要從URL中捕獲一個值,只需要在它周圍放置一對圓括號(分組匹配)。
- 不需要添加一個前導的反斜杠(也就是寫在正則最前面的那個/),因為每個URL 都有。例如,應該是^articles 而不是 ^/articles。
- 每個正則表達式前面的'r' 是可選的但是建議加上。
- ^articles& 以什么結尾,以什么開頭,嚴格限制路徑
下面是views中對url中分發的實現:
# 模糊匹配,以articles開頭 def articles(request): return HttpResponse("hello") # http://127.0.0.1:8000/articles/ # 參數指定默認值,以articles開頭 def articles(request, num="123"): # 未做匹配時,num為默認值,否則為匹配的結果 return HttpResponse("hello"+num) # http://127.0.0.1:8000/articles/ # 精確匹配:^articles/2001/$ def articles_2001(request): return HttpResponse("hello1") # http://127.0.0.1:8000/articles/2001/ # 匹配多個結果:^articles/[0-9]{4}/$ def year_archive(request): return HttpResponse("hello2") # http://127.0.0.1:8000/articles/1222/ # 分組:默認參數,接收變量的位置不能隨意改變,匹配多個結果:^articles/([0-9]{4})/([0-9]{2})/$ def year_month_archive1(request, year, month): return HttpResponse("hello"+year+month) # http://127.0.0.1:8000/articles/2005/02/ # 分組:關鍵字參數,接收變量的位置能隨意改變,匹配多個結果:^articles/(?P<year>[0-9]{4})/(?P<month>[0-9]{2})/$ def year_month_archive2(request, month, year): return HttpResponse("hello"+year+month) # http://127.0.0.1:8000/articles/2005/02/ # 額外參數,接收變量的位置必須放在默認參數的后面,對關鍵字參數傳參無影響 def year_month_archive3(request, month, year, foo): return HttpResponse("hello"+year+month+foo) # http://127.0.0.1:8000/articles/2005/02/
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
等等 —— 都將路由到相同的函數。
捕獲的參數永遠都是字符串:
傳遞到視圖函數views.year_archive()
中的year
參數永遠是一個字符串類型。
補充說明: # 是否開啟URL訪問地址后面不為/跳轉至帶有/的路徑的配置項 APPEND_SLASH=True Django settings.py配置文件中默認沒有 APPEND_SLASH 這個參數,但 Django 默認這個參數為 APPEND_SLASH = True。 其作用就是自動在網址結尾加'/'。其效果就是:我們定義了urls.py: 例如: 訪問 http://www.example.com/blog 時,默認將網址自動轉換為 http://www.example/com/blog/ 。 如果在settings.py中設置了 APPEND_SLASH=False,此時我們再請求 http://www.example.com/blog 時就會提示找不到頁面。
三、include其他的URLconfs(也叫URL分發)
項目文件夾里面的文件都是全局文件,所有的app應用都可以訪問到,這種情況下,一個項目文件可能存在多個應用app文件,這是后為了每個app應用方便管理,降低應用之間的耦合度,所以django在url這里給你提供了一個分發接口,叫做include
項目文件(urls):#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), # app01應用: url(r'^app01/', include("app01.urls")), # 可以包含其他的URLconfs文件
url(r'^app01/2003/', views.special_case_2003,{'foo':'xxxxx'}), #{'foo':'xxxxx'}那么你的視圖函數里面必須有個形參叫做foo來接收這種傳參
# app02應用: url(r'^app02/', include("app02.urls")), # 別忘了要去app01這個應用下創建一個urls.py的文件,現在的意思是凡是以app01開頭的路徑請求,都讓它去找app01下的urls文件中去找對應的視圖函數,還要注意一點,此時這個文件里面的那個app01路徑不能用$結尾,因為如果寫了$,就沒辦法比配上app01/后面的路徑了
]
應用文件(urls):
app01應用文件urls.py: urlpatterns = [ url(r"^home/(\d{4})/(\d{1,2})/", views.home), # 默認參數 ] app02應用文件urls.py: urlpatterns = [ url(r"^index/(?P<year>\d+)/(?P<month>\d+)/", views.index), # 關鍵字參數 ]
應用文件(views)
app01中的views.py def home(request, year, month): return render(request, "home.html", {"year": year, "month": month}) # http://127.0.0.1:8000/app01/home/2000/23/ app02中的views.py def index(request, year, month): return HttpResponse(year + month) # http://127.0.0.1:8000/app02/index/1000/23/
四、傳遞額外的參數給視圖函數
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'}),#注意,這就像一個命名分組一樣,你的函數里面的必須有一個形參,形參必須叫做foo才行,如果是命名分組的url,那么foo參數寫在函數的哪個位置都行,如果不是命名分組,那么都是將這個形參寫在參數的最后。 ] 在這個例子中,對於/blog/2005/請求,Django 將調用views.year_archive(request, year='2005', foo='bar')。 這個技術在Syndication 框架中使用,來傳遞元數據和選項給視圖。
五、命名URL(別名)和URL的反向解析
你想,我們自己寫的url里面的路徑有沒有可能會更改,如果路徑更改了,那么我們前端訪問這個路徑的標簽(a標簽,form表單等等)里面的屬性值是不是也要自己手動去改啊,這樣我們拓展起來就不方便了
人們強烈希望不要硬編碼(其實就是在標簽里面寫死了路徑,凡是寫死了的代碼就是硬編碼)這些URL(費力、不可擴展且容易產生錯誤)或者設計一種與URLconf 毫不相關的專門的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() 方法。
urls.py文件: url(r'^home', views.home, name='home'), # 給我的url匹配模式起名(別名)為 home,別名不需要改,路徑你就可以隨便改了,別的地方使用這個路徑,就用別名來搞 url(r'^index/(\d*)', views.index, name='index'), # 給我的url匹配模式起名為index 在模板里面可以這樣引用:html文件 <form action="{% url 'home' %}" method="post"> # {% url "home" %} 模板反向解析的過程 {% csrf_token %} 用戶名 <input type="text" name="username"> <input type="submit"> </form> 在views函數中可以這樣引用:(這個是視圖函數應用反向解析的內容,上面的是模板應用反向解析的過程) from django.urls import reverse return redirect(reverse('userindex')) # 方式一 return redirect('userindex') # 方式二:內部實現了一個reverse方法 reverse("index", args=("2018", )) # 可以帶參數
注意:
當命名你的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')), # 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' # 指定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' # 指定app02的命名空間,必須寫 urlpatterns = [ url(r'^(?P<pk>\d+)/$', views.detail, name='detail') ]
現在,我的兩個app中 url名稱重復了,我反轉URL的時候就可以通過命名空間的名稱得到我當前的URL。
語法: '命名空間名稱:URL名稱' 模板中使用: {% url 'app01:detail' pk=12 pp=99 %} # 指定用法:app01:別名
views中的函數中使用: v = reverse('app01:detail', kwargs={'pk':11}) # 指定關鍵字傳參:pk 這樣即使app中URL的命名相同,我也可以反轉得到正確的URL了。