把 JavaScript 檔當成嵌入資源打包進 DLL,是 ASP.NET 自訂控制項的標準做法。這樣部署時不必擔心 .js 檔漏掉、路徑寫錯,也能搭配版本控制讓用戶端收到正確的資源網址。
// script_1.js
function doClick1()
{
alert("OK1");
}
// script_2.js
function doClick2()
{
alert("OK2");
}
在方案總管中選取這兩個 .js 檔,檢視屬性,把「進階」中的「生成操作」設為 Embedded Resource。這一步是必要的,否則檔案不會被打進 DLL。
用 WebResource 特性註冊,第一個參數是資源名稱(命名空間加檔名),第二個是 MIME 類型:
[assembly: System.Web.UI.WebResource( "wf.ClientScriptResourceLabel.script_1.js", "application/x-javascript")] [assembly: System.Web.UI.WebResource( "wf.ClientScriptResourceLabel.script_2.js", "application/x-javascript")]
注意資源名稱的格式必須是「預設命名空間.資料夾.檔名」,若 .js 放在專案的某個資料夾中,資料夾名稱也要點號串進去,否則執行期會找不到資源。
using System;
using System.Web.UI;
namespace wf.ClientScriptResourceLabel
{
public class ClientScriptResourceLabel : System.Web.UI.WebControls.WebControl
{
// 呼叫腳本資源
protected override void OnPreRender(EventArgs e)
{
if (this.Page != null)
{
this.Page.ClientScript.RegisterClientScriptResource(
typeof(ClientScriptResourceLabel),
"wf.ClientScriptResourceLabel.script_1.js");
this.Page.ClientScript.RegisterClientScriptResource(
typeof(ClientScriptResourceLabel),
"wf.ClientScriptResourceLabel.script_2.js");
}
base.OnPreRender(e);
}
/// <summary>
/// 呈現控制項的 RenderContents
/// </summary>
protected override void RenderContents(HtmlTextWriter output)
{
output.AddAttribute("id", "1");
output.AddAttribute("type", "checkbox");
output.AddAttribute("value", "測試1");
output.AddAttribute("onclick", "javascript:doClick1();");
output.RenderBeginTag(HtmlTextWriterTag.Input);
output.RenderEndTag();
}
}
}
為什麼用 OnPreRender 而不是 OnInit。因為註冊用戶端腳本必須在頁面即將呈現前進行,此時 Page 參考才確定可用。放在 OnInit 有時會遇到 Page 尚未就緒的情況。
RegisterClientScriptResource 會自動去重。同一個類別與資源名稱組合只會輸出一次,即使頁面上有多個控制項實例——這也是為什麼要用 typeof(某個型別) 而不是每個控制項各自一組。
onclick 裡的字串要注意跳脫。上面把 "javascript:doClick1();" 直接寫進屬性,若函式名稱來自外部輸入,應改用 HttpUtility.JavaScriptStringEncode() 處理,否則等於開了一個 XSS 的入口。
建議改用 Page.ClientScript 的替代方案。ClientScriptManager 的這套 API 在 Web Forms 時代是標準,但今天新專案多半不會再走這條路。若只是要打包前端資源,直接讓建置流程(例如 bundler)產生帶雜湊的檔名並輸出到靜態目錄,會比嵌入 DLL 更靈活——因為修改一個 JS 不必重新編譯整支程式集。
不過在維護既有 Web Forms 專案時,這仍是正確且值得理解的做法:它解決了「控制項與其前端腳本必須一起部署」這個真實的問題。