C# 配置文件app.config 和 web.config详解_C#

一、引言

在 c# 的应用开发中，配置文件就像是幕后的大管家，默默管理着应用程序的各种设置。今天，我们就来深入探索一下 c# 中极为重要的两个配置文件：app.config 和 web.config。无论是开发 windows 应用程序，还是构建asp.net web 应用，它们都发挥着关键作用。通过合理运用这两个配置文件，开发者能够轻松调整应用程序的行为，而无需对代码进行繁琐的修改，大大提升了开发效率和应用的灵活性。接下来，就让我们一起揭开它们的神秘面纱吧！

二、初相识：app.config 与 web.config

2.1 两者的定义与用途

app.config 是 windows 应用程序（如控制台应用程序、windows forms 应用程序）的专属配置文件。它如同一个精密的设置箱，将应用程序所需的各种配置信息，如数据库连接字符串、应用程序的默认设置等，以 xml 格式进行存储。这种存储方式使得开发者在后期维护和调整应用程序时，无需重新编译整个项目，只需轻松修改 app.config 文件中的相关配置，就能实现应用程序行为的改变。例如，在一个 windows forms 的财务管理应用程序中，通过 app.config 可以方便地配置数据库连接字符串，当数据库服务器地址发生变化时，直接修改配置文件中的地址信息，应用程序就能顺利连接到新的数据库。

而 web.config 则是asp.net web 应用程序的得力配置助手。它承担着存储 web 应用程序配置设置的重任，包括但不限于身份验证方式、授权规则、页面编译设置等。以一个在线商城的 web 应用为例，web.config 可以配置用户的身份验证模式为表单验证，同时指定登录页面的 url，还能设置页面的编译调试模式，在开发阶段设置为调试模式以便及时发现错误，上线后切换为发布模式提高性能。

2.2 它们的相同与不同之处

从结构上看，app.config 和 web.config 极为相似，都采用 xml 格式，拥有清晰的层次结构，以作为根节点，内部包含多个子节点用于不同类型配置信息的存储。

在适用场景方面，它们有着明确的分工。app.config 专注于 windows 应用程序的配置，而 web.config 则全心全意为asp.net web 应用程序服务。例如，一个桌面版的绘图软件使用 app.config 配置画笔颜色、画布尺寸等默认设置；而一个在线绘图的 web 应用则依靠 web.config 来配置用户的访问权限、页面的布局样式等与 web 相关的设置。

部分配置节点在两者中是通用的，像节点，都用于存储简单的键值对配置信息。在一个跨平台的新闻阅读应用中，无论是 windows 桌面端还是 web 端，都可以通过节点配置新闻源的 url。然而，也有一些节点是各自特有的。比如，web.config 中的<system.web>节点，用于全面配置asp.net应用程序的各种 web 相关特性，如身份验证、授权、会话状态等；而 app.config 中则没有这一特定节点，因为 windows 应用程序不需要处理这些 web 相关的功能。

三、创建简单示例深入了解

3.1 基于 c# 控制台应用，创建并配置 app.config

3.1.1 新建控制台应用项目

打开 visual studio，在起始页面中点击 “创建新项目”。在弹出的 “创建新项目” 对话框里，左侧筛选器选择 “语言” 为 “c#”，“平台” 选择 “windows”，“项目类型” 选择 “控制台”。接着，在中间的项目模板列表中，选中 “控制台应用 (.net core)” （若使用的是.net framework，可选择对应的控制台应用模板），在下方 “名称” 处输入项目名称，比如 “consoleappconfigdemo”，设置好 “位置” 和 “解决方案名称” 后，点击 “创建” 按钮，一个全新的 c# 控制台应用项目便创建完成。

3.1.2 编写核心代码

在项目中找到 “program.cs” 文件，双击打开。在其中输入如下代码：

using system;
using system.configuration;
namespace consoleappconfigdemo
{
    class program
    {
        static void main(string[] args)
        {
            // 读取配置文件中的值
            string appname = configurationmanager.appsettings["appname"];
            int portnumber = convert.toint32(configurationmanager.appsettings["portnumber"]);
            console.writeline("应用程序名称: " + appname);
            console.writeline("监听端口: " + portnumber);
            console.readline();
        }
    }
}

上述代码中，通过引入system.configuration命名空间，利用configurationmanager.appsettings来获取app.config文件中定义的配置值。其中，appname和portnumber是我们后续将在app.config文件中配置的键名。

3.1.3 构建并配置 app.config 文件

在项目的解决方案资源管理器中，右键点击项目名称，选择 “添加” -> “新建项”。在弹出的 “添加新项” 对话框中，选择 “应用程序配置文件”，保持默认名称 “app.config”，点击 “添加” 按钮。此时，项目中便生成了app.config文件。

为app.config文件添加如下内容：

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <appsettings>
    <!-- 配置应用程序名称 -->
    <add key="appname" value="我的控制台应用"/>
    <!-- 配置监听端口 -->
    <add key="portnumber" value="8080"/>
  </appsettings>
</configuration>

在这段配置中，节点用于存储一系列键值对形式的配置信息。标签用于添加具体的配置项，其中key属性指定配置项的键名，value属性指定对应的值。比如这里的appname键对应的值为 “我的控制台应用”，portnumber键对应的值为 “8080” 。

3.2 基于asp.net web 应用，创建并配置 web.config

3.2.1 新建 web 应用项目

打开 visual studio，点击 “创建新项目”。在 “创建新项目” 对话框中，左侧筛选器按 “语言” 选择 “c#”，“平台” 选择 “web”，“项目类型” 选择 “asp.net”。中间模板列表里选择 “asp.net web 应用程序 (.net core)”（若基于.net framework，选择对应的asp.net web 应用程序模板），在下方输入项目名称，如 “webappconfigdemo”，设置好存放路径和解决方案名称后，点击 “创建”。在弹出的 “创建asp.net web 应用程序” 对话框中，选择合适的模板，如 “空” 模板，然后点击 “创建”，项目创建完成。

3.2.2 编写 web 应用代码

在项目中找到 “pages” 文件夹（若使用的是传统的asp.net web forms，找到 “default.aspx.cs” 文件），在 “index.cshtml.cs” 文件中添加如下代码：

using system;
using system.configuration;
using microsoft.aspnetcore.mvc.razorpages;
namespace webappconfigdemo.pages
{
    public class indexmodel : pagemodel
    {
        public string appname { get; set; }
        public int portnumber { get; set; }
        public void onget()
        {
            // 读取配置文件中的值
            appname = configurationmanager.appsettings["appname"];
            portnumber = convert.toint32(configurationmanager.appsettings["portnumber"]);
        }
    }
}

在上述代码中，通过configurationmanager.appsettings从web.config文件中读取配置值。appname和portnumber属性用于在页面中展示读取到的配置信息。onget方法在页面加载时被调用，负责从配置文件中获取数据。

同时，在 “index.cshtml” 文件中添加如下代码，用于展示配置信息：

@page
@model webappconfigdemo.pages.indexmodel
@{
    viewdata["title"] = "首页";
}
<div>
    <p>应用程序名称: @model.appname</p>
    <p>监听端口: @model.portnumber</p>
</div>

这段代码通过@model来访问indexmodel中的属性，将从配置文件中读取到的应用程序名称和监听端口展示在页面上。

3.2.3 生成并配置 web.config 文件

若项目基于asp.net core，在项目创建完成后，根目录下会自动生成web.config文件（若没有，可手动添加）。若基于传统的asp.net web forms，同样会自动生成web.config文件。

为web.config文件添加如下内容：

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <appsettings>
    <!-- 配置应用程序名称 -->
    <add key="appname" value="我的web应用"/>
    <!-- 配置监听端口 -->
    <add key="portnumber" value="8080"/>
  </appsettings>
  <system.web>
    <compilation debug="true" targetframework="4.8" />
    <httpruntime targetframework="4.8" />
  </system.web>
</configuration>

在这段配置中，节点的作用与app.config中的类似，用于存储键值对形式的配置信息。<system.web>节点则是asp.net应用程序特有的配置节点，其中标签用于配置编译相关的设置，debug="true"表示启用调试模式，在开发过程中便于调试代码；targetframework指定了应用程序所使用的.net framework 版本。标签用于配置asp.net应用程序的运行时设置，targetframework同样指定了.net framework 版本。

四、深入剖析配置文件关键节点

4.1 appsettings 节点

在 c# 的配置文件中，节点就像一个灵活的 “小仓库”，专门用于存储各种简单的配置数据。它以键值对的形式组织信息，使得我们能够轻松地定义和获取应用程序所需的配置项。比如，在一个图片处理应用中，可以在节点中设置默认的图片保存路径。在app.config或web.config文件里添加如下配置：

<appsettings>
    <add key="defaultimagesavepath" value="c:\images\saved\" />
</appsettings>

在代码中，通过以下方式获取该配置值：

using system.configuration;
string savepath = configurationmanager.appsettings["defaultimagesavepath"];

这样，在应用程序的不同地方，都能方便地使用这个配置值，当需要修改默认保存路径时，直接在配置文件中更改即可，无需重新编译代码。

4.2 connectionstrings 节点

节点对于需要与数据库交互的应用程序而言，堪称重中之重。它专门用于定义数据库连接字符串，这些连接字符串包含了连接数据库所需的关键信息，如数据库服务器地址、数据库名称、用户名、密码等。以连接 sql server 数据库为例，在web.config文件中可以这样配置：

<connectionstrings>
    <add name="mydbconnection" 
         connectionstring="data source=yourservername;initial catalog=yourdatabasename;user id=yourusername;password=yourpassword" 
         providername="system.data.sqlclient" />
</connectionstrings>

在上述配置中，name属性为连接字符串指定了一个唯一的名称，方便在代码中引用；connectionstring属性详细定义了连接数据库的各项参数；providername指定了数据库提供程序。

在代码中，通过如下方式获取并使用该连接字符串：

using system.configuration;
using system.data.sqlclient;
string connectionstring = configurationmanager.connectionstrings["mydbconnection"].connectionstring;
using (sqlconnection connection = new sqlconnection(connectionstring))
{
    // 执行数据库操作
    string query = "select * from yourtable";
    sqlcommand command = new sqlcommand(query, connection);
    connection.open();
    // 处理查询结果
    sqldatareader reader = command.executereader();
    while (reader.read())
    {
        // 读取数据
    }
    reader.close();
}

正确配置节点，能够确保应用程序与数据库之间稳定、准确地连接，为数据的存储和读取提供坚实的基础。

4.3 system.web 节点（针对asp.net应用）

<system.web>节点是asp.net应用程序配置的核心部分，它涵盖了 web 应用程序运行的各个关键方面。

在编译设置方面，通过子节点进行配置。例如：

<system.web>
    <compilation debug="true" targetframework="4.8">
        <assemblies>
            <add assembly="system.data.datasetextensions, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089" />
        </assemblies>
    </compilation>
</system.web>

这里debug="true"表示在开发阶段启用调试模式，便于及时发现和解决代码中的问题；targetframework指定了应用程序所使用的.net framework 版本。子节点用于添加应用程序所需的程序集引用。

在身份验证方面，<system.web>节点也起着关键作用。以表单身份验证为例，配置如下：

<system.web>
    <authentication mode="forms">
        <forms loginurl="~/account/login.aspx" timeout="30" />
    </authentication>
</system.web>

上述配置中，mode="forms"指定了使用表单身份验证模式，loginurl指定了登录页面的 url，timeout设置了用户登录后的超时时间。

此外，<system.web>节点还可以配置授权规则、会话状态、页面处理等众多与 web 应用程序运行密切相关的设置，全面掌控着asp.net应用程序的行为和性能。

五、熟练掌握配置文件的使用技巧

5.1 读取配置文件中的信息

在 c# 中，读取配置文件中的信息是极为常见的操作。最常用的方式便是借助system.configuration.configurationmanager类。例如，当我们想要读取appsettings节点中的配置值时，假设在app.config或web.config文件中有如下配置：

<appsettings>
    <add key="databaseserver" value="yourservername" />
    <add key="databasename" value="yourdatabasename" />
</appsettings>

在代码中，通过以下方式轻松获取：

using system.configuration;
string server = configurationmanager.appsettings["databaseserver"];
string database = configurationmanager.appsettings["databasename"];

对于connectionstrings节点中的数据库连接字符串，若配置如下：

<connectionstrings>
    <add name="mydbconnection" 
         connectionstring="data source=yourservername;initial catalog=yourdatabasename;user id=yourusername;password=yourpassword" 
         providername="system.data.sqlclient" />
</connectionstrings>

则在代码中使用如下方式读取：

using system.configuration;
using system.data.sqlclient;
string connectionstring = configurationmanager.connectionstrings["mydbconnection"].connectionstring;
using (sqlconnection connection = new sqlconnection(connectionstring))
{
    // 执行数据库操作
}

此外，在asp.net core 项目中，还可以通过依赖注入的方式获取配置信息。首先，在startup.cs文件中配置服务：

using microsoft.extensions.configuration;
using microsoft.extensions.dependencyinjection;
public void configureservices(iservicecollection services)
{
    var config = new configurationbuilder()
       .setbasepath(directory.getcurrentdirectory())
       .addjsonfile("appsettings.json", optional: false, reloadonchange: true)
       .build();
    services.addsingleton<iconfiguration>(config);
}

然后，在需要使用配置信息的类中，通过构造函数注入iconfiguration：

public class myservice
{
    private readonly iconfiguration _config;
    public myservice(iconfiguration config)
    {
        _config = config;
    }
    public void dosomething()
    {
        string value = _config["somesetting"];
    }
}

5.2 更新配置文件（谨慎操作）

在运行时更新配置文件虽然可行，但务必谨慎为之，因为这一操作可能会引发应用程序的不稳定。在传统的 c# 项目中，若要更新app.config或web.config文件，可以使用system.configuration.configurationmanager.openexeconfiguration方法。例如，将appsettings节点中的appname配置值进行更新：

using system.configuration;
configuration config = configurationmanager.openexeconfiguration(configurationuserlevel.none);
config.appsettings.settings["appname"].value = "新的应用名称";
config.save(configurationsavemode.modified);
configurationmanager.refreshsection("appsettings");

上述代码中，首先打开配置文件，接着修改指定配置项的值，随后保存更改，并刷新appsettings节，使修改后的配置能够立即生效。

在asp.net core 项目中，更新配置文件的方式稍有不同。假设配置文件为appsettings.json，要更新其中的配置值，可以通过以下步骤：

using microsoft.extensions.configuration;
using microsoft.extensions.configuration.json;
using system.io;
var config = new configurationbuilder()
  .setbasepath(directory.getcurrentdirectory())
  .addjsonfile("appsettings.json", optional: false, reloadonchange: true)
  .build();
var appsettingssection = config.getsection("appsettings");
appsettingssection["somesetting"] = "新的值";
var jsonconfig = jsonconvert.serializeobject(config.asenumerable());
file.writealltext("appsettings.json", jsonconfig);

在此过程中，先构建配置对象，获取需要更新的配置节，修改配置值后，将配置对象重新序列化为 json 格式，并写回配置文件。不过，在实际应用中，尤其是在生产环境下，这种直接在运行时更新配置文件的操作应经过充分的测试和评估，以避免对应用程序的正常运行造成不良影响。

六、其他进阶配置选项拓展

6.1 自定义配置节

在实际的项目开发中，有时现有的标准配置节点无法满足复杂的业务需求，这时自定义配置节就派上了用场。自定义配置节允许我们根据项目的特定需求，灵活地定义和组织配置信息。

实现自定义配置节主要分为两个关键步骤。首先，需要编写一个配置节处理器类。这个类要继承自configurationsection类，通过它来定义我们所需的配置属性。例如，我们创建一个用于管理系统用户权限配置的类：

using system.configuration;
public class userpermissionssection : configurationsection
{
    [configurationproperty("adminpermissions", isrequired = true)]
    public string adminpermissions
    {
        get { return (string)this["adminpermissions"]; }
        set { this["adminpermissions"] = value; }
    }
    [configurationproperty("userpermissions", isrequired = true)]
    public string userpermissions
    {
        get { return (string)this["userpermissions"]; }
        set { this["userpermissions"] = value; }
    }
}

在上述代码中，userpermissionssection类定义了两个属性adminpermissions和userpermissions，用于存储管理员和普通用户的权限信息。configurationproperty特性用于指定属性的相关配置，如是否为必需属性等。

接着，在app.config或web.config文件中声明这个自定义配置节。在文件的节点内添加如下内容：

<configsections>
    <section name="userpermissions" type="namespace.userpermissionssection, assemblyname" />
</configsections>

这里的name属性指定了在配置文件中引用该配置节时使用的名称，type属性指定了配置节处理器类的完整命名空间和所在程序集名称。随后，在节点下添加自定义配置节的具体配置：

<userpermissions>
    <adminpermissions>fullaccess</adminpermissions>
    <userpermissions>limitedaccess</userpermissions>
</userpermissions>

这样，在代码中就可以通过configurationmanager.getsection方法获取自定义配置节的信息，并进行相应的处理。例如：

userpermissionssection userpermissions = (userpermissionssection)configurationmanager.getsection("userpermissions");
string adminpermissions = userpermissions.adminpermissions;
string userpermissionsvalue = userpermissions.userpermissions;

6.2 加密配置文件敏感信息

在当今注重数据安全的环境下，配置文件中的敏感信息，如数据库连接字符串、api 密钥等，一旦泄露，可能会给应用程序带来严重的安全风险。因此，对配置文件中的部分或全部内容进行加密就显得尤为重要。

在 c# 中，可以借助aspnet_regiis.exe工具来实现配置文件的加密。以加密web.config文件中的节点为例，在命令提示符中，切换到.net framework对应的版本目录（例如c:\windows[microsoft.net](http://microsoft.net)\framework\v4.8.04084），然后执行以下命令：

aspnet_regiis -pe "connectionstrings" -app "/yourapplicationname" -prov "dataprotectionconfigurationprovider"

上述命令中，-pe表示加密操作，"connectionstrings"指定了要加密的节点名称，-app指定了应用程序的虚拟路径，-prov指定了加密提供程序。执行该命令后，web.config文件中的节点内容将被加密，加密后的内容类似如下：

<connectionstrings configprotectionprovider="dataprotectionconfigurationprovider">
    <encrypteddata>
        <cipherdata>
            <ciphervalue>...</ciphervalue>
        </cipherdata>
    </encrypteddata>
</connectionstrings>

当应用程序运行时，.net 会自动使用指定的加密提供程序对加密内容进行解密，开发人员在代码中无需额外编写解密代码，就可以像往常一样通过configurationmanager.connectionstrings获取连接字符串。

如果需要对app.config文件进行加密，由于aspnet_regiis.exe工具主要针对web.config，可以先将app.config重命名为web.config，执行加密操作后再改回原名。同时，在实际应用中，要妥善保管加密密钥，避免密钥泄露导致加密失去意义。例如，可以将密钥存储在安全的服务器配置中，只有授权的系统管理员才能访问。

七、总结回顾

在本次 c# 配置文件的探索之旅中，我们深入了解了 app.config 和 web.config 的诸多奥秘。从它们的基础定义、创建与配置方法，到关键节点的剖析，再到读取、更新以及进阶的自定义配置节和加密敏感信息等操作，每一步都为我们在 c# 应用开发中灵活管理配置提供了有力支持。

这两个配置文件就如同开发中的得力助手，让我们能够轻松应对各种配置需求，无论是简单的应用程序设置，还是复杂的数据库连接、安全配置等。希望大家在今后的 c# 开发项目中，能够熟练运用这些知识，根据项目的实际需求，巧妙地配置 app.config 和 web.config，为打造高效、稳定且安全的应用程序奠定坚实的基础。让我们在代码的世界里，借助配置文件的力量，创造出更加优秀的软件作品。

到此这篇关于c# 配置文件app.config 和 web.config的文章就介绍到这了,更多相关c# app.config 和 web.config内容请搜索代码网以前的文章或继续浏览下面的相关文章希望大家以后多多支持代码网！