REST framework---基于类的视图

一、程序设计

1.路由设计

from django.conf.urls import url
from django.contrib import admin
from app import views
from django.views import View

urlpatterns = [
    url(r‘^admin/‘, admin.site.urls),

    # 基于类的视图
    url(r‘^login/‘, views.LoginView.as_view()),
    url(r‘^logout/‘, views.LogoutView.as_view()),

]

2.模型设计

from django.contrib.auth.models import AbstractUser
class UserInfo(AbstractUser):
    """
    用户信息表
    """
    nid = models.AutoField(primary_key=True)
    phone = models.CharField(max_length=11,
                             null=True,
                             unique=True,
                             )

    def __str__(self):
        return self.username

    class Meta:
        verbose_name = "用户信息"
        verbose_name_plural = verbose_name

# 不要忘记在setting.py中引用Django的UserInfo表
# 引用Django自带的UserInfo表,继承使用时需要设置
AUTH_USER_MODEL = "app.UserInfo"   

3.视图设计

from django.views import Viewclass LoginView(View):

    def get(self, request, *args, **kwargs):
        form_obj = forms.LoginForm()
        return render(request, "login.html", {"form_obj": form_obj},)

    def post(self, request, *args, **kwargs):
        ret = {"code": 0}
        # 获取用户输入的用户名、密码
        username = request.POST.get("username")
        password = request.POST.get("password")
        # 判断用户是否存在以及认证
        user_obj = auth.authenticate(username=username,
                                     password=password)
        if user_obj:
            # 登录
            auth.login(request, user_obj)

            # 认证成功后可跳转的地址
            ret["data"] = "/index/"
        else:
            # 认证失败
            ret["code"] = 1
            ret["data"] = "用户名或密码错误"

        return JsonResponse(ret)

class LogoutView(View):
    # 退出登录
    def get(self, request, *args, **kwargs):
        auth.logout(request)
        return redirect("/login/")

二、View源码解析

1.基于函数的视图中,URL设计中,当接收到客户端请求时根据正则匹配得到相应的视图函数并执行,然后得到相应的HttpResponse响应

url(r‘^login/‘, views.login),

2.基于类的视图中,最终也是将函数的执行结果返回给客户端,不同的是当接收到客户端请求时,根据类调用类中的方法,由类的继承、封装、多态、属性查找等特性最终得到相应的HttpResponse响应

 url(r‘^login/‘, views.LoginView.as_view()),

  看源码(展示中将部分源码省略):

  1)客户端发起请求,省略前边一系列中间件等流程,进行路由解析的时候,通过路由匹配拿到对应的类,发现

拿到的是一个对象.属性的方法,于是进行类的属性查找

class LoginView(View):
    def get(self, request, *args, **kwargs):
        ...
    def post(self, request, *args, **kwargs):
        ...

  2)发现该视图类中没有 as_view() 这个方法,于是根据属性查找关系到继承的类View中查找

class View(object):
    http_method_names = [‘get‘, ‘post‘, ‘put‘, ‘patch‘, ‘delete‘, ‘head‘, ‘options‘, ‘trace‘]
    @classonlymethod
    def as_view(cls, **initkwargs):
        def view(request, *args, **kwargs):
            return self.dispatch(request, *args, **kwargs)
        return view

  3)函数中的self为当前的访问到的LoginView对象,在上面的view()方法中返回时遇到self.dispatch(),于是有经过一次属性查找,子类中找不到又再次来到View父类中查找dispatch()方法,最终得到以下

def dispatch(self, request, *args, **kwargs):
    if request.method.lower() in self.http_method_names:
        handler = getattr(self, request.method.lower(), self.http_method_not_allowed)return handler(request, *args, **kwargs)

  4)最终通过反射的方式从View类定义的HTTP请求方法和类视图LoginView中对应的方法,获取到HttpResponse响应返回给客户端

以上是Django中内置的类视图方法,还可以通过安装restframework模块,继承其模块内的APIView类实现:

  1)APIView实际上继承的也是Django内置的View类

  2)获取HttpResponse响应返回给客户端的过程与之前解析的方法相同,区别在于经过属性查找原则最终调用dispatch()方法时,调用的是REST framework内的自定义的dispatch()

    def dispatch(self, request, *args, **kwargs):
        """
        `.dispatch()` is pretty much the same as Django‘s regular dispatch,
        but with extra hooks for startup, finalize, and exception handling.
        """
        self.args = args
        self.kwargs = kwargs
        request = self.initialize_request(request, *args, **kwargs)
        self.request = request
        self.headers = self.default_response_headers  # deprecate?

        try:
            self.initial(request, *args, **kwargs)

            # Get the appropriate handler method
            if request.method.lower() in self.http_method_names:
                handler = getattr(self, request.method.lower(),
                                  self.http_method_not_allowed)
            else:
                handler = self.http_method_not_allowed

            response = handler(request, *args, **kwargs)

        except Exception as exc:
            response = self.handle_exception(exc)

        self.response = self.finalize_response(request, response, *args, **kwargs)
        return self.response

  通过属性查找等规则,最后得到一个HttpResponse相应,不同的是在使用REST famework模块时,可在调用dispatch()方法时实现REST framework提供的其它功能

官方网站:

http://www.django-rest-framework.org/

第三方翻译的中文文档:

https://q1mi.github.io/Django-REST-framework-documentation/

原文地址:https://www.cnblogs.com/mdzzbojo/p/9395661.html

时间: 2024-07-30 10:19:42

REST framework---基于类的视图的相关文章

Django REST framework(基于类的视图CBV)

一丶基于类的视图 views.py下 from snippets.models import Snippet from snippets.serializers import SnippetSerializer from django.http import Http404 from rest_framework.views import APIView from rest_framework.response import Response from rest_framework import

Django——基于类的视图(class-based view)

刚开始的时候,django只有基于函数的视图(Function-based views).为了解决开发视图中繁杂的重复代码,基于函数的通用视图( Funcation-based generic views)出现了,但是不久它的弊端就显示出来:无法扩展.无法定制.基于函数的通用视图的不灵活导致它在现实世界中的应用受限.基于类的通用视图也是出于同样的目的被开发出来,它提供一个工具箱(基类)并支持多重继承,随着它的应用,人们发现它的可扩展性和灵活性远超它的小兄弟——基于函数的通用视图. 基于类的通用视

Django编写RESTful API(三):基于类的视图

欢迎访问我的个人网站:www.comingnext.cn 前言 在上一篇文章中,主要讲的是请求和响应,项目里面views.py中的视图函数都是基于函数的,并且我们介绍了@api_view这个很有用的装饰器.同时,我们还介绍了APIView这个类,但是还没使用它.在这篇文章中,我们要做的是把基于方法的视图改为基于类的视图,将会了解到APIView. 改为基于类的视图 重构一下snippets/view.py: from snippets.models import Snippet from sni

Django——基于类的视图源码分析 二

源码分析 抽象类和常用视图(base.py) 这个文件包含视图的顶级抽象类(View),基于模板的工具类(TemplateResponseMixin),模板视图(TemplateView)和重定向视图(RedirectView). View及View的执行顺序 View是所有基于类的视图的基类.仅实现了一些基本的方法和必要的检查工作.其中最重要的是dispatch方法.再次方法中,根据HTTP请求 中的method参数,调用相应的同名处理函数.这里留下了一个口子,后续的类需要根据自己的情况来填补

Django——基于类的视图源码分析 一

基于类的视图(Class-based view)是Django 1.3引入的新的视图编写方式,用于取代以前基于函数(Function-based)方式. 借助于OO和Python中方便的多重继承特性,基于类的视图可以提供更好的抽象与复用能力. 新的通用视图将更加优雅. Django的文档较为丰富,但在实际开发中往往仍显得不够,很多时候还是需要深入到源代码当中一探究竟.为此,仔细整理了一下基于类的视图的实现方式.期望对以后的开发能够提供更加清晰.直接的参考. 说明: Django大量应用了多重继承

基于类的视图简介

使用基于类的视图 本质上,基于类的视图允许您使用不同的类实例方法响应不同的HTTP请求方法,而不是在单个视图函数中通过 if 逻辑来判断使用不同的代码来处理. 在视图函数中处理HTTP请求: from django.http import HttpResponse def my_view(request): if request.method == 'GET': # <view logic> return HttpResponse('result') 在基于类的视图中: from django

Django——基于类的视图源码分析 三

列表类通用视图(list.py) 此文件包含用于显示数据列表常用的类和工具类.不仅可以方便的用于显示基于模型(Model)的数据列表,也可以用于显示自定义数据列表. 此图中绿色部分属于base.py,引入此图中是为了说明他们之间的关系 MultipleObjectMixin 最主要的核心工具类,主要的算法和接口全部都在这个工具类中实现. 属性 allow_empty 默认值True.表示没有数据时显示空列表:否则将会产生一个404错误. queryset 产生数据的queryset实例或"类qu

Django+jenkins+python+RESTful framework(基于方法的视图)(2) 转发邮件

Send_Email.py @api_view(['POST'])def sendEmail(request): data = getRequestBody(request) print type(data) emailServer = data.get('emailServer') user = data.get('fromUser') passwd = data.get('frompasswd') recipients = data.get('toRecipients') startSend

Django+jenkins+python+RESTful framework(基于Class的视图)(4) 转发邮件

Send_Email.pyclass SendEmailViewList(BaseViewList): def __init__(self): super(SendEmailViewList, self).__init__(None) def post(self, request, format=None): data = getRequestBody(request) print type(data) emailServer = data.get('emailServer') user = d

基于类的通用视图

基于类的通用视图 前面我们说过了django的通用视图,不知道django通用视图的去看我前面的随笔,谢谢 django的通用视图帮我们省略了很多代码,但有时候django的通用视图并不能满足我们全部的需求,例如像重定义一些属性和方法的时候,或者我们想换种写法的时候,因此,django提供了基于类的通用视图,通过子类或者在url中传参的方法来配置我们的基于类的通用视图 通用视图和基于类的通用视图是两种不一样的写法,前面我们介绍的通用视图,所有的代码集中于url的配置文件中,而基于类的通用视图主要