架構(Feature-Sliced Design)
優先級:P2(中等)
對可擴展的應用程式採用 Feature-Sliced Design (FSD)。 警告:FSD 會引入樣板程式碼。僅在預期專案會顯著成長(例如,20 個以上功能)時使用。對於較小的專案,建議使用簡單的基於模組的結構。
策略
- RSC 邊界:對從 Server 傳遞到 Client 的 props 強制執行嚴格的序列化規則。請參閱 RSC 邊界與序列化。
- App 層應保持輕薄:
app/目錄(App Router)僅用於路由。- 規則:
page.tsx應僅導入 Widgets/Features。頁面中不得包含業務邏輯(useEffect、fetch)。
- 規則:
- 按切片而非類型分組:按業務領域(User、Product、Cart)對程式碼進行分組,而非按檔案類型(Components、Hooks、Utils)。
- 錯誤:
src/components/LoginForm.tsx、src/hooks/useLogin.ts - 正確:
src/features/auth/login/包含兩者。
- 錯誤:
- 層級依賴規則:程式碼只能從 更低的層級 進行導入。
App->Widgets->Features->Entities->Shared。
- 避免過多的 Entity:不要預先建立 Entity。
- 規則:在
Features或Pages中開始邏輯。僅在資料/邏輯嚴格跨多個不同功能被重複使用時,才將其移至Entities。 - 規則:簡單的 CRUD 屬於
shared/api,而非entities。
- 規則:在
- 使用標準區段:在切片內部使用標準的區段名稱。
ui(元件)、model(狀態/動作)、api(資料擷取)、lib(輔助程式)、config(常數)。- 避免:將
components、hooks、services用作區段名稱。
結構參考
有關具體的目錄佈局和層級定義,請參閱參考文件。
架構檢查清單(強制性)
-
層級導入:是否有任何層級從其上方的層級導入?(App > Widgets > Features > Entities > Shared)
-
頁面邏輯:
page.tsx是否保持輕薄,僅包含 Widgets/Features 且不含任何useEffect/fetch? -
RSC 邊界:Server 元件是否透過適當的 'use client' 邊界與 Client 元件隔離?
-
公共 API:對切片的存取是否全部透過頂層的
index.ts(公共 API)進行? -
跨切片:同一個層級內的切片(例如,兩個 features)是否會直接互相導入?(禁止)
-
Server Actions:將它們放置在 Feature 的
model/資料夾中(例如,features/auth/model/actions.ts)。 -
資料存取層 (DAL):將邏輯放置在 Entity 的
model/資料夾中(例如,entities/user/model/dal.ts)。 -
UI 元件:基礎 UI (shadcn) 屬於
shared/ui。特定功能的 UI 屬於features/*/ui。
反模式
- 禁止跨切片導入:同一層級內的切片不得直接互相導入。
- 禁止在
page.tsx中撰寫業務邏輯:頁面僅導入 Widgets/Features;禁止任何useEffect/fetch。 - 禁止按檔案類型分組的資料夾:按領域分組(
features/auth/),而非按類型(components/、hooks/)。 - 禁止預先建立 Entity:從 Features 開始;僅在嚴格重複使用時才移至 Entities。