如何正确配置ASP.NET网站？

1. 核心配置文件：web.config 是什么，它的基本结构。
2. 常用配置节详解：你最常需要配置的部分，如连接字符串、应用程序设置、认证授权等。
3. 不同 ASP.NET 版本的配置差异：ASP.NET Web Forms vs. ASP.NET Core。
4. 高级配置：如自定义配置、加密、发布和部署时的配置转换。
5. 最佳实践和工具。

核心配置文件：web.config

web.config 是 ASP.NET Web Forms 和旧版 ASP.NET MVC 应用的主要配置文件，它是一个 XML 文件，位于应用程序的根目录下，当应用程序启动时，ASP.NET 运行时会自动读取并解析这个文件。

web.config 的基本结构

一个典型的 web.config 文件结构如下：

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <!-- 1. 配置节处理程序声明 -->
  <!-- 告诉 IIS 如何解析下面的配置节 -->
  <configSections>
    <!-- ... -->
  </configSections>
  <!-- 2. 共享配置 (可选，在 IIS 中) -->
  <location path="." inheritInChildApplications="false">
    <system.webServer>
      <!-- ... -->
    </system.webServer>
  </location>
  <!-- 3. 应用程序核心配置 -->
  <system.web>
    <!-- ... -->
  </system.web>
  <!-- 4. ASP.NET Core 特定配置 (如果托管在 IIS 上) -->
  <aspNetCore processPath="dotnet" arguments=".\YourApp.dll" stdoutLogEnabled="false" stdoutLogFile=".\logs\stdout" hostingModel="inprocess">
    <!-- ... -->
  </aspNetCore>
  <!-- 5. 自定义配置节 -->
  <appSettings>
    <!-- ... -->
  </appSettings>
  <connectionStrings>
    <!-- ... -->
  </connectionStrings>
  <!-- 6. 其他配置 -->
  <system.codedom>
    <!-- ... -->
  </system.codedom>
</configuration>

常用配置节详解

A. <connectionStrings>

用于定义数据库连接字符串,这是最常用的配置之一，因为它使得更换数据库环境（开发、测试、生产）变得非常容易。

<connectionStrings>
  <!-- name 属性在代码中通过 ConfigurationManager.ConnectionStrings["MyDbConnection"].ConnectionString 来引用 -->
  <add name="MyDbConnection" 
       connectionString="Server=.;Database=MyDatabase;Integrated Security=True;" 
       providerName="System.Data.SqlClient" />
  <!-- 另一个连接字符串示例 -->
  <add name="AnotherDb" 
       connectionString="Data Source=prod-server;Initial Catalog=ProdDB;User Id=myuser;Password=mypassword;" 
       providerName="System.Data.SqlClient" />
</connectionStrings>

代码中读取:

// 需要引入 System.Configuration 命名空间
using System.Configuration;
string connString = ConfigurationManager.ConnectionStrings["MyDbConnection"].ConnectionString;

B. <appSettings>

用于存储简单的键值对配置,API 密钥、功能开关、文件路径等。

<appSettings>
  <!-- 在代码中通过 ConfigurationManager.AppSettings["key"] 来读取 -->
  <add key="ApiKey" value="12345-ABCDE" />
  <add key="EnableNewFeature" value="true" />
  <add key="UploadPath" value="C:\Uploads\" />
</appSettings>

代码中读取:

string apiKey = ConfigurationManager.AppSettings["ApiKey"];
bool enableFeature = bool.Parse(ConfigurationManager.AppSettings["EnableNewFeature"]);

注意: 在 ASP.NET Core 中，推荐使用 appsettings.json 和强类型的配置选项模式，它更灵活且类型安全。

C. <system.web>

这是 web.config 的核心，包含了大量关于 ASP.NET 运行时的配置。

• 编译:

  <compilation debug="true" targetFramework="4.8">
    <!-- ... -->
  </compilation>

  • debug="true": 启用调试模式，会生成更详细的 PDB 文件，并禁用页面编译。在生产环境中必须设为 false，以提高性能。
  • targetFramework: 指定应用程序针对的 .NET Framework 版本。

• 自定义错误:

  <customErrors mode="RemoteOnly" defaultRedirect="Error.aspx">
    <error statusCode="404" redirect="NotFound.aspx" />
    <error statusCode="500" redirect="ServerError.aspx" />
  </customErrors>

  • mode: On (对所有用户显示友好错误), Off (显示详细错误), RemoteOnly (对本地用户显示详细错误，远程用户显示友好错误)。生产环境通常用 RemoteOnly 或 On。

• 认证:

  <authentication mode="Forms">
    <forms loginUrl="Login.aspx" timeout="30" slidingExpiration="true" />
  </authentication>

  • mode: Windows, Forms, Passport, None。Forms 是最常用的基于表单的认证。

• 授权:

  <authorization>
    <!-- 拒绝所有匿名用户 -->
    <deny users="?" />
    <!-- 或者允许特定用户/角色 -->
    <!-- <allow users="admin,manager" />
         <allow roles="Developers" />
         <deny users="*" /> -->
  </authorization>

  这通常与认证配合使用,来控制哪些用户可以访问哪些资源。

• 会话状态:

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

  • mode: InProc (进程内，性能高但会随应用程序重启而丢失), StateServer (状态服务，进程外), SQLServer (SQL Server 数据库)。
  • timeout: 会话超时时间（分钟）。

不同 ASP.NET 版本的配置差异

这是一个非常重要的区别,很多新手会混淆。

ASP.NET Web Forms / MVC (旧版)

• 配置文件: web.config。
• 位置: 应用程序根目录。
• 特点: 所有配置都在一个巨大的 XML 文件中，结构是分层的（system.web, system.webServer 等），修改后通常需要回收应用程序池才能生效（部分配置如 appSettings 可以热加载）。

ASP.NET Core (新版)

• 配置文件: appsettings.json 是主要文件，appsettings.{Environment}.json 用于环境特定配置。web.config 不再是主要配置文件。
• 位置: appsettings.json 在项目根目录，发布后会复制到 wwwroot 目录下。
• 特点:
  1. JSON 格式: 更现代、更易读。
  2. 强类型配置: 可以将配置绑定到 C# 类（POCO），提供类型安全。
  3. 环境感知: 默认支持 Development, Staging, Production 等环境，并自动加载对应的 appsettings.{Environment}.json 文件。
  4. 多种配置源: 除了 JSON 文件，还可以从环境变量、命令行参数、Azure Key Vault、数据库等多种来源加载配置，并可以轻松地覆盖优先级。
  5. web.config 的角色: 在 ASP.NET Core 中，web.config 的作用非常有限，主要用于 IIS 托管时的配置，比如设置处理程序映射（aspNetCore 节）和 URL 重写规则。

ASP.NET Core appsettings.json 示例:

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*",
  "ConnectionStrings": {
    "DefaultConnection": "Server=.;Database=MyDb;Trusted_Connection=True;"
  },
  "ApiSettings": {
    "BaseUrl": "https://api.example.com",
    "TimeoutSeconds": 30
  }
}

在 ASP.NET Core 中读取强类型配置:

1. 创建一个配置类：

   public class ApiSettings
   {
       public string BaseUrl { get; set; }
       public int TimeoutSeconds { get; set; }
   }

2. 在 Program.cs 中注册：

   builder.Services.Configure<ApiSettings>(builder.Configuration.GetSection("ApiSettings"));

3. 在服务中通过依赖注入使用：

   public class MyService
   {
       private readonly ApiSettings _apiSettings;
       public MyService(IOptions<ApiSettings> apiSettings)
       {
           _apiSettings = apiSettings.Value;
       }
       // ...
   }

高级配置

A. 自定义配置节

appSettings 不够用，你可以定义自己的配置节。

1. 在 configSections 中声明:

   <configSections>
     <section name="myCustomSettings" type="MyApp.MyConfigSectionHandler, MyApp" />
   </configSections>

2. 在配置文件中定义节:

   <myCustomSettings>
     <setting name="SomeValue" value="Hello World" />
   </myCustomSettings>

3. 创建 C# 处理程序 (需要继承 ConfigurationSection 并使用属性标记):

   public class MyConfigSection : ConfigurationSection
   {
       [ConfigurationProperty("setting", IsRequired = true)]
       public string SettingValue
       {
           get { return (string)this["setting"]; }
           set { this["setting"] = value; }
       }
   }

   然后通过 MyConfigSection config = (MyConfigSection)ConfigurationManager.GetSection("myCustomSettings"); 来读取。

B. 配置转换

在部署时,你需要将开发环境的配置（如连接字符串）转换为生产环境的配置，手动修改 web.config 既繁琐又容易出错。配置转换文件可以解决这个问题。

• 文件命名: web.{EnvironmentName}.config，web.Development.config 和 web.Production.config。
• 工作原理: 发布时，MSBuild 会根据目标环境，将转换文件应用到主 web.config 上。
• 语法: 使用 xdt:Transform 和 xdt:Locator 属性。
  • Replace: 替换整个元素。
  • Insert: 插入元素。
  • SetAttributes: 设置元素的属性。

示例 web.Production.config:

<?xml version="1.0"?>
<configuration xmlns:xdt="http://schemas.microsoft.com/XML-Document-Transform">
  <!-- 替换连接字符串 -->
  <connectionStrings>
    <add name="MyDbConnection" 
         connectionString="Data Source=prod-server;Database=ProdDB;User Id=myuser;Password=mypassword;" 
         providerName="System.Data.SqlClient" 
         xdt:Transform="Replace" xdt:Locator="Match(name)"/>
  </connectionStrings>
  <!-- 将调试模式设为 false -->
  <system.web>
    <compilation xdt:Transform="SetAttributes(debug)" debug="false" />
  </system.web>
</configuration>

C. 配置节加密

为了保护敏感信息（如数据库密码），你可以对 web.config 中的特定节（如 connectionStrings）进行加密。

• 工具: 使用 aspnet_regiis.exe (位于 .NET Framework 目录下)。

• 命令示例:

  # 加密 connectionStrings 节
  aspnet_regiis -pef "connectionStrings" "C:\path\to\your\app" -prov "DataProtectionConfigurationProvider"
  # 解密
  aspnet_regiis -pdf "connectionStrings" "C:\path\to\your\app"

• 注意: 加密是针对服务器环境的，开发机上加密的配置文件无法直接发布到生产服务器，因为解密密钥不同，通常在部署脚本中执行加密操作。

最佳实践和工具

1. 不要提交敏感信息到 Git:

   • 将 web.config 中的敏感部分（如连接字符串、API密钥）移出。
   • 使用 web.config 的 transform 功能，在开发 web.config 中使用占位符。
   • 将生产环境的 web.config 放在 .gitignore 中，通过部署流程自动生成。

2. 使用配置文件转换:

   • 对于任何需要跨环境部署的项目,都应使用 web.config 转换，这是行业标准做法。

3. 为 ASP.NET Core 使用强类型配置:

   • 利用 IOptions<T> 模式，使你的代码更健壮、更易于测试。

4. 使用 Secret Manager (仅限开发环境):

   • 在 ASP.NET Core 开发中，使用 dotnet user-secrets 命令行工具来存储本地开发环境的敏感信息，这些信息不会提交到 Git。

5. 利用 IIS 管理器:

   • IIS 管理器提供了一个图形界面来编辑 web.config 的许多部分（如 URL 重写、HTTP 重定向、处理程序映射等），非常方便。

希望这份详细的指南能帮助你全面了解 ASP.NET 网站的配置！如果你有具体某个配置节的问题，可以随时提问。