Web.config文件的基本原理及相关设置

摘要：本文讲述Web.config文件的基本原理及相关设置。

本页内容：

认识Web.config文件

Web.config文件是一个XML文本文件，它用来储存 ASP.NET Web 应用程序的配置信息（如最常用的设置ASP.NET Web 应用程序的身份验证方式），它可以出现在应用程序的每一个目录中。当你通过.NET新建一个Web应用程序后，默认情况下会在根目录自动创建一个默认的
Web.config文件，包括默认的配置设置，所有的子目录都继承它的配置设置。如果你想修改子目录的配置设置，你可以在该子目录下新建一个Web.config文件。它可以提供除从父目录继承的配置信息以外的配置信息，也可以重写或修改父目录中定义的设置。

在运行时对Web.config文件的修改不需要重启服务就可以生效（注：<processModel> 节例外）。当然Web.config文件是可以扩展的。你可以自定义新配置参数并编写配置节处理程序以对它们进行处理。

web.config文件详解

web.config配置文件（默认的配置设置）以下所有的代码都应该位于

<configuration>
<system.web>
和
</system.web>
</configuration>

之间，出于学习的目的下面的示例都省略了这段XML标记。

1、<authentication> 节
作用：配置 ASP.NET 身份验证支持（为Windows、Forms、PassPort、None四种）。该元素只能在计算机、站点或应用程序级别声明。<authentication> 元素必需与<authorization> 节配合使用。
示例：
以下示例为基于窗体（Forms）的身份验证配置站点，当没有登陆的用户访问需要身份验证的网页，网页自动跳转到登陆网页。

<authentication mode="Forms" >
<forms loginUrl="logon.aspx" name=".FormsAuthCookie"/>
</authentication>

其中元素loginUrl表示登陆网页的名称，name表示Cookie名称。

2、<authorization> 节
作用：控制对 URL 资源的客户端访问（如允许匿名用户访问）。此元素可以在任何级别（计算机、站点、应用程序、子目录或页）上声明。必需与<authentication> 节配合使用。
示例：以下示例禁止匿名用户的访问

<authorization>
　 <deny users="?"/>
</authorization>

注：你可以使用user.identity.name来获取已经过验证的当前的用户名；可以使用
web.Security.FormsAuthentication.RedirectFromLoginPage方法将已验证的用户重定向到用户刚才请求的页面.具体的实例请参考:
Forms验证 http://www.fanvb.net/websample/dataauth.aspx

3、<compilation>节
作用：配置 ASP.NET 使用的所有编译设置。默认的debug属性为“True”.在程序编译完成交付使用之后应将其设为False（Web.config文件中有详细说明，此处省略示例）

4、<customErrors>
作用：为 ASP.NET 应用程序提供有关自定义错误信息的信息。它不适用于 XML Web services 中发生的错误。
示例：当发生错误时，将网页跳转到自定义的错误页面。

<customErrors defaultRedirect="ErrorPage.aspx" mode="RemoteOnly">
</customErrors>

其中元素defaultRedirect表示自定义的错误网页的名称。mode元素表示：对不在本地 Web 服务器上运行的用户显示自定义(友好的)信息。

5、<httpRuntime>节
作用：配置 ASP.NET HTTP 运行库设置。该节可以在计算机、站点、应用程序和子目录级别声明。
示例：控制用户上传文件最大为4M，最长时间为60秒，最多请求数为100

<httpRuntime maxRequestLength="4096" executionTimeout="60" appRequestQueueLimit="100"/>

6、 <pages>
作用：标识特定于页的配置设置（如是否启用会话状态、视图状态，是否检测用户的输入等）。<pages>可以在计算机、站点、应用程序和子目录级别声明。
示例：不检测用户在浏览器输入的内容中是否存在潜在的危险数据（注：该项默认是检测，如果你使用了不检测，一要对用户的输入进行编码或验证)，在从客户端回发页时将检查加密的视图状态，以验证视图状态是否已在客户端被篡改。(注：该项默认是不验证）

<pages buffer="true" enableViewStateMac="true" validateRequest="false"/>

7、<sessionState>
作用：为当前应用程序配置会话状态设置（如设置是否启用会话状态，会话状态保存位置）。
示例：

<sessionState mode="InProc" cookieless="true" timeout="20"/>
</sessionState>

注：
mode="InProc"表示：在本地储存会话状态（你也可以选择储存在远程服务器或SAL服务器中或不启用会话状态）
cookieless="true"表示：如果用户浏览器不支持Cookie时启用会话状态(默认为False）
timeout="20"表示：会话可以处于空闲状态的分钟数

8、<trace>
作用：配置 ASP.NET 跟踪服务，主要用来程序测试判断哪里出错。
示例：以下为Web.config中的默认配置：

<trace enabled="false" requestLimit="10" pageOutput="false" traceMode="SortByTime" localOnly="true" />

注：
enabled="false"表示不启 用跟踪；
requestLimit="10"表示指定在服务器上存储的跟踪请求的数目
pageOutput="false"表示只能通过跟踪实用工具访问跟踪输出；
traceMode="SortByTime"表示以处理跟踪的顺序来显示跟踪信息
localOnly="true" 表示跟踪查看器 (trace.axd) 只用于宿主 Web 服务器

自定义Web.config文件配置

自定义Web.config文件配置节过程分为两步。
1.在在配置文件顶部 <configSections> 和 </configSections>标记之间声明配置节的名称和处理该节中配置数据的 .NET Framework 类的名称。
2.是在 <configSections> 区域之后为声明的节做实际的配置设置。
示例：创建一个节存储数据库连接字符串

<configuration>
　 <configSections>
　 <section name="appSettings" type="System.Configuration.NameValueFileSectionHandler, System, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"/>
</configSections>
　 <appSettings>
　　 <add key="scon" value="server=a;database=northwind;uid=sa;pwd=123"/>
　 </appSettings>
　 <system.web>
　　 ......
　 </system.web>
</configuration>

访问Web.config文件

你可以通过使用ConfigurationSettings.AppSettings 静态字符串集合来访问 Web.config 文件示例：获取上面例子中建立的连接字符串。例如：

protected static string Isdebug = ConfigurationSettings.AppSettings["debug"]

 

---

 

配置文件格式

ASP.NET 配置文件是基于 XML 的文本文件（每个都命名为 web.config），可出现在 ASP.NET Web 应用程序服务器上的任何目录中。 每个 web.config 文件将配置设置应用到它所在的目录和它下面的所有虚拟子目录。子目录中的设置可随意重写或修改在父目录中指定的设置。根配置文件——WinNT/Microsoft.NET/Framework/<version>/config/machine.config，提供整台计算机的默认配置设置。ASP.NET 配置 IIS 阻止对 web.config 文件进行直接的浏览器访问，以确保这些文件的值不能成为公共的（试图访问这些文件将导致 ASP.NET 返回 403 : Access Forbidden）。

运行时，ASP.NET 使用这些 web.config 配置文件，针对传入的每个 URL 目标请求分层计算唯一的设置集合（这些设置只计算一次，然后在后面的请求间被缓存起来；ASP.NET 自动监视文件更改，如果有任何配置文件发生更改时则使缓存无效）。

例如，通过按下列顺序应用 web.config 文件设置，对 URL http://myserver/myapplication/mydir/page.aspx 的配置设置进行计算：

 

Base configuration settings for machine.
C:/WinNT/Microsoft.NET/Framework/v.1.00/config/machine.config

Overridden by the configuration settings for the site (or the root application).
C:/inetpub/wwwroot/web.config

Overridden by application configuration settings.
D:/MyApplication/web.config

Overridden by subdirectory configuration settings.
D:/MyApplication/MyDir/web.config

如果 web.config 文件位于某个站点（如“Inetpub/wwwroot”）的根目录下，其配置设置将应用于该站点的所有应用程序。注意，给定目录或应用程序根中 web.config 文件的存在是完全可选的。如果 web.config 文件不存在，该目录的所有配置设置将自动从父目录继承。

配置节处理程序和节

web.config 文件是基于 XML 的文本文件，它可以包含标准的 XML 文档元素（包括格式正确的标记、注释、文本、cdata 等等）。该文件的编码格式可以为 ANSI、UTF-8 或 Unicode；系统自动检测编码。 web.config 文件的根元素总是 <configuration> 标记。ASP.NET 和最终用户设置因此封装在该标记中，如下所示：

<configuration>
    <!- Configuration settings would go here. -->
</configuration>

<configuration> 标记通常包含三种不同类型的元素，1) 配置节处理程序声明，2) 配置节组，3) 配置节设置。

 

• 配置节处理程序——ASP.NET 配置结构在 web.config 文件中的文件格式或支持的设置方面不进行任何假设。相反，它将处理 web.config 数据的任务委托给配置节处理程序，即实现 IConfigurationSectionHandler 接口的 .NET 框架类。单个 IConfigurationSectionHandler 声明只需要出现一次，通常是在 machine.config 文件中。子目录中的 web.config 文件自动继承此声明。配置节处理程序通过使用嵌套在 <configSections> 标记中的节标记指令在 web.config 文件中声明。节标记可进一步由节组标记限定，将它们组织为逻辑组（参见下文）。每个节标记标识一个表示特定配置数据节的标记名和一个处理该节的关联 IConfigurationSectionHandler 类。

   

• 配置节组——ASP.NET 配置允许出于组织目的对节进行分层分组。<sectionGroup> 标记可显示在 <configSections> 标记的内部或其他 <sectionGroup> 标记的内部。例如，ASP.NET 节处理程序全都显示在 <system.web> 节组中。

   

• 配置节——ASP.NET 配置设置在配置标记节中表示，同时嵌套在 <configuration> 标记（和可选的节组标记）中。对于每个配置节，必须在 config 层次结构中定义适当的节处理程序。例如，在下面的示例中，标记 <httpModules> 是定义 HTTP 模块配置数据的配置节。System.Configuration.HttpModulesConfigurationHandler 类负责在运行时解释 <httpModules> 标记中包含的内容。注意，节处理程序定义和节必须具有相同的节组限定符（此处为 <system.web>）。还应注意，标记名区分大小写，必须按所显示的原样键入。ASP.NET 的各种属性和设置也区分大小写，并且配置运行时不检查大小写是否不匹配。

 

<configuration>

  <configSections>
    <sectionGroup name="system.web">
      <section
        name="httpModules"
        type="System.Web.Configuration.HttpModulesConfigurationHandler,System.Web"
      />
    </sectionGroup>
  </configSections>

  <system.web>
    <httpModules>
      <add
        name="CookielessSession"
        type="System.Web.SessionState.CookielessSessionModule,System.Web"
      />
      <add
        name="OutputCache"
        type="System.Web.Caching.OutputCacheModule,System.Web"
      />
      <add
        name="Session"
        type="System.Web.SessionState.SessionStateModule,System.Web"
      />
      <add
        name="WindowsAuthentication"
        type="System.Web.Security.WindowsAuthenticationModule,System.Web"
      />
      <add
        name="FormsAuthentication"
        type="System.Web.Security.FormsAuthenticationModule,System.Web"
      />
      <add
        name="PassportAuthentication"
        type="System.Web.Security.PassportAuthenticationModule,System.Web"
      />
      <add
        name="UrlAuthorization"
        type="System.Web.Security.UrlAuthorizationModule,System.Web"
      />
      <add
        name="FileAuthorization"
        type="System.Web.Security.FileAuthorizationModule,System.Web"
      />
    </httpModules>
  </system.web>

</configuration>

使用位置和路径

默认情况下，在顶级 <configuration> 标记中定义的所有配置设置都应用到包含 web.config 文件的当前目录位置以及该位置下的所有子路径。还可通过使用具有适当的约束 path 属性的 <location> 标记，将配置设置应用到当前配置文件下的特定子路径。如果配置文件是主 machine.config 文件，则可以将设置应用到特定的虚拟目录或应用程序。如果配置文件是 web.config 文件，则可将设置应用到特定的文件、子目录、虚拟目录或应用程序。

 

<configuration>

  <location path="EnglishPages">
    <system.web>
      <globalization
        requestEncoding="iso-8859-1"
        responseEncoding="iso-8859-1"
      />
    </system.web>
  </location>

  <location path="EnglishPages/OneJapanesePage.aspx">
    <system.web>
      <globalization
        requestEncoding="Shift-JIS"
        responseEncoding="Shift-JIS"
      />
    </system.web>
  </location>

</configuration>

锁定配置设置

除了使用 <location> 标记指定路径信息外，还可以指定安全性以使配置层次结构中的其他深层配置文件无法重写该设置。若要锁定一组设置，可以在周围的 <location> 标记上指定 allowOverride 属性并将其设置为假。以下代码锁定两个不同应用程序的模拟设置。

 

<configuration>

  <location path="app1" allowOverride="false">
    <system.web>
        <identity impersonate="false" userName="app1" password="app1pw" />
    </system.web>
  </location>

  <location path="app2" allowOverride="false">
    <system.web>
        <identity impersonate="false" userName="app2" password="app2pw" />
    </system.web>
  </location>

</configuration>

注意，如果用户试图在其他配置文件中重写这些设置，配置系统将引发错误：

<configuration>

  <system.web>
      <identity userName="developer" password="loginpw" />
  </system.web>

</configuration>

标准 ASP.NET 配置节

ASP.NET 提供了若干标准配置节处理程序，用于处理 web.config 文件中的配置设置。下表提供了有关这些节的简短说明以及指向更多信息的指针。

节名	说明
<httpModules>	负责配置应用程序中的 HTTP 模块。HTTP 模块参与处理应用程序中的每个请求。常用的用途包括安全性和记录。
<httpHandlers>	负责将传入的 URL 映射到 IHttpHandler 类。子目录不继承这些设置。还负责将传入的 URL 映射到 IHttpHandlerFactory 类。<httpHandlers> 节中表示的数据由子目录分层继承。有关更多信息，请参阅本教程的 Http 处理程序和工厂一节。
<sessionState>	负责配置会话状态 HTTP 模块。有关更多信息，请参阅本教程的管理应用程序状态一节。
<globalization>	负责配置应用程序的全局化设置。有关更多信息，请参阅本教程的本地化一节。
<compilation>	负责配置 ASP.NET 使用的所有编译设置。有关更多信息，请参阅本教程的业务对象和调试节。
<trace>	负责配置 ASP.NET 跟踪服务。有关更多信息，请参阅本教程的跟踪一节。
<processModel>	负责配置 IIS Web 服务器系统上的 ASP.NET 进程模型设置。
<browserCaps>	负责控制浏览器功能组件的设置。有关更多信息，请参阅本教程的检索配置一节。