我實現的中間件模式與 Express、Koa 類似。基于一個 context
進行操作,并使用這個 context
作為參數按順序運行一系列中間件。另外還傳遞一個 next
函數。如果調用了這個 next
函數,列表中的下一個中間件將被調用;如果不調用,鏈將被中斷。此外,(與 Express 不同,但與 Koa 類似)中間件可以是 async
函數或返回一個 Promise。
準備工作
首先描述中間件:
/**
* 傳遞給中間件的 'next' 函數
*/
type Next = () => void | Promise<void>;
/**
* 一個中間件
*/
type Middleware<T> =
(context: T, next: Next) => Promise<void> | void;
Middleware
是實際的異步/非異步中間件函數。我為 Next
定義了一個類型,這樣就不需要多次編寫它了。
如何使用它
假設我們有一個“應用程序”、一組中間件和一個我們想要操作的上下文。通過以下代碼表示:
/**
* 應用程序的上下文類型。
* 在 'koa' 中,這個對象將持有對 'request' 和 'response' 的引用,
* 但我們的上下文只有一個屬性。
*/
type MyContext = {
a: number;
}
/**
* 創建應用程序對象
*/
const app = new MwDispatcher<MyContext>();
/**
* 一個中間件
*/
app.use((context: MyContext, next: Next) => {
context.a += 1;
return next();
});
/**
* 一個異步中間件
*/
app.use(async (context: MyContext, next: Next) => {
// 等待 2 秒
await new Promise(res => setTimeout(res, 2000));
context.a += 2;
return next();
});
運行這個應用程序
const context: MyContext = {
a: 0,
}
await app.dispatch(context);
console.log(context.a); // 應該輸出 3
實現
實現這一切的代碼非常簡潔:
/**
* 中間件容器和調用器
*/
class MwDispatcher<T> {
middlewares: Middleware<T>[];
constructor() {
this.middlewares = [];
}
/**
* 添加一個中間件函數。
*/
use(...mw: Middleware<T>[]): void {
this.middlewares.push(...mw);
}
/**
* 在給定的上下文中按添加順序執行中間件鏈。
*/
dispatch(context: T): Promise<void> {
return invokeMiddlewares(context, this.middlewares)
}
}
/**
* 在上下文中調用中間件鏈的輔助函數。
*/
async function invokeMiddlewares<T>(context: T, middlewares: Middleware<T>[]): Promise<void> {
if (!middlewares.length) return;
const mw = middlewares[0];
return mw(context, async () => {
await invokeMiddlewares(context, middlewares.slice(1));
})
}
該文章在 2024/11/16 8:51:53 編輯過