Django檢視系統
文章目錄
一個檢視函式(類),簡稱檢視,是一個簡單的Python函式(類),它接受Web請求並且返回Web響應。
響應可以是一張網頁的HTML內容,一個重定向,一個404錯誤,一個XML文件,或者一張圖片。
無論檢視本身包含什麼邏輯,都要返回響應。程式碼寫在哪裡也無所謂,只要它在你當前專案目錄下面。除此之外沒有更多的要求了,可以說“沒什麼神奇的地方”。
為了將程式碼存放位置統一,大家約定成俗將檢視放置在專案(project)或應用程式(app)目錄中的名為views.py的檔案中。
一個簡單的檢視:
# 以HTML文件的形式返回當前日期和時間
from django.http import HttpResponse
import datetime
def current_datetime (request):
now = datetime.datetime.now()
html = '<html><body>It is now %s.</body></html>' % now
return HttpResponse(now)
讓我們來逐行解釋上面的程式碼:
- 首先,我們從Django.http模組中匯入了HttpResponse類,以及Python的datetime庫.
- 接著,我們定義了current_datetime函式,這個函式就稱為檢視函式,每個檢視行數都適用HttpRequest物件作為第一個引數,並且通常稱之為request
- 這個檢視會返回一個Httpresponse物件,其中包含生成的響應。每個檢視函式都負責返回一個HttpResponse物件.
Django使用請求和響應物件通過系統傳遞狀態.
.
當瀏覽器向伺服器請求一個頁面時,Django建立一個HttpRequest物件,該物件包含關於請求的元資料。然後,Django載入相應的檢視,將這個HttpRequest物件作為第一個引數傳遞給檢視函式.
.
每個檢視負責返回一個HttpResponse物件.
FBV 與 CBV
FBV (function based view) 基於函式的檢視.
CBV (class based view) 基於類的檢視.
對於相同的邏輯(專案摘),FBV與CBV的寫法:
FBV
from django.shortcuts import render, redirect
def classes_add(request):
if request.method == 'POST':
add_classes_name = request.POST.get('add_classes_name') # 提取班級名稱
Classes.objects.create(name=add_classes_name) # 將新建班級寫入資料庫
return redirect('/classes/') # 跳轉至展示頁面
return render(request, 'classes_add.html') # 返回新增頁面
# urls檔案
url(r'^classes_add/$', views.classes_add),
CBV
from django.shortcuts import render, redirect
from django.views import View
class ClassesAdd(View):
# 可自定義允許的請求
# http_method_names = ['get', 'post']
# 處理get請求的邏輯
def get(self, request):
return render(request, 'classes_add.html') # 返回新增頁面
# 處理post請求的邏輯
def post(self, request):
add_classes_name = request.POST.get('add_classes_name') # 提取班級名稱
Classes.objects.create(name=add_classes_name) # 將新建班級寫入資料庫
return redirect('/classes/') # 跳轉至展示頁面
# urls檔案
url(r'^classes_add/$', views.ClassesAdd.as_view()),
給檢視加裝飾器
FBV本身就是函式,所以和給普通函式加裝飾器無差異.
使用裝飾器裝飾CBV
類中的方法與獨立函式不完全相同,因此不能直接將函式裝飾器應用於類中的方法,我們需要將其轉換為方法裝飾器.
Django中提供了method_decorator裝飾器,用於將函式裝飾器轉換為方法裝飾器.
裝飾器函式如下:
import time
def wrapper(fn):
def inner(*args, **kwargs):
start_time = time.time()
ret = fn(*args, **kwargs)
end_time = time.time()
print("used:", end_time - start_time)
return ret
return inner
裝飾CBV寫法如下:
from django.shortcuts import render, redirect
from django.views import View
# 匯入method_decorator
from django.utils.decorators import method_decorator
class ClassesAdd(View):
# 處理get請求的邏輯
@method_decorator(wrapper) #!
def get(self, request):
return render(request, 'classes_add.html') # 返回新增頁面
# 處理post請求的邏輯
@method_decorator(wrapper) #!
def post(self, request):
add_classes_name = request.POST.get('add_classes_name') # 提取班級名稱
Classes.objects.create(name=add_classes_name) # 將新建班級寫入資料庫
return redirect('/classes/') # 跳轉至展示頁面
關於dispatch()方法
使用CBV時需注意,請求過來後會先執行dispatch()方法,如果需要批量對具體的請求處理,如get、post等做一些操作的時,我們可以在子類中手動改寫此方法,這種操作其實和在FBV上加裝飾器的效果一樣.
from django.shortcuts import render, redirect
from django.views import View
class ClassesAdd(View):
# 可自定義處理請求前後的邏輯
def dispatch(self, request, *args, **kwargs):
# 處理請求之前的邏輯
ret = super().dispatch(request, *args, **kwargs)
# 處理請求之後的邏輯
return ret
# 處理get請求的邏輯
def get(self, request):
return render(request, 'classes_add.html') # 返回新增頁面
# 處理post請求的邏輯
def post(self, request):
add_classes_name = request.POST.get('add_classes_name') # 提取班級名稱
Classes.objects.create(name=add_classes_name) # 將新建班級寫入資料庫
return redirect('/classes/') # 跳轉至展示頁面
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類中的屬性.
除了特殊說明的之外,其它均為只讀的.
.
scheme
表示請求方案的字串(通常為http或https)
.
body
一個字串,代表請求報文的主體。在處理非HTTP形式的報文時非常有用,如:二進位制檔案、XML、Json等.
但如果要處理表單資料,還是推薦是POST.
另外,我們還可以使用Python的類檔案方法去操作它,詳細參考request.read()方法.
.
path
一個字串,表示請求的路徑元件(不含域名及?後面的內容).
.
encoding
一個字串,表示提交的資料的編碼方式.
如果為None,則表示是使用DEFAULT_CHARSET的設定,預設為"utf-8".
此屬性是可寫的,可以通過修改它來改變訪問表單資料使用的編碼,修改後對屬性的任何訪問都將使用新的encoding值(例如從GET或POST中讀取資料).
如果確定表單資料的編碼不是DEFAULT_CHARSET,則使用它.
.
POST
一個類似於字典的物件,如果請求中包含表單資料,則將這些資料封裝成QueryDict物件.
POST請求可以帶有空的POST字典 —— 通過HTTP POST方法傳送一個沒有任何資料的表單,也依然會建立QueryDict物件.
因此,我們使用if request.method == 'POST':
來判斷使用的是否是POST方法,而不是使用if request.method:
另外,如果使用POST上傳檔案的話,檔案資訊將包含在FILES屬性中.
.
COOKIES
一個標準的Python字典,包含所有的cookie,鍵和值都為字串.
.
FILES
一個類似於字典的物件,包含所有的上傳檔案資訊.
FILES中的每個鍵為< input type=“file” name="" />中name,值則為對應的資料.
注意,FILES只有在請求的方法為POST且提交的< form>表單中帶有enctype="multipart/form-data"的情況下才會包含資料。否則,FILES將為一個空的類似於字典的物件.
.
session
一個即可讀又可寫的類似於字典的物件,表示當前的會話.
只有當Django啟用會話的支援時才可用.
完整的細節請參見關於會話的文件.
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 鍵。
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 中介軟體時才可用.
.
匿名使用者: classes 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。
上傳檔案例項:
def upload(request):
if request.method == 'POST':
file_obj = request.FILES.get('file') # 獲取檔案物件(獲取檔案資訊要用FILES)
upload_file_path = os.path.join(settings.BASE_DIR, 'upload_file', file_obj.name) # 檔案上傳路徑, file_obj.name為str型別
# 判斷檔案是否存在的邏輯
if os.path.exists(upload_file_path):
name, suffix = file_obj.name.split('.') # 切割檔名與檔案字尾
file_name = name + "_檔案副本1." + suffix # 重新拼接檔名
upload_file_path = os.path.join(settings.BASE_DIR, 'upload_file', file_name) # 檔案上傳路徑
# 判斷檔案是否有副本的邏輯
if os.path.exists(upload_file_path):
file_list = os.listdir(os.path.dirname(upload_file_path))
# 獲取所有副本檔案
file_copy_num = []
for i in file_list:
if name not in i: continue
copy_num = i.split('.')[0][-1] # 提取副本數字
if copy_num == name[-1]: continue
file_copy_num.append(copy_num)
file_copy_max = int(max(file_copy_num)) # 提取最大的副本數字
file_name = name + "_檔案副本" + str(file_copy_max + 1) + '.' + suffix
upload_file_path = os.path.join(settings.BASE_DIR, 'upload_file', file_name) # 檔案上傳路徑
with open(upload_file_path, 'wb') as f:
[f.write(chunk) for chunk in file_obj.chunks()] # 從檔案裡一點一點的讀資料,寫到檔案裡
return HttpResponse("檔案上傳成功!") # 返回提示資訊
return render(request, 'upload.html') # 返回上傳頁面
方法
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() 方法將會失敗。除非使用中介軟體重寫代理的首部。
get_full_path
.
返回path,如果可以 將加上查詢字串.
例如:/list/test/?name=zyk
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
is_secure()
.
如果請求時安全的,則返回True,即請求時通過HTTPS發起的.
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標籤),因該使用getlist()方法.
rsponse物件
與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
def test(request):
dct = {'name': 'zyk', 'sex': 'boy'}
response = JsonResponse(dct)
print(response.content)
return response
預設只會傳遞字典型別的資料,如果要傳遞非字典型別的資料,需要設定引數safe=False:
response = JsonResponse([1, 2, 3], safe=False)