使用 CodeMirror 打造屬于自己的帶高亮顯示的在線代碼編輯器

2024-09-06 19:17:04

字體：大中小

供稿：網(wǎng)友

前提

寫這個(gè)的目的是因?yàn)橹绊?xiàng)目里用到過 CodeMirror，覺得作為一款在線代碼編輯器還是不錯(cuò)，也看到過有些網(wǎng)站用到過在線代碼編輯，當(dāng)然我不知道他們是用什么做的，這里我把公司項(xiàng)目里用到的那部分抽出來，單獨(dú)寫篇博客，并把抽出來的那部分代碼提交到 GitHub 去（地址），以防日后可能會(huì)再次用到（沒準(zhǔn)畢業(yè)設(shè)計(jì)里可能用的到）。

簡單介紹

CodeMirror 是一款在線的支持語法高亮的代碼編輯器。官網(wǎng)： http://codemirror.net/

可能光看官網(wǎng)，第一眼覺得那些在線編輯器有點(diǎn)丑，反正第一眼給我的感覺就是這樣子，但是經(jīng)過自己的細(xì)調(diào)，也能打造出一款精美的在線代碼編輯器。

官網(wǎng)可以把它下載下來。

下載后，解壓開得到的文件夾中，lib 下是放的是核心庫和核心 css，mode 下放的是各種支持語言的語法定義，theme 目錄下是支持的主題樣式。一般在開發(fā)中，添加 lib 下的引用和 mode 下的引用就夠了。

如何使用

下面兩個(gè)是使用 Code Mirror 必須引入的：

<link rel="stylesheet" href="codemirror-5.31.0/lib/codemirror.css" rel="external nofollow" /><script src="codemirror-5.31.0/lib/codemirror.js"></script>

接下來要引用的就是在 mode 目錄下編輯器中要編輯的語言對應(yīng)的 js 文件，這里以 Groovy 為例：

<!--groovy代碼高亮--><script src="codemirror-5.31.0/mode/groovy/groovy.js"></script>

如果你想讓 Java 代碼也支持代碼高亮，則需要引入我從網(wǎng)上下載下來的 clike.js（我已經(jīng)放到我的 GitHub 去了）

<!--Java代碼高亮必須引入--><script src="codemirror-5.31.0/clike.js"></script>

引用的文件用于支持對應(yīng)語言的語法高亮。

然后前面說了第一次進(jìn)入 Code Mirror 官網(wǎng)，覺得那些編輯器比較丑，那可能是主題比較丑，我這里推薦一款還不錯(cuò)的主題，只需按照如下引入即可：

<!--引入css文件，用以支持主題--><link rel="stylesheet" href="codemirror-5.31.0/theme/dracula.css" rel="external nofollow" />

如果你還想讓你的編輯器支持代碼行折疊，請按照如下進(jìn)行操作：

<!--支持代碼折疊--><link rel="stylesheet" href="codemirror-5.31.0/addon/fold/foldgutter.css" rel="external nofollow" /><script src="codemirror-5.31.0/addon/fold/foldcode.js"></script><script src="codemirror-5.31.0/addon/fold/foldgutter.js"></script><script src="codemirror-5.31.0/addon/fold/brace-fold.js"></script><script src="codemirror-5.31.0/addon/fold/comment-fold.js"></script>

是不是這樣引入就好了呢，當(dāng)然不是啦

創(chuàng)建編輯器

在實(shí)際項(xiàng)目中，一般都不會(huì)直接把 body 整個(gè)內(nèi)容作為編輯器的容器。而最常用的，是使用 textarea。這里我在里使用個(gè) textarea，

<!-- begin code --><textarea class="form-control" id="code" name="code"></textarea><!-- end code-->

接下來就是創(chuàng)建編輯器了。

//根據(jù)DOM元素的id構(gòu)造出一個(gè)編輯器var editor = CodeMirror.fromTextArea(document.getElementById("code"), {});

是不是有點(diǎn)單調(diào)？

沒錯(cuò)，我還可以在里面給他設(shè)置些屬性：（充分利用我一開始引入的那些文件）

mode: "text/groovy",  //實(shí)現(xiàn)groovy代碼高亮mode: "text/x-java", //實(shí)現(xiàn)Java代碼高亮lineNumbers: true,	//顯示行號(hào)theme: "dracula",	//設(shè)置主題lineWrapping: true,	//代碼折疊foldGutter: true,gutters: ["CodeMirror-linenumbers", "CodeMirror-foldgutter"],matchBrackets: true,	//括號(hào)匹配//readOnly: true,    //只讀

如果需要查看更多屬性，可以去官網(wǎng)查找，目前我只用到這些屬性！

下面也列舉些吧：

indentUnit: integer
縮進(jìn)單位，值為空格數(shù)，默認(rèn)為2 。

smartIndent: boolean
自動(dòng)縮進(jìn)，設(shè)置是否根據(jù)上下文自動(dòng)縮進(jìn)（和上一行相同的縮進(jìn)量）。默認(rèn)為true。

tabSize: integer
tab字符的寬度，默認(rèn)為4 。

indentWithTabs: boolean
在縮進(jìn)時(shí)，是否需要把 n*tab寬度個(gè)空格替換成n個(gè)tab字符，默認(rèn)為false 。

electricChars: boolean
在輸入可能改變當(dāng)前的縮進(jìn)時(shí)，是否重新縮進(jìn)，默認(rèn)為true （僅在mode支持縮進(jìn)時(shí)有效）。

specialChars: RegExp
需要被占位符(placeholder)替換的特殊字符的正則表達(dá)式。最常用的是非打印字符。默認(rèn)為：/[/u0000-/u0019/u00ad/u200b-/u200f/u2028/u2029/ufeff]/。

specialCharPlaceholder: function(char) → Element
這是一個(gè)接收由specialChars選項(xiàng)指定的字符作為參數(shù)的函數(shù)，此函數(shù)會(huì)產(chǎn)生一個(gè)用來顯示指定字符的DOM節(jié)點(diǎn)。默認(rèn)情況下，顯示一個(gè)紅點(diǎn)（•），這個(gè)紅點(diǎn)有一個(gè)帶有前面特殊字符編碼的提示框。

rtlMoveVisually: boolean
Determines whether horizontal cursor movement through right-to-left (Arabic, Hebrew) text is visual (pressing the left arrow moves the cursor left) or logical (pressing the left arrow moves to the next lower index in the string, which is visually right in right-to-left text). The default is false on Windows, and true on other platforms.（這段完全不曉得搞啥子鬼）

keyMap: string
配置快捷鍵。默認(rèn)值為default，即 codemorrir.js 內(nèi)部定義。其它在key map目錄下。

extraKeys: object
給編輯器綁定與前面keyMap配置不同的快捷鍵。

lineWrapping: boolean
在長行時(shí)文字是換行(wrap)還是滾動(dòng)(scroll)，默認(rèn)為滾動(dòng)(scroll)。

lineNumbers: boolean
是否在編輯器左側(cè)顯示行號(hào)。

firstLineNumber: integer
行號(hào)從哪個(gè)數(shù)開始計(jì)數(shù)，默認(rèn)為1 。

lineNumberFormatter: function(line: integer) → string
使用一個(gè)函數(shù)設(shè)置行號(hào)。

gutters: array
用來添加額外的gutter（在行號(hào)gutter前或代替行號(hào)gutter）。值應(yīng)該是CSS名稱數(shù)組，每一項(xiàng)定義了用于繪制gutter背景的寬度（還有可選的背景）。為了能明確設(shè)置行號(hào)gutter的位置（默認(rèn)在所有其它gutter的右邊），也可以包含CodeMirror-linenumbers類。類名是用于傳給setGutterMarker的鍵名(keys)。

fixedGutter: boolean
設(shè)置gutter跟隨編輯器內(nèi)容水平滾動(dòng)（false）還是固定在左側(cè)（true或默認(rèn)）。

scrollbarStyle: string
設(shè)置滾動(dòng)條。默認(rèn)為”native”，顯示原生的滾動(dòng)條。核心庫還提供了”null”樣式，此樣式會(huì)完全隱藏滾動(dòng)條。Addons可以設(shè)置更多的滾動(dòng)條模式。

coverGutterNextToScrollbar: boolean
當(dāng)fixedGutter啟用，并且存在水平滾動(dòng)條時(shí)，在滾動(dòng)條最左側(cè)默認(rèn)會(huì)顯示gutter，當(dāng)此項(xiàng)設(shè)置為true時(shí)，gutter會(huì)被帶有CodeMirror-gutter-filler類的元素遮擋。
inputStyle: string
選擇CodeMirror處理輸入和焦點(diǎn)的方式。核心庫定義了textarea和contenteditable輸入模式。在移動(dòng)瀏覽器上，默認(rèn)是contenteditable，在桌面瀏覽器上，默認(rèn)是textarea。在contenteditable模式下對IME和屏幕閱讀器支持更好。

readOnly: boolean|string
編輯器是否只讀。如果設(shè)置為預(yù)設(shè)的值 “nocursor”，那么除了設(shè)置只讀外，編輯區(qū)域還不能獲得焦點(diǎn)。

showCursorWhenSelecting: boolean
在選擇時(shí)是否顯示光標(biāo)，默認(rèn)為false。

lineWiseCopyCut: boolean
啟用時(shí)，如果在復(fù)制或剪切時(shí)沒有選擇文本，那么就會(huì)自動(dòng)操作光標(biāo)所在的整行。

undoDepth: integer
最大撤消次數(shù)，默認(rèn)為200（包括選中內(nèi)容改變事件）。

historyEventDelay: integer
在輸入或刪除時(shí)引發(fā)歷史事件前的毫秒數(shù)。

tabindex: integer
編輯器的tabindex。

autofocus: boolean
是否在初始化時(shí)自動(dòng)獲取焦點(diǎn)。默認(rèn)情況是關(guān)閉的。但是，在使用textarea并且沒有明確指定值的時(shí)候會(huì)被自動(dòng)設(shè)置為true。

dragDrop: boolean
是否允許拖放，默認(rèn)為true。

allowDropFileTypes: array
默認(rèn)為null。當(dāng)設(shè)置此項(xiàng)時(shí)，只接收包含在此數(shù)組內(nèi)的文件類型拖入編輯器。文件類型為MIME名稱。

cursorBlinkRate: number
光標(biāo)閃動(dòng)的間隔，單位為毫秒。默認(rèn)為530。當(dāng)設(shè)置為0時(shí)，會(huì)禁用光標(biāo)閃動(dòng)。負(fù)數(shù)會(huì)隱藏光標(biāo)。

cursorScrollMargin: number
當(dāng)光標(biāo)靠近可視區(qū)域邊界時(shí)，光標(biāo)距離上方和下方的距離。默認(rèn)為0 。

cursorHeight: number
光標(biāo)高度。默認(rèn)為1，也就是撐滿行高。對一些字體，設(shè)置0.85看起來會(huì)更好。

resetSelectionOnContextMenu: boolean
設(shè)置在選擇文本外點(diǎn)擊打開上下文菜單時(shí)，是否將光標(biāo)移動(dòng)到點(diǎn)擊處。默認(rèn)為true。

workTime, workDelay: number
通過一個(gè)假的后臺(tái)線程高亮 workTime 時(shí)長，然后使用 timeout 休息 workDelay 時(shí)長。默認(rèn)為200和300 。（完全不懂這個(gè)功能是在說啥）

pollInterval: number
指明CodeMirror向?qū)?yīng)的textarea滾動(dòng)（寫數(shù)據(jù)）的速度（獲得焦點(diǎn)時(shí)）。大多數(shù)的輸入都是通過事件捕獲，但是有的輸入法（如IME）在某些瀏覽器上并不會(huì)生成事件，所以使用數(shù)據(jù)滾動(dòng)。默認(rèn)為100毫秒。

flattenSpans: boolean
默認(rèn)情況下，CodeMirror會(huì)將使用相同class的兩個(gè)span合并成一個(gè)。通過設(shè)置此項(xiàng)為false禁用此功能。

addModeClass: boolean
當(dāng)啟用時(shí)（默認(rèn)禁用），會(huì)給每個(gè)標(biāo)記添加額外的表示生成標(biāo)記的mode的以cm-m開頭的CSS樣式類。例如，XML mode產(chǎn)生的標(biāo)記，會(huì)添加cm-m-xml類。

maxHighlightLength: number
當(dāng)需要高亮很長的行時(shí)，為了保持響應(yīng)性能，當(dāng)?shù)竭_(dá)某些位置時(shí)，編輯器會(huì)直接將其他行設(shè)置為純文本(plain text)。默認(rèn)為10000，可以設(shè)置為Infinity來關(guān)閉此功能。

viewportMargin: integer
指定當(dāng)前滾動(dòng)到視圖中內(nèi)容上方和下方要渲染的行數(shù)。這會(huì)影響到滾動(dòng)時(shí)要更新的行數(shù)。通常情況下應(yīng)該使用默認(rèn)值10?？梢栽O(shè)置值為Infinity始終渲染整個(gè)文檔。注意：這樣設(shè)置在處理大文檔時(shí)會(huì)影響性能。

如果你要設(shè)置代碼框的大小該怎么做呢？