asp.net夜話(huà)之十一:web.config詳解
在開(kāi)發(fā)中經(jīng)常會(huì )遇到這樣的情況,在部署程序時(shí)為了保密起見(jiàn)并不將源代碼隨項目一同發(fā)布,而我們開(kāi)發(fā)時(shí)的環(huán)境與部署環(huán)境可能不一致(比如數據庫不一樣),如果在代碼中保存這些配置這些信息部署時(shí)需要到用戶(hù)那里更改代碼再重新編譯,這種部署方式非常麻煩。在.net中提供了一種便捷的保存項目配置信息的辦法,那就是利用配置文件,配置文件的文件后綴一般是.config,在asp.net中配置文件名一般默認是web.config。每個(gè)web.config文件都是基于XML的文本文件,并且可以保存到Web應用程序中的任何目錄中。在發(fā)布Web應用程序時(shí)web.config文件并不編譯進(jìn)dll文件中。如果將來(lái)客戶(hù)端發(fā)生了變化,僅僅需要用記事本打開(kāi)web.config文件編輯相關(guān)設置就可以重新正常使用,非常方便。
本篇要講述的知識如下:
配置文件的查找優(yōu)先級
配置文件節點(diǎn)說(shuō)明
配置文件的操作
配置文件的查找優(yōu)先級
在.net提供了一個(gè)針對當前機器的配置文件,這個(gè)文件是machine.config,它位于%windir%\Microsoft.NET\Framework\v2.0.50727\CONFIG\文件下(%windir%是系統分區下的系統目錄,在命令行模式下輸入%windir%然后回車(chē)就能查看當前機器的系統目錄,在Windows2003及WindowsXP中%windir%是系統分區下的windows目錄,在Windows2000中%windir%是系統分區下的WinNT目錄,在筆者機器上這個(gè)系統目錄是C:\WINDOWS)。這個(gè)文件里面定義了針對當前機器的WinForm程序和asp.net應用程序的配置。下面是machine.config文件的內容:
在這個(gè)文件夾下還有一個(gè)web.config文件,這個(gè)文件包含了asp.net網(wǎng)站的常用配置。下面是這個(gè)web.config文件的內容:
asp.net網(wǎng)站IIS啟動(dòng)的時(shí)候會(huì )加載配置文件中的配置信息,然后緩存這些信息,這樣就不必每次去讀取配置信息。在運行過(guò)程中asp.net應用程序會(huì )監視配置文件的變化情況,一旦編輯了這些配置信息,就會(huì )重新讀取這些配置信息并緩存。
當我們要讀取某個(gè)節點(diǎn)或者節點(diǎn)組信息時(shí),是按照如下方式搜索的:
(1)如果在當前頁(yè)面所在目錄下存在web.config文件,查看是否存在所要查找的結點(diǎn)名稱(chēng),如果存在返回結果并停止查找。
(2)如果當前頁(yè)面所在目錄下不存在web.config文件或者web.config文件中不存在該結點(diǎn)名,則查找它的上級目錄,直到網(wǎng)站的根目錄。
(3)如果網(wǎng)站根目錄下不存在web.config文件或者web.config文件中不存在該節點(diǎn)名則在%windir%\Microsoft.NET\Framework\v2.0.50727\CONFIG\web.config文件中查找。
(4)如果在%windir%\Microsoft.NET\Framework\v2.0.50727\CONFIG\web.config文件中不存在相應結點(diǎn),則在%windir%\Microsoft.NET\Framework\v2.0.50727\CONFIG\machine.config文件中查找。
(5)如果仍然沒(méi)有找到則返回null。
所以如果我們對某個(gè)網(wǎng)站或者某個(gè)文件夾有特定要求的配置,可以在相應的文件夾下創(chuàng )建一個(gè)web.config文件,覆蓋掉上級文件夾中的web.config文件中的同名配置即可。這些配置信息的尋找只查找一次,以后便被緩存起來(lái)供后來(lái)的調用。在asp.net應用程序運行過(guò)程中,如果web.config文件發(fā)生更改就會(huì )導致相應的應用程序重新啟動(dòng),這時(shí)存儲在服務(wù)器內存中的用戶(hù)會(huì )話(huà)信息就會(huì )丟失(如存儲在內存中的Session)。一些軟件(如殺毒軟件)每次完成對web.config的訪(fǎng)問(wèn)時(shí)就會(huì )修改web.config的訪(fǎng)問(wèn)時(shí)間屬性,也會(huì )導致asp.net應用程序的重啟。
配置文件節點(diǎn)說(shuō)明
web.config文件是一個(gè)XML文件,它的根結點(diǎn)是<configuration>,在<configuration>節點(diǎn)下的常見(jiàn)子節點(diǎn)有:<configSections>、<appSettings>、<connectionStrings>和<system.web>。其中<appSettings>節點(diǎn)主要用于配置一些網(wǎng)站的應用配置信息,而<connectionStrings>節點(diǎn)主要用于配置網(wǎng)站的數據庫連接字符串信息。
<system.web>節點(diǎn)主要是網(wǎng)站運行時(shí)的一些配置,它的常見(jiàn)節點(diǎn)有如下:
<appSettings>節點(diǎn)
<appSettings>節點(diǎn)主要用來(lái)存儲asp.net應用程序的一些配置信息,比如上傳文件的保存路徑等,以下是一個(gè)例子:
<appSettings>
<!--允許上傳的圖片格式類(lèi)型-->
<addkey="ImageType"value=".jpg;.bmp;.gif;.png;.jpeg"/>
<!--允許上傳的文件類(lèi)型-->
<addkey="FileType"value=".jpg;.bmp;.gif;.png;.jpeg;.pdf;.zip;.rar;.xls;.doc"/>
</appSettings>
對于<appSettings>節點(diǎn)中的值可以按照key來(lái)進(jìn)行訪(fǎng)問(wèn),以下就是一個(gè)讀取key值為“FileType”節點(diǎn)值的例子:
stringfileType=ConfigurationManager.AppSettings["FileType"];
<connectionStrings>節點(diǎn)
<connectionStrings>節點(diǎn)主要用于配置數據庫連接的,我們可以<connectionStrings>節點(diǎn)中增加任意個(gè)節點(diǎn)來(lái)保存數據庫連接字符串,將來(lái)在代碼中通過(guò)代碼的方式動(dòng)態(tài)獲取節點(diǎn)的值來(lái)實(shí)例化數據庫連接對象,這樣一旦部署的時(shí)候數據庫連接信息發(fā)生變化我們僅需要更改此處的配置即可,而不必因為數據庫連接信息的變化而需要改動(dòng)程序代碼和重新部署。
以下就是一個(gè)<connectionStrings>節點(diǎn)配置的例子:
<connectionStrings>
<!--SQLServer數據庫配置-->
<addname="AspNetStudyConnectionString1"connectionString="DataSource=(local);InitialCatalog=AspNetStudy;UserID=sa;Password=sa"/>
</connectionStrings>
在代碼中我們可以這么實(shí)例化數據庫連接對象:
//讀取web.config節點(diǎn)配置
stringconnectionString=ConfigurationManager.ConnectionStrings["AspNetStudyConnectionString1"].ConnectionString;
//實(shí)例化SqlConnection對象
SqlConnectionconnection=newSqlConnection(connectionString);
這樣做的好處是一旦開(kāi)發(fā)時(shí)所用的數據庫和部署時(shí)的數據庫不一致,僅僅需要用記事本之類(lèi)的文本編輯工具編輯connectionString屬性的值就行了。
<compilation>節點(diǎn)
<compilation>節點(diǎn)配置ASP.NET使用的所有編譯設置。默認的debug屬性為“true”,即允許調試,在這種情況下會(huì )影響網(wǎng)站的性能,所以在程序編譯完成交付使用之后應將其設為“false”。
<authentication>節點(diǎn)設置asp.net身份驗證模式,有四種身份驗證模式,它們的值分別如下:
Mode說(shuō)明
Windows使用Windows身份驗證,適用于域用戶(hù)或者局域網(wǎng)用戶(hù)。
Forms使用表單驗證,依靠網(wǎng)站開(kāi)發(fā)人員進(jìn)行身份驗證。
Passport使用微軟提供的身份驗證服務(wù)進(jìn)行身份驗證。
None不進(jìn)行任何身份驗證。
<authentication>節點(diǎn)
<authentication>節點(diǎn)控制用戶(hù)對網(wǎng)站、目錄或者單獨頁(yè)的訪(fǎng)問(wèn),必須配合<authentication>節點(diǎn)一起使用。
<customErrors>節點(diǎn)
<customErrors>節點(diǎn)用于定義一些自定義錯誤信息的信息。此節點(diǎn)有Mode和defaultRedirect兩個(gè)屬性,其中defaultRedirect屬性是一個(gè)可選屬性,表示應用程序發(fā)生錯誤時(shí)重定向到的默認URL,如果沒(méi)有指定該屬性則顯示一般性錯誤。Mode屬性是一個(gè)必選屬性,它有三個(gè)可能值,它們所代表的意義分別如下:
Mode說(shuō)明
On表示在本地和遠程用戶(hù)都會(huì )看到自定義錯誤信息。
Off禁用自定義錯誤信息,本地和遠程用戶(hù)都會(huì )看到詳細的錯誤信息。
RemoteOnly表示本地用戶(hù)將看到詳細錯誤信息,而遠程用戶(hù)將會(huì )看到自定義錯誤信息。
這里有必要說(shuō)明一下本地用戶(hù)和遠程用戶(hù)的概念。當我們訪(fǎng)問(wèn)asp.net應用程時(shí)所使用的機器和發(fā)布asp.net應用程序所使用的機器為同一臺機器時(shí)成為本地用戶(hù),反之則稱(chēng)之為遠程用戶(hù)。在開(kāi)發(fā)調試階段為了便于查找錯誤Mode屬性建議設置為Off,而在部署階段應將Mode屬性設置為On或者RemoteOnly,以避免這些詳細的錯誤信息暴露了程序代碼細節從而引來(lái)黑客的入侵。
下面我們添加一個(gè)頁(yè)面CustomErrorsDemo.aspx,在它的Page_Load事件里拋出一個(gè)異常,代碼如下:
usingSystem;
usingSystem.Data;
usingSystem.Configuration;
usingSystem.Collections;
usingSystem.Web;
usingSystem.Web.Security;
usingSystem.Web.UI;
usingSystem.Web.UI.WebControls;
usingSystem.Web.UI.WebControls.WebParts;
usingSystem.Web.UI.HtmlControls;
publicpartialclassCustomErrorsDemo:System.Web.UI.Page
{
voidPage_Load()voidPage_Load(objectsender,EventArgse)
{
thrownewException("故意拋出的異常。");
}
}
我們先配置<customErrors>如下:
<customErrorsmode="RemoteOnly">
<errorstatusCode="403"redirect="NoAccess.htm"/>
<errorstatusCode="404"redirect="FileNotFound.htm"/>
</customErrors>
這時(shí)本地運行CustomErrorsDemo.aspx的效果如下:
遠程訪(fǎng)問(wèn)時(shí)看到的效果:
如果我們將customErrors的Mode屬性設置為“On”本地運行和遠程訪(fǎng)問(wèn)都會(huì )看到如下效果:
如果將customErrors的Mode屬性設置為“Off”本地運行和遠程訪(fǎng)問(wèn)都會(huì )看到如下效果:
<error>子節點(diǎn)
在<customErrors>節點(diǎn)下還包含有<error>子節點(diǎn),這個(gè)節點(diǎn)主要是根據服務(wù)器的HTTP錯誤狀態(tài)代碼而重定向到我們自定義的錯誤頁(yè)面,注意要使<error>子節點(diǎn)下的配置生效,必須將<customErrors>節點(diǎn)節點(diǎn)的Mode屬性設置為“On”。下面是一個(gè)例子:
<customErrorsmode="On"defaultRedirect="GenericErrorPage.htm">
<errorstatusCode="403"redirect="403.htm"/>
<errorstatusCode="404"redirect="404.htm"/>
</customErrors>
在上面的配置中如果用戶(hù)訪(fǎng)問(wèn)的頁(yè)面不存在就會(huì )跳轉到404.htm頁(yè)面,如果用戶(hù)沒(méi)有權限訪(fǎng)問(wèn)請求的頁(yè)面則會(huì )跳轉到403.htm頁(yè)面,403.htm和404.htm頁(yè)面都是我們自己添加的頁(yè)面,我們可以在頁(yè)面中給出友好的錯誤提示。
<httpHandlers>節點(diǎn)
<httpHandlers>節點(diǎn)用于根據用戶(hù)請求的URL和HTTP謂詞將用戶(hù)的請求交給相應的處理程序??梢栽谂渲眉墑e的任何層次配置此節點(diǎn),也就是說(shuō)可以針對某個(gè)特定目錄下指定的特殊文件進(jìn)行特殊處理。
下面是與machine.config文件同一目錄下的web.config文件中的<httpHandlers>節點(diǎn)配置:
<httpHandlers>
<addpath="*.rules"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.xoml"verb="*"type="System.ServiceModel.Activation.HttpHandler,System.ServiceModel,Version=3.0.0.0,Culture=neutral,PublicKeyToken=b77a5c561934e089"validate="false"/>
<addpath="trace.axd"verb="*"type="System.Web.Handlers.TraceHandler"validate="true"/>
<addpath="WebResource.axd"verb="GET"type="System.Web.Handlers.AssemblyResourceLoader"validate="true"/>
<addpath="*.axd"verb="*"type="System.Web.HttpNotFoundHandler"validate="true"/>
<addpath="*.aspx"verb="*"type="System.Web.UI.PageHandlerFactory"validate="true"/>
<addpath="*.ashx"verb="*"type="System.Web.UI.SimpleHandlerFactory"validate="true"/>
<addpath="*.asmx"verb="*"type="System.Web.Services.Protocols.WebServiceHandlerFactory,System.Web.Services,Version=2.0.0.0,Culture=neutral,PublicKeyToken=b03f5f7f11d50a3a"validate="false"/>
<addpath="*.rem"verb="*"type="System.Runtime.Remoting.Channels.Http.HttpRemotingHandlerFactory,System.Runtime.Remoting,Version=2.0.0.0,Culture=neutral,PublicKeyToken=b77a5c561934e089"validate="false"/>
<addpath="*.soap"verb="*"type="System.Runtime.Remoting.Channels.Http.HttpRemotingHandlerFactory,System.Runtime.Remoting,Version=2.0.0.0,Culture=neutral,PublicKeyToken=b77a5c561934e089"validate="false"/>
<addpath="*.asax"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.ascx"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.master"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.skin"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.browser"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.sitemap"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.dll.config"verb="GET,HEAD"type="System.Web.StaticFileHandler"validate="true"/>
<addpath="*.exe.config"verb="GET,HEAD"type="System.Web.StaticFileHandler"validate="true"/>
<addpath="*.config"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.cs"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.csproj"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.vb"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.vbproj"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.webinfo"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.licx"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.resx"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.resources"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.mdb"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.vjsproj"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.java"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.jsl"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.ldb"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.ad"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.dd"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.ldd"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.sd"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.cd"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.adprototype"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.lddprototype"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.sdm"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.sdmDocument"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.mdf"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.ldf"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.exclude"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.refresh"verb="*"type="System.Web.HttpForbiddenHandler"validate="true"/>
<addpath="*.svc"verb="*"type="System.ServiceModel.Activation.HttpHandler,System.ServiceModel,Version=3.0.0.0,Culture=neutral,PublicKeyToken=b77a5c561934e089"validate="false"/>
<addpath="*"verb="GET,HEAD,POST"type="System.Web.DefaultHttpHandler"validate="true"/>
<addpath="*"verb="*"type="System.Web.HttpMethodNotAllowedHandler"validate="true"/>
</httpHandlers>
從上面的配置中可以看出,針對*.mdf、*.ldf文件的Get或者Post請求都會(huì )交給System.Web.HttpForbiddenHandler來(lái)處理,處理的結果就是用戶(hù)不能查看或者下載相關(guān)的文件。如果我們某個(gè)文件夾下的文件或者某個(gè)類(lèi)型的文件不允許用戶(hù)下載,可以在</httpHandlers>節點(diǎn)中增加相應的子節點(diǎn)。
下面我們以一個(gè)例子來(lái)說(shuō)明<httpHandlers>節點(diǎn)的用法,在我們的asp.net應用程序中建立一個(gè)IPData目錄,在IPData目錄中創(chuàng )建一個(gè)IPData.txt文件,然后在Web.config中添加以下配置:
<httpHandlers>
<addpath="IPData/*.txt"verb="*"type="System.Web.HttpForbiddenHandler"/>
</httpHandlers>
上面的代碼的作用是禁止訪(fǎng)問(wèn)IPData目錄下的任何txt文件。
然后新建一個(gè)頁(yè)面,在頁(yè)面中添加一個(gè)超級鏈接,鏈接到該目錄下IPData.txt文件,代碼如下:
<%@PageLanguage="C#"AutoEventWireup="true"CodeFile="HttpHandlersDemo.aspx.cs"Inherits="HttpHandlersDemo"%>
<!DOCTYPEhtmlPUBLIC"-//W3C//DTDXHTML1.0Transitional//EN""http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<htmlxmlns="http://www.w3.org/1999/xhtml">
<headrunat="server">
<title>httpHandlers節點(diǎn)的例子</title>
</head>
<body>
<formid="form1"runat="server">
<div>
<ahref="IPData/IPData.txt"title="打開(kāi)IPData/IPData.txt">打開(kāi)IPData/IPData.txt</a>
</div>
</form>
</body>
</html>
運行這個(gè)頁(yè)面的效果如下:
當前web.config文件的<customErrors>節點(diǎn)配置如下:
<customErrorsmode="On"defaultRedirect="GenericErrorPage.htm">
<errorstatusCode="403"redirect="403.htm"/>
<errorstatusCode="404"redirect="404.htm"/>
</customErrors>
如果存在403.htm和404.htm頁(yè)面,點(diǎn)擊超級鏈接之后會(huì )出現如下效果:
我們從上圖中可以看到當<customErrors>節點(diǎn)的Mode屬性為“On”時(shí),因為被禁止訪(fǎng)問(wèn)IPData文件夾下的所有txt文件,所以會(huì )跳轉到自定義的沒(méi)有權限提示頁(yè)面,即403.htm。
<httpRuntime>節點(diǎn)
<httpRuntime>節點(diǎn)用于對ASP.NETHTTP運行庫設置。該節可以在計算機、站點(diǎn)、應用程序和子目錄級別聲明。
例如下面的配置控制用戶(hù)最大能上傳的文件為40M(40*1024K),最大超時(shí)時(shí)間為60秒,最大并發(fā)請求為100個(gè)。
<httpRuntimemaxRequestLength="40960"executionTimeout="60"appRequestQueueLimit="100"/>
<pages>節點(diǎn)
<pages>節點(diǎn)用于表示對特定頁(yè)設置,主要有三個(gè)屬性,分別如下:
屬性名說(shuō)明
buffer是否啟用了HTTP響應緩沖。
enableViewStateMac是否應該對頁(yè)的視圖狀態(tài)運行計算機身份驗證檢查(MAC),以放置用戶(hù)篡改,默認為false,如果設置為true將會(huì )引起性能的降低。
validateRequest是否驗證用戶(hù)輸入中有跨站點(diǎn)腳本攻擊和SQL注入式漏洞攻擊,默認為true,如果出現匹配情況就會(huì )發(fā)HttpRequestValidationException異常。對于包含有在線(xiàn)文本編輯器頁(yè)面一般自行驗證用戶(hù)輸入而將此屬性設為false。
下面就是一個(gè)配置節點(diǎn)的例子:
<pagesbuffer="true"enableViewStateMac="true"validateRequest="false"/>
<sessionState>節點(diǎn)
<sessionState>節點(diǎn)用于配置當前asp.net應用程序的會(huì )話(huà)狀態(tài)配置。以下就是一個(gè)常見(jiàn)配置:
<sessionStatecookieless="false"mode="InProc"timeout="30"/>
上面的節點(diǎn)配置是設置在asp.net應用程序中啟用Cookie,并且指定會(huì )話(huà)狀態(tài)模式為在進(jìn)程中保存會(huì )話(huà)狀態(tài),同時(shí)還指定了會(huì )話(huà)超時(shí)為30分鐘。
<sessionState>節點(diǎn)的Mode屬性可以是以下幾種值之一:
屬性值說(shuō)明
Custom使用自定義數據來(lái)存儲會(huì )話(huà)狀態(tài)數據。
InProc默認值。由asp.net輔助進(jìn)程來(lái)存儲會(huì )話(huà)狀態(tài)數據。
Off禁用會(huì )話(huà)狀態(tài)。
SQLServer使用進(jìn)程外SQLServer數據庫保存會(huì )話(huà)狀態(tài)數據。
StateServer使用進(jìn)程外ASP.NET狀態(tài)服務(wù)存儲狀態(tài)信息。
一般默認情況下使用InProc模式來(lái)存儲會(huì )話(huà)狀態(tài)數據,這種模式的好處是存取速度快,缺點(diǎn)是比較占用內存,所以不宜在這種模式下存儲大型的用戶(hù)會(huì )話(huà)數據。
<globalization>節點(diǎn):
用于配置應用程序的全球化設置。此節點(diǎn)有幾個(gè)比較重要的屬性,分別如下:
屬性名說(shuō)明
fileEncoding可選屬性。設置.aspx、.asmx和.asax文件的存儲編碼。
requestEncoding可選屬性。設置客戶(hù)端請求的編碼,默認為UTF-8.
responseEncoding可選屬性。設置服務(wù)器端響應的編碼,默認為UTF-8.
以下就是asp.net應用程序中的默認配置:
<globalizationfileEncoding="utf-8"requestEncoding="utf-8"responseEncoding="utf-8"/>
配置文件的讀寫(xiě)操作
雖然web.config文件是一個(gè)XML文件,但是由于權限的原因它在部署中不能像操作普通XML文件那樣進(jìn)行修改,在.net中提供了一個(gè)類(lèi)用于對web.config進(jìn)行修改。
下面是針對web.config修改通用類(lèi)的代碼:
usingSystem;
usingSystem.Configuration;
usingSystem.Web;
usingSystem.Web.Configuration;
///<summary>
///ConfigurationOperator的摘要說(shuō)明
///</summary>
publicclassConfigurationOperator:IDisposable
{
privateConfigurationconfig;
ConfigurationOperator()ConfigurationOperator():this(HttpContext.Current.Request.ApplicationPath)
{
}
ConfigurationOperator()ConfigurationOperator(stringpath)
{
config=WebConfigurationManager.OpenWebConfiguration(path);
}
///<summary>
///設置應用程序配置節點(diǎn),如果已經(jīng)存在此節點(diǎn),則會(huì )修改該節點(diǎn)的值,否則添加此節點(diǎn)
///</summary>
///<paramname="key">節點(diǎn)名稱(chēng)</param>
///<paramname="value">節點(diǎn)值</param>
voidSetAppSetting()voidSetAppSetting(stringkey,stringvalue)
{
AppSettingsSectionappSetting=(AppSettingsSection)config.GetSection("appSettings");
if(appSetting.Settings[key]==null)//如果不存在此節點(diǎn),則添加
{
appSetting.Settings.Add(key,value);
}
else//如果存在此節點(diǎn),則修改
{
appSetting.Settings[key].Value=value;
}
}
///<summary>
///設置數據庫連接字符串節點(diǎn),如果不存在此節點(diǎn),則會(huì )添加此節點(diǎn)及對應的值,存在則修改
///</summary>
///<paramname="key">節點(diǎn)名稱(chēng)</param>
///<paramname="value">節點(diǎn)值</param>
voidSetConnectionString()voidSetConnectionString(stringkey,stringconnectionString)
{
ConnectionStringsSectionconnectionSetting=(ConnectionStringsSection)config.GetSection("connectionStrings");
if(connectionSetting.ConnectionStrings[key]==null)//如果不存在此節點(diǎn),則添加
{
ConnectionStringSettingsconnectionStringSettings=newConnectionStringSettings(key,connectionString);
connectionSetting.ConnectionStrings.Add(connectionStringSettings);
}
else//如果存在此節點(diǎn),則修改
{
connectionSetting.ConnectionStrings[key].ConnectionString=connectionString;
}
}
///<summary>
///保存所作的修改
///</summary>
voidSave()voidSave()
{
config.Save();
config=null;
}
voidDispose()voidDispose()
{
if(config!=null)
{
config.Save();
}
}
}
把上面的代碼存放到App_Code文件夾下,我們在項目中就可以直接使用了。
我們通過(guò)一個(gè)例子演示如果使用這個(gè)通用類(lèi)對web.config進(jìn)行設置。新建一個(gè)aspx頁(yè)面,下面是前臺代碼:
<%@PageLanguage="C#"AutoEventWireup="true"CodeFile="ConfigModifyDemo.aspx.cs"Inherits="ConfigModifyDemo"%>
<!DOCTYPEhtmlPUBLIC"-//W3C//DTDXHTML1.0Transitional//EN""http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<htmlxmlns="http://www.w3.org/1999/xhtml">
<headrunat="server">
<title>在部署后修改web.config的例子</title>
</head>
<body>
<formid="form1"runat="server">
<div>
<tableborder="0"cellpadding="0"cellspacing="0">
<tr><td>類(lèi)型</td><td>名稱(chēng)</td><td>值</td></tr>
<tr><td>
程序配置</td><td>
<asp:TextBoxID="txtKey"runat="server"></asp:TextBox>
<asp:RequiredFieldValidatorID="RequiredFieldValidator2"runat="server"ControlToValidate="txtKey"
ErrorMessage="*"Display="Dynamic"></asp:RequiredFieldValidator></td><td>
<asp:TextBoxID="txtAppSetting"runat="server"></asp:TextBox></td></tr>
<tr><td>
數據庫連接</td><td>
<asp:TextBoxID="txtConnectionName"runat="server"></asp:TextBox>
<asp:RequiredFieldValidatorID="RequiredFieldValidator1"runat="server"ErrorMessage="*"ControlToValidate="txtConnectionName"Display="Dynamic"></asp:RequiredFieldValidator></td><tdstyle="height:24px">
<asp:TextBoxID="txtConnectionString"runat="server"></asp:TextBox></td></tr>
<tr><td>
<asp:ButtonID="btnModify"runat="server"OnClick="btnModify_Click"Text="修改"/></td><td></td><td></td></tr>
</table>
</div>
</form>
</body>
</html>
編寫(xiě)后臺代碼有時(shí)可能需要增加對配置文件讀寫(xiě)操作類(lèi)所在dll的引用,如下:
下面是后臺代碼:
usingSystem;
usingSystem.Data;
usingSystem.Configuration;
usingSystem.Collections;
usingSystem.Web;
usingSystem.Web.Security;
usingSystem.Web.UI;
usingSystem.Web.UI.WebControls;
usingSystem.Web.UI.WebControls.WebParts;
usingSystem.Web.UI.HtmlControls;
usingSystem.Web.Configuration;//注意添加這個(gè)命名空間
publicpartialclassConfigModifyDemo:System.Web.UI.Page
{
voidPage_Load()voidPage_Load(objectsender,EventArgse)
{
}
voidbtnModify_Click()voidbtnModify_Click(objectsender,EventArgse)
{
stringappSetting=txtAppSetting.Text;//appSetting子節點(diǎn)值
stringconnectionString=txtConnectionString.Text;//連接字符串
stringkey=txtKey.Text;//appSetting子節點(diǎn)Key
stringconnectionName=txtConnectionName.Text;//連接Name
ConfigurationOperatorop=newConfigurationOperator();
op.SetAppSetting(key,appSetting);
op.SetConnectionString(connectionName,connectionString);
op.Save();
}
}
下面是運行界面:
我們在上面的表單中填入如下信息:
假設此時(shí)web.config文件相關(guān)節點(diǎn)的內容如下:
<appSettings>
</appSettings>
<connectionStrings>
<addname="Conn"connectionString="DataSource=(local);InitialCatalog=AspNetStudy;PersistSecurityInfo=True;UserID=sa;Password=sa"/>
</connectionStrings>
我們點(diǎn)擊“修改”按鈕之后的文件內容如下:
<appSettings>
<addkey="country"value="china"/>
</appSettings>
<connectionStrings>
<addname="Conn"connectionString="DataSource=(local);InitialCatalog=Study;UserID=sa;Password=sa"
providerName="System.Data.SqlClient"/>
</connectionStrings>
從執行結果可以看出我們的程序確實(shí)能做到修改和添加web.config中的節點(diǎn)的功能。需要注意的是,在利用了某些版本控制軟件之后(如MicrosoftVisualSourceSafe),版本控制軟件可能會(huì )將web.config設置為只讀屬性,就會(huì )出現不能設置的情況,我們需要手動(dòng)將web.config的只讀屬性去掉才能設置web.config文件。在實(shí)際部署項目的時(shí)候就不會(huì )存在這個(gè)問(wèn)題。
總結:web.config是asp.net應用程序中一個(gè)很重要的配置文件,通過(guò)web.config文件可以方便我們進(jìn)行開(kāi)發(fā)和部署asp.net應用程序。此外還能對程序進(jìn)行一些靈活的控制。在本篇中詳細講述了各節點(diǎn)的作用。因為在部署asp.net應用程序后因為權限原因不能按照XML方式進(jìn)行修改web.config文件,所以在本篇中還提供了一個(gè)針對<appSettings>節點(diǎn)和<connectionStrings>節點(diǎn)設置的通用類(lèi),讀者朋友可以根據實(shí)際項目需要對這個(gè)通用類(lèi)進(jìn)行完善和補充。
下一篇筆者將帶領(lǐng)大家進(jìn)入到asp.net的內部,了解一下asp.net的內部運行機制,這對于我們更加靈活地控制asp.net應用程序是非常有幫助的。
2008-11-501:47
周公(周金橋)
最近事情比較多,忙不過(guò)來(lái)了,可能發(fā)表時(shí)間會(huì )比較長(cháng),不過(guò)也好能有時(shí)間讓我再思考一下我的表述方式。
聯(lián)系客服