如何在 ASP.NET Core 中使用功能开关

.NET Core 中的 功能管理 (Feature Management) 包可用于实现 功能开关，什么意思呢？就是可以通过 功能开关 特性动态的改变应用程序的行为而不需要改变任何的业务逻辑代码，听起来是不是挺有意思，本篇我们就来讨论如何使用这个包。

安装 Feature Management 包

要想使用 功能管理，需要通过 NuGet 安装 Microsoft.FeatureManagement.AspNetCore，可通过 Visual Studio 2019 下的 NuGet Package Manager 可视化管理界面或者通过 .NET CLI 命令行工具输入如下命令。


dotnet add package Microsoft.FeatureManagement.AspNetCore

在 ASP.NET Core 中添加

为了能够在项目中用上 功能管理，需要在 Startup.ConfigureServices 方法下进行 service 注入，如下代码所示：


    public class Startup
    {
        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllersWithViews();
            services.AddFeatureManagement();
        }
    }

有一点要注意： 功能管理 中的 功能开关 读取的值来自于 .NET Core 中的配置文件，如果你想让 功能开关 的值来源于 Configuration 文件的不同节点，必须在 service 注册时单独指定一下，如下代码所示：


    public void ConfigureServices(IServiceCollection services)
    {
        services.AddFeatureManagement(options =>
        {
            options.UseConfiguration(Configuration.GetSection("IDGFeatureFlags"));
        });
    }

在 controller 中使用功能管理

为了能够在 Controller 中用上 功能管理(feature management)，需要通过依赖注入的方式将其注入到 Controller 中，如下代码所示:


public class HomeController : Controller
{
        private readonly ILogger<HomeController> _logger;
        private readonly IFeatureManager _featureManager;

        public HomeController(ILogger<HomeController> logger, IFeatureManagerSnapshot featureManager)
        {
            _logger = logger;
            _featureManager = featureManager;
        }
}

接下来在 appsettings.json 配置文件中定义一个名为 FeatureManagement 节点，文件内容参考如下：


{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "FeatureManagement": {
    "DbLogger": "true"
  },
  "AllowedHosts": "*"
}

使用 FeatureGate特性管控功能开关

可以使用 FeatureGate 特性来管控 Action 方法是否可以被执行，什么意思呢？先看如下代码。


    public class HomeController : Controller
    {
        private readonly ILogger<HomeController> _logger;
        private readonly IFeatureManager _featureManager;

        public HomeController(ILogger<HomeController> logger, IFeatureManagerSnapshot featureManager)
        {
            _logger = logger;
            _featureManager = featureManager;
        }

        [FeatureGate("DbLogger")]
        public IActionResult Index()
        {
            return View();
        }
    }

可以看到， Index 方法标注了 [FeatureGate("DbLogger")] 特性，这里面的 DbLogger 就是 appsettings.json 中的 DbLogger 节点的值，当值为 True 时，这个 Index 方法是可以被 HttpGet 所请求的，如下图：

当值为 False 时，这个 Index 方法将会抛出 404 错误，是不是很有意思哈，如下图所示：


{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "FeatureManagement": {
    "DbLogger": "false"
  },
  "AllowedHosts": "*"
}

用法就是这么一个用法，可以看到 .NET Core 对 功能管理 提供了开箱即用的支持，这确实是一个非常实用的特性，更多关于该知识点的介绍，可参考官网：https://docs.microsoft.com/en-us/azure/azure-app-configuration/use-feature-flags-dotnet-core

译文链接：https://www.infoworld.com/article/3481516/how-to-use-feature-flags-in-aspnet-core.html