DIV CSS 佈局教程網

怎麼把參數傳給外部 JS 檔:五種做法與取捨
編輯:關於JavaScript     

用 script 標籤載入外部 JS 時,該怎麼把參數交給它?這問題看似瑣碎,卻牽涉到標准、效能與可維護性。以下整理五種做法。

一、全域變數

最簡單的方式,Google Adsense 就是這樣:

<script type="text/javascript">
google_ad_client = 'pub-3741595817388494';
</script>
<script type="text/javascript" src="https://pagead2.googlesyndication.com/pagead/show_ads.js"></script>

缺點很直接:污染了全域命名空間。引入檔案的方式另有兩個變體:

// 變體一:用 document.write 輸出
<script type="text/javascript">
google_ga_id = 'g6u7un8646xx';
document.write(unescape('%3Cscript type="text/javascript" src="https://www.google-analytics.com/ga.js"%3E%3C/script%3E'));
</script>

// 變體二:用 DOM 操作 append 到 head
<script type="text/javascript">
G_BEACON_ATP = 'category=&userid=&channel=112ad_id=';
document.getElementsByTagName('head')[0]
        .appendChild(document.createElement('script')).src = 'https://taobao.com/atp.js';
</script>

變體一的常見寫法還有這兩種:

// 直接轉義
document.write('<script type="text/javascript" src="test.js"><\/script>');

// 拆字串避開解析器誤判(Yahoo! 首頁的做法)
document.write('<scr' + 'ipt type="text/javascript" src="test.js"></scr' + 'ipt>');

補充一個關鍵細節:在 script 區塊內的字串裡若要寫 </script>,必須把結尾斜線轉義成 <\/script>,否則 HTML 解析器會提早關閉標籤,整頁隨之崩潰。這是無數人踩過的坑。

二、解析 script 標籤自身的 src

比起灑全域變數,我們更希望寫成這樣:

<script type="text/javascript" src="test.js?a=b&c=d"></script>

核心問題變成「如何取得 src 屬性」,有幾種取徑:

方法一:加上 id。用 id 取得當前 script,再以正則從 src 中取出參數。缺點是 HTML 4.01 規範中 SCRIPT 元素並沒有 id 屬性——不過這也算不上什麼缺點。

方法二:以檔名為鉤子。用 document.getElementsByTagName('script') 取回全部,再以正則比對出當前檔案。這個方法最正統,但要求檔名獨一無二,程式碼也較囉嗦,對效能略有影響。

方法三:加一個自訂屬性。在方法一的基礎上,乾脆另外放一個 data 屬性:

<script id="testScript" type="text/javascript" src="test.js" data="a=b&c=d"></script>

在 test.js 裡取值就一行:

var scriptArgs = document.getElementById('testScript').getAttribute('data');

方法四:利用執行順序。JavaScript 檔案的載入可以同步或異步,但執行一定依文檔中的先後順序。因此某個 js 執行時,必定是「已載入的檔案中最後一個」:

var scripts = document.getElementsByTagName('script');
var currentScript = scripts[scripts.length - 1];

這招比方法二聰明,程式碼也短。寫個測試即可驗證:

<!DOCTYPE html>
<html>
<script src="a2.js"></script>
<script src="a2.js"></script>
<script src="a2.js"></script>
</html>

a2.js 內容:

var scripts = document.getElementsByTagName('script');
alert(scripts.length);

三次載入分別印出 1、2、3。

綜合程式碼精簡度與效能:方法三 > 方法一 > 方法四 > 方法二。

三、幾個「邪門歪道」

John Resig 那篇《Degrading Script Tags》開了一扇想像的門。以下幾種寫法都能達到目的:

利用 script 標籤的內容:

<script type="text/javascript" src="test.js">
  TB.SomeApp.scriptArgs = 'a=b&c=d';
</script>

在 test.js 裡把它 eval 起來:

TB = {};
TB.SomeApp = {};
var scripts = document.getElementsByTagName("script");
eval(scripts[scripts.length - 1].innerHTML);

參數不多時甚至可以更簡潔:

<script type="text/javascript" src="test.js">a=b&c=d</script>

var scripts = document.getElementsByTagName("script");
var scriptArgs = scripts[scripts.length - 1].innerHTML.replace(/\s/g, '');

利用 onload:

<script type="text/javascript" src="test.js" onload="TB.SomeFun('a=b&c=d')"></script>

TB = {};
TB.SomeFun = function (arg) {
    // 在這裡處理參數
};

以上寫法在非 IE 瀏覽器都能正常運作。IE 則需補上幾行:

if (window.ActiveXObject) {
    var scripts = document.getElementsByTagName('script');
    eval(scripts[scripts.length - 1].getAttribute('onload'));
}

今日的建議

上面五種方法中,只有「方法三(自訂 data 屬性)」值得沿用,而且建議改用標準的 dataset:

<script id="myScript" src="test.js" data-user="abc" data-lang="zh-Hant"></script>

// test.js 內部
var self = document.getElementById('myScript');
var user = self.dataset.user;
var lang = self.dataset.lang;

其餘各種則有明確問題:

  • document.write 在今日若於頁面載入完成後執行,會直接清空整個文件。它已被視為反模式,請勿使用。
  • eval 有安全與效能雙重問題,且會被嚴格的 CSP 政策直接封鎖。永遠有更好的替代方案。
  • onload 屬性 屬於行內事件,同樣會被 CSP 擋下。

而現代真正的答案其實是 ES Module。用 <script type="module"> 搭配 import / export,或使用 bundler 在建置階段處理依賴,參數傳遞與作用域隔離都由語言本身解決,不必再靠這些技巧:

// config.js
export const config = { user: 'abc', lang: 'zh-Hant' };

// main.js
import { config } from './config.js';
console.log(config.user);

當年那些絞盡腦汁的變體寫法,如今回頭看,更像是一份關於「在限制中尋找出路」的紀錄。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved