依據業務邏輯 (如 A/B 測試、功能開關、多語系、權限) 決定是否載入特定 JS 檔案,是常見需求。本文介紹三種伺服端動態註冊 JS 的模式,比較優缺點與適用場景。
protected void RegisterScript(string url, string key = null) {
if (Page.Header == null) return; // 需
key = key ?? url;
if (Page.ClientScript.IsClientScriptBlockRegistered(GetType(), key)) return;
var script = new HtmlGenericControl("script");
script.Attributes["type"] = "text/javascript";
script.Attributes["src"] = ResolveClientUrl(url); // 支援 ~ 路徑
Page.Header.Controls.Add(script);
Page.ClientScript.RegisterClientScriptBlock(GetType(), key, "", true); // 標記已註冊防重複
}
呼叫:`RegisterScript("~/Scripts/feature-a.js");`
ScriptManager.RegisterClientScriptInclude(this, GetType(), "featureA", ResolveClientUrl("~/Scripts/feature-a.js"));
若需內嵌初始化參數而非外部檔案:
string script = $@"var FeatureAConfig = {{ apiUrl: '{ResolveUrl("~/api/feature")}', lang: '{CurrentCulture}' }};";
Page.ClientScript.RegisterClientScriptBlock(GetType(), "FeatureAConfig", script, true);
| 模式 | 輸出位置 | 支援 UpdatePanel | 去重機制 | 適用場景 |
|---|---|---|---|---|
| HtmlGenericControl | 否 | 手動檢查 | 靜態外部 JS、需放 head (如 SEO、預載) | |
| ScriptManager.RegisterClientScriptInclude | 表單底部 | 是 | 自動 (key) | AJAX 頁面、外部 JS 非阻塞載入 |
| RegisterClientScriptBlock | 表單底部 | 是 | 自動 (key) | 內嵌配置物件、Inline 程式碼 |
// 依功能開關決定
if (FeatureToggle.IsEnabled("NewDashboard")) {
RegisterScript("~/Scripts/dashboard.v2.js?v=" + AppVersion);
}
// 依權限載入管理腳本
if (User.IsInRole("Admin")) {
ScriptManager.RegisterClientScriptInclude(this, GetType(), "AdminTools", ResolveClientUrl("~/Scripts/admin.js"));
}
// 版本查詢字串防快取
string versionedUrl = $"{url}?v={Assembly.GetExecutingAssembly().GetName().Version}";