django-檢視函式
Django的View(檢視)
一個檢視函式(類),簡稱檢視,是一個簡單的Python 函式(類),它接受Web請求並且返回Web響應。
響應可以是一張網頁的HTML內容,一個重定向,一個404錯誤,一個XML文件,或者一張圖片。
無論檢視本身包含什麼邏輯,都要返回響應。程式碼寫在哪裡也無所謂,只要它在你當前專案目錄下面。除此之外沒有更多的要求了——可以說“沒有什麼神奇的地方”。為了將程式碼放在某處,大家約定成俗將檢視放置在專案(project)或應用程式(app)目錄中的名為views.py的檔案中。
一個簡單的檢視
下面是一個以HTML文件的形式返回當前日期和時間的檢視:from django.http importHttpResponse import datetime def current_datetime(request): now = datetime.datetime.now() html = "<html><body>It is now %s.</body></html>" % now return HttpResponse(html)
讓我們來逐行解釋下上面的程式碼:
-
首先,我們從django.http模組匯入了HttpResponse類,以及Python的datetime庫。
-
接著,我們定義了current_datetime
注意,檢視函式的名稱並不重要;不需要用一個統一的命名方式來命名,以便讓Django識別它。我們將其命名為current_datetime,是因為這個名稱能夠比較準確地反映出它實現的功能。
-
這個檢視會返回一個HttpResponse物件,其中包含生成的響應。每個檢視函式都負責返回一個HttpResponse物件。
Django使用請求和響應物件來通過系統傳遞狀態。
當瀏覽器向服務端請求一個頁面時,Django建立一個HttpRequest物件,該物件包含關於請求的元資料。然後,Django載入相應的檢視,將這個HttpRequest物件作為第一個引數傳遞給檢視函式。
每個檢視負責返回一個HttpResponse物件。
CBV和FBV
我們之前寫過的都是基於函式的view,就叫FBV。還可以把view寫成基於類的。
就拿我們之前寫過的新增班級為例:
FBV版:
# FBV版新增班級 def add_class(request): if request.method == "POST": class_name = request.POST.get("class_name") models.Classes.objects.create(name=class_name) return redirect("/class_list/") return render(request, "add_class.html")
CBV版:
# CBV版新增班級 from django.views import View class AddClass(View): def get(self, request): return render(request, "add_class.html") def post(self, request): class_name = request.POST.get("class_name") models.Classes.objects.create(name=class_name) return redirect("/class_list/")
注意:
使用CBV時,urls.py中也做對應的修改:
# urls.py中 url(r'^add_class/$', views.AddClass.as_view()),
給檢視加裝飾器
使用裝飾器裝飾FBV
FBV本身就是一個函式,所以和給普通的函式加裝飾器無差:
def wrapper(func): def inner(*args, **kwargs): start_time = time.time() ret = func(*args, **kwargs) end_time = time.time() print("used:", end_time-start_time) return ret return inner # FBV版新增班級 @wrapper def add_class(request): if request.method == "POST": class_name = request.POST.get("class_name") models.Classes.objects.create(name=class_name) return redirect("/class_list/") return render(request, "add_class.html")
使用裝飾器裝飾CBV
類中的方法與獨立函式不完全相同,因此不能直接將函式裝飾器應用於類中的方法 ,我們需要先將其轉換為方法裝飾器。
Django中提供了method_decorator裝飾器用於將函式裝飾器轉換為方法裝飾器。
# CBV版新增班級 from django.views import View from django.utils.decorators import method_decorator class AddClass(View): @method_decorator(wrapper) def get(self, request): return render(request, "add_class.html") def post(self, request): class_name = request.POST.get("class_name") models.Classes.objects.create(name=class_name) return redirect("/class_list/")
# 使用CBV時要注意,請求過來後會先執行dispatch()這個方法,如果需要批量對具體的請求處理方法,如get,post等做一些操作的時候,這裡我們可以手動改寫dispatch方法,這個dispatch方法就和在FBV上加裝飾器的效果一樣。 class Login(View): def dispatch(self, request, *args, **kwargs): print('before') obj = super(Login,self).dispatch(request, *args, **kwargs) print('after') return obj def get(self,request): return render(request,'login.html') def post(self,request): print(request.POST.get('user')) return HttpResponse('Login.post')關於CBV的擴充套件閱讀
Request物件和Response物件
request物件
當一個頁面被請求時,Django就會建立一個包含本次請求原資訊的HttpRequest物件。
Django會將這個物件自動傳遞給響應的檢視函式,一般檢視函式約定俗成地使用 request 引數承接這個物件。
請求相關的常用值
- path_info 返回使用者訪問url,不包括域名
- method 請求中使用的HTTP方法的字串表示,全大寫表示。
- GET 包含所有HTTP GET引數的類字典物件
- POST 包含所有HTTP POST引數的類字典物件
- body 請求體,byte型別 request.POST的資料就是從body裡面提取到的
屬性
所有的屬性應該被認為是隻讀的,除非另有說明。
屬性: 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 啟用會話的支援時才可用。 完整的細節參見會話的文件。request屬性相關
上傳檔案示例
def upload(request): """ 儲存上傳檔案前,資料需要存放在某個位置。預設當上傳檔案小於2.5M時,django會將上傳檔案的全部內容讀進記憶體。從記憶體讀取一次,寫磁碟一次。 但當上傳檔案很大時,django會把上傳檔案寫到臨時檔案中,然後存放到系統臨時資料夾中。 :param request: :return: """ if request.method == "POST": # 從請求的FILES中獲取上傳檔案的檔名,file為頁面上type=files型別input的name屬性值 filename = request.FILES["file"].name # 在專案目錄下新建一個檔案 with open(filename, "wb") as f: # 從上傳的檔案物件中一點一點讀 for chunk in request.FILES["file"].chunks(): # 寫入本地檔案 f.write(chunk) return HttpResponse("上傳OK")上傳檔案示例程式碼
方法
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') 裝飾你的檢視以讓響應能夠正確地快取。請求相關方法
注意:鍵值對的值是多個的時候,比如checkbox型別的input標籤,select標籤,需要用:
request.POST.getlist("hobby")
Response物件
與由Django自動建立的HttpRequest物件相比,HttpResponse物件是我們的職責範圍了。我們寫的每個檢視都需要例項化,填充和返回一個HttpResponse。
HttpResponse類位於django.http模組中。
使用
傳遞字串
from django.http 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']
屬性
HttpResponse.content:響應內容
HttpResponse.charset:響應內容的編碼
HttpResponse.status_code:響應的狀態碼
JsonResponse物件
JsonResponse是HttpResponse的子類,專門用來生成JSON編碼的響應。
from django.http import JsonResponse response = JsonResponse({'foo': 'bar'}) print(response.content) b'{"foo": "bar"}'
預設只能傳遞字典型別,如果要傳遞非字典型別需要設定一下safe關鍵字引數。
response = JsonResponse([1, 2, 3], safe=False)
Django shortcut functions
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.http 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()函式。
傳遞一個具體的ORM物件(瞭解即可)
將呼叫具體ORM物件的get_absolute_url()方法來獲取重定向的URL:
from django.shortcuts import redirect def my_view(request): ... object = MyModel.objects.get(...) return redirect(object)
傳遞一個檢視的名稱
def my_view(request): ... return redirect('some-view-name', foo='bar')
傳遞要重定向到的一個具體的網址
def my_view(request): ... return redirect('/some/url/')
當然也可以是一個完整的網址
def my_view(request): ... return redirect('http://example.com/')
預設情況下,redirect()返回一個臨時重定向。以上所有的形式都接收一個permanent引數;如果設定為True,將返回一個永久的重定向:
def my_view(request): ... object = MyModel.objects.get(...) return redirect(object, permanent=True)
擴充套件閱讀:
臨時重定向(響應狀態碼:302)和永久重定向(響應狀態碼:301)對普通使用者來說是沒什麼區別的,它主要面向的是搜尋引擎的機器人。
A頁面臨時重定向到B頁面,那搜尋引擎收錄的就是A頁面。
A頁面永久重定向到B頁面,那搜尋引擎收錄的就是B頁面。