如何在ASP.NET應(yīng)用程序中初始化
每個(gè)程序都需要初始化的過(guò)程，用來(lái)讀取配置或者設(shè)置一些運(yùn)行環(huán)境（變量），對(duì)于ASP.NET程序來(lái)說(shuō)，又該在哪里執(zhí)行初始化的任務(wù)呢？
我想應(yīng)該絕大多數(shù)人都知道在Global.asax中執(zhí)行初始化的過(guò)程，然而有些細(xì)節(jié)是我們需要關(guān)注的。
本文用例
在這篇博客的示例代碼中，AppInitializer包含了網(wǎng)站的初始化的實(shí)現(xiàn)代碼：
- public static class AppInitializer
- {
- public static ConnectionStringSettings MyNorthwindConnectionSetting { get; private set; }
- public static void Init()
- {
- // 讀取連接字符串。
- LoadConnectionString();
- // 設(shè)置SQLSERVER緩存依賴通知。
- SetSqlDependency();
- // 其它的初始化操作。
- OthersInit();
- }
- static void LoadConnectionString()
- {
- ConnectionStringSettings setting = ConfigurationManager.ConnectionStrings["MyNorthwind"];
- if( setting == null )
- throw new ConfigurationException("沒(méi)有配置MyNorthwind連接字符串。");
- if( string.IsNullOrEmpty(setting.ConnectionString) )
- throw new ConfigurationException("沒(méi)有為MyNorthwind連接字符串指定內(nèi)容。");
- if( string.IsNullOrEmpty(setting.ProviderName) )
- throw new ConfigurationException("沒(méi)有為MyNorthwind連接字符串指定ProviderName 。");
- // 保存讀取到的連接字符串，供程序使用。
- MyNorthwindConnectionSetting = setting;
- }
- static void SetSqlDependency()
- {
- // 判斷SQLSERVER版本是否為 2005以上版本，
- // 是否開(kāi)啟Service Broker的檢查代碼就不列出了。
- SqlDependency.Start(MyNorthwindConnectionSetting.ConnectionString);
- }
- static void OthersInit()
- {
- // 其它的初始化操作。
- // 例如：
- // 1. 加載必要的緩存數(shù)據(jù)。
- // 2. 檢查上傳目錄是不存在。
- // 3. ...................
- }
- }
這段代碼的意圖很清楚，一定要確保正確的配置了數(shù)據(jù)庫(kù)連接字符串，否則以異常的形式報(bào)告出來(lái)。
示例程序還有一個(gè)頁(yè)面，Default.aspx
- <body>
- <form id="form1" runat="server">
- <div>
- <h1>User Login</h1>
- </div>
- <p style="line-height: 150%;">
- UserName: <asp:TextBox ID="txtUserName" runat="server" Width="200px" Text="Fish Li"></asp:TextBox><br />
- Password: <asp:TextBox ID="txtPassword" runat="server" Width="200px" TextMode="Password"></asp:TextBox><br />
- <asp:Button ID="btnLogin" runat="server" Text="登錄" OnClick="btnLogin_Click" />
- </p>
- </form>
- </body>
其實(shí)就是一個(gè)登錄頁(yè)面，后臺(tái)代碼為：
- protected void btnLogin_Click(object sender, EventArgs e)
- {
- bool ok = false;
- using( SqlConnection connection
- = new SqlConnection(AppInitializer.MyNorthwindConnectionSetting.ConnectionString) ) {
- connection.Open();
- // 其它的數(shù)據(jù)庫(kù)操作。
- ok = true;
- }
- if( ok )
- Response.Redirect("Default2.aspx");
- }
你沒(méi)有想到的Global.asax怪事！
或許有些人會(huì)這樣寫他們的初始化代碼：
- void Application_Start(object sender, EventArgs e)
- {
- //在應(yīng)用程序啟動(dòng)時(shí)運(yùn)行的代碼
- try {
- AppInitializer.Init();
- }
- catch( Exception ex ) {
- LogException(ex);
- // .....................
- }
- }
這段代碼有什么問(wèn)題呢？
其實(shí)問(wèn)題的線索在于：為什么要加try....catch語(yǔ)句，是因?yàn)橹揽赡軙?huì)發(fā)生異常嗎？
如果真有異常情況發(fā)生，這樣處理后，后續(xù)的請(qǐng)求是不是會(huì)發(fā)生各種想像不到的錯(cuò)誤？
顯然這里不能吃掉異常，要不然后面的請(qǐng)求肯定會(huì)有問(wèn)題，因?yàn)樗鼈円蕾嚨脑O(shè)置沒(méi)有正確的初始化。
好吧，那我去掉 try.....catch語(yǔ)句，這樣總該行了吧：
- void Application_Start(object sender, EventArgs e)
- {
- //在應(yīng)用程序啟動(dòng)時(shí)運(yùn)行的代碼
- AppInitializer.Init();
- }
還是看來(lái)一下真實(shí)的運(yùn)行情況吧。
噢，抱歉，我還真忘記了配置連接字符串，這個(gè)異常提示太給力了。
現(xiàn)在就加上連接字符串嗎？
別急，想像一下，如果這個(gè)網(wǎng)站是一個(gè)真實(shí)的在線網(wǎng)站，會(huì)是什么情況呢？
答案有二種：
1. 另一個(gè)用戶也發(fā)起了一次請(qǐng)求。
2. 當(dāng)前用戶看到錯(cuò)誤頁(yè)面后，重新刷新了一次當(dāng)前頁(yè)面。
現(xiàn)在我用Opera來(lái)扮演第二個(gè)瀏覽用戶吧，還是打開(kāi)同樣的網(wǎng)址。
太奇怪了，第二個(gè)用戶居然能打開(kāi)頁(yè)面，好吧，讓他登錄試試。
結(jié)果第二個(gè)用戶看到的錯(cuò)誤情況和第一個(gè)用戶完全不同。
如果此時(shí)第一個(gè)用戶刷新他的瀏覽器，發(fā)現(xiàn)頁(yè)面又可以顯示了，然而登錄時(shí)，會(huì)看到與第二個(gè)用戶一樣的異常信息。
這個(gè)示例代碼實(shí)在太簡(jiǎn)單了，我想維護(hù)人員根據(jù)NullReferenceException這個(gè)線索找下去，很快就能找到答案。如果初始化代碼再?gòu)?fù)雜一些，比如SetSqlDependency()中出現(xiàn)異常呢，那么程序仍然能夠正常運(yùn)行，但是我們期望的緩存依賴可能就沒(méi)有效果了，最終可能會(huì)產(chǎn)生性能問(wèn)題，排查的難度就會(huì)大多了。
記得以前做項(xiàng)目時(shí)，就遇到過(guò)這種情況，當(dāng)時(shí)感到很奇怪，為什么刷新一下就沒(méi)黃頁(yè)了，不過(guò)后面的錯(cuò)誤就很折騰人了，最終也讓我總結(jié)了這個(gè)教訓(xùn)。所以我建議：如果在初始化階段出現(xiàn)了異常，干脆就別讓程序繼續(xù)運(yùn)行了，每個(gè)請(qǐng)求都直接顯示黃頁(yè)，直到排除故障為止。
#p#
如何保證初始化異常一直顯示？
當(dāng)初始化發(fā)生異常時(shí)，如何保證初始化異常一直顯示呢？
方法其實(shí)并不難，我們需要修改一下代碼：
- private static Exception s_initException;
- void Application_Start(object sender, EventArgs e)
- {
- try {
- AppInitializer.Init();
- }
- catch( Exception ex ) {
- // 記下初始化的異常。
- s_initException = ex;
- }
- }
- protected void Application_BeginRequest(object sender, EventArgs e)
- {
- // 如果存在初始化異常，就拋出來(lái)。
- // 直到開(kāi)發(fā)人員發(fā)現(xiàn)這個(gè)異常，并已解決了異常為止。
- if( s_initException != null )
- throw s_initException;
- }
現(xiàn)在不管有多少個(gè)用戶來(lái)訪問(wèn)，或者第一個(gè)訪問(wèn)者刷新瀏覽器多少次，都會(huì)看到同樣的異常信息：
說(shuō)明：Global.asax的這個(gè)問(wèn)題在IIS7以上版本的集成模式下并不存在。
還有哪些初始化方法？
除了Global.asax中的Application_Start，還有哪些方法可以在ASP.NET程序執(zhí)行初始化的任務(wù)呢？
目前我知道的還有另三種方法：
1. App_Code中的AppInitialize方法。
2. 寫個(gè)專用的HttpModule。
3. ASP.NET 4.0的PreApplicationStartMethodAttribute
App_Code中的AppInitialize方法
ASP.NET允許我們?cè)贏pp_Code中的任何一個(gè)類型定義一個(gè)AppInitialize方法，用它也能執(zhí)行初始化的任務(wù)。
- public class Class1
- {
- public static void appInitialize()
- {
- AppInitializer.Init();
- }
- }
如果我此時(shí)再次運(yùn)行示例程序（已注釋掉Global.asax中的代碼），會(huì)看到以下顯示：
顯然，我們期望的初始化代碼確實(shí)被調(diào)用了。
這個(gè)AppInitialize方法有什么限制呢？
我們還是來(lái)看一下ASP.NET的源代碼吧：
- internal class BuildResultMainCodeAssembly : BuildResultCompiledAssembly
- {
- private MethodInfo FindAppInitializeMethod(Type t)
- {
- return t.GetMethod("AppInitialize",
- BindingFlags.Public | BindingFlags.Static | BindingFlags.IgnoreCase,
- null, new Type[0], null);
- }
根據(jù)代碼我們可以發(fā)現(xiàn)AppInitialize方法的特點(diǎn)有：
1. 必須是一個(gè)公開(kāi)的靜態(tài)方法：BindingFlags.Public | BindingFlags.Static
2. 方法名不區(qū)分大小寫：BindingFlags.IgnoreCase
3. 方法不允許有傳入?yún)?shù)：new Type[0]
HttpModule也能執(zhí)行初始化的任務(wù)
由于HttpModule總是會(huì)在ASP.NET管線中被調(diào)用，所以，我們還可以用它來(lái)完成初始化的操作。
- public class InitAppModule : IHttpModule
- {
- public void Init(HttpApplication context)
- {
- //注意：Init事件可能被多次調(diào)用，所以這個(gè)方法會(huì)被多次調(diào)用。
- AppInitializer.Init();
- }
正如代碼注釋所說(shuō)的那樣，這種調(diào)用代碼是不對(duì)的，除非你能接受初始化代碼被多次調(diào)用！
所以，我們應(yīng)該按單例模式的思路來(lái)改寫代碼：
- private static readonly object s_lock = new object();
- private static bool s_initOK;
- public void Init(HttpApplication context)
- {
- lock( s_lock ) {
- if( s_initOK == false ) {
- //保證初始化代碼只執(zhí)行一次。
- AppInitializer.Init();
- s_initOK = true;
- }
- }
- }
如果你希望代碼簡(jiǎn)單一點(diǎn)，還可以這樣實(shí)現(xiàn)：
- public class InitAppModule : IHttpModule
- {
- static InitAppModule()
- {
- AppInitializer.Init();
- }
- public void Init(HttpApplication context)
- {
- // 留個(gè)空方法，
- // ASP.NET會(huì)調(diào)用這個(gè)方法，最后能觸發(fā)靜態(tài)方法的調(diào)用。
- }
ASP.NET 4.0新增的初始化方法
為了讓一些類庫(kù)能自動(dòng)執(zhí)行一些初始化，ASP.NET提供了一種新方法，允許為程序集指定一個(gè)PreApplicationStartMethodAttribute
為了演示這種用法，我將前面的示例（VS2008開(kāi)發(fā)）移到一個(gè)類庫(kù)中（用VS2012開(kāi)發(fā)）并設(shè)置類庫(kù)的命名空間為InitClassLibrary1。
然后，我添加了一個(gè)調(diào)用類：
- namespace InitClassLibrary1
- {
- public class Class1
- {
- public static void InitApp()
- {
- AppInitializer.Init();
- }
- }
- }
最后，我們可以在InitClassLibrary1類庫(kù)的AssemblyInfo.cs文件中，增加一個(gè)Attribute
- [assembly: System.Web.PreApplicationStartMethod(
- typeof(InitClassLibrary1.Class1), "InitApp")]
當(dāng)然了，你也可以直接像下面設(shè)置，免得多創(chuàng)建一個(gè)類型出來(lái)：
- [assembly: System.Web.PreApplicationStartMethod(
- typeof(InitClassLibrary1.AppInitializer), "Init")]
這樣設(shè)置后，再運(yùn)行網(wǎng)站，你也能發(fā)現(xiàn)我們的初始化代碼確實(shí)運(yùn)行了：黃頁(yè)仍然在顯示。
#p#
各種初始化方法的差別
前面介紹了4種在ASP.NET執(zhí)行初始化的方法，你或許想知道它們到底有哪些區(qū)別呢？
由于它們都能實(shí)現(xiàn)初始化的操作，它們的差別也只有執(zhí)行的時(shí)刻不同而已，我們可以用簡(jiǎn)單的方法區(qū)分它們的調(diào)用位置：看異常的調(diào)用堆棧信息。
AppInitialize方法異常時(shí)的調(diào)用堆棧信息：
HttpModule異常時(shí)的調(diào)用堆棧信息：
PreApplicationStartMethodAttribute異常時(shí)的調(diào)用堆棧信息：
Global.asax的Application_Start事件處理器的調(diào)用方式則不同，ASP.NET采用了反射調(diào)用，當(dāng)異常發(fā)生只保留了內(nèi)部異常，我們看不到調(diào)用堆棧（不信的話，自己去試試）。
沒(méi)關(guān)系，既然ASP.NET不告訴我們調(diào)用堆棧信息，我們自己也可以去取，請(qǐng)看下面的代碼：
- void Application_Start()
- {
- System.Diagnostics.StackTrace stack = new System.Diagnostics.StackTrace();
- System.IO.File.WriteAllText("h:\\Application_Start_stack.txt", stack.ToString());
- }
再打開(kāi)文件看一下吧。
說(shuō)明：Global.asax的Application_Start事件處理器還有幾種等效的方法：
- // 這二個(gè)方法都可以實(shí)現(xiàn)與Application_Start(object sender, EventArgs e)相同的行為。
- void Application_OnStart()
- {
- }
- void Application_Start()
- {
- }
根據(jù)以上分析，可以可以得知：
1. AppInitialize和PreApplicationStartMethodAttribute指向的方法被調(diào)用的時(shí)機(jī)發(fā)生在ASP.NET創(chuàng)建宿主環(huán)境時(shí)，屬于比較早的時(shí)刻。
2. Application_Start和HttpModule的調(diào)用時(shí)刻要晚一點(diǎn)。
這個(gè)結(jié)論有用嗎？
其實(shí)我也感覺(jué)意義不大，不過(guò)分析它僅僅為了滿足我的求知欲和好奇心而已，你是否也有這樣的好奇心呢？
如果你仍然好奇想知道這4種方法的執(zhí)行時(shí)機(jī)的先后順序，我也能告訴你：
1. PreApplicationStartMethodAttribute指向的方法。
2. App_Code中的appInitialize方法。
3. Application_Start。
4. HttpModule
再補(bǔ)充一點(diǎn)：在開(kāi)發(fā)環(huán)境中，當(dāng)我們編譯網(wǎng)站時(shí)，PreApplicationStartMethodAttribute指向的方法可能會(huì)被調(diào)用，這處決于類庫(kù)的程序集是否發(fā)生了修改。
到底該選擇哪種初始化方法？
今天給大家介紹了4種在ASP.NET中執(zhí)行初始化的方法，或許有些人會(huì)想：到底該選擇哪種初始化方法呢？
的確，方法越多越讓人迷惑。
下面的觀點(diǎn)僅代表我個(gè)人的建議，你也可以根據(jù)自己的喜好來(lái)選擇。
1. 優(yōu)先選擇Application_Start（雖然IIS的經(jīng)典模式下需要多寫點(diǎn)代碼），因?yàn)槿魏稳苏页跏蓟a時(shí)都會(huì)想到那里，便于其他人維護(hù)。
2. AppInitialize方法雖然使用簡(jiǎn)單，但它并不適合于WebApplication項(xiàng)目。
3. PreApplicationStartMethodAttribute只支持ASP.NET 4.0以上版本，且尤其適合于類庫(kù)的內(nèi)部初始化。
4. 當(dāng)以上方法都不可行時(shí)，HttpModule將成為最后的救命稻草，它適合所有ASP.NET版本。
原文鏈接：http://www.cnblogs.com/fish-li/archive/2013/03/24/2979780.html
