萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> PHP 程式設計

PHP 實現程式碼語法高亮:正則表達式方案與專業庫對比

需求場景

技術部落格、代碼分享平台、API 文檔、線上 IDE 需要將原始碼渲染為帶語法高亮的 HTML。PHP 原生提供 highlight_string(),但自定義需求(主題、行號、行內高亮)需自行實現或引入專業庫。

方案一:PHP 內建函數(最簡單)

<?php
$code = '<?php echo "Hello World"; ?>';

// 直接輸出高亮 HTML
highlight_string($code, true); // true=返回字串,false=直接輸出

// 自定義顏色(需 PHP 5.6+)
ini_set('highlight.comment', '#999');
ini_set('highlight.default', '#333');
ini_set('highlight.html', '#06c');
ini_set('highlight.keyword', '#c00');
ini_set('highlight.string', '#080');
highlight_string($code);

方案二:正則表達式簡易實現(教學用)

<?php
/**
 * 簡易語法高亮(僅供教學/極簡場景)
 * ⚠ 生產環境請勿使用,正則無法正確處理巢狀結構、字串逃逸、註解邊界
 */
function simpleSyntaxHighlight($code) {
    $code = htmlspecialchars($code, ENT_QUOTES, 'UTF-8');
    
    // 字串(雙引號、單引號、Heredoc/Nowdoc 簡化處理)
    $code = preg_replace('/("([^"\\\\]|\\\\.)*")|(\'([^\'\\\\]|\\\\.)*\')/s', 
        '$0', $code);
    
    // 關鍵字
    $keywords = ['if', 'else', 'elseif', 'while', 'for', 'foreach', 'function', 'return', 
        'class', 'interface', 'trait', 'extends', 'implements', 'public', 'protected', 'private',
        'static', 'abstract', 'final', 'const', 'new', 'clone', 'try', 'catch', 'finally',
        'throw', 'use', 'namespace', 'echo', 'print', 'var_dump', 'isset', 'empty'];
    $kwPattern = '/\b(' . implode('|', $keywords) . ')\b/';
    $code = preg_replace($kwPattern, '$1', $code);
    
    // 註解
    $code = preg_replace('/\/\/.*$/m', '$0', $code);
    $code = preg_replace('/\/\*[\s\S]*?\*\//', '$0', $code);
    
    // 變數
    $code = preg_replace('/\$[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*/', 
        '$0', $code);
    
    // 數字
    $code = preg_replace('/\b\d+(\.\d+)?\b/', '$0', $code);
    
    return '
' . $code . '
'; } // CSS 樣式(可對應 VS Code、GitHub、Monokai 等主題) $css = ' .hl-keyword { color: #c00; font-weight: bold; } .hl-string { color: #080; } .hl-comment { color: #999; font-style: italic; } .hl-variable { color: #60f; } .hl-number { color: #f60; } .highlight { background: #f8f8f8; padding: 1em; border-radius: 4px; overflow-x: auto; } ';

方案三:專業庫 GeSHi(Generic Syntax Highlighter)

<?php
// Composer: composer require geshi/geshi
require_once 'vendor/autoload.php';

$code = file_get_contents('example.php');
$geshi = new GeSHi($code, 'php');
$geshi->enable_line_numbers(GESHI_FANCY_LINE_NUMBERS);
$geshi->set_header_type(GESHI_HEADER_DIV);
$geshi->set_overall_style('font-family: monospace; border: 1px solid #ddd;');
$geshi->set_link_styles(GESHI_LINK, 'color: #006;');
$geshi->set_link_styles(GESHI_URL, 'color: #060;');

echo $geshi->parse_code();

方案四:現代首選 - PHP-Parsing + 前端高亮

最佳架構:PHP 僅負責輸出原始碼 + 語言標識,前端用 Prism.js、Highlight.js 或 Shiki 渲染。

後端輸出

<pre class="language-php"><code class="language-php"><?php
echo htmlspecialchars($sourceCode);
?></code></pre>

前端引入(Prism.js 範例)

<!-- CSS 主題 -->
<link href="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/themes/prism-tomorrow.min.css" rel="stylesheet">
<!-- 核心 + PHP 元件 -->
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-core.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-php.min.js"></script>
<!-- 行號、行高亮、複製按鈕等外掛 -->
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/plugins/copy-to-clipboard/prism-copy-to-clipboard.min.js"></script>

方案對比總結

方案優點缺點推薦場景
PHP highlight_string零依賴、原生支援 PHP僅支援 PHP、樣式自定義弱、無行號快速原型、僅需 PHP 高亮
正則自製完全可控、無依賴極難處理邊界情況、維護成本高、效能差教學理解原理、極簡靜態頁
GeSHi支援 200+ 語言、伺服器端渲染、SEO 友好專案較舊、效能一般、HTML 體積大需 SEO、無 JS 環境、多語言支援
前端高亮 (Prism/HLJS/Shiki)效能佳、主題豐富、外掛生態強、支援 WASM 級精準解析需 JS 執行、SSR 需額外處理現代 Web 應用首選

進階:行內高亮與差異對比

<!-- Prism 行內高亮 -->
<code class="language-php">echo <span class="token keyword">hello</span>;</code>

<!-- 差異對比(需 diff-highlight 外掛) -->
<pre class="language-diff"><code>- $old = 1;
+ $new = 2;</code></pre>

總結

2024 年 PHP 專案實現語法高亮:

  1. 首選前端方案(Prism.js/Highlight.js/Shiki),體驗最好、維護最輕
  2. 需 SSR/SEO/無 JS 環境:用 GeSHi 或 highlight_string() 伺服器端渲染
  3. 切勿自寫正則高亮器,邊界情況極多(字串內關鍵字、巢狀註解、Heredoc、屬性存取等)
copyright © 萬盛學電腦網 all rights reserved