中介軟體 (Middleware)
中介軟體 (Middleware) 允許您在請求完成前執行程式碼。然後根據傳入的請求,您可以透過重寫、重新導向、修改請求或回應標頭,或直接回應來修改回應。
中介軟體會在快取內容和路由匹配之前執行。詳情請參閱 路徑匹配。
使用情境
中介軟體 (Middleware) 適用於以下常見場景:
- 讀取傳入請求的部分內容後快速重新導向
- 根據 A/B 測試或實驗重寫到不同頁面
- 修改所有頁面或部分頁面的標頭
中介軟體 (Middleware) 不 適合用於:
- 緩慢的資料獲取
- 會話管理
慣例
在專案根目錄中使用 middleware.ts
(或 .js
) 檔案來定義中介軟體 (Middleware)。例如,與 pages
或 app
同層級,或在適用的情況下放在 src
目錄內。
注意:雖然每個專案僅支援一個
middleware.ts
檔案,但您仍可以模組化組織中介軟體邏輯。將中介軟體功能拆分到獨立的.ts
或.js
檔案中,並在主要的middleware.ts
檔案中導入它們。這樣可以更清晰地管理特定路由的中介軟體,並在middleware.ts
中集中控制。透過強制使用單一中介軟體檔案,簡化了配置,避免了潛在衝突,並透過避免多層中介軟體來優化效能。
範例
路徑匹配
中介軟體 (Middleware) 會為 專案中的每個路由 調用。因此,使用匹配器 (matcher) 精確定位或排除特定路由至關重要。以下是執行順序:
next.config.js
中的headers
next.config.js
中的redirects
- 中介軟體 (Middleware) (
rewrites
、redirects
等) next.config.js
中的beforeFiles
(rewrites
)- 檔案系統路由 (
public/
、_next/static/
、pages/
、app/
等) next.config.js
中的afterFiles
(rewrites
)- 動態路由 (
/blog/[slug]
) next.config.js
中的fallback
(rewrites
)
有兩種方式可以定義中介軟體 (Middleware) 將執行的路徑:
匹配器 (Matcher)
matcher
允許您過濾中介軟體 (Middleware) 以在特定路徑上執行。
您可以使用陣列語法匹配單一路徑或多個路徑:
matcher
配置支援完整的正則表達式,因此支援如負向先行斷言或字元匹配等功能。以下是一個負向先行斷言的範例,用於匹配除特定路徑外的所有路徑:
您也可以透過使用 missing
或 has
陣列,或兩者的組合,來繞過某些請求的中介軟體 (Middleware):
須知:
matcher
值必須是常數,以便在構建時進行靜態分析。動態值(如變數)將被忽略。
配置的匹配器:
- 必須以
/
開頭 - 可以包含命名參數:
/about/:path
匹配/about/a
和/about/b
,但不匹配/about/a/c
- 可以在命名參數上使用修飾符(以
:
開頭):/about/:path*
匹配/about/a/b/c
,因為*
表示 零個或多個。?
表示 零個或一個,+
表示 一個或多個 - 可以使用括號內的正則表達式:
/about/(.*)
與/about/:path*
相同
詳情請參閱 path-to-regexp 文件。
須知:為了向後兼容,Next.js 始終將
/public
視為/public/index
。因此,/public/:path
的匹配器將匹配。
條件語句
NextResponse
NextResponse
API 允許您:
redirect
傳入的請求到不同的 URLrewrite
回應以顯示給定的 URL- 為 API 路由、
getServerSideProps
和rewrite
目的地設定請求標頭 - 設定回應的 cookies
- 設定回應標頭
要從中介軟體 (Middleware) 產生回應,您可以:
rewrite
到一個產生回應的路由 (頁面 或 Edge API 路由)- 直接返回
NextResponse
。請參閱 產生回應
使用 Cookies
Cookies 是常規的標頭。在 Request
中,它們存儲在 Cookie
標頭中。在 Response
中,它們存儲在 Set-Cookie
標頭中。Next.js 透過 NextRequest
和 NextResponse
上的 cookies
擴展提供了一種方便的方式來存取和操作這些 cookies。
- 對於傳入的請求,
cookies
提供以下方法:get
、getAll
、set
和delete
cookies。您可以使用has
檢查 cookie 是否存在,或使用clear
刪除所有 cookies。 - 對於傳出的回應,
cookies
提供以下方法:get
、getAll
、set
和delete
。
設定標頭
您可以使用 NextResponse
API 設定請求和回應標頭(自 Next.js v13.0.0 起支援設定 請求 標頭)。
須知:避免設定過大的標頭,因為根據後端網頁伺服器的配置,可能會導致 431 請求標頭欄位過大 錯誤。
CORS
您可以在中介軟體 (Middleware) 中設定 CORS 標頭以允許跨來源請求,包括 簡單 和 預檢 請求。
產生回應
您可以直接從中介軟體 (Middleware) 回傳 Response
或 NextResponse
實例來產生回應。(此功能自 Next.js v13.1.0 起可用)
waitUntil
與 NextFetchEvent
NextFetchEvent
物件繼承了原生的 FetchEvent
物件,並包含 waitUntil()
方法。
waitUntil()
方法接收一個 Promise 作為參數,並延長中介軟體的生命週期直到該 Promise 完成。這對於在背景執行工作非常有用。
進階中介軟體旗標
在 Next.js v13.1
版本中,新增了兩個中介軟體旗標 skipMiddlewareUrlNormalize
和 skipTrailingSlashRedirect
來處理進階使用情境。
skipTrailingSlashRedirect
會停用 Next.js 對於新增或移除尾部斜線的自動重新導向。這允許在中介軟體中自訂處理方式,針對某些路徑保留尾部斜線而其他路徑則不保留,這對於漸進式遷移特別有用。
skipMiddlewareUrlNormalize
允許停用 Next.js 的 URL 標準化處理,讓直接訪問與客戶端轉換的行為保持一致。在某些進階情境中,此選項可透過使用原始 URL 來提供完整控制權。
單元測試 (實驗性功能)
自 Next.js 15.1 起,next/experimental/testing/server
套件包含了協助測試中介軟體檔案的實用工具。單元測試中介軟體有助於確保它僅在預期的路徑上執行,且自訂路由邏輯在程式碼上線前能如預期運作。
unstable_doesMiddlewareMatch
函式可用於斷言中介軟體是否會針對提供的 URL、標頭和 cookies 執行。
也可以測試整個中介軟體函式。
執行環境
中介軟體預設使用 Edge 執行環境 (Edge Runtime)。自 v15.2 (canary) 起,我們實驗性支援使用 Node.js 執行環境。要啟用此功能,請在 next.config
檔案中加入旗標:
然後在中介軟體檔案中,於 config
物件設定執行環境為 nodejs
:
注意:此功能目前不建議用於正式環境。因此,除非您使用 next@canary 版本而非穩定版本,否則 Next.js 將會拋出錯誤。
平台支援
部署選項 | 是否支援 |
---|---|
Node.js 伺服器 | 是 |
Docker 容器 | 是 |
靜態匯出 | 否 |
轉接器 (Adapters) | 依平台而定 |
瞭解如何在使用 Next.js 自架時設定中介軟體。