萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 腳本程式專題 >> JavaScript

JS 嵌入大段字串常量的優雅姿勢:利用函數 toString() 與註釋技巧

痛點:字串拼接地獄

將 HTML 模板、SQL 語句、詩詞歌賦等大段文本內嵌 JS 時,傳統寫法極其痛苦:

// 傳統拼接法:轉義、引號、縮進三重折磨
const html = 
  '<div>' +
  '  <p>Hello</p>' +
  '  <p>World</p>' +
  '</div>';

// 模板字串雖好,但舊環境不支援,且無法直接貼入含反引號的內容

核心洞察:函數 toString() 保留原始源碼

JS 函數的 toString() 會返回完整的函數聲明原始碼,包含註釋、縮進、換行——這就是天然的「多行原始字串容器」!

通用提取器 _TEXT()

function _TEXT(fn) {
  // 匹配 /* 內容 */ 或 // 內容\n
  const match = fn.toString().match(/\/\*[\s\S]*?\*\/|\/\/.*/);
  if (!match) return '';
  // 移除註釋標記,保留純內容
  return match[0]
    .replace(/^\/\*\s*|\s*\*\/$/g, '')  // /* ... */
    .replace(/^\/\/\s*/gm, '');         // // ...
}

實戰應用範例

嵌入 C++ 代碼片段

const RES_CODE = _TEXT(function(){/*
#include <iostream>

int main() {
  std::cout << "Hello world" << std::endl;
  return 0;
}
*/});

嵌入古詩詞(含標點、換行)

const RES_POEM = _TEXT(function(){/*
更吹落,星如雨。
寶馬雕車香滿路。
鳳箫聲動,玉壺光轉,一夜魚龍舞。
蛾兒雪柳黃金縷,
笑語盈盈暗香去。
眾裡尋他千百度,
蓦然回首,那人卻在燈火闌珊處。
*/});

嵌入 XML 配置(含屬性引號、巢狀結構)

const RES_XML = _TEXT(function(){/*
<projectDescription>
  <name>Hello</name>
  <comment></comment>
  <buildSpec>
    <buildCommand>
      <name>com.adobe.flexbuilder.project.flexbuilder</name>
    </buildCommand>
  </buildSpec>
</projectDescription>
*/});

使用效果

console.log(RES_CODE);  // 完整保留縮進、換行、雙引號
console.log(RES_POEM);  // 詩詞格式零損失
console.log(RES_XML);   // XML 結構完美保持

進階優化:支援任意分隔符

function _RAW(fn, delimiter = 'CONTENT') {
  const regex = new RegExp(`${delimiter}([\\s\\S]*?)${delimiter}`);
  const match = fn.toString().match(regex);
  return match ? match[1].trim() : '';
}

// 使用自定義分隔符,避免內容衝突
const sql = _RAW(function(){/*
@@@
SELECT u.name, p.title
FROM users u
JOIN posts p ON u.id = p.user_id
WHERE u.active = 1
@@@
*/}, '@@@');

⚠️ 關鍵限制與規避

限制影響解決方案
內容含 */ 會提前截斷註釋結束標記衝突使用 // 單行註釋模式或自定義分隔符
壓縮工具會刪除註釋生產構建失效配置 terser/uglify 保留特定註釋:comments: /^!/
箭頭函數 toString() 行為不一可能返回編譯後代碼堅持使用 function() {} 聲明式

現代替代方案對比

方案優點缺點適用場景
模板字串 `...`原生、支援插值ES6+、反引號衝突現代項目首選
import.meta.url + fetch外部檔案、快取友好需網路、CORS 限制大型模板、團隊協作
打包工具 raw-loader構建時內聯、無運行開銷需 Webpack/Rollup工程化項目標配
本文技巧零依賴、ES3 兼容、零轉義註釋衝突、壓縮需配置舊環境、快速原型、無建置流程

總結

「函數註釋作字串容器」是 JS 動態特性的巧妙利用——將語法結構反向用作數據載體。雖然現代開發多有更好方案,但理解這類「非常規思維」能拓寬技術視野,在受限環境下成為破局利器。

copyright © 萬盛學電腦網 all rights reserved