0

0

如何在 Django 中正确使用 CKEditor 并保存富文本内容

花韻仙語

花韻仙語

发布时间:2026-01-25 22:58:01

|

555人浏览过

|

来源于php中文网

原创

如何在 Django 中正确使用 CKEditor 并保存富文本内容

本文详解 django 中 ckeditor 表单提交失败、显示为原始 textarea 的根本原因——未调用 `form.is_valid()` 与 `cleaned_data`,并提供完整修复方案,确保富文本内容被正确解析并存入数据库。

在 Django 项目中集成 CKEditor(如 django-ckeditor)时,一个常见误区是:表单渲染正常、编辑器界面可用,但提交后数据库中却存入了包含 <textarea> 标签的 HTML 片段,而非纯净的富文本内容。正如问题中所示,{{ form.as_p }} 渲染出的并非纯文本输入框,而是嵌套了 CKEditor 初始化逻辑的 <div><textarea> 结构;而直接将 form 实例(而非其清洗后的值)赋给模型字段,会导致 Django 将整个未处理的表单对象(含 HTML 模板结构)错误地序列化存储。

根本原因在于:
✅ CKEditorWidget 是前端增强组件,它通过 JavaScript 将 <textarea> 升级为可视化编辑器,但提交时仍以普通 POST 字段(name="body")发送纯 HTML 字符串
❌ 原始代码中 f = Document(..., body = form, ...) 错误地将整个 PostForm 实例传入 body 字段,而 RichTextField 期望的是字符串(如 "<p>Hello</p>"),不是 Form 对象;
❌ 未调用 form.is_valid(),导致 form.cleaned_data 不可用,无法安全提取已清洗、转义、验证过的富文本内容。

✅ 正确做法:始终通过 cleaned_data 获取富文本值

首先,修正 forms.py 中的表单定义(注意:forms.Form 无需 Meta.model,且 fields 属性仅适用于 ModelForm):

# forms.py
from django import forms
from ckeditor.widgets import CKEditorWidget

class PostForm(forms.Form):
    body = forms.CharField(widget=CKEditorWidget())
    # 注意:此处无需 Meta 类 —— 这是普通 Form,非 ModelForm

接着,在视图中严格遵循 Django 表单处理规范:

# views.py
from django.shortcuts import render, HttpResponseRedirect
from django.urls import reverse
from .forms import PostForm
from .models import Document, Category

def add_document(request):
    if request.method == "POST":
        form = PostForm(request.POST)  # 绑定 POST 数据
        if form.is_valid():  # ✅ 关键:触发验证与清洗
            body = form.cleaned_data['body']  # ✅ 获取清洗后的 HTML 字符串
            header = request.POST.get("header", "")
            category_id = request.POST.get("category")

            try:
                category = Category.objects.get(id=category_id)
                doc = Document.objects.create(
                    header=header,
                    body=body,  # ✅ 直接传入 clean HTML 字符串
                    category=category
                )
                return HttpResponseRedirect(
                    reverse("core:category", kwargs={"id": category_id})
                )
            except Category.DoesNotExist:
                form.add_error('category', 'Invalid category selected.')
        # 若验证失败,继续渲染表单(带错误提示)
    else:
        form = PostForm()  # GET 请求:返回空表单

    categories = Category.objects.all()
    languages = get_language_choices()
    context = {
        "allCategories": categories,
        "form": form,  # ✅ 传递实例,非类
        "languages": languages
    }
    return render(request, "documents/add-document.html", context)

⚠️ 同时检查模板与静态资源

确保 add-document.html 正确加载 CKEditor 资源:

Magic AI Avatars
Magic AI Avatars

神奇的AI头像,获得200多个由AI制作的自定义头像。

下载
<!-- documents/add-document.html -->
<form method="post">
    {% csrf_token %}
    <div class="form-group">
        {{ form.as_p }}
        {{ form.media }}  <!-- ✅ 必须存在:注入 CKEditor JS/CSS -->
    </div>
    <button type="submit">Save Document</button>
</form>
? {{ form.media }} 是关键!它由 CKEditorWidget 自动生成,负责引入 ckeditor.js、配置脚本及皮肤资源。缺失此行将导致编辑器不初始化,退化为普通 textarea。

? 额外建议:升级为 ModelForm(推荐)

为减少重复代码、自动绑定字段与验证,建议改用 ModelForm:

# forms.py
class PostForm(forms.ModelForm):
    class Meta:
        model = Document
        fields = ['header', 'body', 'category']
        widgets = {
            'body': CKEditorWidget(config_name='default'),  # 可选自定义配置
        }

对应视图简化为:

def add_document(request):
    if request.method == "POST":
        form = PostForm(request.POST)
        if form.is_valid():
            doc = form.save()  # ✅ 自动处理所有字段,包括 RichTextField
            return HttpResponseRedirect(
                reverse("core:category", kwargs={"id": doc.category_id})
            )
    else:
        form = PostForm()
    # ... 渲染逻辑同上

✅ 总结

问题现象 正确解法
提交后数据库存入 <textarea> HTML 片段 ✅ 始终使用 form.is_valid() + form.cleaned_data['field_name']
body = form 导致类型错误 ✅ RichTextField 接收 str,非 Form 实例
编辑器未激活(显示为纯 textarea) ✅ 确保模板中包含 {{ form.media }}
手动提取 request.POST["header"] 易出错 ✅ 用 form.cleaned_data 统一处理所有字段,含验证与清理

遵循以上规范,CKEditor 即可无缝融入 Django 表单流程,实现所见即所得的富文本编辑与可靠持久化。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
Python Web 框架 Django 深度开发
Python Web 框架 Django 深度开发

本专题系统讲解 Python Django 框架的核心功能与进阶开发技巧,包括 Django 项目结构、数据库模型与迁移、视图与模板渲染、表单与认证管理、RESTful API 开发、Django 中间件与缓存优化、部署与性能调优。通过实战案例,帮助学习者掌握 使用 Django 快速构建功能全面的 Web 应用与全栈开发能力。

166

2026.02.04

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

760

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

221

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1567

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

649

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

1228

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

1204

2024.04.29

go语言字符串相关教程
go语言字符串相关教程

本专题整合了go语言字符串相关教程,阅读专题下面的文章了解更多详细内容。

193

2025.07.29

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Sass 教程
Sass 教程

共14课时 | 0.9万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3.6万人学习

CSS教程
CSS教程

共754课时 | 42.5万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号