Flask專案整合富文字編輯器CKeditor

發表於2016-03-24

本文介紹如何在Flask專案中整合富文字編輯器CKeditor，並實現圖片上傳、檔案上傳、視訊上傳等功能。

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>

<!DOCTYPE html>

<html>

<head>

<title>A Simple Page with CKEditor</title>

</head>

<body>

<form>

This is my textarea to be replaced with CKEditor.

</textarea>

// 用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>

<!DOCTYPE html>

<html>

<head>

<title>A Simple Page with CKEditor</title>

</head>

<body>

<form>

This is my textarea to be replaced with CKEditor.

</textarea>

</form>

</body>

</html>

CKEditor指令碼檔案也可以引用CDN上的檔案，下面給出幾個參考連結：

基礎版（迷你版）

JavaScript

<script src="//cdn.ckeditor.com/4.4.6/basic/ckeditor.js"></script>

1

<script src="//cdn.ckeditor.com/4.4.6/basic/ckeditor.js"></script>
標準版

JavaScript

<script src="//cdn.ckeditor.com/4.4.6/standard/ckeditor.js"></script>

1

<script src="//cdn.ckeditor.com/4.4.6/standard/ckeditor.js"></script>
完整版

JavaScript

<script src="//cdn.ckeditor.com/4.4.6/full/ckeditor.js"></script>

1

<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/';
    // ...
};

CKEDITOR.editorConfig = function( config ) {

// ...

// file upload url

config.filebrowserUploadUrl = '/ckupload/';

// ...

};

方法2：將設定值放入作為引數放入CKEDITOR.replace():

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

CKEDITOR.replace('editor1', {

filebrowserUploadUrl: '/ckupload/',

});

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

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 = """

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編輯器。

SpringMVC整合富文字編輯器
2019-04-18
SpringMVC
ckeditor4.8 富文字編輯器的使用與填坑-PHP
2020-01-10
PHP
[MAUI]整合富文字編輯器Editor.js至.NET MAUI Blazor專案
2024-04-13
UIJSBlazor
Django搭建個人部落格：使用django-ckeditor富文字編輯器
2019-03-21
Django
富文字編輯器初探
2018-01-26
Javascript富文字編輯器
2014-11-18
JavaScript
富文字編輯器CKeditor的配置和圖片上傳，看完不後悔
2019-02-16
Element UI 整合富文字編輯器 vue-quill-editor
2020-01-12
UIVue
一個富文字編輯器quill 以Vue專案為例
2019-03-27
UIVue
線上富文字編輯器初探
2022-04-28
關於專案中使用的富文字編輯器markdown和傳統的富文字編輯器的對比和選擇
2021-05-01
Vue-Cli 3+tinymce 5 富文字編輯器整合
2019-09-27
Vue
分享 - 富文字編輯器 Froala Editor
2018-08-27
[Djangorestframework]-富文字編輯器的使用
2020-12-22
DjangoRESTFramework
SSM使用UEditor富文字編輯器
2020-11-06
SSM
Eleditor移動端富文字編輯器
2019-05-11
利用 javascript 實現富文字編輯器
2017-11-09
JavaScript
Extjs4.2x與富文字框編輯器KindEditor的整合
2014-03-23
JS
深入淺出contenteditable富文字編輯器
2019-03-04
九、Vue+Element使用富文字編輯器
2021-09-09
Vue
vue 富文字編輯器 vue-quill-editor
2018-11-07
VueUI
Django後臺管理配置富文字編輯器
2018-05-28
Django
手把手實現富文字編輯器
2015-10-15
quill 富文字編輯器自定義格式化
2019-04-06
UI
iOS使用UITableView實現的富文字編輯器
2019-04-04
iOSUIView
富文字編輯器之遊戲角色升級ing
2021-07-05
遊戲
HTML 頁面使用 wangeditor 富文字編輯器
2021-06-02
HTML
淺析富文字編輯器框架Slate.js
2021-07-08
框架JS
富文字及編輯器的跨平臺方案
2021-08-17
幾種開源富文字編輯器對比
2018-10-20
在VueJS中使用 froala 富文字編輯器
2024-03-10
VueJS
富文字編譯器
2017-10-08
編譯
vue專案中富文字編輯器踩坑之旅
2019-03-04
Vue
re-editor -- 開箱即用的react富文字編輯器
2019-03-21
React
各種富文字/ HTML編輯器和框架比較
2019-01-26
HTML框架
一個百度富文字編輯器的坑
2020-10-27
富文字編輯器 VUE-QUILL-EDITOR 使用教程（最全）
2023-05-12
VueUI
所見即所得富文字編輯器實現原理
2016-08-05