首页
所有分类
TAGS
文字工具 EMOJI BIBLE
编程 Python

Python的Flask框架中集成CKeditor富文本编辑器的教程

Posted in Python onJune 13, 2016

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

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

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

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

在<script>标签引入CKeditor主脚本文件。可以引入本地的文件，也可以引用CDN上的文件。
使用CKEDITOR.replace()把现存的<textarea>标签替换成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" 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>追加名为ckeditor的class属性值，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来设置:

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

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

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

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

def 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 : 错误信息。若无错误，返回空字符串

使用蓝本
在大型应用中经常会使用蓝本，在蓝本视图中集成CKEditor的步骤和app视图基本相同。

1. 创建蓝本时需指明蓝本static目录的绝对路径

demo = Blueprint('demo', static_folder="/path/to/static")

2. 对应url需加上蓝本端点

<script src="{{url_for('.static', filename='ckeditor/ckeditor.js')}}"></script>

<script type="text/javascript">
  CKEDITOR.replace(
    "ckeditor_demo", {
      filebrowserUploadUrl: './ckupload/'
    }
  );
</script>

3. 设置endpoint端点值

response = form.upload(endpoint=demo)

Python的Flask框架中集成CKeditor富文本编辑器的教程

- Author -

digwtx

声明：登载此文出于传递更多信息之目的，并不意味着赞同其观点或证实其描述。

Python 相关文章推荐
Python Web框架Pylons中使用MongoDB的例子
Dec 03 Python
跟老齐学Python之总结参数的传递
Oct 10 Python
python求解水仙花数的方法
May 11 Python
在Python中处理时间之clock()方法的使用
May 22 Python
mac 安装python网络请求包requests方法
Jun 13 Python
Python实现快速傅里叶变换的方法（FFT）
Jul 21 Python
Python数据类型之Set集合实例详解
May 07 Python
Python使用pymysql模块操作mysql增删改查实例分析
Dec 19 Python
解决Keras中CNN输入维度报错问题
Jun 29 Python
django使用graphql的实例
Sep 02 Python
python 偷懒技巧——使用 keyboard 录制键盘事件
Sep 21 Python
快速解决pymongo操作mongodb的时区问题
Dec 05 Python
Linux中安装Python的交互式解释器IPython的教程
Jun 13 #Python
浅谈python中的面向对象和类的基本语法
Jun 13 #Python
深入理解python多进程编程
Jun 12 #Python
python中根据字符串调用函数的实现方法
Jun 12 #Python
python中函数总结之装饰器闭包详解
Jun 12 #Python
Python备份目录及目录下的全部内容的实现方法
Jun 12 #Python
深入理解python中的闭包和装饰器
Jun 12 #Python
忘记密码(1) 写入策略(1) 增删改查(2) 优化(1) instantclient(1) B+树(2) binlog(2) redo log(1) 存储过程(3) pt-archiver(1)
You might like
php编写一个简单的路由类
2011/04/13 PHP
PHP 获取远程网页内容的代码(fopen,curl已测)
2011/06/06 PHP
ThinkPHP CURD方法之page方法详解
2014/06/18 PHP
thinkPHP中create方法与令牌验证实例浅析
2015/12/08 PHP
用PHP写的一个冒泡排序法的函数简单实例
2016/05/26 PHP
php使用正则表达式获取字符串中的URL
2016/12/29 PHP
PHP使用反向Ajax技术实现在线客服系统详解
2019/07/01 PHP
PHP检测一个数组有没有定义的方法步骤
2019/07/20 PHP
浅谈PHP5.6 与 PHP7.0 区别
2019/10/09 PHP
c#和Javascript操作同一json对象的实现代码
2012/01/17 Javascript
7个JS基础知识总结
2014/03/05 Javascript
JS实现模拟风力的雪花飘落效果
2015/05/13 Javascript
Express与NodeJs创建服务器的两种方法
2017/02/06 NodeJs
微信小程序上滑加载下拉刷新（onscrollLower）分批加载数据（一）
2017/05/11 Javascript
Node.js学习之地址解析模块URL的使用详解
2017/09/28 Javascript
javascript按钮禁用和启用的效果实例代码
2017/10/29 Javascript
vue-cli扩展多模块打包的示例代码
2018/04/09 Javascript
关于js对textarea换行符的处理方法浅析
2018/08/03 Javascript
JavaScript中Array方法你该知道的正确打开方法
2018/09/11 Javascript
vue 点击展开显示更多(点击收起部分隐藏)
2019/04/09 Javascript
基于p5.js 2D图像接口的扩展（交互实现）
2020/11/30 Javascript
vue实现登录、注册、退出、跳转等功能
2020/12/23 Vue.js
python 网络编程常用代码段
2016/08/28 Python
Python中xml和json格式相互转换操作示例
2018/12/05 Python
Python3 xml.etree.ElementTree支持的XPath语法详解
2020/03/06 Python
Python 实现自动登录+点击+滑动验证功能
2020/06/10 Python
新手学python应该下哪个版本
2020/06/11 Python
HTML5触摸事件实现移动端简易进度条的实现方法
2018/05/04 HTML / CSS
简述进程的启动、终止的方式以及如何进行进程的查看
2013/07/12 面试题
留学自荐信
2013/10/10 职场文书
普师专业个人自荐信范文
2013/11/26 职场文书
给领导的致歉信范文
2014/01/13 职场文书
竞聘书怎么写，如何写？
2014/03/31 职场文书
设计顾问服务计划书
2014/05/04 职场文书
求职导师推荐信范文
2015/03/27 职场文书
《扇形统计图》教学反思
2016/02/17 职场文书