1. 程式人生 > >Django的View(檢視)和路由系統

Django的View(檢視)和路由系統

一、Django的View(檢視)
1、介紹
一個檢視函式(類),簡稱檢視,是一個簡單的Python 函式(類),它接受Web請求並且返回Web響應。
響應可以是一張網頁的HTML內容,一個重定向,一個404錯誤,一個XML文件,或者一張圖片。
無論檢視本身包含什麼邏輯,都要返回響應。
程式碼寫在哪裡也無所謂,只要它在你當前專案目錄下面。
大家約定俗成將檢視放置在專案(project)或應用程式(app)目錄中的名為views.py的檔案中。


2、FBV和CBV(Function Base View和Class Base View)
1. 基於函式的檢視:FBV
    檢視函式中通過request.method的不同進而執行不同的程式碼

例如:
urls.py程式碼
urlpatterns 
= [ url(r'^login/', views.login), ] views.py程式碼 def login(request): if request.method == 'POST': username = request.POST.get('username') pwd = request.POST.get('pwd') ret = UserInfo.objects.filter(username=username, pwd=pwd) if ret: return
HttpResponse('登入成功') else: return render(request, 'login.html') return render(request, 'login.html') 2. 基於類的檢視:CBV 1. 檢視類必須繼承django.views.View 2. 在類中定義和請求方法同名的方法 3. urls.py中註冊基於類的檢視的時候要區別於FBV要寫成:類名.as_view() 例如: urls.py程式碼 urlpatterns = [ url(r
'^login/', views.LoginView.as_view()), ] views.py程式碼 from django import views class LoginView(views.View): def get(self, request): return render(request, 'login.html') def post(self, request): username = request.POST.get('username') pwd = request.POST.get('pwd') ret = UserInfo.objects.filter(username=username, pwd=pwd) if ret: return HttpResponse('登入成功') else: return render(request, 'login.html') 二、request物件 1、請求相關的常用值: path_info 返回使用者訪問url,不包括域名 method 請求中使用的HTTP方法的字串表示,全大寫表示。 GET 包含所有HTTP GET引數的類字典物件 POST 包含所有HTTP POST引數的類字典物件 body 請求體,byte型別 request.POST的資料就是從body裡面提取到的 FILES 一個類似於字典的物件,包含所有的上傳檔案資訊。 例如:上面的登入示例 在瀏覽器輸入:http://127.0.0.1:8000/login/?id=1 request.path_info --> login --> 只能取到url,取不到url的引數 request.path --> login --> 只能取到url,取不到url的引數 request.get_full_path() --> /login/?id=1 --> 可以取到url和url引數 body 請求體,byte型別 request.POST的資料就是從body裡面提取到的 request.body 返回的是一個bytes型別的資料,是POST提交上來的資料,是沒有進行過修飾的資料, request.POST 的內容就是在request.body資料的基礎上進行分割組成的字典。 例如: request.body: b'csrfmiddlewaretoken=0o2Lc8UH2uhLbaKySq7j3gFm3afb8IBrfD6YHTUM7cD5KVSYtIlPcC7Vsx9xwcIx&username=zbj&pwd=123' request.POST: <QueryDict: {'csrfmiddlewaretoken': ['0o2Lc8UH2uhLbaKySq7j3gFm3afb8IBrfD6YHTUM7cD5KVSYtIlPcC7Vsx9xwcIx'], 'username': ['zbj'], 'pwd': ['123']}> 2、屬性 所有的屬性應該被認為是隻讀的,除非另有說明。 屬性: django將請求報文中的請求行、頭部資訊、內容主體封裝成 HttpRequest 類中的屬性。 除了特殊說明的之外,其他均為只讀的。 0.HttpRequest.scheme 表示請求方案的字串(通常為http或https) 1.HttpRequest.body 一個字串,代表請求報文的主體。在處理非 HTTP 形式的報文時非常有用,例如:二進位制圖片、XML,Json等。 但是,如果要處理表單資料的時候,推薦還是使用 HttpRequest.POST 。 另外,我們還可以用 python 的類檔案方法去操作它,詳情參考 HttpRequest.read() 。 2.HttpRequest.path 一個字串,表示請求的路徑元件(不含域名)。 例如:"/music/bands/the_beatles/" 3.HttpRequest.method 一個字串,表示請求使用的HTTP 方法。必須使用大寫。 例如:"GET""POST" 4.HttpRequest.encoding 一個字串,表示提交的資料的編碼方式(如果為 None 則表示使用 DEFAULT_CHARSET 的設定,預設為 'utf-8')。 這個屬性是可寫的,你可以修改它來修改訪問表單資料使用的編碼。 接下來對屬性的任何訪問(例如從 GET 或 POST 中讀取資料)將使用新的 encoding 值。 如果你知道表單資料的編碼不是 DEFAULT_CHARSET ,則使用它。 5.HttpRequest.GET 一個類似於字典的物件,包含 HTTP GET 的所有引數。詳情請參考 QueryDict 物件。 6.HttpRequest.POST 一個類似於字典的物件,如果請求中包含表單資料,則將這些資料封裝成 QueryDict 物件。 POST 請求可以帶有空的 POST 字典 —— 如果通過 HTTP POST 方法傳送一個表單,但是表單中沒有任何的資料,QueryDict 物件依然會被建立。 因此,不應該使用 if request.POST 來檢查使用的是否是POST 方法;應該使用 if request.method == "POST" 另外:如果使用 POST 上傳檔案的話,檔案資訊將包含在 FILES 屬性中。 7.HttpRequest.COOKIES 一個標準的Python 字典,包含所有的cookie。鍵和值都為字串。 8.HttpRequest.FILES 一個類似於字典的物件,包含所有的上傳檔案資訊。 FILES 中的每個鍵為<input type="file" name="" /> 中的name,值則為對應的資料。 注意,FILES 只有在請求的方法為POST 且提交的<form> 帶有enctype="multipart/form-data" 的情況下才會 包含資料。否則,FILES 將為一個空的類似於字典的物件。 9.HttpRequest.META 一個標準的Python 字典,包含所有的HTTP 首部。具體的頭部資訊取決於客戶端和伺服器,下面是一些示例: CONTENT_LENGTH —— 請求的正文的長度(是一個字串)。 CONTENT_TYPE —— 請求的正文的MIME 型別。 HTTP_ACCEPT —— 響應可接收的Content-Type。 HTTP_ACCEPT_ENCODING —— 響應可接收的編碼。 HTTP_ACCEPT_LANGUAGE —— 響應可接收的語言。 HTTP_HOST —— 客服端傳送的HTTP Host 頭部。 HTTP_REFERER —— Referring 頁面。 HTTP_USER_AGENT —— 客戶端的user-agent 字串。 QUERY_STRING —— 單個字串形式的查詢字串(未解析過的形式)。 REMOTE_ADDR —— 客戶端的IP 地址。 REMOTE_HOST —— 客戶端的主機名。 REMOTE_USER —— 伺服器認證後的使用者。 REQUEST_METHOD —— 一個字串,例如"GET""POST"。 SERVER_NAME —— 伺服器的主機名。 SERVER_PORT —— 伺服器的埠(是一個字串)。   從上面可以看到,除 CONTENT_LENGTH 和 CONTENT_TYPE 之外,請求中的任何 HTTP 首部轉換為 META 的鍵時, 都會將所有字母大寫並將連線符替換為下劃線最後加上 HTTP_ 字首。 所以,一個叫做 X-Bender 的頭部將轉換成 META 中的 HTTP_X_BENDER 鍵。 10.HttpRequest.user 一個 AUTH_USER_MODEL 型別的物件,表示當前登入的使用者。 如果使用者當前沒有登入,user 將設定為 django.contrib.auth.models.AnonymousUser 的一個例項。你可以通過 is_authenticated() 區分它們。 例如: if request.user.is_authenticated(): # Do something for logged-in users. else: # Do something for anonymous users.   user 只有當Django 啟用 AuthenticationMiddleware 中介軟體時才可用。 ------------------------------------------------------------------------------------- 匿名使用者 class models.AnonymousUser django.contrib.auth.models.AnonymousUser 類實現了django.contrib.auth.models.User 介面,但具有下面幾個不同點: id 永遠為None。 username 永遠為空字串。 get_username() 永遠返回空字串。 is_staff 和 is_superuser 永遠為False。 is_active 永遠為 False。 groups 和 user_permissions 永遠為空。 is_anonymous() 返回True 而不是False。 is_authenticated() 返回False 而不是True。 set_password()、check_password()、save() 和delete() 引發 NotImplementedError。 New in Django 1.8: 新增 AnonymousUser.get_username() 以更好地模擬 django.contrib.auth.models.User。 11.HttpRequest.session 一個既可讀又可寫的類似於字典的物件,表示當前的會話。只有當Django 啟用會話的支援時才可用。 完整的細節參見會話的文件。 3、上傳檔案示例 注意:form表單提交的時候,enctype預設是application/x-www-form-urlencoded這個編碼形式, 即使用鍵值對的形式POST資料,在只有文字資料提交時使用。 而如果POST請求中有檔案型別的資料,則需指定enctype="multipart/form-data" 表明POST的資料中 既有文字型別資料(鍵值對傳輸資料)也有檔案型別資料(二進位制傳輸資料)。 upload.html程式碼 <!DOCTYPE html> <html lang="zh-CN"> <head> <meta http-equiv="content-type" charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <title>Upload</title> </head> <body> <form action="" method="post" enctype="multipart/form-data"> {% csrf_token %} <p><input type="text" name="username"></p> <p><input type="file" name="file"></p> <p><input type="submit"></p> </form> </body> </html> views.py程式碼 class UploadView(views.View): def get(self, request): return render(request, 'upload.html') def post(self, request): # 文字型別的資料用request.POST獲取,鍵對應的值是字串型別 print(request.POST) # 檔案型別的資料用request.FILES獲取,鍵對應的值是類的物件 print(request.FILES) # 獲取檔案物件(是一大串bytes型別的位元組碼) file_obj = request.FILES.get('file') # 檔案物件有個內建的屬性name,用於獲取接收到的檔名 filename = file_obj.name # 建一個同名的檔案接收上傳的資料 # with open(filename, 'wb') as f: # for i in file_obj: # f.write(i) # 跟上面的方法是一樣的,只不過chunks是一個內建的方法,可以設定每次接收的資料大小 with open(filename, 'wb') as f: for chunk in file_obj.chunks(chunk_size=1024): f.write(chunk) return HttpResponse('收到啦!') 4、方法 1.HttpRequest.get_host()   根據從HTTP_X_FORWARDED_HOST(如果開啟 USE_X_FORWARDED_HOST,預設為False)和 HTTP_HOST 頭部資訊返回請求的原始主機。 如果這兩個頭部沒有提供相應的值,則使用SERVER_NAME 和SERVER_PORT,在PEP 3333 中有詳細描述。   USE_X_FORWARDED_HOST:一個布林值,用於指定是否優先使用 X-Forwarded-Host 首部,僅在代理設定了該首部的情況下,才可以被使用。   例如:"127.0.0.1:8000"   注意:當主機位於多個代理後面時,get_host() 方法將會失敗。除非使用中介軟體重寫代理的首部。 2.HttpRequest.get_full_path()   返回 path,如果可以將加上查詢字串。   例如:"/music/bands/the_beatles/?print=true" 3.HttpRequest.get_signed_cookie(key, default=RAISE_ERROR, salt='', max_age=None)   返回簽名過的Cookie 對應的值,如果簽名不再合法則返回django.core.signing.BadSignature。   如果提供 default 引數,將不會引發異常並返回 default 的值。   可選引數salt 可以用來對安全金鑰強力攻擊提供額外的保護。max_age 引數用於檢查Cookie 對應的時間戳以確保Cookie 的時間不會超過max_age 秒。 >>> request.get_signed_cookie('name') 'Tony' >>> request.get_signed_cookie('name', salt='name-salt') 'Tony' # 假設在設定cookie的時候使用的是相同的salt >>> request.get_signed_cookie('non-existing-cookie') ... KeyError: 'non-existing-cookie' # 沒有相應的鍵時觸發異常 >>> request.get_signed_cookie('non-existing-cookie', False) False >>> request.get_signed_cookie('cookie-that-was-tampered-with') ... BadSignature: ... >>> request.get_signed_cookie('name', max_age=60) ... SignatureExpired: Signature age 1677.3839159 > 60 seconds >>> request.get_signed_cookie('name', False, max_age=60) False 4.HttpRequest.is_secure()   如果請求時是安全的,則返回True;即請求通是過 HTTPS 發起的。 5.HttpRequest.is_ajax()   如果請求是通過XMLHttpRequest 發起的,則返回True,方法是檢查 HTTP_X_REQUESTED_WITH 相應的首部是否是字串'XMLHttpRequest'。   大部分現代的 JavaScript 庫都會發送這個頭部。如果你編寫自己的 XMLHttpRequest 呼叫(在瀏覽器端),你必須手工設定這個值來讓 is_ajax() 可以工作。   如果一個響應需要根據請求是否是通過AJAX 發起的,並且你正在使用某種形式的快取例如Django 的 cache middleware, 你應該使用 vary_on_headers('HTTP_X_REQUESTED_WITH') 裝飾你的檢視以讓響應能夠正確地快取。 三、Response物件 1、介紹 與由Django自動建立的HttpRequest物件相比,HttpResponse物件是我們的職責範圍了。我們寫的每個檢視都需要例項化,填充和返回一個HttpResponse。 2、使用 傳遞字串 from django.shortcuts import HttpResponse response = HttpResponse("Here's the text of the Web page.") response = HttpResponse("Text only, please.", content_type="text/plain") 設定或刪除響應頭資訊 response = HttpResponse() response['Content-Type'] = 'text/html; charset=UTF-8' del response['Content-Type'] 3、屬性 HttpResponse.content:響應內容 HttpResponse.charset:響應內容的編碼 HttpResponse.status_code:響應的狀態碼 四、JsonResponse物件 JsonResponse是HttpResponse的子類,專門用來生成JSON編碼的響應。 1、使用HttpResponse返回字典 def json_data(request): d = {"name": "小明", "age": 24} import json str_d = json.dumps(d, ensure_ascii=False) return HttpResponse(str_d, content_type='application/json') 2、使用JsonResponse 上面的程式碼等於: def json_data(request): d = {"name": "小明", "age": 24} from django.http import JsonResponse return JsonResponse(d) 注意:JsonResponse一般用於返回字典的Json序列化,列表一般不推薦使用, 如果你死皮賴臉就是想要返回列表,那麼就需要新增safe=False引數 def json_data(request): l = ["a", "b", "c"] from django.http import JsonResponse return JsonResponse(l, safe=False) 五、render 結合一個給定的模板和一個給定的上下文字典,並返回一個渲染後的 HttpResponse 物件。 引數: request: 用於生成響應的請求物件。 template_name:要使用的模板的完整名稱,可選的引數 context:新增到模板上下文的一個字典。預設是一個空字典。如果字典中的某個值是可呼叫的,檢視將在渲染模板之前呼叫它。 content_type:生成的文件要使用的MIME型別。預設為 DEFAULT_CONTENT_TYPE 設定的值。預設為'text/html' status:響應的狀態碼。預設為200。 useing: 用於載入模板的模板引擎的名稱。 例子: from django.shortcuts import render def my_view(request): # 檢視的程式碼寫在這裡 return render(request, 'myapp/index.html', {'foo': 'bar'}) 上面的程式碼等於: from django.shortcuts import HttpResponse from django.template import loader def my_view(request): # 檢視程式碼寫在這裡 t = loader.get_template('myapp/index.html') c = {'foo': 'bar'} return HttpResponse(t.render(c, request)) 六、redirect 引數可以是: 一個模型:將呼叫模型的get_absolute_url() 函式 一個檢視,可以帶有引數:將使用urlresolvers.reverse 來反向解析名稱 一個絕對的或相對的URL,將原封不動的作為重定向的位置。 預設返回一個臨時的重定向;傳遞permanent=True 可以返回一個永久的重定向。 示例: 你可以用多種方式使用redirect() 函式。 1、傳遞一個具體的ORM物件 將呼叫具體ORM物件的get_absolute_url() 方法來獲取重定向的URL: from django.shortcuts import redirect def my_view(request): ... object = MyModel.objects.get(...) return redirect(object) 2、傳遞一個檢視的名稱 def my_view(request): ... return redirect('some-view-name', foo='bar') 3、傳遞要重定向到的一個具體的網址 def my_view(request): ... return redirect('/some/url/') 4、一個完整的網址 def my_view(request): ... return redirect('http://example.com/') 5、預設情況下,redirect() 返回一個臨時重定向。以上所有的形式都接收一個permanent 引數;如果設定為True,將返回一個永久的重定向: def my_view(request): ... object = MyModel.objects.get(...) return redirect(object, permanent=True) 臨時重定向(響應狀態碼:302)和永久重定向(響應狀態碼:301)對普通使用者來說是沒什麼區別的,它主要面向的是搜尋引擎的機器人。 A頁面臨時重定向到B頁面,那搜尋引擎收錄的就是A頁面。 A頁面永久重定向到B頁面,那搜尋引擎收錄的就是B頁面。 七、路由系統 1、URLconf配置 基本格式(django1.x版本):引數都是字串型別的 from django.conf.urls import url urlpatterns = [ url(正則表示式, views檢視函式,引數,別名), ] Django 2.0版本中的路由系統已經替換成下面的寫法:引數支援整型 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引數 擴充套件:如果想在django2.x版本使用1.x版本的程式碼 from django.urls import re_path urlpatterns = [ re_path(正則表示式, views檢視函式,引數,別名), ] 2、正則表示式詳解 基本配置: from django.conf.urls import url from appname 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), ] 注意事項: urlpatterns中的元素按照書寫順序從上往下逐一匹配正則表示式,一旦匹配成功則不再繼續。 若要從URL中捕獲一個值,只需要在它周圍放置一對圓括號(分組匹配)。 不需要新增一個前導的反斜槓,因為每個URL 都有。例如,應該是^articles 而不是 ^/articles。 每個正則表示式前面的'r' 是可選的但是建議加上。 補充說明: # 是否開啟URL訪問地址後面不為/跳轉至帶有/的路徑的配置項 APPEND_SLASH=True Django settings.py配置檔案中預設沒有 APPEND_SLASH 這個引數,但 Django 預設這個引數為 APPEND_SLASH = True。 其作用就是自動在網址結尾加'/'。 其效果就是: 我們定義了urls.py: from django.conf.urls import url from appname 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 時就會提示找不到頁面。 3、分組命名匹配 上面的示例使用簡單的正則表示式分組匹配(通過圓括號)來捕獲URL中的值並以位置引數形式傳遞給檢視。 在更高階的用法中,可以使用分組命名匹配的正則表示式組來捕獲URL中的值並以關鍵字引數形式傳遞給檢視。 在Python的正則表示式中,分組命名正則表示式組的語法是(?P<name>pattern),其中name是組的名稱,pattern是要匹配的模式。 Django路由系統匹配URL路徑的時候是從上到下按照註冊順序來的 Django的路由系統只匹配URL路徑,不匹配域名、埠、URL引數 注意:分組匹配和分組命名匹配不能混合使用!!! url(r'^book/(?P<yyyy>[0-9]{4})/([0-9]{2})/$', views.book) # 錯誤的 3-1、圓括號獲取URL中的值並以位置引數形式傳遞給檢視 urlpatterns = [ url(r'^book/([0-9]{4})/$', views.book), # 這裡([0-9]{4})獲取到的值會當成位置引數傳遞給views.book ] 所以views.book定義的時候應該要定義多一個形參用來接收匹配到的實參 def book(request, year): print(year) return HttpResponse('book') 3-2、分組命名(?P<name>)匹配的正則表示式組來捕獲URL中的值並以關鍵字引數形式傳遞給檢視。 urlpatterns = [ url(r'^book/(?P<yyyy>[0-9]{4})/$', views.book), # 這裡([0-9]{4})獲取到的值會當成關鍵字引數傳遞給views.book ] 所以views.book定義的時候應該要定義多一個關鍵字引數yyyy用來接收匹配到的實參 def book(request, yyyy): # 只能使用yyyy接收,因為是關鍵字傳參 print(yyyy) return HttpResponse('book')