Flask项目集成富文本编辑器CKeditor

本文介绍如何在Flask项目中集成富文本编辑器CKeditor,并实现图片上传、文件上传、视频上传等功能。

CKeditor是目前最优秀的可见即可得网页编辑器之一,它采用JavaScript编写。具备功能强大、配置容易、跨浏览器、支持多种编程语言、开源等特点。它非常流行,互联网上很容易找到相关技术文档,国内许多WEB项目和大型网站均采用了CKeditor。

下载CKeditor

访问CKeditor官方网站,进入下载页面,选择Standard Package(一般情况下功能足够用了),然后点击Download CKEditor按钮下载ZIP格式的安装文件。如果你想尝试更多的功能,可以选择下载Full Package

下载好CKeditor之后,解压到Flask项目static/ckeditor目录即可。

在Flask项目中使用CKeditor

在Flask项目中使用CKeditor只需要执行两步就可以了:

  1. <script>标签引入CKeditor主脚本文件。可以引入本地的文件,也可以引用CDN上的文件。
  2. 使用CKEDITOR.replace()把现存的<textarea>标签替换成CKEditor。

示例代码:

html<!DOCTYPE html>
<html>
    <head>
        <title>A Simple Page with CKEditor</title>
        <!-- 请确保CKEditor文件路径正确 -->
        <script src="{{ url_for('static', filename='ckeditor/ckeditor.js') }}"></script>
    </head>
    <body>
        <form>
            <textarea name="editor1" id="editor1" rows="10" cols="80">
                This is my textarea to be replaced with CKEditor.
            </textarea>
            <script>
                // 用CKEditor替换<textarea id="editor1">
                // 使用默认配置
                CKEDITOR.replace('editor1');
            </script>
        </form>
    </body>
</html>

因为CKeditor足够优秀,所以第二步也可只为<textarea>追加名为ckeditorclass属性值,CKeditor就会自动将其替换。例如:

<!DOCTYPE html>
<html>
    <head>
        <title>A Simple Page with CKEditor</title>
        <!-- 请确保CKEditor文件路径正确 -->
        <script src="{{ url_for('static', filename='ckeditor/ckeditor.js') }}"></script>
    </head>
    <body>
        <form>
            <textarea name="editor1" id="editor1" class="ckeditor" rows="10" cols="80">
                This is my textarea to be replaced with CKEditor.
            </textarea>
        </form>
    </body>
</html>

CKEditor脚本文件也可以引用CDN上的文件,下面给出几个参考链接:

  • <script src="//cdn.ckeditor.com/4.4.6/basic/ckeditor.js"></script> 基础版(迷你版)
  • <script src="//cdn.ckeditor.com/4.4.6/standard/ckeditor.js"></script> 标准版
  • <script src="//cdn.ckeditor.com/4.4.6/full/ckeditor.js"></script> 完整版

开启上传功能

默认配置下,CKEditor是没有开启上传功能的,要开启上传功能,也相当的简单,只需要简单修改配置即可。下面来看看几个相关的配置值:

  • filebrowserUploadUrl :文件上传路径。若设置了,则上传按钮会出现在链接、图片、Flash对话窗口。
  • filebrowserImageUploadUrl : 图片上传路径。若不设置,则使用filebrowserUploadUrl值。
  • filebrowserFlashUploadUrl : Flash上传路径。若不设置,则使用filebrowserUploadUrl值。

为了方便,这里我们只设置filebrowserUploadUrl值,其值设为/ckupload/(后面会在Flask中定义这个URL)。

设置配置值主要使用2种方法:

方法1:通过CKEditor根目录的配置文件config.js来设置:

javascriptCKEDITOR.editorConfig = function( config ) {
    // ...
    // file upload url
    config.filebrowserUploadUrl = '/ckupload/';
    // ...
};

方法2:将设置值放入作为参数放入CKEDITOR.replace():

javascript<script>
CKEDITOR.replace('editor1', {
    filebrowserUploadUrl: '/ckupload/',
});
</script>

Flask处理上传请求

CKEditor上传功能是统一的接口,即一个接口可以处理图片上传、文件上传、Flash上传。先来看看代码:

pythondef gen_rnd_filename():
    filename_prefix = datetime.datetime.now().strftime('%Y%m%d%H%M%S')
    return '%s%s' % (filename_prefix, str(random.randrange(1000, 10000)))

@app.route('/ckupload/', methods=['POST'])
def ckupload():
    """CKEditor file upload"""
    error = ''
    url = ''
    callback = request.args.get("CKEditorFuncNum")
    if request.method == 'POST' and 'upload' in request.files:
        fileobj = request.files['upload']
        fname, fext = os.path.splitext(fileobj.filename)
        rnd_name = '%s%s' % (gen_rnd_filename(), fext)
        filepath = os.path.join(app.static_folder, 'upload', rnd_name)
        # 检查路径是否存在,不存在则创建
        dirname = os.path.dirname(filepath)
        if not os.path.exists(dirname):
            try:
                os.makedirs(dirname)
            except:
                error = 'ERROR_CREATE_DIR'
        elif not os.access(dirname, os.W_OK):
            error = 'ERROR_DIR_NOT_WRITEABLE'
        if not error:
            fileobj.save(filepath)
            url = url_for('static', filename='%s/%s' % ('upload', rnd_name))
    else:
        error = 'post error'
    res = """

<script type="text/javascript">
  window.parent.CKEDITOR.tools.callFunction(%s, '%s', '%s');
</script>

""" % (callback, url, error)
    response = make_response(res)
    response.headers["Content-Type"] = "text/html"
    return response

上传文件的获取及保存部分比较简单,是标准的文件上传。这里主要讲讲上传成功后如何回调的问题。

CKEditor文件上传之后,服务端返回HTML文件,HTML文件包含JAVASCRIPT脚本,JS脚本会调用一个回调函数,若无错误,回调函数将返回的URL转交给CKEditor处理。

这3个参数依次是:

  • CKEditorFuncNum : 回调函数序号。CKEditor通过URL参数提交给服务端
  • URL : 上传后文件的URL
  • Error : 错误信息。若无错误,返回空字符串

完整DEMO

这里有个简单的DEMO:https://coding.net/u/wtx358/p/flask-ckeditor-demo/git

小结

在之前的文章中,我们讲到了UEditor,就个人感觉而言,CKEditor的使用体验比UEditor好很多,使用方式也比较灵活。希望此文可以帮助大家在项目中加入优秀的CKEditor编辑器。

原文:http://flask123.sinaapp.com/article/49/


digwtx
python flask攻城狮

python flask工程师

1.7k 声望
93 粉丝
0 条评论
推荐阅读
Flask-Admin 1.1.0 发布, 修正大量BUG
2015年3月初, mrjoes 发布了 Flask-Admin 1.1.0 版本. 这是一个大量 BUG 修正版本. 亮点: 可在列表页面编辑内联模型 FileAdmin 重构并修正 FileUploadField 和 ImageUploadField 可使用 Required() 验证器 BUG 修...

digwtx1阅读 3.2k

富文本编辑器 quill.js 开发(二): 升级与表格功能
在目前的 1.x 版本中并不支持表格的元素, 而我们想要这个功能的话 一是升级, 通过官方的支持来添加, 二是我们自己开发, 但是这样的成本过大了

Grewer1阅读 555

Flink 1.16:Hive SQL 如何平迁到 Flink SQL
摘要:本文整理自 Apache Flink PMC&Committer 伍翀(云邪)在 9 月 24 日 Apache Flink Meetup 的演讲。主要内容包括:Hive SQL 迁移的动机Hive SQL 迁移的挑战Hive SQL 迁移的实践Hive SQL 迁移的演示未来规划

ApacheFlink阅读 1k

封面图
富文本编辑器 quill.js 开发(一): 自定义工具栏
Quill.js 是一个具有跨平台和跨浏览器支持的富文本编辑器。凭借其可扩展架构和富有表现力的 API,可以完全自定义它以满足个性化的需求。由于其模块化架构和富有表现力的 API,可以从 Quill 核心开始,然后根据需...

Grewer阅读 642

使用Flask快速部署PyTorch模型
对于数据科学项目来说,我们一直都很关注模型的训练和表现,但是在实际工作中如何启动和运行我们的模型是模型上线的最后一步也是最重要的工作。今天我将通过一个简单的案例:部署一个PyTorch图像分类模型,介绍这...

deephub阅读 552

封面图
Flask + Echarts 制作 仪表盘
下载 {代码...} 代码展示html {代码...} flask {代码...} print {代码...}

台湾省委书记阅读 489

封面图
工业场景全流程!机器学习开发并部署服务到云端 ⛵
本文以保险金额预估为例,讲解机器学习从开发到云端服务部署的全流程:基于PyCaret开发机器学习全流程、基于Flask搭建简易前端Web应用程序、在Heroku云上部署机器学习应用。

ShowMeAI阅读 402

python flask工程师

1.7k 声望
93 粉丝
宣传栏