Django 基于类的视图详解

说是完结,马上又开始写进阶篇了。

本章不会为博客项目增加新功能,但是也同样重要,因为我们要学习高逼格的基于的视图。

什么是类视图

前面章节中写的所有视图都是基于函数的,即def;而类视图是基于类的,即class

有编程基础的同学都知道,是面向对象技术中非常重要的概念。具有复杂数据功能的类,可以通过继承轻而易举的将自身特性传递给另一个类,从而实现代码的高效复用。

相比以前的函数视图,类视图有以下优势:

说的都是什么意思?通过例子来感受一下。

列表

函数和类

假设我们有一个博客列表,列表既有GET方法、又有POST方法,那么用视图函数看起来像这样:

views.py

def article_list_example(request):
    """处理GET请求"""
    if request.method == 'GET':
        articles = ArticlePost.objects.all()
        context = {'articles': articles}
        return render(request, 'article/list.html', context)

而在类视图中,则变为这样:

views.py

from django.views import View

class ArticleListView(View):
    """处理GET请求"""
    def get(self, request):
        articles = ArticlePost.objects.all()
        context = {'articles': articles}
        return render(request, 'article/list.html', context)

从本质上讲,基于类的视图允许你使用不同的类实例方法(即上面的def get())响应不同的HTTP请求方法,而不需要使用条件分支代码。这样做的好处是把不同的HTTP请求都分离到独立的函数中,逻辑更加清晰,并且方便复用。

需要注意的是,因为Django的URL解析器希望将请求发送到函数而不是类,所以类视图有一个 as_view()方法,该方法返回一个函数,当请求匹配关联模式的URL时,则调用该函数。

即,视图函数的url原本写为:

urls.py

...
urlpatterns = [
    path('...', views.article_list_example, name='...'),
]

类视图的url需改写为:

urls.py

...
urlpatterns = [
    path('...', views.ArticleListView.as_view(), name='...'),
]

通用视图

列表这样的功能在web开发中是很常见的,开发者会一遍又一遍写几乎相同的列表逻辑。Django的通用视图正是为缓解这种痛苦而开发的。它们对常用模式进行抽象,以便你快速编写公共视图,而无需编写太多代码。

因此用列表通用视图改写如下:

views.py

from django.views.generic import ListView

class ArticleListView(ListView):
    # 上下文的名称
    context_object_name = 'articles'
    # 查询集
    queryset = ArticlePost.objects.all()
    # 模板位置
    template_name = 'article/list.html'

列表继承了父类ListView,也就获得了父类中的处理列表的方法,因此你可以看到,我们在自己的类中没有写任何处理的逻辑,仅仅是赋值了几个变量而已。

动态过滤

从数据库中筛选特定的内容也是常见的需求,类视图如何实现呢?

你可能想到了,将上面代码中改为queryset = ArticlePost.objects.filter()就可以了。

除此之外,更好的办法是覆写get_queryset()方法:

views.py

...

class ArticleListView(ListView):
    context_object_name = 'articles'
    template_name = 'article/list.html'

    def get_queryset(self):
        """
        查询集
        """
        queryset = ArticlePost.objects.filter(title='Python')
        return queryset

例子中只是过滤出标题为“Python”的文章而已,有些大材小用了;但是你可以在get_queryset()中写复杂的联合查询逻辑,满足个性化的功能。

添加上下文

在博客列表的设计时,我们返回给模板的上下文除了articles以外,还有很多额外的信息,如ordersearch;在类视图中同样可以实现,改写get_context_data()方法即可:

views.py

...

class ArticleListView(ListView):
    ...

    def get_context_data(self, **kwargs):
        # 获取原有的上下文
        context = super().get_context_data(**kwargs)
        # 增加新上下文
        context['order'] = 'total_views'
        return context

除此之外,ListView还有些别的方法可以覆写,深入了解可以看这里:官方文档

混入类

混入类(Mixin)是指具有某些功能、通常不独立使用、提供给其他类继承功能的类。嗯,就是“混入”的字面意思。

前面的列表视图中已经有get_context_data()方法了。假设需要写一个功能类似的视频列表,就可以用Mixin来避免重复代码:

views.py

...

class ContextMixin:
    def get_context_data(self, **kwargs):
        context = super().get_context_data(**kwargs)
        context['order'] = 'total_views'
        return context

class ArticleListView(ContextMixin, ListView):
    ...

class VideoListView(ContextMixin, ListView):
    ...

通过混入,两个子类都获得了get_context_data()方法。

从语法上看,混入是通过多重继承实现的。有区别的是,Mixin是作为功能添加到子类中的,而不是作为父类。

实际上Django内置了很多通用的Mixin类,实现了大部分常用的功能,点这里深入了解:官方文档

详情页

既然列表都有通用视图,详情页当然也有对应的DetailView

用类视图写一个简单的详情页

views.py

from django.views.generic import DetailView

class ArticleDetailView(DetailView):
    queryset = ArticlePost.objects.all()
    context_object_name = 'article'
    template_name = 'article/detail.html'

然后配置url:

urls.py

...
urlpatterns = [
    # 详情类视图
    path('detail-view/<int:pk>/', views.ArticleDetailView.as_view(), name='...'),
]

注意这里传入的参数不是id而是pk,这是视图的要求(也可以传入slug)。pk是数据表的主键,在默认情况下其实就是id

这就写好了!

也可以添加任何别的功能,比如统计浏览量

views.py

...
class ArticleDetailView(DetailView):
    ...
    def get_object(self):
        """
        获取需要展示的对象
        """
        # 首先调用父类的方法
        obj = super(ArticleDetailView, self).get_object()
        # 浏览量 +1
        obj.total_views += 1
        obj.save(update_fields=['total_views'])
        return obj

方法get_object()的作用是获取需要展示的对象。首先调用父类方法,将这个对象赋值给obj变量,然后再对其进行统计浏览量的操作,最后将对象返回。相当于在原有的方法中把自己的逻辑“塞”了进去。

关于DetailView更多特性看这里:官方文档

除了能够展示信息,通用视图还包含CreateViewUpdateViewDeleteView编辑数据的类。

如果要新建文章,则视图可以这么写:

views.py

from django.views.generic.edit import CreateView

class ArticleCreateView(CreateView):
    model = ArticlePost

    fields = '__all__'
    # 或者只填写部分字段,比如:
    # fields = ['title', 'content']

    template_name = 'article/create_by_class_view.html'

创建create_by_class_view.html文件(目录在哪,你应该已经很清楚了),写入:

create_by_class_view.html

<form method="post">{% csrf_token %}
    {{ form.as_p }}
    <input type="submit" value="Save">
</form>

最后添加url:

urls.py

urlpatterns = [
    path('create-view/', views.ArticleCreateView.as_view(), name='...'),
]

虽然外观简陋(这不是重点),但现在这个视图确实已经能够创建新文章了!

UpdateViewDeleteView这里就不再赘述了,以后用到的地方再进行讲解。

想提前了解的同学戳这里:官方文档

总结

有没有感受到代码隔离继承的强大?没有?以后的章节会逐渐使用编写视图,你会慢慢体会的。

类视图的内容非常丰富,短短一篇文章只能蜻蜓点水而已。读者在编程中遇到困难了,官方文档是你最好的教程。

如果你有耐心从头到尾阅读类视图的官方文档,那当然是最好的了。


教程来源于Github,感谢杜赛 www.dusaiphoto.com大佬的无私奉献,致敬!

技术教程推荐

微服务架构核心20讲 -〔杨波〕

深入浅出gRPC -〔李林锋〕

ZooKeeper实战与源码剖析 -〔么敬国〕

即时消息技术剖析与实战 -〔袁武林〕

现代C++编程实战 -〔吴咏炜〕

To B市场品牌实战课 -〔曹林〕

手机摄影 -〔@随你们去〕

自动化测试高手课 -〔柳胜〕

后端工程师的高阶面经 -〔邓明〕