维基教科书

ASP.NET/web.config

< ASP.NET

web.config是一个XML文本文件。用来存储ASP.NET WEB的配置信息。修改后，会自动重新加载程序，并放弃原进程的会话状态和程序状态。

当创建一个ASP.NET项目时，默认情况下会在根目录自动创建一个默认的web.config文件，包括默认的配置设置，所有的子目录都继承它的配置设置。如果想修改子目录的配置设置，可以在该子目录下新建一个web.config文件。它可以提供除从父目录继承的配置信息以外的配置信息，也可以重写或修改父目录中定义的设置。

配置节的声明

编辑

配置节处理程序声明出现在配置文件顶部 <configSections> 和 </configSections> 标记之间，配置节声明使用<section>节。配置节也支持嵌套，外层的配置节使用<sectionGroup>，内层的使用<section>。所有的配置节都必须遵守先声明后使用的原则，不然编译程序时会报错。web.config中默认生成的配置节没看到声明就直接用，因为这些节的声明是在Windows\Microsoft .NET\Framework\versionNumber\CONFIG\Machine.config中完成的。 

<section name="section_name"
         type="configuration_section_handler_class, assembly_name_wo_dll_ext" />

文件内容

编辑

web.config作为XML，根结点是<configuration>。在<configuration>节点下的常见子节点有：

  • <configSections>
  • <appSettings>：用于配置一些网站的应用配置信息。节点中的value可以按照key来进行访问
  • <connectionStrings>：用于配置网站的数据库连接字符串信息
  • <system.web>：网站运行时的一些配置
    • <compilation>节点控制页面编译和程序集引用。默认的debug属性为“true”，即允许调试，在这种情况下会影响网站的性能，所以在程序编译完成交付使用之后应将其设为“false”。
    • <authentication>节点控制用户对网站、目录或者单独页的访问。属于应用程序级别的元素，不能配置于子目录下的 web.config。设置asp.net身份验证模式，有四种身份验证模式：
      • Windows 使用Windows身份验证，适用于域用户或者局域网用户。
      • Forms 使用表单验证，当没有登陆的用户访问需要身份验证的网页，网页自动跳转到登陆网页。Name属性: 指定完成身份验证的Http cookie的名称。LoginUrl属性: 如果未通过验证或超时后重定向的页面URL，一般为登录页面，让用户重新登录。Protection属性: 指定 cookie数据的保护方式，可设置为四种保护方式，All表示加密数据，并进行有效性验证两种方式，None表示不保护Cookie，Encryption表示对Cookie内容进行加密，validation表示对Cookie内容进行有效性验证。TimeOut: 指定Cookie的失效时间. 超时后要重新登录.
      • Passport 采用Passport cookie验证模式
      • None 不进行任何身份验证。
    • <authorization> 控制对 URL 资源的客户端访问（如允许匿名用户访问）。此元素可以在任何级别（计算机、站点、应用程序、子目录或页）上声明。必需与<authentication> 节配合使用。例如，子节点<deny users="?"/>禁止匿名用户的访问。可以使用user.identity.name来获取已经过验证的当前的用户名；可以使用web.Security.FormsAuthentication.RedirectFromLoginPage方法将已验证的用户重定向到用户刚才请求的页面。
    • <customErrors>节点用于定义一些自定义错误信息的信息。此节点有Mode和defaultRedirect两个属性，其中defaultRedirect属性是一个可选属性，表示应用程序发生错误时重定向到的默认URL，如果没有指定该属性则显示一般性错误。Mode属性是一个必选属性，它有三个可能值，它们所代表的意义分别如下。访问asp.net应用程时所使用的机器和发布asp.net应用程序所使用的机器为同一台机器时成为本地用户，反之则称之为远程用户。在开发调试阶段为了便于查找错误Mode属性建议设置为Off，而在部署阶段应将Mode属性设置为On或者RemoteOnly，以避免这些详细的错误信息暴露了程序代码细节从而引来黑客的入侵。
      • On 表示在本地和远程用户都会看到自定义错误信息。
      • Off 禁用自定义错误信息，本地和远程用户都会看到详细的错误信息。
      • RemoteOnly 表示本地用户将看到详细错误信息，而远程用户将会看到自定义错误信息。
      • <error>子节点：根据服务器的HTTP错误状态代码而重定向到自定义的错误页面，注意要使<error>子节点下的配置生效，必须将<customErrors>节点节点的Mode属性设置为“On”。
    • <httpHandlers>节点：添加或移除HTTP handler。根据用户请求的URL和HTTP verb将用户的请求交给相应的处理程序。可以在配置级别的任何层次配置此节点，也就是说可以针对某个特定目录下指定的特殊文件进行特殊处理。
    • <httpmodule>节点： 添加或移除HTTP模块以及诸如安全、日志之类的应用方式。属于应用程序级别的元素，不能配置于子目录下的 web.config
    • <trace>节点：配置ASP.NET的跟踪服务
    • <security>节点：　ASP.NET的安全配置
    • <iisprocessmodel>节点：在IIS上配置ASP.NET的处理模式
    • <browercaps>节点：根据用户代理指定浏览器的能力。配置浏览器的兼容部件
    • <identity> 为该应用程序指定标识
    • <machineKey> 控制验证和解密的钥匙
    • <processModel> 控制工作者进程的行为方式。属于机器级别元素，只能用于machine.config。
    • <securityPolicy> 使用相关的策略文件定义信任等级
    • <trust> 选择使用的信任等级.属于应用程序级别的元素，不能配置于子目录下的 web.config
    • <webServices> 指定Web服务的协议和范围
    • <clientTarget>定义客户目标
    • <httpRuntime>节点用于对 ASP.NET HTTP 运行库设置。该节可以在计算机、站点、应用程序和子目录级别声明。属性有：
      • executionTimeout="36000" 最大超时时间为36000秒
      • maxRequestLength="2097151" 用户最大能上传的文件为40M
      • requestLengthDiskThreshold="80"
      • useFullyQualifiedRedirectUrl="false"
      • minFreeThreads="8"
      • minLocalRequestFreeThreads="4"
      • appRequestQueueLimit="5000" 最大并发请求为5000个
      • enableKernelOutputCache="true"
      • enableVersionHeader="true"
      • enable="true"
      • shutdownTimeout="3600"
      • delayNotificationTimeout="5"
      • waitChangeNotification="0"
      • maxWaitChangeNotification="0"
      • enableHeaderChecking="true"
      • sendCacheControlHeader="true"
      • apartmentThreading="false"
    • <pages>节点用于表示对特定页设置，主要有三个属性：
      • buffer 是否启用了 HTTP 响应缓冲。
      • enableViewStateMac 是否应该对页的视图状态运行计算机身份验证检查 (MAC)，以放置用户篡改，默认为false，如果设置为true将会引起性能的降低。
      • validateRequest 是否验证用户输入中有跨站点脚本攻击和SQL注入式漏洞攻击，默认为true，如果出现匹配情况就会。如果使用了不检测，一要对用户的输入进行编码或验证
    • <sessionState>节点用于配置当前asp.net应用程序的会话状态配置。属于应用程序级别的元素，不能配置于子目录下的 web.config
      • cookieless="false" 保存会话状态
      • mode="InProc" ：默认值。由asp.net辅助进程来存储会话状态数据；Custom 使用自定义数据来存储会话状态数据；Off 禁用会话状态；SQLServer 使用进程外SQL Server数据库保存会话状态数据；StateServer 使用进程外 ASP.NET 状态服务存储状态信息。默认情况下使用InProc模式来存储会话状态数据，这种模式的好处是存取速度快，缺点是比较占用内存，所以不宜在这种模式下存储大型的用户会话数据。
      • timeout="30" 会话超时为30分钟
      • stateConnectionString :指定Asp.net应用程序存储远程会话状态的服务器名，默认为本机
      • sqlConnectionString: 当用会话状态数据库时，在这里设置连接字符串
    • <globalization>节点：用于配置应用程序的全球化设置。fileEncoding可选属性：设置.aspx、.asmx 和 .asax 文件的存储编码。requestEncoding可选属性：设置客户端请求的编码，默认为UTF-8。responseEncoding可选属性：设置服务器端响应的编码，默认为UTF-8。

配置文件的读写操作

编辑

虽然web.config文件是一个XML文件，但是由于权限的原因它在部署中不能像操作普通XML文件那样进行修改，在.net中提供了一个类System.Configuration用于对web.config进行修改。 

using System; 
using System.Configuration; 
using System.Web; 
using System.Web.Configuration; 
/// <summary> 
/// ConfigurationOperator 的摘要说明 
/// </summary> 
public class ConfigurationOperator:IDisposable 
{ 
    private Configuration config; 
 public ConfigurationOperator():this(HttpContext.Current.Request.ApplicationPath) 
 { 
         
 } 
    public ConfigurationOperator(string path) 
    { 
        config = WebConfigurationManager.OpenWebConfiguration(path); 
    } 
    /// <summary>  
    /// 设置应用程序配置节点，如果已经存在此节点，则会修改该节点的值，否则添加此节点 
    /// </summary>  
    /// <param name="key">节点名称</param>  
    /// <param name="value">节点值</param>  
    public void SetAppSetting(string key, string value) 
    { 
        AppSettingsSection appSetting = (AppSettingsSection)config.GetSection("appSettings"); 
        if (appSetting.Settings[key] == null)//如果不存在此节点，则添加  
        { 
            appSetting.Settings.Add(key, value); 
        } 
        else//如果存在此节点，则修改  
        { 
            appSetting.Settings[key].Value = value; 
        } 
    } 
    /// <summary>  
    /// 设置数据库连接字符串节点，如果不存在此节点，则会添加此节点及对应的值，存在则修改  
    /// </summary>  
    /// <param name="key">节点名称</param>  
    /// <param name="value">节点值</param>  
    public void SetConnectionString(string key, string connectionString) 
    { 
        ConnectionStringsSection connectionSetting = (ConnectionStringsSection)config.GetSection("connectionStrings"); 
        if (connectionSetting.ConnectionStrings[key] == null)//如果不存在此节点，则添加  
        { 
            ConnectionStringSettings connectionStringSettings = new ConnectionStringSettings(key, connectionString); 
            connectionSetting.ConnectionStrings.Add(connectionStringSettings); 
        } 
        else//如果存在此节点，则修改  
        { 
            connectionSetting.ConnectionStrings[key].ConnectionString = connectionString; 
        } 
    } 
    /// <summary>  
    /// 保存所作的修改  
    /// </summary>  
    public void Save() 
    { 
        config.Save(); 
        config = null; 
    } 
    public void Dispose() 
    { 
        if (config != null) 
        { 
            config.Save(); 
        } 
    } 
}

使用上述代码： 

using System; 
using System.Data; 
using System.Configuration; 
using System.Collections; 
using System.Web; 
using System.Web.Security; 
using System.Web.UI; 
using System.Web.UI.WebControls; 
using System.Web.UI.WebControls.WebParts; 
using System.Web.UI.HtmlControls; 
using System.Web.Configuration;//注意添加这个命名空间 
public partial class ConfigModifyDemo : System.Web.UI.Page 
{ 
    protected void Page_Load(object sender, EventArgs e) 
    { 
    } 
    protected void btnModify_Click(object sender, EventArgs e) 
    { 
        string appSetting = txtAppSetting.Text;//appSetting子节点值 
        string connectionString = txtConnectionString.Text;//连接字符串 
        string key = txtKey.Text;//appSetting子节点Key 
        string connectionName = txtConnectionName.Text;//连接Name 
        ConfigurationOperator op = new ConfigurationOperator(); 
        op.SetAppSetting(key, appSetting); 
        op.SetConnectionString(connectionName, connectionString); 
        op.Save(); 
    } 
     
}

搜索顺序

编辑

搜索顺序：

  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应用程序的重启。

常见的配置

编辑

connectionStrings配置（这个一般用来配置数据库连接）： 

 <connectionStrings>
   <add name="Default" connectionString="Server=.; Database=Inferno;User ID=sa; Password=pwd123;MultipleActiveResultSets=true" providerName="System.Data.SqlClient" />
 </connectionStrings>

获取： 

 string dbStr=ConfigurationManager.ConnectionStrings["Default"].ConnectionString;

appSettings配置（这个一般用来配置不确定的或者需要用户配置的内容） 

<appSettings>
   <add key="webpages:Version" value="3.0.0.0" />
   <add key="webpages:Enabled" value="false" />
   <add key="ClientValidationEnabled" value="true" />
   <add key="UnobtrusiveJavaScriptEnabled" value="true" />
</appSettings>

获取 

string clientValidationEnabled= ConfigurationManager.AppSettings["ClientValidationEnabled"].ToString();
检索自“https://zh.wikibooks.org/w/index.php?title=ASP.NET/web.config&oldid=166208”