Django 基于类的通用视图

web开发

浏览数:150

2019-1-30

在早期,我们认识到在视图开发过程中有共同的用法和模式。这时我们引入基于函数的通用视图来抽象这些模式以简化常见情形的视图开发。

基于函数视图的用法有以下三种:

def index(request):
    return HttpResponse('hello world!')

def index(request):
    result = {'demo':'demo'}
    return render(request, 'blog/about.html', result)

def index(request):
    result = {'demo':'demo'}
    return render_to_response('blog/about.html', result)

基于函数的视图的问题在于,虽然它们很好地覆盖了简单的情形,但是不能扩展或自定义它们,即使是一些简单的配置选项,这让它们在现实应用中受到很多限制。基于类的通用视图然后应运而生,目的与基于函数的通用视图一样,就是为了使得视图的开发更加容易。

下面三个是最常使用的基于类的通用视图:

TemplateView,ListView,DetailView

TemplateView

TemplateView 一般只在需要返回模板时使用。

class ProtectView(TemplateView):
    template_name = 'polls/name.html'  

TemplateView 可以方便的定义要返回的模板但它不能把数据库中的内容查询展示出来,所以需要使用 DetailViewListView

所有基于类的通用视图中定义的方法需要在类视图调用 as_view() 方法后会被自动调用,因为 DjangoURL 解析器将请求和关联的参数发送给一个可调用的函数而不是一个类,所以基于类的视图有一个 as_view() 类方法用来作为类的可调用入口。

ListView

ListView 用于获取存储在数据库中的某个 Model 的列表。

class IndexView(ListView):  
    """
        首页视图函数,继承 ListView ,展示从数据库中获取的文章列表   
    """
    template_name = "blog/index.html"
    context_object_name = "article_list"
    model = Article

template_name 属性指定了需要渲染的模板,context_object_name 指定了模板中使用的上下文变量,model 指定了数据的来源。它的功能相当于取出了 modelArticle 的所有数据,使用变量 article_list 传递给了 blog/index.html 模板。ListView 中默认使用 object_list 作为上下文变量,可以使用 context_object_name 来自定义上下文变量,一般使用默认的对模板设计者不友好,所以都是自定义上下文变量的。model 属性指定了要获取表中的所有数据,它的功能相当于 article_list = Article.objects.all(),但是当你需要使用过滤条件或者对数据进行一定的操作时,则需要重写 ListView 中获取数据的方法(get_queryset 方法),像下面这样:

class IndexView(ListView):  
    """
        首页视图函数,继承 ListView ,展示从数据库中获取的文章列表   
    """
    template_name = "blog/index.html"
    context_object_name = "article_list"

    def get_queryset(self):
        """
            重写 get_queryset 方法,取出发表的文章并转换文章格式
        """
        article_list = Article.objects.filter(status='p')
        for article in article_list:
            article.body = markdown2.markdown(article.body, extras=['fenced-code-blocks'], )
        return article_list

    def get_context_data(self, **kwargs):
        kwargs['category_list'] = Category.objects.all().order_by('name')
        return super(IndexView, self).get_context_data(**kwargs)

此次重写了 get_context_data 方法,这个方法是用来添加额外的内容传递到模板文件的上下文对象(context)中。上面的例子中将 category_list 添加到上下文变量中,则在模板中可以使用 {{ }} 来展示 category_list 中的内容。

ListView 主要用来获取某个 model 中的所有数据,通过 template_name 属性来指定需要渲染的模板,通过 context_object_name 属性来指定上下文变量(默认为 object_list),通过重写 get_queryset 方法来对 model 中的数据增加其他逻辑,通过重写 get_context_data 方法来为上下文对象添加额外的对象。

DetailView

ListView 用来获取某个 model 中的所有数据,而 DetailView 则是获取每个数据的详细信息,比如 ListView 获取所有文章列表,DetailView 用来获取文章的详细信息。

class ArticleDetailView(DetailView):
    """
        文章详情页
    """

    model = Article
    template_name = 'blog/detail.html'
    context_object_name = "article"
    # 在 urlpattern 中定义的
    pk_url_kwarg = 'article_id'
    
    def get_object(self, queryset=None):
        """ 
            获取对应文章的信息
        """
        obj = super(ArticleDetailView, self).get_object()
        obj.body = markdown2.markdown(obj.body, extras=['fenced-code-blocks'], )
        return obj 

    # 增加 form 到 context
    def get_context_data(self, **kwargs):
        kwargs['comment_list'] = self.object.blogcomment_set.all()  #获取评论
        return super(ArticleDetailView, self).get_context_data(**kwargs)

pk_url_kwarg 定义用来获取对应的单条数据,需要传递主键的值。get_object 方法获取 pk_url_kwarg 中所要查找的对象,类似于 ListView 中的 get_queryset 方法,get_context_data 方法和 ListView 中的功能相同。

DetailView 主要用在获取某个 model 的单个对象中,需要在 URL 中传递一个主键值进行查询。

原文地址:https://www.jianshu.com/p/6d6c890f5f72