asp.net夜話之十一：web.config詳解

在開發中經常會遇到這樣的情況，在部署程式時為了保密起見並不將原始碼隨專案一同釋出，而我們開發時的環境與部署環境可能不一致（比如資料庫不一樣），如果在程式碼中儲存這些配置這些資訊部署時需要到使用者那裡更改程式碼再重新編譯，這種部署方式非常麻煩。
在.net 中提供了一種便捷的儲存專案配置資訊的辦法，那就是利用配置檔案，配置檔案的檔案字尾一般是.config，在asp.net中配置檔名一般預設是 web.config。每個web.config檔案都是基於XML的文字檔案，並且可以儲存到Web應用程式中的任何目錄中。在釋出Web應用程式時 web.config檔案並不編譯進dll檔案中。如果將來客戶端發生了變化，僅僅需要用記事本開啟web.config檔案編輯相關設定就可以重新正常 使用，非常方便。
本篇要講述的知識如下：
配置檔案的查詢優先順序

配置檔案節點說明
配置檔案的操作

配置檔案的查詢優先順序
在.net提供了一個針對當前機器的配置檔案，這個檔案是 machine.config，它位於%windir%/Microsoft.NET/Framework/v2.0.50727/CONFIG/檔案下 （%windir%是系統分割槽下的系統目錄，在命令列模式下輸入%windir%然後回車就能檢視當前機器的系統目錄，在Windows2003及 WindowsXP中%windir%是系統分割槽下的windows目錄，在Windows2000中%windir%是系統分割槽下的WinNT目錄，在 筆者機器上這個系統目錄是C:/WINDOWS）。這個檔案裡面定義了針對當前機器的WinForm程式和asp.net應用程式的配置。下面是 machine.config檔案的內容：
 
在這個資料夾下還有一個web.config檔案，這個檔案包含了asp.net網站的常用配置。下面是這個web.config檔案的內容：
 
asp.net網站IIS啟動的時候會載入配置檔案中的配置資訊，然後快取這些資訊，這樣就不必每次去讀取配置資訊。在執行過程中asp.net應用程式會監視配置檔案的變化情況，一旦編輯了這些配置資訊，就會重新讀取這些配置資訊並快取。
當我們要讀取某個節點或者節點組資訊時，是按照如下方式搜尋的：
(1)如果在當前頁面所在目錄下存在web.config檔案，檢視是否存在所要查詢的結點名稱，如果存在返回結果並停止查詢。
(2)如果當前頁面所在目錄下不存在web.config檔案或者web.config檔案中不存在該結點名，則查詢它的上級目錄，直到網站的根目錄。
(3)如果網站根目錄下不存在web.config檔案或者web.config檔案中不存在該節點名則在%windir%/Microsoft.NET/Framework/v2.0.50727/CONFIG/web.config檔案中查詢。
(4) 如果在%windir%/Microsoft.NET/Framework/v2.0.50727/CONFIG/web.config檔案中不存在相應 結點，則在%windir%/Microsoft.NET/Framework/v2.0.50727/CONFIG/machine.config檔案 中查詢。
(5)如果仍然沒有找到則返回null。
所以如果我們對某個網站或者某個資料夾有特定要求的配置，可以在相應的資料夾下建立一個 web.config檔案，覆蓋掉上級資料夾中的web.config檔案中的同名配置即可。這些配置資訊的尋找只查詢一次，以後便被快取起來供後來的調 用。在asp.net應用程式執行過程中，如果web.config檔案發生更改就會導致相應的應用程式重新啟動，這時儲存在伺服器記憶體中的使用者會話資訊 就會丟失（如儲存在記憶體中的Session）。一些軟體（如防毒軟體）每次完成對web.config的訪問時就會修改web.config的訪問時間屬 性，也會導致asp.net應用程式的重啟。

配置檔案節點說明
web.config檔案是一個XML檔案，它的根結點 是<configuration>，在<configuration>節點下的常見子節點 有：<configSections>、<appSettings>、<connectionStrings> 和<system.web>。其中<appSettings>節點主要用於配置一些網站的應用配置資訊， 而<connectionStrings>節點主要用於配置網站的資料庫連線字串資訊。
<system.web>節點主要是網站執行時的一些配置，它的常見節點有如下：
<appSettings>節點
<appSettings>節點主要用來儲存asp.net應用程式的一些配置資訊，比如上傳檔案的儲存路徑等，以下是一個例子：

對於<appSettings>節點中的值可以按照key來進行訪問，以下就是一個讀取key值為“FileType”節點值的例子：

<connectionStrings>節點
<connectionStrings> 節點主要用於配置資料庫連線的，我們可以<connectionStrings>節點中增加任意個節點來儲存資料庫連線字串，將來在程式碼中 通過程式碼的方式動態獲取節點的值來例項化資料庫連線物件，這樣一旦部署的時候資料庫連線資訊發生變化我們僅需要更改此處的配置即可，而不必因為資料庫連線 資訊的變化而需要改動程式程式碼和重新部署。
以下就是一個<connectionStrings>節點配置的例子：

在程式碼中我們可以這麼例項化資料庫連線物件：

這樣做的好處是一旦開發時所用的資料庫和部署時的資料庫不一致，僅僅需要用記事本之類的文字編輯工具編輯connectionString屬性的值就行了。

<compilation>節點
<compilation>節點配置 ASP.NET 使用的所有編譯設定。預設的debug屬性為“true”，即允許除錯，在這種情況下會影響網站的效能，所以在程式編譯完成交付使用之後應將其設為“false”。

<authentication>節點
設定asp.net身份驗證模式，有四種身份驗證模式，它們的值分別如下：
Mode 說明
Windows 使用Windows身份驗證，適用於域使用者或者區域網使用者。
Forms 使用表單驗證，依靠網站開發人員進行身份驗證。
Passport 使用微軟提供的身份驗證服務進行身份驗證。
None 不進行任何身份驗證。

<authentication>節點
<authentication>節點控制使用者對網站、目錄或者單獨頁的訪問，必須配合<authentication>節點一起使用。

<customErrors>節點
<customErrors>節點用於定義 一些自定義錯誤資訊的資訊。此節點有Mode和defaultRedirect兩個屬性，其中defaultRedirect屬性是一個可選屬性，表示應 用程式發生錯誤時重定向到的預設URL，如果沒有指定該屬性則顯示一般性錯誤。Mode屬性是一個必選屬性，它有三個可能值，它們所代表的意義分別如下：
Mode 說明
On 表示在本地和遠端使用者都會看到自定義錯誤資訊。
Off 禁用自定義錯誤資訊，本地和遠端使用者都會看到詳細的錯誤資訊。
RemoteOnly 表示本地使用者將看到詳細錯誤資訊，而遠端使用者將會看到自定義錯誤資訊。
這 裡有必要說明一下本地使用者和遠端使用者的概念。當我們訪問asp.net應用程時所使用的機器和釋出asp.net應用程式所使用的機器為同一臺機器時成為 本地使用者，反之則稱之為遠端使用者。在開發除錯階段為了便於查詢錯誤Mode屬性建議設定為Off，而在部署階段應將Mode屬性設定為On或者 RemoteOnly，以避免這些詳細的錯誤資訊暴露了程式程式碼細節從而引來黑客的入侵。
下面我們新增一個頁面CustomErrorsDemo.aspx，在它的Page_Load事件裡丟擲一個異常，程式碼如下：

 

我們先配置<customErrors>如下：

這時本地執行CustomErrorsDemo.aspx的效果如下：
 
遠端訪問時看到的效果：
 
如果我們將customErrors的Mode屬性設定為“On”本地執行和遠端訪問都會看到如下效果：
 
如果將customErrors的Mode屬性設定為“Off”本地執行和遠端訪問都會看到如下效果：
 

<error>子節點
在<customErrors>節點下還包含 有<error>子節點，這個節點主要是根據伺服器的HTTP錯誤狀態程式碼而重定向到我們自定義的錯誤頁面，注意要 使<error>子節點下的配置生效，必須將<customErrors>節點節點的Mode屬性設定為“On”。下面是一個例 子：

在上面的配置中如果使用者訪問的頁面不存在就會跳轉到404.htm頁面，如果使用者沒有許可權訪問請求的頁面則會跳轉到403.htm頁面，403.htm和404.htm頁面都是我們自己新增的頁面，我們可以在頁面中給出友好的錯誤提示。

<httpHandlers>節點
<httpHandlers>節點用於根據使用者請求的URL和HTTP謂詞將使用者的請求交給相應的處理程式。可以在配置級別的任何層次配置此節點，也就是說可以針對某個特定目錄下指定的特殊檔案進行特殊處理。

下面是與machine.config檔案同一目錄下的web.config檔案中的<httpHandlers>節點配置：

 

從上面的配置中可以看出，針對*.mdf、*.ldf檔案的Get或者Post請求都會交給 System.Web.HttpForbiddenHandler來處理，處理的結果就是使用者不能檢視或者下載相關的檔案。如果我們某個資料夾下的檔案或 者某個型別的檔案不允許使用者下載，可以在</httpHandlers>節點中增加相應的子節點。
下面我們以一個例子來說明<httpHandlers>節點的用法，在我們的asp.net應用程式中建立一個IPData目錄，在IPData目錄中建立一個IPData.txt檔案，然後在Web.config中新增以下配置：

上面的程式碼的作用是禁止訪問IPData目錄下的任何txt檔案。
然後新建一個頁面，在頁面中新增一個超級連結，連結到該目錄下IPData.txt檔案，程式碼如下：

 

執行這個頁面的效果如下：
 
當前web.config檔案的<customErrors>節點配置如下：
<customErrors mode="On" defaultRedirect="GenericErrorPage.htm">
     <error statusCode="403" redirect="403.htm" />
     <error statusCode="404" redirect="404.htm" />
</customErrors>
如果存在403.htm和404.htm頁面，點選超級連結之後會出現如下效果：
 
我們從上圖中可以看到當<customErrors>節點的Mode屬性為“On”時，因為被禁止訪問IPData資料夾下的所有txt檔案，所以會跳轉到自定義的沒有許可權提示頁面，即403.htm。

<httpRuntime>節點
<httpRuntime>節點用於對 ASP.NET HTTP 執行庫設定。該節可以在計算機、站點、應用程式和子目錄級別宣告。
例如下面的配置控制使用者最大能上傳的檔案為40M（40*1024K），最大超時時間為60秒，最大併發請求為100個。

<pages>節點
<pages>節點用於表示對特定頁設定，主要有三個屬性，分別如下：
屬性名 說明
buffer 是否啟用了 HTTP 響應緩衝。
enableViewStateMac 是否應該對頁的檢視狀態執行計算機身份驗證檢查 (MAC)，以放置使用者篡改，預設為false，如果設定為true將會引起效能的降低。
validateRequest 是 否驗證使用者輸入中有跨站點指令碼攻擊和SQL隱碼攻擊式漏洞攻擊，預設為true，如果出現匹配情況就會發 HttpRequestValidationException 異常。對於包含有線上文字編輯器頁面一般自行驗證使用者輸入而將此屬性設為false。
下面就是一個配置節點的例子：

<sessionState>節點
<sessionState>節點用於配置當前asp.net應用程式的會話狀態配置。以下就是一個常見配置：

上面的節點配置是設定在asp.net應用程式中啟用Cookie，並且指定會話狀態模式為在程式中儲存會話狀態，同時還指定了會話超時為30分鐘。
<sessionState>節點的Mode屬性可以是以下幾種值之一：
屬性值 說明
Custom 使用自定義資料來儲存會話狀態資料。
InProc 預設值。由asp.net輔助程式來儲存會話狀態資料。
Off 禁用會話狀態。
SQLServer 使用程式外SQL Server資料庫儲存會話狀態資料。
StateServer 使用程式外 ASP.NET 狀態服務儲存狀態資訊。
一般預設情況下使用InProc模式來儲存會話狀態資料，這種模式的好處是存取速度快，缺點是比較佔用記憶體，所以不宜在這種模式下儲存大型的使用者會話資料。

<globalization>節點：
用於配置應用程式的全球化設定。此節點有幾個比較重要的屬性，分別如下：
屬性名 說明
fileEncoding 可選屬性。設定.aspx、.asmx 和 .asax 檔案的儲存編碼。
requestEncoding 可選屬性。設定客戶端請求的編碼，預設為UTF-8.
responseEncoding 可選屬性。設定伺服器端響應的編碼，預設為UTF-8.
以下就是asp.net應用程式中的預設配置：

配置檔案的讀寫操作
雖然web.config檔案是一個XML檔案，但是由於許可權的原因它在部署中不能像操作普通XML檔案那樣進行修改，在.net中提供了一個類用於對web.config進行修改。
下面是針對web.config修改通用類的程式碼：

 

把上面的程式碼存放到App_Code資料夾下，我們在專案中就可以直接使用了。
我們通過一個例子演示如果使用這個通用類對web.config進行設定。新建一個aspx頁面，下面是前臺程式碼：

 

編寫後臺程式碼有時可能需要增加對配置檔案讀寫操作類所在dll的引用，如下：

下面是後臺程式碼：

下面是執行介面：
 
我們在上面的表單中填入如下資訊：
 
假設此時web.config檔案相關節點的內容如下：

我們點選“修改”按鈕之後的檔案內容如下：

從執行結果可以看出我們的程式確實能做到修改和新增web.config中的節點的功能。需要注意的是，在利用了某些版本控制軟體之後（如 Microsoft Visual SourceSafe），版本控制軟體可能會將web.config設定為只讀屬性，就會出現不能設定的情況，我們需要手動將web.config的只讀 屬性去掉才能設定web.config檔案。在實際部署專案的時候就不會存在這個問題。

總結：web.config是asp.net應用程式中一個很重要的配置檔案，通過web.config檔案可以方便我們進行開發和部署 asp.net應用程式。此外還能對程式進行一些靈活的控制。在本篇中詳細講述了各節點的作用。因為在部署asp.net應用程式後因為許可權原因不能按照 XML方式進行修改web.config檔案，所以在本篇中還提供了一個針對<appSettings>節點 和<connectionStrings>節點設定的通用類，讀者朋友可以根據實際專案需要對這個通用類進行完善和補充。
下一篇筆者將帶領大家進入到asp.net的內部，瞭解一下asp.net的內部執行機制，這對於我們更加靈活地控制asp.net應用程式是非常有幫助的。
2008-11-5 01：47
周公（周金橋）

最近事情比較多，忙不過來了，可能發表時間會比較長，不過也好能有時間讓我再思考一下我的表述方式。

注意，因為個人空間大小和下載速度受限，所以以後不再提供從本人主機上的下載地址，可以到www.verycd.com下載。地址是：http://www.verycd.com/topics/2730883/

PS：相信看過這篇文章後，對web.config檔案就會有一個全面的瞭解了