我想這很大程度上可能是因為網上沒有如何妥善處理ASP.NET中JavaScript的可靠信息。此文的目的就是提供一種最佳方案,用于管理ASP.NET中的JavaScript。該方案將能解決以下問題:
內聯JS:把JS直接放在頁面中將導致頁面臃腫不堪。
發布JS:經常忘記發布JS文件。
錯誤引用:在其它Web程序中引用JS時經常失敗。
依賴性:需要記住JS文件中錯綜復雜的依賴關系。
無效引用:頁面上引用的JS從來沒有被用到。
HTTP/HTTPS:跨HTTPS頁面引用HTTP的JS。
重構:重構一個新版本將花費大量時間。
冗余:多次引用統一個JS文件。
預備知識
確保已安裝Visual Studio 2010。Express版可能不支持此文涉及到的一些概念。
概述
大部分上述問題是由把JS或JS文件引用直接放到ASPX頁面引起的。對幾乎所有上述問題的解決方法是使用ASP.NET的內置功能來嵌入JS文件到一個DLL,然后動態引用這些文件。本文將演示這些功能,以及一些充分使用它們的技巧。接下來我們將逐步介紹該如何實現。
開始
第一步,啟動Visual Studio 2010,并新建一個名為ParchmentPurveyor的空Web程序。
接下來添加一個窗體:Default.aspx,并添加一些簡單的HTML代碼。大致如下:
<%@ Page Language="C#" AutoEventWireup="true" CodeBehind="Default.aspx.cs" Inherits="ParchmentPurveyor.Default" %><html xmlns="http://www.w3.org/1999/xhtml"><headrunat="server"> <title>Parchment Purveyor</title></head><body> <form id="form1" runat="server"> <h1>Parchment Purveyor</h1> <p>Paper for printers, painting, publication, paper planes, and plenty of other plebeian projects!</p> </form></body></html>
添加JS
不同于在站點中添加JS文件,我們新建一個項目,用于包含我們所有的JS文件。在解決方案中添加一個新的類庫項目JavaScriptLibrary:
項目添加后刪除Class1.cs文件,右鍵項目,選擇添加文件夾,并命名為JavaScript,然后在該文件夾中添加兩個JS文件,分別為ShowMessage.js和GreetUser.js,下一步,在項目中添加一個類JavaScriptHelper(注意不要放到JavaScript目錄下),現在解決方案目錄結構如下:
接下來編寫JS,在ShowMessage.js中添加如下代碼:
function ShowMessage(msg) { alert("Message From Website: " + msg);}
在GreetUser.js文件中添加如下代碼:
function GreetUser() { ShowMessage("Greetings and Salutations!");}
注意,GreetUser()依賴于ShowMessage()。
嵌入JS文件
相比把JS文件發布到站點,我們更樂于把它們嵌入到DLL。這樣子,如果DLL被發布到站點,那么所有JS文件也被自動發布。做到一點很簡單,我們只需要右鍵JS文件,打開屬性頁,為“生成操作”選擇“嵌入資源”即可,如下:
在確定JS文件嵌入DLL后,你需要使它們能夠被Web用戶訪問。為此,需要為項目JavaScriptLibrary添加System.Web的引用:
然后編輯JavaScriptHelper.cs,添加如下代碼:
using System.Web.UI;[assembly: WebResource("JavaScriptLibrary.JavaScript.ShowMessage.js", "application/x-javascript")][assembly: WebResource("JavaScriptLibrary.JavaScript.GreetUser.js", "application/x-javascript")]
這樣就能保證Web用戶通過客戶端訪問嵌入式JS文件了。
引用嵌入式JS文件
現在你已嵌入了JS文件,并能通過客戶端電腦訪問它們。在使用的時候,你必須在頁面上引用它們。為此,需要對JavaScriptHelper類做如下修改:
using System;using System.Web.UI;[assembly: WebResource("JavaScriptLibrary.JavaScript.ShowMessage.js", "application/x-javascript")][assembly: WebResource("JavaScriptLibrary.JavaScript.GreetUser.js", "application/x-javascript")]namespace JavaScriptLibrary{ /// <summary> /// 幫助頁面引用嵌入式JS文件 /// </summary> public class JavaScriptHelper{ #region 靜態字段 private const string NAME_SHOW_MESSAGE = "JavaScriptLibrary.JavaScript.ShowMessage.js"; private const string NAME_GREET_USER = "JavaScriptLibrary.JavaScript.GreetUser.js"; #endregion #region 公共方法 /// <summary> /// 在頁面上引用ShowMessage.js文件 /// </summary> /// <param name="manager">通過Page.ClientScript訪問</param> public static void Include_ShowMessage(ClientScriptManager manager){ IncludeJavaScript(manager, NAME_SHOW_MESSAGE); } /// <summary> /// 在頁面上引用GreetUser.js文件 (包括所有依賴文件) /// </summary> /// <param name="manager">通過Page.ClientScript訪問</param> public static void Include_GreetUser(ClientScriptManager manager){ //依賴(ShowMessage.js). Include_ShowMessage(manager); //引用 GreetUser.js. IncludeJavaScript(manager, NAME_GREET_USER); } #endregion #region 私有方法 /// <summary> /// 在頁面上引用指定的嵌入式js文件 /// </summary> /// <param name="manager">通過Page.ClientScript訪問</param> /// <param name="resourceName">用于標示嵌入式JS文件的名字</param> private static void IncludeJavaScript(ClientScriptManager manager, string resourceName){ var type = typeof(JavaScriptLibrary.JavaScriptHelper); manager.RegisterClientScriptResource(type, resourceName); } #endregion }}
IncludeJavaScript()是關鍵所在。它通過調用RegisterClientScriptResource()確保為嵌入式JS文件獲取一個腳本標簽。Include_GreetUser()調用了IncludeJavaScript(),同時也調用了Include_ShowMessage()(用于處理依賴關系)。因此,任何頁面在引用GreetUser()時也將引用ShowMessage()。
現在我們有了可用的類,接下在讓我們在Default.aspx頁面中試用它。首先在站點ParchmentPurveyor中添加對JavaScriptLibrary的引用:
接下來我們需要修改引用JS頁面的后臺代碼。
using System;using System.Web.UI;namespace ParchmentPurveyor{&n
聲明:本網頁內容旨在傳播知識,若有侵權等問題請及時與本網聯系,我們將在第一時間刪除處理。TEL:177 7030 7066 E-MAIL:11247931@qq.com