django原始碼解讀之 View View、 ContextMixin、TemplateResponseMixin、TemplateView、RedirectView
View
class View(object):
"""
所有檢視的基類
1 簡答的請求方啊過濾 所有的請求都應該在被允許的 請求列表 http_method_names 中
2 實現請求的分發，即按照請求的方法，呼叫對應的檢視函式。<eg: get請求 執行self.get()>
"""
# "被允許的請求方式列表"
http_method_names = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace']
def __init__(self, **kwargs):
"""
檢視的建構函式,kwargs 接受所有的額外的引數
"""
# 遍歷所有的關鍵字引數,並將鍵作為例項的屬性,值作為例項物件的值
for key, value in six.iteritems(kwargs):
setattr(self, key, value)
@classonlymethod # 限制該方法只允許類本身呼叫 不允許例項物件呼叫
def as_view(cls, **initkwargs):
"""
返回一個接受請求並返回響應的可呼叫檢視
流程：1 過濾傳入的引數是否在http_method_names
2 檢視傳入的引數是否是self 本身擁有的屬性，只允許傳入本身擁有的屬性，例如:query_set物件
eg: View.as_view(query_set=User.object.all())
在URLconf中指定查詢資料集為 User的所有例項
"""
for key in initkwargs: # 遍歷所有的傳入欄位
if key in cls.http_method_names:
# 不允許傳入的引數名為 http請求方法名 即http_method_names中定義的
raise TypeError("You tried to pass in the %s method name as a "
"keyword argument to %s(). Don't do that."
% (key, cls.__name__))
if not hasattr(cls, key):
# 不允許傳入的引數名為Response/Request沒有的屬性
raise TypeError("%s() received an invalid keyword %r. as_view "
"only accepts arguments that are already "
"attributes of the class." % (cls.__name__, key))
def view(request, *args, **kwargs):
""" 建立檢視函式 初始化檢視資訊 """
self = cls(**initkwargs) # 例項化檢視物件 initkwargs 為as_view()方法傳入的引數字典
if hasattr(self, 'get') and not hasattr(self, 'head'):
self.head = self.get # 繫結了get方法的請求物件
self.request = request # WSGI請求物件 <django.core.handlers.wsgi.WSGIRequest>
self.args = args # 位置引數 URL傳入的
self.kwargs = kwargs # 關鍵字引數 URL傳入的關鍵字引數
return self.dispatch(request, *args, **kwargs) # 呼叫dispatch方法 分發
# 為檢視函式新增 view_class 屬性 和 view_initkwargs 屬性
view.view_class = cls
view.view_initkwargs = initkwargs # <as_view()接收的引數>
# take name and docstring from class
update_wrapper(view, cls, updated=())
# and possible attributes set by decorators
# like csrf_exempt from dispatch
update_wrapper(view, cls.dispatch, assigned=())
return view
def dispatch(self, request, *args, **kwargs):
# Try to dispatch to the right method; if a method doesn't exist,
# defer to the error handler. Also defer to the error handler if the
# request method isn't on the approved list.
# 如果方法被允許
if request.method.lower() in self.http_method_names: # 判斷請求WSGIRequest方法是否在允許的方法中。
# 檢視例項化物件是否擁有get/post... 或 被 http_method_names 包含的同名屬性(方法)。（也就 是說如果繼承 View 則需要實現 http_method_names 方法中的一個或多個）
handler = getattr(self, request.method.lower(), self.http_method_not_allowed)
else:
# 否則 丟擲警告資訊 `Method Not Allowed...`<self.http_method_not_allowed 方法中定義>
handler = self.http_method_not_allowed
# 返回結果
return handler(request, *args, **kwargs)
def http_method_not_allowed(self, request, *args, **kwargs):
# 丟擲 警告
logger.warning(
'Method Not Allowed (%s): %s', request.method, request.path,
extra={'status_code': 405, 'request': request}
)
return http.HttpResponseNotAllowed(self._allowed_methods())
def options(self, request, *args, **kwargs):
"""
options（request，* args，** kwargs）¶
處理對OPTIONS HTTP動詞的請求的響應。返回一個響應，該響應的Allow標頭包含檢視的允許的HTTP方法名稱的列表。
Handles responding to requests for the OPTIONS HTTP verb.
"""
response = http.HttpResponse()
response['Allow'] = ', '.join(self._allowed_methods())
response['Content-Length'] = '0'
return response
def _allowed_methods(self):
# 列表生成式 如果繼承View的類 實現了 http_method_names 中的方法，則會返回大寫的方法名列表
# 沒有 在 hasattr 不成立。不會反回。
# 也就是說返回的應該是一個 全部被允許的<均實現的>大寫的方法列表
return [m.upper() for m in self.http_method_names if hasattr(self, m)]
ContextMixin
class ContextMixin(object):
"""
將接收到的關鍵字引數 放入上下文中
通常來說繼承該類，會重寫該方法，更新或新增一些其他的資訊，用於模版的渲染
返回 字典型別物件，包含上下文需要的資訊。
"""
def get_context_data(self, **kwargs):
# 所有基於類的通用檢視的模板上下文都包含一個 view 它是View的例項。
if 'view' not in kwargs:
kwargs['view'] = self
return kwargs
# demo
def get_context_data(**kwargs)
context = super().get_context_data(**kwargs)
context.update({"name": "monkey",
"gender": "male"})
return context
TemplateResponseMixin
class TemplateResponseMixin(object):
"""
為視通指定模板，使得它成為一種可配置的選項，並且可以由子類進一步自定義。
我覺得這是 django 非常高明的設計
"""
template_name = None # 使用的模版名稱 HTML文件名 需要寫明路徑 如果是None django.core.exceptions.ImproperlyConfigured異常。它沒有被明確的定義出來在 1.18 版本中
template_engine = None # 渲染模版的引擎 可以指定，在settings中設定的
# 一般是Django自己的或者jinja2
# 1 'django.template.backends.django.DjangoTemplates'
# 2 'django.template.backends.jinja2.Jinja2'
response_class = TemplateResponse # 響應類 通常是預設的TemplateResponse 或其子類 它由
# render_to_response 方法返回 如果需要自定義響應類，可以建立子類，然後指定給 respone_class
content_type = None # 用於響應的MIME。content_type作為關鍵字引數傳遞給response_class。預設值為None-表示Django使用'text/html'
def render_to_response(self, context, **response_kwargs):
"""
這個方法的作用是將 HTML 模版和傳入的上下文字典 response_kwargs 渲染成為期望的響應物件。最終形成(響應位元組流資料) 這一步在HttpRespone中完成。<參看HttpResponseBase 原始碼解析>
任何額外的引數都將傳遞給響應類的建構函式。
注意：修改 上下文的 context
因為這需要傳入上下文引數字典 context 因此也可以在此時操作 context 來管理上下文中的資訊
重寫get_context_data()方法和重寫此方法都可以，但是重寫此方法可定製的東西會更多更靈活也更直接，並且一定不會被覆蓋掉。
"""
response_kwargs.setdefault('content_type', self.content_type)
return self.response_class(
request=self.request,
template=self.get_template_names(),
context=context,
using=self.template_engine,
**response_kwargs
)
def get_template_names(self):
"""
返回用於請求的模板名稱的列表，必須返回一個列表。
因為此方法在 render_to_response 中 例項化response_class時呼叫，因此
如果render_to_response被覆蓋，則可能不會被呼叫。
"""
if self.template_name is None: # 如果沒有值 報錯～
raise ImproperlyConfigured(
"TemplateResponseMixin requires either a definition of "
"'template_name' or an implementation of 'get_template_names()'")
else:
return [self.template_name] # 必須返回列表
TemplateView
# 推薦使用者繼承的類
# 遵從 View中 對方法的約束，實現了get方法 它接受URLconf中所有的關鍵字引數 更新到上下文模版中
# 繼承該類需要顯示的指定 TemplateResponseMixin 定義的 template_name 的值 否則報錯
# 其他屬性或方法根據實際需求覆蓋
class TemplateView(TemplateResponseMixin, ContextMixin, View):
"""
主要的功能都在父類中實現，自己實現get方法 <View中要求需要實現http_method_names 方法中的一種>。
"""
def get(self, request, *args, **kwargs):
context = self.get_context_data(**kwargs)
return self.render_to_response(context)
RedirectView
# 繼承自 View 實現了 get方法， 其他所有的方法來 都會呼叫get <:感覺呼叫 寫的好繁瑣的樣子 ～ ～ >
class RedirectView(View):
"""
重定向的類檢視，要求是一個GET請求 其他請求都會呼叫get 來處理
"""
permanent = False # 重定向是否應該是永久的。唯一的區別是返回的HTTP狀態程式碼。如果為True，則重定向將使用狀態程式碼301。如果為False，則重定向將使用狀態程式碼302。預設情況下permanent為False。
url = None # 重定向到的URL
pattern_name = None # 用於反向解析 url別名
query_string = False # 是否將URL攜帶的查詢引數 傳遞給重定向的 URL True 則傳遞 否則 丟棄 預設是丟棄的
def get_redirect_url(self, *args, **kwargs):
"""
返回重定向到的URL (會按照query_string來選擇是否拼接引數在URL後面)
"""
if self.url: # 如果寫了url 拼接引數後直接賦值
url = self.url % kwargs
elif self.pattern_name: # 如果沒有 但是寫了URL別名 則反向解析路徑並填充引數
try:
url = reverse(self.pattern_name, args=args, kwargs=kwargs)
except NoReverseMatch:
return None
else:
return None # 當 url 和 pattern_name 都顯示的指定 則返回None
args = self.request.META.get('QUERY_STRING', '') # 去請求中提取get方法的 'QUERY_STRING'欄位，沒有則為 ''
if args and self.query_string: # 如果拿到了 並且 query_string 為真 則拼接查詢字串 否則 直接返回上一步 拼接好的url 不帶查詢引數
url = "%s?%s" % (url, args)
return url
def get(self, request, *args, **kwargs):
# get 方法 拿到url 呼叫 get_redirect_url
url = self.get_redirect_url(*args, **kwargs)
if url: # 如果拿到了URL
if self.permanent: # 永久重定向為 True 則返回 301 False 返回 302
return http.HttpResponsePermanentRedirect(url) # <父類新增 status_code = 301 其父類是 HttpResponse 的子類 本質上是一個 重定向的 響應物件>
else:
return http.HttpResponseRedirect(url) # < 父類新增 status_code = 302 >
else: # 沒拿到URL 警告！410 <被請求的資源在伺服器上已經不再可用，而且沒有任何已知的轉發地址。這樣的狀況應當被認為是永久性的>
logger.warning(
'Gone: %s', request.path,
extra={'status_code': 410, 'request': request}
)
return http.HttpResponseGone() # 返回410
# 所有的請求方式都 呼叫get方法來處理 <感覺這裡的原始碼好彆扭 ， 3.x版本還是這樣子～ 查閱文件中和資料也沒有人提到 大膽的改了改原始碼 重寫了 disptch 方法能 發現 沒什麼毛病 ～ 一切都很完美 不曉得框架這樣寫的目的 可能為了後期維護和擴充套件吧>
def head(self, request, *args, **kwargs):
return self.get(request, *args, **kwargs)
def post(self, request, *args, **kwargs):
return self.get(request, *args, **kwargs)
def options(self, request, *args, **kwargs):
return self.get(request, *args, **kwargs)
def delete(self, request, *args, **kwargs):
return self.get(request, *args, **kwargs)
def put(self, request, *args, **kwargs):
return self.get(request, *args, **kwargs)
def patch(self, request, *args, **kwargs):
return self.get(request, *args, **kwargs)