作者:HelloGitHub-追梦人物
文中涉及的示例代码,已同步更新到 [HelloGitHub-Team 仓库](https://github.com/HelloGitHub-Team/HelloDjango-blog-tutorial)
博客文章的模型有一个 excerpt
字段,这个字段用于存储文章的摘要。目前为止,还只能在 django admin 后台手动为文章输入摘要。每次手动输入摘要比较麻烦,对有些文章来说,只要摘取正文的前 N 个字符作为摘要,以便提供文章预览就可以了。因此我们来实现如果文章没有输入摘要,则自动摘取正文的前 N 个字符作为摘要,这有两种实现方法。
覆写 save 方法
第一种方法是通过覆写模型的 save
方法,从正文字段摘取前 N 个字符保存到摘要字段。在 创作后台开启,请开始你的表演 中我们提到过 save
方法中执行的是保存模型实例数据到数据库的逻辑,因此通过覆写 save 方法,在保存数据库前做一些事情,比如填充某个缺失字段的值。
回顾一下博客文章模型代码:
blog/models.pyclass Post(models.Model):# 其它字段...body = models.TextField()excerpt = models.CharField(max_length=200, blank=True)def save(self, *args, **kwargs):self.modified_time = timezone.now()super().save(*args, **kwargs)
其中 body
字段存储的是正文,excerpt
字段用于存储摘要。通过覆写模型的 save 方法,在数据被保存到数据库前,先从 body
字段摘取 N 个字符保存到 excerpt
字段中,从而实现自动摘要的目的。具体代码如下:
blog/models.pyimport markdown
from django.utils.html import strip_tagsclass Post(models.Model):# 其它字段...body = models.TextField()excerpt = models.CharField(max_length=200, blank=True)# 其它方法...def save(self, *args, **kwargs):self.modified_time = timezone.now()# 首先实例化一个 Markdown 类,用于渲染 body 的文本。# 由于摘要并不需要生成文章目录,所以去掉了目录拓展。md = markdown.Markdown(extensions=['markdown.extensions.extra','markdown.extensions.codehilite',])# 先将 Markdown 文本渲染成 HTML 文本# strip_tags 去掉 HTML 文本的全部 HTML 标签# 从文本摘取前 54 个字符赋给 excerptself.excerpt = strip_tags(md.convert(self.body))[:54]super().save(*args, **kwargs)
这里生成摘要的方案是,先将 body
中的 Markdown 文本转为 HTML 文本,去掉 HTML 文本里的 HTML 标签,然后摘取文本的前 54 个字符作为摘要。去掉 HTML 标签的目的是防止前 54 个字符中存在块级 HTML 标签而使得摘要格式比较难看。可以看到很多网站都采用这样一种生成摘要的方式。
然后在模板中适当的地方使用模板标签引用 {{ post.excerpt }}
显示摘要的值即可:
templates/blog/index.html<article class="post post-{{ post.pk }}">...<div class="entry-content clearfix"><p>{{ post.excerpt }}...</p><div class="read-more cl-effect-14"><a href="{{ post.get_absolute_url }}" class="more-link">继续阅读 <span class="meta-nav">→</span></a></div></div>
</article>
新添加一篇文章(这样才能触发 save 方法,此前添加的文章不会自动生成摘要,要手动保存一下触发 save 方法),可以看到摘要效果了。
使用 truncatechars 模板过滤器
第二种方法是使用 truncatechars
模板过滤器(Filter)。在 django 的模板系统中,模板过滤器的使用语法为 {{ var | filter: arg }}
。可以将模板过滤看做一个函数,它会作用于被它过滤的模板变量,从而改变模板变量的值。例如这里的 truncatechars
过滤器可以截取模板变量值的前 N 个字符显示。关于模板过滤器,我们之前使用过 safe
过滤器,可以参考 让博客支持 Markdown 语法和代码高亮 这篇文章中对模板过滤器的说明。
例如摘要效果,需要显示 post.body
的前 54 的字符,那么可以在模板中使用 {{ post.body | truncatechars:54 }}
。
templates/blog/index.html<article class="post post-{{ post.pk }}">...<div class="entry-content clearfix"><p>{{ post.body|truncatechars:54 }}</p><div class="read-more cl-effect-14"><a href="{{ post.get_absolute_url }}" class="more-link">继续阅读 <span class="meta-nav">→</span></a></div></div>
</article>
不过这种方法的一个缺点就是如果前 54 个字符含有块级 HTML 元素标签的话(比如一段代码块),会使摘要比较难看。所以推荐使用第一种方法。
『讲解开源项目系列』启动——让对开源项目感兴趣的人不再畏惧、让开源项目的发起者不再孤单。跟着我们的文章,你会发现编程的乐趣、使用和发现参与开源项目如此简单。欢迎联系我们给我们投稿,让更多人爱上开源、贡献开源~