教程：在 .NET Framework 应用中使用动态配置

项目
11/04/2024

应用程序配置中的数据可在 .NET Framework 应用中加载为应用设置。有关详细信息，请参阅此快速入门。但是，根据 .NET Framework 的设计，只能在应用重启时刷新应用设置。应用程序配置 .NET 提供程序是一个 .NET Standard 库。它支持动态缓存和刷新配置，而无需重启应用。本教程演示如何在 .NET Framework 控制台应用中实现动态配置更新。

在本教程中，你将了解如何执行以下操作：

设置 .NET Framework 应用，使其能够更新配置以响应应用程序配置存储区中的更改。
在应用程序中注入最新配置。

先决条件

具有活动订阅的 Azure 帐户。创建试用版订阅。
应用程序配置存储区。创建存储区。
Visual Studio
.NET Framework 4.7.2 或更高版本

添加键值

将以下键值添加到应用程序配置存储区，并让“标签”和“内容类型”保留默认值。有关如何使用 Azure 门户或 CLI 将键值添加到存储区的详细信息，请转到创建键值。

密钥	值
TestApp:Settings:Message	Azure 应用配置的数据

创建 .NET Framework 控制台应用

启动 Visual Studio 并选择“创建新项目”。
在“创建新项目”中，按“控制台”项目类型进行筛选，然后从项目模板列表中选择“控制台应用(.NET Framework)”，语言为 C# 。按“下一步”。
在配置新项目中，输入项目名称。在“Framework”下，选择“.NET Framework 4.7.2”或更高版本。按“创建”。

从应用配置重载数据

右键单击项目，然后选择“管理 NuGet 包” 。在“浏览”选项卡中，搜索以下 NuGet 包的最新版本并将其添加到项目中。

Microsoft.Extensions.Configuration.AzureAppConfiguration

打开“Program.cs”并添加以下命名空间。

using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Configuration.AzureAppConfiguration;

添加两个变量来存储与配置相关的对象。

private static IConfiguration _configuration;
private static IConfigurationRefresher _refresher;

更新 Main 方法，以便能用指定的刷新选项连接到应用配置。

static void Main(string[] args)
{
    var builder = new ConfigurationBuilder();
    builder.AddAzureAppConfiguration(options =>
    {
        options.Connect(Environment.GetEnvironmentVariable("ConnectionString"))
                // Load all keys that start with `TestApp:`.
                .Select("TestApp:*")
                // Configure to reload the key 'TestApp:Settings:Message' if it is modified.
                .ConfigureRefresh(refresh =>
                {
                    refresh.Register("TestApp:Settings:Message")
                           .SetCacheExpiration(TimeSpan.FromSeconds(10));
                });

        _refresher = options.GetRefresher();
    });

    _configuration = builder.Build();
    PrintMessage().Wait();
}

在 ConfigureRefresh 方法中，应用程序配置存储中的密钥注册用于监视更改。 Register 方法具有一个可选的布尔参数 refreshAll，该参数可用于指示在注册的密钥发生更改时是否应刷新所有配置值。在此示例中，只会刷新密钥 TestApp:Settings:Message。 SetCacheExpiration 方法指定向应用程序配发出新请求以检查任何配置更改之前必须经过的最小时间。在此示例中，替代默认的过期时间（30 秒），改为指定一个 10 秒的时间用于演示目的。

添加一个名为 PrintMessage() 的方法，该方法触发针对应用程序配置中配置数据的刷新操作。
```
private static async Task PrintMessage()
{
    Console.WriteLine(_configuration["TestApp:Settings:Message"] ?? "Hello world!");

    // Wait for the user to press Enter
    Console.ReadLine();

    await _refresher.TryRefreshAsync();
    Console.WriteLine(_configuration["TestApp:Settings:Message"] ?? "Hello world!");
}
```
单独调用 ConfigureRefresh 方法不会自动刷新配置。从接口 IConfigurationRefresher 调用 TryRefreshAsync 方法以触发刷新。此设计旨在避免请求发送到应用配置（即使应用程序处于空闲状态）。你可在你认为应用程序处于活动状态的位置包含 TryRefreshAsync 调用。例如，可以是在处理传入消息、订单或复杂任务迭代时。如果应用程序始终处于活动状态，则也可以是在计时器中。在此示例中，按 Enter 键时会调用 TryRefreshAsync。请注意，即使调用 TryRefreshAsync 因任何原因而失败，应用程序也将继续使用缓存的配置。当配置的缓存过期时间已过，并且应用程序活动再次触发 TryRefreshAsync 调用时，将进行另一次尝试。在配置的缓存过期时间过去之前调用 TryRefreshAsync 是一个空操作，因此，即使频繁调用，它的性能影响也很小。

在本地生成并运行应用

将名为 ConnectionString 的环境变量设置为在应用配置存储创建期间获得的只读密钥连接字符串。

如果使用 Windows 命令提示符，请运行以下命令：
```
setx ConnectionString "connection-string-of-your-app-configuration-store"
```
如果使用 Windows PowerShell，请运行以下命令：
```
$Env:ConnectionString = "connection-string-of-your-app-configuration-store"
```
重启 Visual Studio 以便使所做更改生效。
按 Ctrl+F5 生成并运行控制台应用。
在 Azure 门户中，导航到应用程序配置存储区的“配置资源管理器”，并更新以下键的值。

键值

TestApp:Settings:Message Azure 应用配置的数据 - 已更新
回到运行中的应用程序，按 Enter 键触发刷新，并在命令提示符或 PowerShell 窗口中打印更新的值。

注意

由于在指定刷新操作的配置时已使用 SetCacheExpiration 方法将缓存过期时间设置为 10 秒，因此只有在针对该设置进行刷新并已过去至少 10 秒以后，才会更新此配置设置的值。

键	值
TestApp:Settings:Message	Azure 应用配置的数据 - 已更新

清理资源

如果不想继续使用本文中创建的资源，请删除此处创建的资源组以避免产生费用。

重要

删除资源组的操作不可逆。将永久删除资源组以及其中的所有资源。请确保不要意外删除错误的资源组或资源。如果在包含要保留的其他资源的资源组中创建了本文的资源，请从相应的窗格中单独删除每个资源，而不是删除该资源组。

登录到 Azure 门户，然后选择“资源组”。
在“按名称筛选”框中，输入资源组的名称。
在结果列表中，选择资源组名称以查看概述。
选择“删除资源组”。
系统会要求确认是否删除资源组。重新键入资源组的名称进行确认，然后选择“删除”。

片刻之后，将会删除该资源组及其所有资源。

后续步骤

在本教程中，你已启用 .NET Framework 应用，以通过应用程序配置动态刷新配置设置。若要了解如何在 ASP.NET Web 应用程序 (.NET Framework) 中实现动态配置，请继续学习下一篇教程：

在 ASP.NET Web 应用程序中实现动态配置

若要了解如何使用 Azure 托管标识来简化对应用程序配置的访问，请继续学习下一篇教程：

托管标识集成