ASP .Net Core动态注册中间件

改错

我在之前的文章ASP .Net Core实现动态文件服务器中的有些内容是错误的,这篇文章主要也是为了纠正其中的内容。

有两个错误:

  1. 我在那篇文章里说

很可惜,这些个是不能够动态设定的,也就是这些设置必须在apiApp.RunAsync()之前设定,启动之后再设置就没用了。但是如果按默认的设定,把apiApp停了整个服务就会挂掉,没法走设定后重启的路线,因此得在主应用之下加一个寄生应用作为文件服务的专有应用。

这个说法也对也不对,在app.Run()之后确实没法加入新的中间件了,ASP .Net Core管道中的中间件是有顺序的,app.Run()不接收next参数,也就是在之后加入的中间件是怎么也不会通过的。不对的地方在于实际上是可以通过((IApplicationBuilder)app).New()来新建一个拥有一模一样的管道,来替换掉原来的管道的,新建之后加入需要的中间件然后Run,就可以了。

  1. 我上篇文章开启服务用的方法是UseStaticFiles和UseDirectoryBrowser,这也不能说错,但是不够简洁,实际上ASP .Net Core除了提供UseStaticFiles和UseDirectoryBrowser,还提供了一个综合两者的功能UseFileServer,使用方法如下:
var fileServerOption = new FileServerOptions();
fileServerOption.RequestPath = urlPath;
fileServerOption.FileProvider = new PhysicalFileProvider(physicalPath);
fileServerOption.StaticFileOptions.ServeUnknownFileTypes = true;
fileServerOption.EnableDirectoryBrowsing = true;
app.UseFileServer(fileServerOption);
  1. 还有最最最大一个错误,我在之前的文章里是使用新端口另开服务来实现的,使用dotnet命令不指定端口号启动应用时没有问题,但当指定端口号或者使用IIS这样的WEB容器来部署时就没法开启除配置之外的端口了。

中间件

讲Asp .Net Core中间件的文章蛮多的,官方文档也很详细,我简单说下,他的概念是应用收到网络请求后,会经过一系列处理,然后响应,这个流程就好像水流过自来水管一样,所以叫管道。中间各种处理流程就是中间件,通过app.Use()来注册,最后响应是用app.Run(),因此app.Run()算是管道的出口。还有一个app.Map(),是用来定义分支的,就好像自来水管的分叉,每个分支最终也要用app.Run()来定义出口。

app.Map()的使用方式大概是这样:

app.Map("/home", app=>{
    app.Run(async context =>
    {
        await context.Response.WriteAsync("Home Page");
    });
});

看形式还是蛮好理解的,分支其实针对不同路径的请求给与不同的响应,分支当然是可以多段的。上面也展示了app.Run(),做的也确实是响应的事情。再就是app.Use()的使用方式了:

app.Use(async (context, next) =>
{
    // Do something
    await next.Invoke();
});

看形式也比较高理解,我们在Use中可以对请求的context进行各种操作,然后通过next()或者await next.Invoke()把它交给下一个中间件。

其他的各种Use比如我们用到的UseFileServer,也都是内置的或者外置的扩展中间件。

动态注册中间件

在第一部分有提到可以用((IApplicationBuilder)app).New()的方式来创建一个新管道替换原有管道,所以需要创建一个中间件用来干这个事。

app.Use(async (context,next) => {
    if (Global.MiddlewareAction != null)
    {
        var builder = ((IApplicationBuilder)app).New();
        Global.MiddlewareAction(builder);
        builder.Run(next);
        await builder.Build()(context);
    }
    else
    {
        await next.Invoke(context);
    }
})

其中Global.MiddlewareActioAction<IApplicationBuilder>类型的委托,在需要动态注册中间件的时候给其赋值:

[HttpPost]
public async Task<string> SetFileServerAsync(FileServerDto fileDto)
{
    Global.MiddlewareAction = app =>
    {
        
        app.UseCors(options =>
        {
            options.AllowAnyOrigin()
                    .AllowAnyHeader()
                    .AllowAnyMethod();
        });
        var fileServerOption = new FileServerOptions();
        fileServerOption.RequestPath = fileDto.UrlPath;
        fileServerOption.FileProvider = new PhysicalFileProvider(fileDto.PhysicalPath);
        fileServerOption.StaticFileOptions.ServeUnknownFileTypes = true;
        fileServerOption.EnableDirectoryBrowsing = true;
        app.UseFileServer(fileServerOption);
    };
    return "success";
}

当Global.MiddlewareAction为空的时候直接交给下一个中间件,如果不为空,也就是表示需要动态注册中间件,则复制新管道,添加中间件,替换原管道。

当然上面这个做法非常原始和初级,我在微软Chris Ross的github上找到一个注册中间件的中间件示例

整合代码如下:

public static class MiddlewareInjectorExtensions
{
    public static IApplicationBuilder UseMiddlewareInjector(this IApplicationBuilder builder, MiddlewareInjectorOptions options)
    {
        return builder.UseMiddleware<MiddlewareInjectorMiddleware>(builder.New(), options);
    }
}

public class MiddlewareInjectorMiddleware
{
    private readonly RequestDelegate _next;
    private readonly IApplicationBuilder _builder;
    private readonly MiddlewareInjectorOptions _options;
    private RequestDelegate _subPipeline;

    public MiddlewareInjectorMiddleware(RequestDelegate next, IApplicationBuilder builder, MiddlewareInjectorOptions options)
    {
        _next = next ?? throw new ArgumentNullException(nameof(next));
        _builder = builder ?? throw new ArgumentNullException(nameof(builder));
        _options = options ?? throw new ArgumentNullException(nameof(options));
    }

    public Task Invoke(HttpContext httpContext)
    {
        var injector = _options.GetInjector();
        if (injector != null)
        {
            var builder = _builder.New();
            injector(builder);
            builder.Run(_next);
            _subPipeline = builder.Build();
        }

        if (_subPipeline != null)
        {
            return _subPipeline(httpContext);
        }

        return _next(httpContext);
    }
}

public class MiddlewareInjectorOptions
{
    private Action<IApplicationBuilder> _injector;

    public void InjectMiddleware(Action<IApplicationBuilder> builder)
    {
        Interlocked.Exchange(ref _injector, builder);
    }

    internal Action<IApplicationBuilder> GetInjector()
    {
        return Interlocked.Exchange(ref _injector, null);
    }
}

使用是首先对MiddlewareInjectorOptions注册单例

builder.Services.AddSingleton<MiddlewareInjectorOptions>();

然后注册中间件

var injectorOptions = app.Services.GetService<MiddlewareInjectorOptions>();
app.UseMiddlewareInjector(injectorOptions);

最后在使用的时候

[HttpPost]
public async Task<string> SetFileServerAsync(FileServerDto fileDto)
{
    _middlewareInjectorOptions.InjectMiddleware(app =>
    {
        app.UseCors(options =>
        {
            options.AllowAnyOrigin()
                    .AllowAnyHeader()
                    .AllowAnyMethod();
        });
        var fileServerOption = new FileServerOptions();
        fileServerOption.RequestPath = fileDto.UrlPath;
        fileServerOption.FileProvider = new PhysicalFileProvider(fileDto.PhysicalPath);
        fileServerOption.StaticFileOptions.ServeUnknownFileTypes = true;
        fileServerOption.EnableDirectoryBrowsing = true;
        app.UseFileServer(fileServerOption);
    });
    return "success";
}

大功告成,补完上一篇文章的漏洞。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,718评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,683评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,207评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,755评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,862评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,050评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,136评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,882评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,330评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,651评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,789评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,477评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,135评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,864评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,099评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,598评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,697评论 2 351

推荐阅读更多精彩内容