使用 Minimal API 改造动态文件提供者

Posted 2021-08-29 dotNET跨平台

使用 Minimal API 改造动态文件提供者

Intro

之前介绍过一个基于动态文件提供者来实现静态网站的动态更新，可以参考 ASP.NET Core 实现一个简单的静态网站滚动更新，在 Minimal API 出现之后想改造成 Minimal API 的写法，但是由于之前版本的 Minimal API 有点问题，Configuration Reload 的时候没有生效，所以没有使用 Minimal API 的形式，在 .NET 6 Preview 6 中这个问题被修复了，所以最近把这个应用使用 Minimal API 改造了一下

Issue

之前的版本中 Minimal API 存在的问题是这样的，当我们在应用中对 Configuration 进行 Reload 的时候，并不会触发配置变化，详细可以参考这个 issue：https://github.com/dotnet/aspnetcore/issues/34056

为了方便重现，我也写了一个简单的示例来重现这个问题（需要 .NET 6 Preview 4/5），有需要的童鞋可以参考

https://github.com/WeihanLi/AspNetCorePlayground/tree/master/MinimalAPIConfigurationIssue

Minimal API

之前的代码也使用了 C# 9 的新特性去掉了 Main 已经比较简洁了

var builder = Host.CreateDefaultBuilder(args);
builder.ConfigureWebHostDefaults(webHostBuilder =>
{
    webHostBuilder.ConfigureServices((context, services) =>
    {
        services.Configure<DynamicFileProviderOptions>(context.Configuration);
        services.AddSingleton<DynamicFileProvider>();
    });
    webHostBuilder.Configure(app =>
    {
        app.Map(new PathString("/redeploy"), appBuilder => appBuilder.Run(context =>
        {
            if (context.RequestServices.GetRequiredService<IConfiguration>() is ConfigurationRoot configuration)
            {
                var currentSlot = configuration["CurrentSlot"];
                configuration["CurrentSlot"] = "Slot2" != currentSlot ? "Slot2" : "Slot1";
                configuration.Reload();
                return context.Response.WriteAsync("Success");
            }
            return Task.CompletedTask;
        }));

        var dynamicFileProvider = app.ApplicationServices.GetRequiredService<DynamicFileProvider>();
        app.UseStaticFiles(new StaticFileOptions()
        {
            FileProvider = dynamicFileProvider,
        });
    });
});
var host = builder.Build();
host.Run();

使用 Minimal API 之后，代码更加简洁，代码量减少到原来代码量的一半左右，改造后的代码如下：

var builder = WebApplication.CreateBuilder(args);
builder.Services.Configure<DynamicFileProviderOptions>(builder.Configuration);
builder.Services.AddSingleton<DynamicFileProvider>();
var app = builder.Build();
app.Map(new PathString("/redeploy"), appBuilder => appBuilder.Run(context =>
{
    if (context.RequestServices.GetRequiredService<IConfiguration>() is IConfigurationRoot configuration)
    {
        var currentSlot = configuration["CurrentSlot"];
        configuration["CurrentSlot"] = "Slot2" != currentSlot ? "Slot2" : "Slot1";
        configuration.Reload();
        return context.Response.WriteAsync("Success");
    }
    return Task.CompletedTask;
}));
var dynamicFileProvider = app.Services.GetRequiredService<DynamicFileProvider>();
app.UseStaticFiles(new StaticFileOptions {FileProvider = dynamicFileProvider});
app.Run();

实际运行效果和原来一样

More

目前的实现感觉还是有一些复杂的，现在有两个 Configuration 对象，一个是属于 Host 构建过程中的，另外一个是应用实际运行过程中用到的，现在的解决方式相当于是给应用 Configuration 加了 callback 以触发 Host 构建过程中的 Configuration，后续也会继续优化使用 ChainedConfigurationSource 来简化当前的做法，可以参考：https://github.com/dotnet/aspnetcore/issues/34056#issuecomment-881038203

现在我们还手动引用了命名空间，结合此前介绍的隐式命名空间引用特性 .NET 6 即将到来的新特性 — 隐式命名空间引用 ，我们将可以移除命名空间引用，进一步精简我们的代码

References

• https://github.com/WeihanLi/SamplesInPractice/tree/master/DynamicStaticFileProvider

• https://github.com/dotnet/aspnetcore/issues/34056

• https://github.com/dotnet/aspnetcore/pull/33081

• https://github.com/WeihanLi/AspNetCorePlayground/tree/master/MinimalAPIConfigurationIssue

• https://github.com/dotnet/aspnetcore/compare/v6.0.0-preview.5.21301.17...v6.0.0-preview.6.21355.2#diff-64b273cd414609b9e4c6b0f7d1135735073283603825b1d2c19480357b0206c5R89