先說幾句背景。去年用 C# 做過一個語法高亮的小工具,依組態檔的設定把程式碼格式化成 HTML,讓它能在網頁上呈現與編輯器相同的高亮效果,並支援程式碼摺疊。因為當時我用的平台沒有提供這個功能,只好自己寫一個。
起初我用的是最原始的 for、while、switch、if 逐字判斷關鍵字,程式碼冗長到以後自己都不忍卒睹。心想別人的軟體不可能是這樣寫的吧,於是搜尋了一下,找到一些語法高亮的程式碼與開源專案,打開一看——每個都複雜得令人頭暈。除非有非常詳細的文件,否則讀別人的程式碼實在是件痛苦的事。
雖然那些專案沒幫上什麼忙,卻讓我知道了正則表達式這個東西。於你一邊研究、一邊改造那個「破玩意兒」。後來公司有個模組需要剔除資料庫結果中的所有 HTML 標籤,正當我打開 RegexBuddy 時,看到它的說明文件中有一段 JScript 使用正則的簡單教學,於是好奇心又起,便開始動手實驗。
實驗的過程這裡就不再覆述,因為很多地方是反覆繞路才得出的,以下直接給出結論。
JScript 中提供正則操作的是 RegExp,可以用兩種方式建立。
方法一,建構函式:
var myRegex = new RegExp("\\w+", "igm");
// \w+ 是實際的正則;注意第一個 \ 是跳脫之用
// igm 分別表示忽略大小寫、全域搜尋、多行搜尋
方法二,直接賦值:
var myRegex = /\w+/igm; // 效果相同,但這裡不需要跳脫字元,正則長什麼樣就是什麼樣
用哪種取決於個人喜好,第二種讀起來比較直觀。要注意的是:正則中含有 / 時,字面值寫法必須跳脫成 \/;而正則若完全來自外部輸入,就只能用建構函式。
exec(str):執行比對並回傳結果。每次呼叫會從上次比對結束的位置繼續,適合用迴圈取出所有符合項。
compile(regex, flags):預先編譯正則以加快執行速度,實測在重複使用同一條複雜正則時有明顯效果。flags 可為下列三者的組合:g 全域搜尋(不加 g 就只比對第一個符合項)、i 忽略大小寫、m 多行搜尋。
test(str):若 str 符合正則回傳 true,否則 false。類似 String 物件的 match 方法,但回傳的是布林值,判斷用途更直接。
index:字串中第一個符合正則的位置,初始為 -1。
input:正則比對的目標字串,唯讀。
lastIndex:下一個比對開始的位置,全域比對時由 exec 自動推進。
lastMatch:最後一個符合正則的字串。
lastParen:最後一個子比對的結果,也就是多組 () 中的最後一組。
leftContext:從目標字串開頭到 lastMatch 起始位置的所有字元。
rightContext:從 lastMatch 結束位置到字串結尾的所有字元。
$1…$9:第 n 組子比對的結果,有多組 () 時很有用。
match(regex):接受一個正則,回傳比對結果陣列;全域比對時會回傳所有符合項組成的陣列,但不含捕獲群組。
replace(regex, replacement):以正則取代,replacement 可用字串(支援 $1 這類參照)或函式(能對每個符合項做更複雜的處理)。
search(regex):回傳第一個符合項的位置,找不到則回傳 -1。
split(regex):以正則作為分隔條件切割字串。
回到一開始的問題。用正則做語法高亮的關鍵,是「不要一次處理所有東西」。實務上的做法是先掃描並切出「字串常數」與「註解」這兩個區塊,把它們用佔位符換掉,接著對剩下的部分套用關鍵字與數字的高亮,最後再把佔位符換回已處理好的字串與註解 HTML。
若不這樣分階段,最大的問題是:關鍵字規則會誤傷字串內容裡的字,而註解中的 * 又會被當成運算子。分階段的成本很低,卻能省掉無數邊界判斷。
另一個提醒:產生的 HTML 若要插入頁面,請確保對 <、>、& 都做了跳脫,否則被高亮的程式碼本身若含有標籤,就會破壞頁面結構,甚至形成 XSS。順序上必須「先跳脫、後加高亮標籤」。