一 URL配置 "Django 1.11版本 URLConf官方文檔" URL配置(URLconf)就像Django 所支撐網站的目錄。它的本質是URL與要為該URL調用的視圖函數之間的映射表。你就是以這種方式告訴Django,對於這個URL調用這段代碼,對於那個URL調用那段代碼。 基本格式 註意 ...
一 URL配置
URL配置(URLconf)就像Django 所支撐網站的目錄。它的本質是URL與要為該URL調用的視圖函數之間的映射表。你就是以這種方式告訴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參數
二 正則表達式詳解
基本配置
from django.conf.urls import url
from . import views
urlpatterns = [
url(r'^articles/2003/$', views.special_case_2003), #思考:如果用戶想看2004、2005、2006....等,你要寫一堆的url嗎,是不是在articles後面寫一個正則表達式/d{4}/就行啦,網址裡面輸入127.0.0.1:8000/articles/1999/試一下看看
url(r'^articles/([0-9]{4})/$', views.year_archive),
url(r'^articles/([0-9]{4})/([0-9]{2})/$', views.month_archive), #思考,如果你想拿到用戶輸入的什麼年份,並通過這個年份去資料庫裡面匹配對應年份的文章,你怎麼辦?怎麼獲取用戶輸入的年份啊,分組/(\d{4})/,一個小括弧搞定
url(r'^articles/([0-9]{4})/([0-9]{2})/([0-9]+)/$', views.article_detail),
]
views.py中視圖函數的寫法:
第一個參數必須是request,後面跟的三個參數是對應著上面分組正則匹配的每個參數的
def article_detail(request,year,month,day):
return HttpResponse(year+month+day)
註意事項
- urlpatterns中的元素按照書寫順序從上往下逐一匹配正則表達式,一旦匹配成功則不再繼續。
- 若要從URL中捕獲一個值,只需要在它周圍放置一對圓括弧(分組匹配)。
- 不需要添加一個前導的反斜杠(也就是寫在正則最前面的那個/),因為每個URL 都有。例如,應該是^articles 而不是 ^/articles。
- 每個正則表達式前面的'r' 是可選的但是建議加上。
- ^articles& 以什麼結尾,以什麼開頭,嚴格限制路徑
補充說明
# 是否開啟URL訪問地址後面不為/跳轉至帶有/的路徑的配置項
APPEND_SLASH=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裡面寫的是2003數字,匹配出來之後也是字元串
url(r'^articles/(\d{4})/$', views.year_archive),#year_archive(request,n),小括弧為分組,有分組,那麼這個分組得到的用戶輸入的內容,就會作為對應函數的位置參數傳進去,別忘了形參要寫兩個了,明白了嗎?
url(r'^articles/(?P<year>[0-9]{4})/$', views.year_archive),#某年的,(?P<year>[0-9]{4})這是命名參數(正則命名匹配還記得嗎?),那麼函數year_archive(request,year),形參名稱必須是year這個名字。而且註意如果你這個正則後面沒有寫$符號,即便是輸入了月份路徑,也會被它攔截下拉,因為它的正則也能匹配上
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"),year和month的位置可以換,沒所謂了,因為是按照名字來取數據的,還記得關鍵字參數嗎?
在實際應用中,使用分組命名匹配的方式可以讓你的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的POST
、GET
、HEAD
等等 —— 都將路由到相同的函數。
捕獲的參數永遠都是字元串
每個在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(也叫URL分發)
問大家一個問題,views和models文件是不是都放在每一個app應用裡面了啊,而urls.py這個文件放在哪了,是不是放在項目文件夾裡面了,說明什麼,說明是不是所有的app都在使用它,如果你一個項目有10個應用,每個應用有100個url,那意味著你要在urls文件裡面要寫多少條url對應關係,並且所有的app的url都寫在了這一個urls文件裡面啊,這樣好嗎,當然也沒有問題,但是耦合程度太高了,所以django在url這裡給你提供了一個分發介面,叫做include
#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(r'^app01/',include('app01.urls')), #別忘了要去app01這個應用下創建一個urls.py的文件,現在的意思是凡是以app01開頭的路徑請求,都讓它去找app01下的urls文件中去找對應的視圖函數,還要註意一點,此時這個文件裡面的那個app01路徑不能用$結尾,因為如果寫了$,就沒辦法比配上app01/後面的路徑了
]
app01的urls.py的內容:(其實就是將全局的urls.py裡面的內容copy一下,放到你在app01文件夾下創建的那個urls.py文件中,把不是這個app01應用的url給刪掉就行了)
from django.conf.urls import url
#from django.contrib import admin
from app01 import views
urlpatterns = [
# url(r'^admin/', admin.site.urls),
url(r'^articles/2003/', views.special_case_2003,{'foo':'xxxxx'}), #{'foo':'xxxxx'}那麼你的視圖函數裡面必須有個形參叫做foo來接收這種傳參
url(r'^articles/(\d{4})/(\d{2})/', views.year_archive),
]
此時的目錄結構:
此時我們再訪問之前的articles相關的網址路徑的時候,就需要寫上app01開頭的了
正確輸入方式:
其實相當於做了什麼呢,將網址http://127.0.0.1:8000/app01/articles/2003/,裡面的路徑部分app01/articles/2003/,到項目的urls.py裡面匹配,匹配到了app01/,然後拿著路徑剩餘的部分articles/2003/去app01裡面的urls.py文件裡面進行匹配,找到對應的函數執行。
還要註意一點,看下麵的$符號:
再來看:如果我們想通過輸入http://127.0.0.1:8000/app01/,看到app01這個應用的首頁,怎麼辦?就像我現在輸入一個http://127.0.0.1:8000來查看網站的首頁,怎麼辦,也就是說我後面不加任何路徑,就看你網址的首頁,怎麼辦,一般網站的根路徑都是網站的首頁,對不對
看下麵這種寫法可不可以:
views.py裡面寫了這麼個函數
輸入網址:
發現都跑到index這個函數裡面去執行了,也就是說,全部被這個沒有匹配規則的url獲取到了,對不對
所以,正確的寫法,匹配根路徑的寫法:
url(r'^$', views.index),#以空開頭,還要以空結尾,寫在項目的urls.py文件裡面就是項目的首頁,寫在應用文件夾裡面的urls.py文件中,那就是app01的首頁
app01函數的內容:
還有註意一點,就是加app的時候,需要進行配置:
傳遞額外的參數給視圖函數(瞭解)
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表單等等)裡面的屬性值是不是也要自己手動去改啊,這樣我們拓展起來就不方便了,你想是不是?尤其是前端可能不是你寫的,那你是不是要進行部門溝通啊,想一想怎麼辦?
在使用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' %} #模板渲染的時候,被django解析成了這個名字對應的那個url,這個過程叫做反向解析
在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,))) #或者直接return redirect('news-year-archive',year) redirect內部會自動調用reverse來進行反向解析
如果出於某種原因決定按年歸檔文章發佈的URL應該調整一下,那麼你將只需要修改URLconf 中的內容。
在某些場景中,一個視圖是通用的,所以在URL 和視圖之間存在多對一的關係。對於這些情況,當反查URL 時,只有視圖的名字還不夠。
註意:
為了完成上面例子中的URL 反查,你將需要使用命名的URL 模式。URL 的名稱使用的字元串可以包含任何你喜歡的字元。不只限制在合法的Python 名稱。
當命名你的URL 模式時,請確保使用的名稱不會與其它應用中名稱衝突。如果你的URL 模式叫做comment
,而另外一個應用中也有一個同樣的名稱,當你在模板中使用這個名稱的時候不能保證將插入哪個URL。
在URL 名稱中加上一個首碼,比如應用的名稱,將減少衝突的可能。我們建議使用myapp-comment
而不是comment
。
五 命名空間模式
這個內容,我們後面用到的時候再過來學吧,比較靠後的一個內容~~~
即使不同的APP使用相同的URL名稱,URL的命名空間模式也可以讓你唯一反轉命名的URL。
舉個例子:
項目的urls.py寫法:
from django.conf.urls import url,include
from django.contrib import admin
urlpatterns = [
url(r'^admin/', admin.site.urls),
url(r'^app01/', include('app01.urls')),
url(r'^app02/', include('app02.urls')),
]
app01下的urls.py寫法
django.conf.urls import url
from django.contrib import admin
from app01 import views
urlpatterns = [
## url(r'^admin/', admin.site.urls),
url(r'^index/', views.index,name='index'),
]
app02下的urls.py的寫法
from django.conf.urls import url
from django.contrib import admin
from app02 import views
# app_name = 'app02'
urlpatterns = [
# url(r'^admin/', admin.site.urls),
url(r'^index/', views.index,name='index'),
]
app01下的views.py的寫法
from django.shortcuts import render,HttpResponse,redirect
from django.urls import reverse
# Create your views here.
def index(request):
print(reverse('index'))
return HttpResponse('ok')
app02下的views.py的寫法
from django.shortcuts import render,HttpResponse,redirect
from django.urls import reverse
# Create your views here.
def index(request):
print(reverse('index'))
return HttpResponse('ok2')
你會發現,不管你是訪問app01下的index還是app02下的index,列印的結果都是/app02/index/,也就是列印的是最後一個index別名對應的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
urlpatterns = [
url(r'^(?P<pk>\d+)/$', views.detail, name='detail')
]
app02中的urls.py
from django.conf.urls import url
from app02 import views
urlpatterns = [
url(r'^(?P<pk>\d+)/$', views.detail, name='detail')
]
現在,我的兩個app中 url名稱重覆了,我反轉URL的時候就可以通過命名空間的名稱得到我當前的URL。
語法:
'命名空間名稱:URL名稱'
模板中使用:
{% url 'app01:detail' pk=12 pp=99 %}
views中的函數中使用
v = reverse('app01:detail', kwargs={'pk':11})
這樣即使app中URL的命名相同,我也可以反轉得到正確的URL了。
第二種寫法:就是在每個app下的urls.py文件中指定app名稱,同樣是命名空間。
from django.conf.urls import url,include
from django.contrib import admin
urlpatterns = [
url(r'^admin/', admin.site.urls),
# url(r'^app01/', include('app01.urls',namespace='app01')),
url(r'^app01/', include('app01.urls')),
# url(r'^app02/', include('app02.urls',namespace='app02')),
url(r'^app02/', include('app02.urls')),
]
app01下的urls.py
from django.conf.urls import url
from django.contrib import admin
from app01 import views
app_name = 'app01'
urlpatterns = [
# url(r'^admin/', admin.site.urls),
url(r'^index/', views.index,name='index'),
]
app02下的urls.py
from django.conf.urls import url
from django.contrib import admin
from app02 import views
app_name = 'app02'
urlpatterns = [
# url(r'^admin/', admin.site.urls),
url(r'^index/', views.index,name='index'),
]
app01下的view視圖中反向解析
def index(request):
print(reverse('app01:index'))
return HttpResponse('ok')
app02下的view視圖中反向解析
def index(request):
print(reverse('app02:index'))
return HttpResponse('ok2')
第三種寫法:
項目的urls.py中的寫法:
from django.conf.urls import url,include
from django.contrib import admin
urlpatterns = [
url(r'^admin/', admin.site.urls),
# url(r'^app01/', include('app01.urls',namespace='app01')),
url(r'^app01/', include(('app01.urls','app01'),namespace='app01')),
# url(r'^app02/', include('app02.urls',namespace='app02')),
url(r'^app02/', include(('app02.urls','app02'),namespace='app02')),
]
那麼其他的app中的urls.py中就不需要寫app_name='應用名'了,看app01下urls.py的寫法:
from django.conf.urls import url
from django.contrib import admin
from app01 import views
urlpatterns = [
# url(r'^admin/', admin.site.urls),
url(r'^index/', views.index,name='index'),
]
app02下urls.py的寫法:
from django.conf.urls import url
from django.contrib import admin
from app02 import views
urlpatterns = [
# url(r'^admin/', admin.site.urls),
url(r'^index/', views.index,name='index'),
]
視圖的寫法:
#app01
def index(request):
print(reverse('app01:index'))
return HttpResponse('ok')
#app02
def index(request):
print(reverse('app02:index'))
return HttpResponse('ok2')