Step26: rss feed

Author: zmrenwu

Diff for: README.md

@@ -146,6 +146,7 @@ tutorial 分支为项目的主分支，每一篇教程的代码都和历史提
 23. [通过 Django Pagination 实现简单分页](https://www.zmrenwu.com/courses/hellodjango-blog-tutorial/materials/81/)
 24. [稳定易用的 Django 分页库，完善分页功能](https://www.zmrenwu.com/courses/hellodjango-blog-tutorial/materials/82/)
 25. [统计各个分类和标签下的文章数](https://www.zmrenwu.com/courses/hellodjango-blog-tutorial/materials/83/)
+26. [开启 Django 博客的 RSS 功能](https://www.zmrenwu.com/courses/hellodjango-blog-tutorial/materials/84/)
 
 ## 公众号
 <p align="center">

Diff for: blog/feeds.py

@@ -0,0 +1,26 @@
+from django.contrib.syndication.views import Feed
+
+from .models import Post
+
+
+class AllPostsRssFeed(Feed):
+    # 显示在聚合阅读器上的标题
+    title = "HelloDjango-blog-tutorial"
+
+    # 通过聚合阅读器跳转到网站的地址
+    link = "/"
+
+    # 显示在聚合阅读器上的描述信息
+    description = "HelloDjango-blog-tutorial 全部文章"
+
+    # 需要显示的内容条目
+    def items(self):
+        return Post.objects.all()
+
+    # 聚合器中显示的内容条目的标题
+    def item_title(self, item):
+        return "[%s] %s" % (item.category, item.title)
+
+    # 聚合器中显示的内容条目的描述
+    def item_description(self, item):
+        return item.body_html

Diff for: blog/models.py

@@ -1,9 +1,29 @@
+import re
+
 import markdown
 from django.contrib.auth.models import User
 from django.db import models
 from django.urls import reverse
 from django.utils import timezone
+from django.utils.functional import cached_property
 from django.utils.html import strip_tags
+from django.utils.text import slugify
+from markdown.extensions.toc import TocExtension
+
+
+def generate_rich_content(value):
+    md = markdown.Markdown(
+        extensions=[
+            "markdown.extensions.extra",
+            "markdown.extensions.codehilite",
+            # 记得在顶部引入 TocExtension 和 slugify
+            TocExtension(slugify=slugify),
+        ]
+    )
+    content = md.convert(value)
+    m = re.search(r'<div class="toc">\s*<ul>(.*)</ul>\s*</div>', md.toc, re.S)
+    toc = m.group(1) if m is not None else ""
+    return {"content": content, "toc": toc}
 
 
 class Category(models.Model):
@@ -16,10 +36,11 @@ class Category(models.Model):
     Django 内置的全部类型可查看文档：
     https://docs.djangoproject.com/en/2.2/ref/models/fields/#field-types
     """
-    name = models.CharField('分类名', max_length=100)
+
+    name = models.CharField("分类名", max_length=100)
 
     class Meta:
-        verbose_name = '分类'
+        verbose_name = "分类"
         verbose_name_plural = verbose_name
 
     def __str__(self):
@@ -31,10 +52,11 @@ class Tag(models.Model):
     标签 Tag 也比较简单，和 Category 一样。
     再次强调一定要继承 models.Model 类！
     """
-    name = models.CharField('标签名', max_length=100)
+
+    name = models.CharField("标签名", max_length=100)
 
     class Meta:
-        verbose_name = '标签'
+        verbose_name = "标签"
         verbose_name_plural = verbose_name
 
     def __str__(self):
@@ -47,19 +69,19 @@ class Post(models.Model):
     """
 
     # 文章标题
-    title = models.CharField('标题', max_length=70)
+    title = models.CharField("标题", max_length=70)
 
     # 文章正文，我们使用了 TextField。
     # 存储比较短的字符串可以使用 CharField，但对于文章的正文来说可能会是一大段文本，因此使用 TextField 来存储大段文本。
-    body = models.TextField('正文')
+    body = models.TextField("正文")
 
     # 这两个列分别表示文章的创建时间和最后一次修改时间，存储时间的字段用 DateTimeField 类型。
-    created_time = models.DateTimeField('创建时间', default=timezone.now)
-    modified_time = models.DateTimeField('修改时间')
+    created_time = models.DateTimeField("创建时间", default=timezone.now)
+    modified_time = models.DateTimeField("修改时间")
 
     # 文章摘要，可以没有文章摘要，但默认情况下 CharField 要求我们必须存入数据，否则就会报错。
     # 指定 CharField 的 blank=True 参数值后就可以允许空值了。
-    excerpt = models.CharField('摘要', max_length=200, blank=True)
+    excerpt = models.CharField("摘要", max_length=200, blank=True)
 
     # 这是分类与标签，分类与标签的模型我们已经定义在上面。
     # 我们在这里把文章对应的数据库表和分类、标签对应的数据库表关联了起来，但是关联形式稍微有点不同。
@@ -70,22 +92,22 @@ class Post(models.Model):
     # 同时我们规定文章可以没有标签，因此为标签 tags 指定了 blank=True。
     # 如果你对 ForeignKey、ManyToManyField 不了解，请看教程中的解释，亦可参考官方文档：
     # https://docs.djangoproject.com/en/2.2/topics/db/models/#relationships
-    category = models.ForeignKey(Category, verbose_name='分类', on_delete=models.CASCADE)
-    tags = models.ManyToManyField(Tag, verbose_name='标签', blank=True)
+    category = models.ForeignKey(Category, verbose_name="分类", on_delete=models.CASCADE)
+    tags = models.ManyToManyField(Tag, verbose_name="标签", blank=True)
 
     # 文章作者，这里 User 是从 django.contrib.auth.models 导入的。
     # django.contrib.auth 是 Django 内置的应用，专门用于处理网站用户的注册、登录等流程，User 是 Django 为我们已经写好的用户模型。
     # 这里我们通过 ForeignKey 把文章和 User 关联了起来。
     # 因为我们规定一篇文章只能有一个作者，而一个作者可能会写多篇文章，因此这是一对多的关联关系，和 Category 类似。
-    author = models.ForeignKey(User, verbose_name='作者', on_delete=models.CASCADE)
+    author = models.ForeignKey(User, verbose_name="作者", on_delete=models.CASCADE)
 
     # 新增 views 字段记录阅读量
     views = models.PositiveIntegerField(default=0, editable=False)
 
     class Meta:
-        verbose_name = '文章'
+        verbose_name = "文章"
         verbose_name_plural = verbose_name
-        ordering = ['-created_time']
+        ordering = ["-created_time"]
 
     def __str__(self):
         return self.title
@@ -95,10 +117,9 @@ def save(self, *args, **kwargs):
 
         # 首先实例化一个 Markdown 类，用于渲染 body 的文本。
         # 由于摘要并不需要生成文章目录，所以去掉了目录拓展。
-        md = markdown.Markdown(extensions=[
-            'markdown.extensions.extra',
-            'markdown.extensions.codehilite',
-        ])
+        md = markdown.Markdown(
+            extensions=["markdown.extensions.extra", "markdown.extensions.codehilite",]
+        )
 
         # 先将 Markdown 文本渲染成 HTML 文本
         # strip_tags 去掉 HTML 文本的全部 HTML 标签
@@ -110,8 +131,20 @@ def save(self, *args, **kwargs):
     # 自定义 get_absolute_url 方法
     # 记得从 django.urls 中导入 reverse 函数
     def get_absolute_url(self):
-        return reverse('blog:detail', kwargs={'pk': self.pk})
+        return reverse("blog:detail", kwargs={"pk": self.pk})
 
     def increase_views(self):
         self.views += 1
-        self.save(update_fields=['views'])
+        self.save(update_fields=["views"])
+
+    @property
+    def toc(self):
+        return self.rich_content.get("toc", "")
+
+    @property
+    def body_html(self):
+        return self.rich_content.get("content", "")
+
+    @cached_property
+    def rich_content(self):
+        return generate_rich_content(self.body)

Diff for: blog/views.py

@@ -1,49 +1,47 @@
-import re
-
-import markdown
-from django.shortcuts import get_object_or_404, render
-from django.utils.text import slugify
+from django.shortcuts import get_object_or_404
 from django.views.generic import DetailView, ListView
-from markdown.extensions.toc import TocExtension
+
 from pure_pagination.mixins import PaginationMixin
 
 from .models import Category, Post, Tag
 
 
 class IndexView(PaginationMixin, ListView):
     model = Post
-    template_name = 'blog/index.html'
-    context_object_name = 'post_list'
+    template_name = "blog/index.html"
+    context_object_name = "post_list"
     paginate_by = 10
 
 
 class CategoryView(IndexView):
-
     def get_queryset(self):
-        cate = get_object_or_404(Category, pk=self.kwargs.get('pk'))
+        cate = get_object_or_404(Category, pk=self.kwargs.get("pk"))
         return super().get_queryset().filter(category=cate)
 
 
 class ArchiveView(IndexView):
     def get_queryset(self):
-        year = self.kwargs.get('year')
-        month = self.kwargs.get('month')
-        return super().get_queryset().filter(created_time__year=year,
-                                             created_time__month=month)
+        year = self.kwargs.get("year")
+        month = self.kwargs.get("month")
+        return (
+            super()
+            .get_queryset()
+            .filter(created_time__year=year, created_time__month=month)
+        )
 
 
 class TagView(IndexView):
     def get_queryset(self):
-        t = get_object_or_404(Tag, pk=self.kwargs.get('pk'))
+        t = get_object_or_404(Tag, pk=self.kwargs.get("pk"))
         return super().get_queryset().filter(tags=t)
 
 
 # 记得在顶部导入 DetailView
 class PostDetailView(DetailView):
     # 这些属性的含义和 ListView 是一样的
     model = Post
-    template_name = 'blog/detail.html'
-    context_object_name = 'post'
+    template_name = "blog/detail.html"
+    context_object_name = "post"
 
     def get(self, request, *args, **kwargs):
         # 覆写 get 方法的目的是因为每当文章被访问一次，就得将文章阅读量 +1
@@ -58,19 +56,3 @@ def get(self, request, *args, **kwargs):
 
         # 视图必须返回一个 HttpResponse 对象
         return response
-
-    def get_object(self, queryset=None):
-        # 覆写 get_object 方法的目的是因为需要对 post 的 body 值进行渲染
-        post = super().get_object(queryset=None)
-        md = markdown.Markdown(extensions=[
-            'markdown.extensions.extra',
-            'markdown.extensions.codehilite',
-            # 记得在顶部引入 TocExtension 和 slugify
-            TocExtension(slugify=slugify),
-        ])
-        post.body = md.convert(post.body)
-
-        m = re.search(r'<div class="toc">\s*<ul>(.*)</ul>\s*</div>', md.toc, re.S)
-        post.toc = m.group(1) if m is not None else ''
-
-        return post

Diff for: blogproject/urls.py

@@ -16,8 +16,13 @@
 from django.contrib import admin
 from django.urls import path, include
 
+from blog.feeds import AllPostsRssFeed
+
 urlpatterns = [
     path('admin/', admin.site.urls),
     path('', include('blog.urls')),
     path('', include('comments.urls')),
+
+    # 记得在顶部引入 AllPostsRssFeed
+    path('all/rss/', AllPostsRssFeed(), name='rss'),
 ]

Diff for: templates/base.html

@@ -124,7 +124,7 @@ <h1><a href="{% url 'blog:index' %}"><b>Black</b> &amp; White</a></h1>
         {% show_tags %}
 
         <div class="rss">
-          <a href=""><span class="ion-social-rss-outline"></span> RSS 订阅</a>
+          <a href="{% url 'rss' %}"><span class="ion-social-rss-outline"></span> RSS 订阅</a>
         </div>
       </aside>
     </div>

Diff for: templates/blog/detail.html

@@ -15,7 +15,7 @@ <h1 class="entry-title">{{ post.title }}</h1>
       </div>
     </header>
     <div class="entry-content clearfix">
-      {{ post.body|safe }}
+      {{ post.body_html|safe }}
     </div>
   </article>
   <section class="comment-area" id="comment-area">