django树形结构之博客评论案例(带回复功能) - 基础篇


前言说明

这里先以博客的评论模板展开实战,基础班是最基本的实现了评论和回复评论功能,但是在UI展示方面,没有能实现树状的层级结构,而且是回复评论的记录都在对应的顶层评论之下进行缩进

先看效果图

django-comment-02

模型设计

这里因为是做Demo介绍,所以把文章评论放到了一个应用中去,常规情况下为了应用的复用,建议是拆分成两个独立的应用

1、模型代码

# comment/models.py
class Post(models.Model):
    """
    1、用于测试,不用给全所有属性
    2、常规建议文章是独立的APP,评论是独立的APP,这里为了测试放到了一起
    """
    title = models.CharField(max_length=128, verbose_name="文章标题")

    def __str__(self):
        return self.title 


class Comment(models.Model):
    post = models.ForeignKey(Post, on_delete=models.DO_NOTHING, verbose_name="评论的文章")
    comment_body = models.TextField(verbose_name="评论的内容")
    comment_time = models.DateTimeField(default=timezone.now, verbose_name="评论时间")
    comment_user = models.CharField(max_length=32, verbose_name="评论人")
    comment_email = models.EmailField(verbose_name="评论者邮箱")
    comment_url = models.URLField(blank=True, null=True, verbose_name="评论者URL")
    # 关联自身
    parent_comment = models.ForeignKey('self', null=True, on_delete=models.DO_NOTHING, verbose_name="回复的评论")

    def __str__(self):
        return f'{self.comment_user.username} 评论说: {{ self.comment_content[:20] }}'

视图设计

视图函数代码

# comment/views.py
def index(request): 
    posts = Post.objects.all()  
    context = { 'posts': posts }
    return render(request,'comment/index.html',context=context)


def detail(request, id):
    post = Post.objects.get(pk=id)
    comments = Comment.objects.filter(post_id=id)
    form = CommentForm()
    context = { 'post': post, "comments": comments, "form": form}
    return render(request,'comment/detail.html',context=context)


def comment(request):
    comment_body = request.POST.get('comment_body')
    post_id = request.POST.get('post_id')
    pid = request.POST.get('pid')
    username = request.POST.get('comment_user')
    email = request.POST.get('comment_email')
    url = request.POST.get('comment_url')
    post = Post.objects.get(id=post_id)
    new_comment = Comment()
    new_comment.comment_body = comment_body
    new_comment.comment_user = username
    new_comment.comment_email = email 
    new_comment.comment_url = url 
    new_comment.post = post 

    if pid:
        new_comment.parent_comment_id = pid
    new_comment.save()

    # 评论成功跳转回当前详情页,是为了刷新当前页看到刚评论的内容
    return HttpResponseRedirect(reverse("comment:detail", args=(post_id)))

引入Form表单

因为是在学习Django,所以能用Django自带功能实现的,就优先使用Django功能

在template表单页展示时,可以自己写纯HTML页面,也可以使用 Django Form 表单来快速创建

Form表单代码

from django.forms import ModelForm, Textarea
from comment.models import Comment

class CommentForm(ModelForm):
    class Meta:
        model = Comment
        fields = ['comment_user', 'comment_email', 'comment_url', 'comment_body']

URL及Template模板

1、URL设计

# comment/urls.py
from django.urls import path
from comment import views

app_name = 'comment'
urlpatterns = [
    path('', views.index, name='index'),
    path('post/<int:id>/', views.detail, name='detail'),
    path('post/comment/', views.comment, name='comment'),
]

2、template模板,这里只有 index.html 和 detail.html

index.html是展示文章列表,为了友好的跳转到详情页去

detail.html 页面主要是演示 评论框、评论列表和回复功能, 因为文章只有title,所以重点在演示评论功能

<!-- comment/templates/comment/detail.html -->
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css" rel="stylesheet" >
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.9.1/font/bootstrap-icons.css">
    <script src="https://cdn.bootcdn.net/ajax/libs/jquery/3.6.0/jquery.js"></script>

    <title>Document</title>
</head>
<body>
    <div class="container">
        <!-- 文章部分忽略,详细代码见开源源码 -->

        <!-- comment form -->
         <h5>发表评论</h5>
         <div class="row" style="margin-bottom:15px;">
            <form action="{% url 'comment:comment' %}" method="post">
                {% csrf_token %}
                <input type="text" name="post_id" value="{{ post.id }}" hidden>
                <input type="text" name="pid" id="id_parent_comment" hidden>
                <div class="col-md-4">
                    <label for="form.comment_user.id_for_label">{{ form.comment_user.label }}: </label>
                    {{ form.comment_user }}
                    {{ form.comment_user.errors }}
                </div>
                <div class="col-md-4">
                    <label for="form.comment_email.id_for_label">{{ form.comment_email.label }}: </label>
                    {{ form.comment_email }}
                    {{ form.comment_email.errors }}
                </div>
                <div class="col-md-4">
                    <label for="form.comment_url.id_for_label">{{ form.comment_url.label }}: </label>
                    {{ form.comment_url }}
                    {{ form.comment_url.errors }}
                </div>
                <div class="col-md-12">
                    <label for="form.comment_body.id_for_label">{{ form.comment_body.label }}: </label> <br>
                    
                    {{ form.comment_body }}
                    {{ form.comment_body.errors }}
                    <input type="submit" value="提交">

                </div>
                
            </form>
        </div>

        <!-- comment list -->
        <div class="row">
            <h5>评论列表, 总 <span>{{  comment_count }}</span> 条评论</h5>
            <ul class="comment-list list-unstyled">
                {% for comment in comments %}
                <li class="comment-item" style="margin-top: 10px ; padding-bottom: 5px; border-bottom: 1px solid gray;"> 
                    <div class="">
                        <!-- <p>第{{ forloop.counter }}楼 -> By:<span>{{ comment.comment_user }}</span> -> 
                            <span>{{ comment.comment_time }}</span>
                        </p> -->
                        <p style="margin: 0px;">
                            <span>{{ comment.comment_user }} </span><span>{{ comment.comment_time |date:'Y-m-d'}}</span> 发表评论:
                        </p>
                        {% if comment.parent_comment_id %}
                            <div id="parent" style="color: orange; padding-left: 5px; margin-left: 10px; border-left: 2px solid orangered;">
                                  
                                  {{ comment.parent_comment.comment_body|linebreaks}}
                            </div>
                            
                        {% endif %}
                        <p><span>{{ comment.comment_body|linebreaks }}</span></p>
                        
                        <button class="reply" username="{{ comment.comment_user }}" pk="{{ comment.pk }}">Reply</button>
                        
                    </div>
                </li>
                {% empty %}
                <p>暂无评论</p>
                {% endfor %}
            </ul>
        </div>

    </div>
    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/js/bootstrap.bundle.min.js"></script>
    <script>
    
        $(".reply").click(function() {
                $("#id_comment_body").focus()
                var val = "@" + $(this).attr("username") + ' '
                $("#id_comment_body").val(val)
                var pid = $(this).attr("pk")
                console.log(pid)
                var var_pid = document.getElementById("id_parent_comment")
                var_pid.value = pid
                // 下面这两种方式设置都是存在问题的
                // $("#id_parent_comment").value = pid
                // $("#id_parent_comment").setAttribute("value", pid)
            })
    </script>
</body>
</html>

这里有一小段js代码,需要在文件head中引入 jquery ,目的有:
1、在点击Reply/回复 的时候聚焦到 评论框,同时这里还给回复的时候添加了默认的内容 @xxx

2、同时设置回复的内容的ID,也就是当前评论的父级评论的ID,为了是为了知道 回复的那条评论

知识点总结

1、引入了Django Form 表单,单独的Python文件定义,然后可以在template中快速创建响应的表单

2、一小段JS代码,实现回复时自动聚焦到评论框和设置父级评论的ID

3、在template中的模板表单 等post提交数据的地方,需要添加{% csrf_token %} 不然会报错,当然可以通过在post对应的待处理的视图函数上添加@csrf_exempt装饰器(忽略csrf校验) 对应的有个 csrf_protect 开启csrf校验

4、在comment视图函数中,注意需要判断父级评论id是否为空,来设定当前是回复的评论还是一般评论 ;同时注意评论成功之后进行跳转到当前详情页,查看当然评论的内容

问题和思考

从最开始的图片可以看到,虽然模型定义是符合树状结构 的,但是实际页面展示的时候却没有按照树状结构进行层级缩进 展示

因为在多层级的情况下,需要判断是不是叶子节点,而且还要用到递归处理。 写个递归很简单,但是又涉及到在template模板中进行数据展示,常规的函数无法使用,需要编写 标签或者过滤器才可以

那除了自己开发之外, 有没有更好的方案呢?

当然有,现在常用的是 django-mptt 第三包,另外一篇文章我们单独讲解 django-mptt

代码开源地址:https://gitee.com/colin5063/django_learning_v2/tree/django_blog_comment_v1/

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值