前言
欢迎来到系列教程的第六部分!在这篇教程中,我们将详细探讨基于类的视图(简称CBV)。我们也将重构一些现有的视图,以便利用内置的基于类的通用视图(Generic Class-Based Views)。
这篇教程我们还将讨论许多其他主题,例如如何使用分页,如何使用markdown以及如何添加简单的编辑器。我们还将探索一个名为 Humanize 的内置软件包,用于对数据进行“人为操作”。
好了,伙计们!让我们来实现一些代码。今天我们还有很多工作要做!
视图策略
到头来,所有的Django视图其实都是函数。即便是CBV。在类的底层,它完成了所有的功能并最终返回一个视图函数。
引入了基于类的视图,使开发人员可以更轻松地重新使用和扩展视图。使用它们有很多好处,例如可扩展性,多重继承之类的面向对象技术的运用,HTTP 方法的处理是在单独的方法中完成的,而不是使用条件分支,并且还有通用的基于类的视图(简称GCBV)。
在我们继续教程之前,让我们清楚这三个术语的含义:
- 基于函数的视图(FBV)
- 基于类的视图(CBV)
- 基于类的通用视图(GCBV)
FBV是Django视图中最简单的表示:它就是一个接收 HttpRequest 对象并返回一个 HttpResponse 的函数。
CBV是每个Django视图都被定义为一个扩展 django.views.generic.view
抽象类后的 Python 类。
GCBV是可以解决一些具体问题的内置的CBV集合,比如列表视图,创建,更新和删除视图等。
下面我们将探讨一些不同实现方式的例子。
基于函数的视图 (FBV)
views.py
def new_post(request):
if request.method == 'POST': form = PostForm(request.POST) if form.is_valid(): form.save() return redirect('post_list') else: form = PostForm() return render(request, 'new_post.html', {'form': form})
urls.py
urlpatterns = [
url(r'^new_post/$', views.new_post, name='new_post'), ]
基于类的视图 (CBV)
CBV是View类的集成类。这里的主要区别在于请求是以HTTP方法命名的类方法内处理的,例如GET ,POST ,PUT ,HEAD 等。
所以,在这里,我们不需要做一个条件来判断请求是一个 POST 还是它是一个 GET 。代码会直接跳转到正确的方法中。在 View 类中内部处理了这个逻辑。
views.py
from django.views.generic import View
class NewPostView(View): def post(self, request): form = PostForm(request.POST) if form.is_valid(): form.save() return redirect('post_list') return render(request, 'new_post.html', {'form': form}) def get(self, request): form = PostForm() return render(request, 'new_post.html', {'form': form})
我们在 urls.py 模块中引用CBV的方式也会有点不同:
urls.py
urlpatterns = [
url(r'^new_post/$', views.NewPostView.as_view(), name='new_post'), ]
在这里,我们需要调用 as_view()
这个类方法,它将返回一个符合url模式视图函数。在某些情况下,我们也可以将一些关键字参数传递给 as_view()
,以便自定义CBV的行为,就像我们用一些身份验证视图来定制模板一样。
总之,关于CBV的好处是我们可以在类里面添加更多的方法,也许可以这样做:
from django.views.generic import View
class NewPostView(View): def render(self, request): return render(request, 'new_post.html', {'form': self.form}) def post(self, request): self.form = PostForm(request.POST) if self.form.is_valid(): self.form.save() return redirect('post_list') return self.render(request) def get(self, request): self.form = PostForm() return self.render(request)
还可以创建一些通用视图来完成一些任务,以便我们可以在整个项目中重复利用它。
你需要知道的关于CBV的基本就是这些。就这么简单。
基于类的通过视图(GCBV)
接下来关于GCBV。这是一个不同的情况。正如我前面提到的,GCBV是内置CBV的常见用例。它们的实现往往会大量使用多重继承(混合继承)和其他面向对象的策略。
他们非常灵活,可以节省很多的工作量。但是一开始可能相对比较难上手。
当我第一次开始使用Django时,我发现GCBV很难使用。起初,很难说出发生了什么,因为代码执行流程看起来并不明显,因为在父类中隐藏了大量代码。官方文档也有一定的难度,主要是因为属性和方法有时分布在八个父类中。使用GCBV时,最好打开 ccbv.co.uk (需科学上网) 以便快速参考。不用担心,我们将一起探索它。
现在我们来看一个GCBV的例子。
views.py
from django.views.generic import CreateView
class NewPostView(CreateView): model = Post form_class = PostForm success_url = reverse_lazy('post_list') template_name = 'new_post.html'
这里我们使用了一个用于创建模型对象的通用视图。它会处理所有表单处理并在表单有效时保存对象。
因为它是一个CBV,所以我们在 urls.py 中以与其他CBV相同的方式来引用它:
urls.py
urlpatterns = [ url(r'^new_post/$', views.NewPostView.as_view(), name='new_post'), ]
GCBV 中的其他例子还有:detailview,deleteview,formview,updateview,listview。
更新视图
让我们回到我们项目的实现。这次我们将使用 GCBV 来实现编辑帖子的视图:
boards/views.py (查看文件全部内容)
from django.shortcuts import redirect
from django.views.generic import UpdateView from django.utils import timezone class PostUpdateView(UpdateView): model = Post fields = ('message', ) template_name = 'edit_post.html' pk_url_kwarg = 'post_pk' context_object_name = 'post' def form_valid(self, form): post = form.save(commit=False) post.updated_by = self.request.user post.updated_at = timezone.now() post.save() return redirect('topic_posts', pk=post.topic.board.pk, topic_pk=post.topic.pk)
使用 UPDATEVIEW 和 CREATEVIEW ,我们可以选择定义 form_class 或 fields 属性。在上面的例子中,我们使用 fields 属性来即时创建模型表单。在内部,Django 将使用模型表单工厂函数来组成 POST 模型的一种形式。因为它只是一个非常简单的表单,只有 message 字段,所以在这里我们可以这么做。但对于复杂的表单定义,最好从外部定义模型表单然后在这里引用它。
系统将使用 pk_url_kwarg 来标识用于检索 Post 对象的关键字参数的名称。就像我们在 urls.py 中定义一样。
如果我们没有设置 context_object_name 属性,Post 对象将作为“Object”在模板中可用。所以,在这里我们使用 context_object_name 来重命名它来发布。你会看到我们在下面的模板中如何使用它。
在这个特定的例子中,我们不得不重写 form_valid()
方法来设置一些额外的字段,例如updated_by 和 updated_at 。你可以在这里看到 form_valid()
方法原本的样子:updateview#form_valid。
myproject/urls.py (查看文件全部内容)
from django.conf.urls import url
from boards import views urlpatterns = [ # ... url(r'^boards/(?P<pk>\d+)/topics/(?P<topic_pk>\d+)/posts/(?P<post_pk>\d+)/edit/$', views.PostUpdateView.as_view(), name='edit_post'), ]
现在我们可以将链接添加到编辑页面:
templates/topic_posts.html (查看文件全部内容)
{% if post.created_by == user %} <div class="mt-3"> <a href="{% url 'edit_post' post.topic.board.pk post.topic.pk post.pk %}" class="btn btn-primary btn-sm" role="button">Edit</a> </div> {% endif %}
templates/edit_post.html (查看文件全部内容)
{% extends 'base.html' %}
{% block title %}Edit post{% endblock %} {% block breadcrumb %} <li class="breadcrumb-item"><a href="{% url 'home' %}">Boards</a></li> <li class="breadcrumb-item"><a href="{% url 'board_topics' post.topic.board.pk %}">{{ post.topic.board.name }}</a></li> <li class="breadcrumb-item"><a href="{% url 'topic_posts' post.topic.board.pk post.topic.pk %}">{{ post.topic.subject }}</a></li> <li class="breadcrumb-item active">Edit post</li> {% endblock %} {% block content %} <form method="post" class="mb-4" novalidate> {% csrf_token %} {% include 'includes/form.html' %} <button type="submit" class="btn btn-success">Save changes</button> <a href="{% url 'topic_posts' post.topic.board.pk post.topic.pk %}" class="btn btn-outline-secondary" role="button">Cancel</a> </form> {% endblock %}
现在观察我们如何引导到 post 对象:post.topic.board.pk。如果我们没有设置context_object_name 来发布,它将可以被用作:object.topic.board.pk。明白了吗?
测试更新视图
在 boards/tests 文件夹内创建一个名为 test_view_edit_post.py 的新测试文件。点击下面的链接,你会看到很多常用测试,就像我们在本教程中做的一样。我会在这里重点介绍一下新的内容:
boards/tests/test_view_edit_post.py (查看完整文件)
from django.contrib.auth.models import User
from django.test import TestCase from django.urls import reverse from ..models import Board, Post, Topic from ..views import PostUpdateView class PostUpdateViewTestCase(TestCase): ''' Base test case to be used in all `PostUpdateView` view tests ''' def setUp(self): self.board = Board.objects.create(name='Django', description='Django board.') self.username = 'john' self.password = '123' user = User.objects.create_user(username=self.username, email='john@doe.com', password=self.password) self.topic = Topic.objects.create(subject='Hello, world', board=self.board, starter=user) self.post = Post.objects.create(message='Lorem ipsum dolor sit amet', topic=self.topic, created_by=user) self.url = reverse('edit_post', kwargs={ 'pk': self.board.pk, 'topic_pk': self.topic.pk, 'post_pk': self.post.pk }) class LoginRequiredPostUpdateViewTests(PostUpdateViewTestCase): def test_redirection(self): ''' Test if only logged in users can edit the posts ''' login_url = reverse('login') response = self.client.get(self.url) self.assertRedirects(response, '{login_url}?next={url}'.format(login_url=login_url, url=self.url)) class UnauthorizedPostUpdateViewTests(PostUpdateViewTestCase): def setUp(self): ''' Create a new user different from the one who posted ''' super().setUp() username = 'jane' password