.NET 应用如何优雅的做功能开关(Feature Flag)

.NET 应用如何优雅的做功能开关(Feature Flag)
微信公众号“汪宇杰博客”

导语

曾经,我们要在应用程序里做功能开关,就避免不了在配置文件里加上一堆 bool 类型的配置项,然后在代码里用 if else 去判断。尽管这种做法是可行的,但我们现在有办法让代码更加整洁,避免成堆的 if else 出现。

.NET 功能管理库

微软为了解决常见的功能开关问题场景,推出了 .NET Core Feature Management 库。它由 Azure 团队发布,并属于 Azure 文档的一部分,但我发现就算在没有 Azure 环境的情况下,它依然可以正常全功能运行

Azure 在此的作用仅仅是用 Azure App Configuration 作为功能开关的数据源,而我们完全可以用本地的 appsettings.json 来替代,避免了购买 Azure 从而落魄街头的风险

安装功能管理库

以我的博客系统为例,我的应用是 ASP.NET MVC / Web API类型的,我需要添加的包为 Microsoft.FeatureManagement.AspNetCore。如果你的应用并非ASP.NET,可以只添加 Microsoft.FeatureManagement

<PackageReference Include="Microsoft.FeatureManagement" Version="2.2.0" />

然后注册到 DI 里去

using Microsoft.FeatureManagement;

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddFeatureManagement();
    }
}

添加功能开关配置项

以我的博客系统为例,原先我在 AppSettings section 中有两个bool类型的配置项,现在就可以迁移到名为 FeatureManagement 的新 section 里。

.NET 应用如何优雅的做功能开关(Feature Flag)

相对应的,在 C# 代码里,去掉原来的项,添加一个新的枚举类型,值的名称对应配置项的名称。

这个枚举类型不是必须的,但非常建议创建枚举,这是为了保证在使用功能开关的时候有强类型支持,避免用string导致哪里名字没改对造成996。

.NET 应用如何优雅的做功能开关(Feature Flag)

使用功能开关

我们只需从DI里拿到 IFeatureManager 的实例,即可判断功能开关是否打开。例如:

IFeatureManager featureManager;
...
if (await featureManager.IsEnabledAsync(nameof(MyFeatureFlags.FeatureA)))
{
    // 执行代码
}

在 ASP.NET 项目里,最方便的就是通过构造函数获取 IFeatureManager 的实例

public class HomeController : Controller
{
    private readonly IFeatureManager _featureManager;
    public HomeController(IFeatureManager featureManager)
    {
        _featureManager = featureManager;
    }
}

那么问题来了,说好的少写 if else 呢?这个 IsEnabledAsync 不还是得写 if?

其实 Microsoft.FeatureManagement.AspNetCore 这个包包括了 MVC / Web API 项目所需要用到的许多助手功能。可以让我们避免大量的 if else。

在 Controller 级别添加功能开关

还是以我博客系统为例,我的 GraphController 只有在 EnableWebApi 开关打开的时候才响应用户请求,那么本来的 if else 判断现在就可以:

[FeatureGate(FeatureFlags.EnableWebApi)]
// ... 
public class GraphController : ControllerBase 
{
// ...
}

是不是很爽?

在 Action 级别添加功能开关

[FeatureGate(FeatureFlags.EnableAudit)]
public async Task<IActionResult> ClearAuditLogs()
{
    // ...
}

在 View 上添加功能开关

先在 _ViewImports.cshtml 中添加 taghelper 声明。

@addTagHelper *, Microsoft.FeatureManagement.AspNetCore

然后就可以用 <feature> 标签选择性的渲染 HTML 内容了!

<feature name="FeatureA">
    <p>This can only be seen if 'FeatureA' is enabled.</p>
</feature>

对于feature关闭才显示的内容,加个 negate 就好了

<feature name="FeatureA" negate="true">
    <p>This will be shown if 'FeatureA' is disabled.</p>
</feature>

还可用  All, Any 属性控制多个功能开关的显示处理。All 表示列出的功能得全启用才执行,Any 表示列出的功能里任意一个为 true 就可以执行。

<feature name="FeatureA, FeatureB" requirement="All">
    <p>This can only be seen if 'FeatureA' and 'FeatureB' are enabled.</p>
</feature>
<feature name="FeatureA, FeatureB" requirement="Any">
    <p>This can be seen if 'FeatureA', 'FeatureB', or both are enabled.</p>
</feature>

根据功能开关添加 Filter

使用 AddForFeature() 拓展方法

using Microsoft.FeatureManagement.FeatureFilters;

IConfiguration Configuration { get; set;}

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc(options => {
        options.Filters.AddForFeature<SomeMvcFilter>(nameof(MyFeatureFlags.FeatureA));
    });
}

根据功能开关添加 Middleware

app.UseMiddlewareForFeature<ThirdPartyMiddleware>(nameof(MyFeatureFlags.FeatureA));

或者

app.UseForFeature(featureName, appBuilder => {
    appBuilder.UseMiddleware<T>();
});

小提示

功能开关的配置值更改,无需重启应用程序,修改配置文件后可以热更新,立即生效!

另外,如果你足够有钱,也推荐试试 Azure App Configuration,将你的应用功能开关放在云端统一管理,可以非常方便的针对用户群体配置 A/B,蓝绿测试哦!

参考文档:https://docs.microsoft.com/en-us/azure/azure-app-configuration/use-feature-flags-dotnet-core?WT.mc_id=AZ-MVP-5002809

.NET 应用如何优雅的做功能开关(Feature Flag)
汪宇杰博客
Azure | .NET | 微软 MVP
无广告,不卖课,做纯粹的技术公众号

原文出处:微信公众号【汪宇杰 汪宇杰博客】

原文链接:https://mp.weixin.qq.com/s/y-IEBb1z4nItieXi_j7Cmw

本文观点不代表Dotnet9立场,转载请联系原作者。

发表评论

登录后才能评论