话说web.config之使用

 .net中提供了一种便捷的保存项目配置信息的办法，那就是利用配置文件，配置文件的文件后缀一般是.config，在asp.net中配置文件名一般默认是web.config。每个web.config文件都是基于XML的文本文件，并且可以保存到Web应用程序中的任何目录中。在发布Web应用程序时web.config文件并不编译进dll文件中。如果将来客户端发生了变化，仅仅需要用记事本打开web.config文件编辑相关设置就可以重新正常使用，非常方便。

配置文件节点说明
web.config文件是一个XML文件，它的根结点是<configuration>，在<configuration>节点下的常见子节点有：<configSections>、<appSettings>、<connectionStrings>和<system.web>。其中<appSettings>节点主要用于配置一些网站的应用配置信息，而<connectionStrings>节点主要用于配置网站的数据库连接字符串信息。
<system.web>节点主要是网站运行时的一些配置，它的常见节点有如下：
<appSettings>节点
<appSettings>节点主要用来存储asp.net应用程序的一些配置信息，比如上传文件的保存路径等，以下是一个例子：

1. <appSettings>
2.     <!--允许上传的图片格式类型-->
3.     <add key="ImageType" value=".jpg;.bmp;.gif;.png;.jpeg"/>
4.     <!--允许上传的文件类型-->
5.     <add key="FileType" value=".jpg;.bmp;.gif;.png;.jpeg;.pdf;.zip;.rar;.xls;.doc"/>
6. </appSettings>

对于<appSettings>节点中的值可以按照key来进行访问，以下就是一个读取key值为“FileType”节点值的例子：

1. string fileType=ConfigurationManager.AppSettings["FileType "];

<connectionStrings>节点
<connectionStrings>节点主要用于配置数据库连接的，我们可以<connectionStrings>节点中增加任意个节点来保存数据库连接字符串，将来在代码中通过代码的方式动态获取节点的值来实例化数据库连接对象，这样一旦部署的时候数据库连接信息发生变化我们仅需要更改此处的配置即可，而不必因为数据库连接信息的变化而需要改动程序代码和重新部署。
以下就是一个<connectionStrings>节点配置的例子：

1. <connectionStrings>
2.     <!--SQL Server数据库配置-->
3.     <add name="AspNetStudyConnectionString1" connectionString="Data Source=(local);Initial Catalog=AspNetStudy;User ID=sa;Password=sa"/>
4. </connectionStrings>

在代码中我们可以这么实例化数据库连接对象：

1. //读取web.config节点配置
2. string connectionString = ConfigurationManager.ConnectionStrings["AspNetStudyConnectionString1"].ConnectionString;
3. //实例化SqlConnection对象
4. SqlConnection connection = new SqlConnection(connectionString);

这样做的好处是一旦开发时所用的数据库和部署时的数据库不一致，仅仅需要用记事本之类的文本编辑工具编辑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，以避免这些详细的错误信息暴露了程序代码细节从而引来黑客的入侵。

<error>子节点
在<customErrors>节点下还包含有<error>子节点，这个节点主要是根据服务器的HTTP错误状态代码而重定向到我们自定义的错误页面，注意要使<error>子节点下的配置生效，必须将<customErrors>节点节点的Mode属性设置为“On”。下面是一个例子：

1. <customErrors mode="On" defaultRedirect="GenericErrorPage.htm">
2.      <error statusCode="403" redirect="403.htm" />
3.      <error statusCode="404" redirect="404.htm" />
4. </customErrors>

在上面的配置中如果用户访问的页面不存在就会跳转到404.htm页面，如果用户没有权限访问请求的页面则会跳转到403.htm页面，403.htm和404.htm页面都是我们自己添加的页面，我们可以在页面中给出友好的错误提示。

 <httpHandlers>节点
<httpHandlers>节点用于根据用户请求的URL和HTTP谓词将用户的请求交给相应的处理程序。可以在配置级别的任何层次配置此节点，也就是说可以针对某个特定目录下指定的特殊文件进行特殊处理。

下面是与machine.config文件同一目录下的web.config文件中的<httpHandlers>节点配置：

<httpRuntime>节点
<httpRuntime>节点用于对 ASP.NET HTTP 运行库设置。该节可以在计算机、站点、应用程序和子目录级别声明。
例如下面的配置控制用户最大能上传的文件为40M（40*1024K），最大超时时间为60秒，最大并发请求为100个。

1. <httpRuntime maxRequestLength="40960" executionTimeout="60" appRequestQueueLimit="100"/>

<pages>节点
<pages>节点用于表示对特定页设置，主要有三个属性，分别如下：
属性名 说明
buffer 是否启用了 HTTP 响应缓冲。
enableViewStateMac 是否应该对页的视图状态运行计算机身份验证检查 (MAC)，以放置用户篡改，默认为false，如果设置为true将会引起性能的降低。
validateRequest 是否验证用户输入中有跨站点脚本攻击和SQL注入式漏洞攻击，默认为true，如果出现匹配情况就会发 HttpRequestValidationException 异常。对于包含有在线文本编辑器页面一般自行验证用户输入而将此属性设为false。
下面就是一个配置节点的例子：

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

<sessionState>节点
<sessionState>节点用于配置当前asp.net应用程序的会话状态配置。以下就是一个常见配置：

1. <sessionState cookieless="false" mode="InProc" timeout="30" />

上面的节点配置是设置在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应用程序中的默认配置：

1. <globalization fileEncoding="utf-8" requestEncoding="utf-8" responseEncoding="utf-8"/>

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

配置文件的读写操作
 public class ConfigurationOperator : IDisposable
    {
        private Configuration config;
        /// <summary>
        /// base表示在调用该构造函数前，先调用基类指定参数的构造函数
        /// this表示在调用该构造函数前，先调用当前类非默认的构造函数
        /// </summary>
        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 SetAppSeting(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="connectionstring"></param>
        public void SetConnectionString(string key, string connectionstring)
        {
            ConnectionStringsSection connectionSetting = (ConnectionStringsSection)config.GetSection("connectStrings");
            if (connectionSetting.ConnectionStrings[key] == null)
            {
                ConnectionStringSettings connectionString = new ConnectionStringSettings(key, connectionstring);
                connectionSetting.ConnectionStrings.Add(connectionString);
            }
            else
            {
                connectionSetting.ConnectionStrings[key].ConnectionString = connectionstring;
            }
        }

        /// <summary>
        /// 保存修改
        /// </summary>
        public void Save()
        {
            config.Save();
            config = null;//资源回收
        }

        public void Dispose()
        {
            if (config != null)
                config.Save();
        }
       

       从执行结果可以看出我们的程序确实能做到修改和添加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应用程序是非常有帮助的。