Django-URL路由配置

1、URL配置

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

  基本格式:前端

from django.conf.urls import url
#循環urlpatterns,找到對應的函數執行,匹配上一個路徑就找到對應的函數執行,就再也不往下循環了,並給函數傳一個參數request,和wsgiref的environ相似,就是請求信息的全部內容
urlpatterns = [
     url(正則表達式, views視圖函數,參數,別名),
]

  注意:python

  Django 2.0版本中的路由系統已經替換成下面的寫法,可是django2.0是向下兼容1.x版本的語法的(官方文檔):web

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是要匹配的模式。django

  下面是以上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),  # 若是用戶想看200四、200五、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類型
]

注意事項

  1. urlpatterns中的元素按照書寫順序從上往下逐一匹配正則表達式,一旦匹配成功則再也不繼續。
  2. 若要從URL中捕獲一個值,只須要在它周圍放置一對圓括號(分組匹配)。
  3. 不須要添加一個前導的反斜槓(也就是寫在正則最前面的那個/),由於每一個URL 都有。例如,應該是^articles 而不是 ^/articles。
  4. 每一個正則表達式前面的'r' 是可選的可是建議加上。
  5. ^articles& 以什麼結尾,以什麼開頭,嚴格限制路徑

  下面是views中對url中分發的實現:app

# 模糊匹配,以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的POSTGETHEAD等等 —— 都將路由到相同的函數。

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

  傳遞到視圖函數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 時就會提示找不到頁面。

3、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/

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

   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 框架中使用,來傳遞元數據和選項給視圖。

5、命名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

  重定向圖例:

img

6、命名空間模式

  即便不一樣的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了。
相關文章
相關標籤/搜索