middleware是目前一些framework比較流行的概念,通常一個開發框架需要提供一些可擴展可定制化的功能。所以middleware這種pattern就很實用。
熟悉asp.net core的開發可能第一個想到的就是asp.net core的middleware,如下圖:
當一個http request進入到處理的pipeline后,先被一個個middleware嵌套的執行,完成后在一個個推出。如果我們需要一些定制化功能,比如想把每個request要做一個統計記錄,那開發可以自己寫個middleware,加入到這個pipeline里,這樣任何一個request都會從這個middleware通過,middleware就可以對request進行統計分析。
我自己整理了一下bot framework的middleware,如下圖:
可以看到當 Adapter 把 TurnContext 創建好后,就會開始一個個調用middleware,每一個middleware會通過調用next()
來觸發下一個middleware,在middleware pipeline的終點是ActivityHandler的OnTurnAsync()
方法。
如果一個middleware想要短路(Short circuiting)整個turn的處理,可以很簡單的不調用next來達到這個目的。
下面我們先來看一下IMiddleware接口:
public interface IMiddleware
{Task OnTurnAsync(ITurnContext turnContext, NextDelegate next, CancellationToken cancellationToken = default(CancellationToken));
}
一個最簡單的middleware如下:
public class MyMiddleware : IMiddleware
{public async Task OnTurnAsync(ITurnContext turnContext, NextDelegate next, CancellationToken cancellationToken = default){// some logicawait next(cancellationToken).ConfigureAwait(false);// more logic}
}
有了自己的middleware后,我們需要在我們自己的Adapter類的構造函數里,把middleware加入到middleware列表。
public class MyHandler : BotFrameworkHttpAdapter
{public MyHandler(IConfiguration configuration, ILogger<BotFrameworkHttpAdapter> logger): base(configuration, logger){Use(new MyMiddleware());}
}
Middleware的調用順序是如何的?
我們用代碼來說明,創建兩個middleware,A和B
public class MyHandler : BotFrameworkHttpAdapter
{public MyHandler(IConfiguration configuration, ILogger<BotFrameworkHttpAdapter> logger): base(configuration, logger){Use(new TestAMiddleware(logger));Use(new TestBMiddleware(logger));}
}public class TestAMiddleware : IMiddleware
{private readonly ILogger _logger;public TestAMiddleware(ILogger logger){_logger = logger;}public async Task OnTurnAsync(ITurnContext turnContext, NextDelegate next, CancellationToken cancellationToken = default){_logger.LogInformation("Middleware A begin");await next(cancellationToken).ConfigureAwait(false);_logger.LogInformation("Middleware A end");}
}public class TestBMiddleware : IMiddleware
{private readonly ILogger _logger;public TestBMiddleware(ILogger logger){_logger = logger;}public async Task OnTurnAsync(ITurnContext turnContext, NextDelegate next, CancellationToken cancellationToken = default){_logger.LogInformation("Middleware B begin");await next(cancellationToken).ConfigureAwait(false);_logger.LogInformation("Middleware B end");}
}
當在處理一個activity時,我們可以看到打印出來的log:
Middleware A beginMiddleware B beginOnMessageActivityAsyncMiddleware B endMiddleware A end
現在各位看到這里就清楚了吧,先通過Use()
加入的middleware將會先被調用到。