Django 基于类的通用视图

django

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

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

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 中传递一个主键值进行查询。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,817评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,329评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,354评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,498评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,600评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,829评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,979评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,722评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,189评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,519评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,654评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,329评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,940评论 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,762评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,993评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,382评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,543评论 2 349

推荐阅读更多精彩内容