评论功能迁移完善:把四处 site-packages 补丁收拢为 sitecomments 自定义 app

liulinhai 2026.10.23 23:57 13 1
Django技术 网站迁移 django_comments 评论 楼中楼 sitecomments

收录于《把博客搬回家》第 2 篇

缘起:四处手动补丁的痛

本站的评论功能从一开始就不是 django_comments 的默认形态:楼中楼回复、AJAX 提交、email 免验证,这些都是在《从阿里云迁移至腾讯云》第 5 节记录过的方式实现的——手动修改 site-packages 里 django_comments 包的四个文件:

  • abstracts.py:给评论模型加 root_id / reply_to / reply_name 三个字段,实现楼中楼;
  • views/comments.py:post_comment 从"表单 POST 后跳转"改为返回 JSON 的 AJAX 接口;
  • templatetags/comments.py:get_queryset 只取根评论,并动态挂上 replies;
  • forms.py:email 字段改为非必填。

这种方式有两个硬伤:一是每次迁移服务器都要重打四遍补丁,漏一个评论就坏;二是补丁只存在于 site-packages,数据库里却是补丁后的表结构,形成"数据库有补丁 schema、代码无补丁"的不一致态。这次把博客从云服务器搬回本地 Docker(见《把网站从云服务器搬回家里》),正好撞上这个问题,于是借 Django 官方的钩子机制做了一次彻底收拢。

Django 留下的官方后门:COMMENTS_APP

django_comments 的设计里预留了一个钩子:在 settings 中配置 COMMENTS_APP 指向一个自定义 app,框架的 get_model() / get_form() / get_form_target() 就会改调用这个 app 里的同名函数。也就是说,只要在自己的项目里建一个 app,把那四个文件"复刻 + 打补丁",就能完整接管评论功能,一行 site-packages 都不用改:

# settings.py
INSTALLED_APPS = [
    ...
    'sitecomments',        # 替换掉 'django_comments'
]

# 钩子:告诉 django_comments 包,模型和表单来这个 app 拿
COMMENTS_APP = 'sitecomments'

四处补丁的去向

新建的 sitecomments app 就放在项目目录里,随代码走。四个补丁一一对应:

原补丁(site-packages) 现在的位置(项目内)
abstracts.py 模型加三字段 sitecomments/models.py:Comment 继承 CommentAbstractModel,Meta.db_table='django_comments' 复用老表
views post_comment 改 AJAX sitecomments/views.py:返回 JsonResponse,501 未登录 / 502 缺字段或表单错 / 503 安全校验失败 / 200 成功
templatetags 楼中楼查询 sitecomments/templatetags/comments.py:根评论 root_id=0 + 动态挂 replies 属性
forms.py email 免验证 sitecomments/forms.py:CommentForm.email required=False

顺带把包内依赖 django_comments.models 的审核流程(flag / delete / approve 和后台动作)也在 app 内完整实现,权限码相应变为 sitecomments.can_moderate。

数据库:老表原样复用

新 app 的 Comment 模型声明 db_table='django_comments',直接复用老表,56 条历史评论(含 2 条回复)一行不动。麻烦在于迁移:新 app 自带 migrations,Django 会尝试 CREATE TABLE,而表已经存在。解法是用 SeparateDatabaseAndState 把一次迁移拆成两半——state 侧登记"建表"(让 ORM 知道表结构),database 侧零操作:

class Migration(migrations.Migration):
    initial = True
    operations = [
        migrations.SeparateDatabaseAndState(
            state_operations=[migrations.CreateModel(name='Comment', ...)],
            database_operations=[],   # 表已存在,DB 侧什么都不做
        ),
    ]

之后 makemigrations --check 干净,migrate 对老库是空操作,历史数据无损。

三处接线

  • settings.py:INSTALLED_APPS 用 sitecomments 换掉 django_comments,新增 COMMENTS_APP;
  • blogproject/urls.py:^comments/ 指向 sitecomments.urls;
  • blog/templatetags/blog_tags.py:评论计数改走 django_comments.get_model() 钩子取模型——django_comments 已不在 INSTALLED_APPS,不能直接 import 它的模型。

详情页模板一行没动:{% load comments %} 发现的就是 sitecomments 的模板标签。

踩过的坑

AppRegistryNotReady 崩溃循环:app 的 __init__.py 在 Django populate 阶段就被导入,顶层 import models/forms 会触发"模型类定义早于注册表就绪",web 容器直接起不来。钩子函数必须惰性 import:

# sitecomments/__init__.py
def get_model():
    from .models import Comment      # 函数内 import,调用时注册表已就绪
    return Comment

makemigrations --check 报 AlterField:手抄迁移时把 help_text 的 the comment 误写成 this comment,Django 认为模型与迁移不一致。字段级细节也要逐字对齐,改完删掉多余的 0002 重建才干净。

改代码不生效:这套部署只有 db / media / static 是绑定挂载,Python 和模板全部 COPY 进镜像,改完代码必须 docker compose build web && docker compose up -d web;容器里 makemigrations 生成的迁移文件在可写层,要 docker cp 取回主机。

测试客户端 400:用 Django 测试客户端跑接口,默认 Host=testserver 触发 DisallowedHost,需临时放行 ALLOWED_HOSTS。

验证清单

  • COMMENTS_APP 钩子识别、email 免验证、56 条历史评论读取;
  • 楼中楼属性(根评论 root_id=0 取根、动态 replies);
  • AJAX 提交与楼中楼回复、未登录 501 拦截;
  • 后台评论管理 200,权限码 sitecomments.can_moderate;
  • 线上文章页楼中楼嵌套渲染正常。

换机器只剩三步

pip install 依赖 → docker compose up -d --build → 老库直接 migrate(空操作)。评论功能跟着代码走,迁移零手动修改,再也不用心疼"忘了打第几个补丁"。

唯一要记住的:不要把 django_comments 再加回 INSTALLED_APPS——它的模型、迁移、后台、模板标签都已被 sitecomments 接管,重复安装会和 django_comments 老表冲突。

相关阅读:从阿里云迁移至腾讯云(第 5 节即原补丁方案全记录)、把网站从云服务器搬回家里:Django + Docker + IPv6 DDNS 迁移实录。

Last Modified·2026年10月23日 23:57

linxiaoyun:1#

ai牛逼

2026年10月24日 0:02


您尚未登录,请先才能评论。