ویرگول
ورودثبت نام
Farhad Adeli
Farhad Adeliمهندس نرم‌افزار ارشد با ۱۶+ سال تجربه در فرانت‌اند، بک‌اند و سیستم‌های بلادرنگ؛ علاقه‌مند به معماری نرم‌افزار، WebRTC و یادگیری سریع با کمک AI.
Farhad Adeli
Farhad Adeli
خواندن ۶ دقیقه·۵ ماه پیش

اپلیکیشن فرانت‌اند را فقط بر اساس نوع فایل مرتب نکنید

یکی از ساده‌ترین راه‌ها برای اینکه یک پروژه فرانت‌اند در ابتدا تمیز به نظر برسد، مرتب کردن فایل‌ها بر اساس نوع آن‌هاست.

مثلاً:

src/ components/ hooks/ services/ utils/ pages/ types/ stores/

در نگاه اول منطقی است.

کامپوننت‌ها داخل components.
هوک‌ها داخل hooks.
سرویس‌ها داخل services.
تایپ‌ها داخل types.

ساده و مرتب.

اما وقتی پروژه بزرگ‌تر می‌شود، این ساختار می‌تواند کم‌کم دردسرساز شود.

نه به این خاطر که این فولدرها ذاتاً اشتباه هستند.

مشکل اینجاست که پروژه را بر اساس دسته‌بندی فنی مرتب می‌کنند، نه بر اساس فیچرهای محصول.

و اپلیکیشن‌های واقعی معمولاً با فیچرها رشد می‌کنند.

مشکل ساختارهای مبتنی بر نوع فایل

فرض کنید روی یک داشبورد فروشگاهی کار می‌کنید.

فیچرهایی مثل:

احراز هویت محصولات سفارش‌ها مشتریان پرداخت‌ها تخفیف‌ها گزارش‌ها

اما ساختار پروژه این است:

components/ hooks/ services/ utils/ stores/ types/

حالا هر بار که روی فیچر orders کار می‌کنید، باید بین فایل‌های مختلف جابه‌جا شوید:

components/OrderTable.tsx components/OrderStatusBadge.tsx hooks/useOrders.ts services/orderService.ts stores/orderStore.ts types/order.ts utils/formatOrderStatus.ts

از نظر فنی فایل‌ها مرتب هستند.

اما خود فیچر در کل پروژه پخش شده است.

این باعث می‌شود درک کدبیس سخت‌تر شود، چون ساختار فولدرها به شما نمی‌گوید محصول چه کار می‌کند.

فقط می‌گوید چه نوع فایل‌هایی وجود دارد.

نوع فایل معماری نیست

یک اشتباه رایج این است که فکر کنیم فولدرهایی مثل components، hooks و services خودشان معماری خوب ایجاد می‌کنند.

این‌طور نیست.

این فولدرها فقط فایل‌ها را دسته‌بندی می‌کنند.

معماری درباره مرزها، مالکیت، جهت وابستگی‌ها و جدا کردن تغییرات است.

سؤال بهتر این نیست:

این فایل کامپوننت است، هوک است، سرویس است یا تایپ؟

سؤال بهتر این است:

این کد متعلق به کدام فیچر است؟

این سؤال ما را به ساختار متفاوتی می‌رساند.

ساختار مبتنی بر فیچر

در ساختار feature-based، فایل‌های مرتبط نزدیک به هم قرار می‌گیرند.

مثلاً:

src/ features/ orders/ components/ OrderTable.tsx OrderStatusBadge.tsx hooks/ useOrders.ts api/ orderApi.ts types/ order.types.ts utils/ formatOrderStatus.ts stores/ orderStore.ts

حالا وقتی روی orders کار می‌کنید، بیشتر چیزهایی که لازم دارید در یک جا قرار دارد.

فیچر خانه مشخصی دارد.

این کار باعث می‌شود کدبیس راحت‌تر قابل جستجو، حذف، refactor و واگذاری به یک توسعه‌دهنده باشد.

چرا این موضوع در پروژه‌های واقعی مهم است؟

در پروژه‌های کوچک، تقریباً هر ساختاری جواب می‌دهد.

می‌توانید همه‌چیز را بر اساس نوع فایل مرتب کنید، بر اساس فیچر مرتب کنید یا حتی خیلی چیزها را کنار هم نگه دارید و باز هم مشکلی نداشته باشید.

مشکل از جایی شروع می‌شود که پروژه رشد می‌کند.

وقتی تعداد توسعه‌دهنده‌ها بیشتر می‌شود، صفحه‌های بیشتری اضافه می‌شود، APIهای بیشتری ساخته می‌شود و قوانین بیزینسی پیچیده‌تر می‌شوند، هزینه مالکیت نامشخص خودش را نشان می‌دهد.

کم‌کم این سؤال‌ها پیش می‌آیند:

این منطق کجا باید باشد؟ آیا می‌توانم این فایل را با خیال راحت تغییر دهم؟ این کامپوننت فقط همین‌جا استفاده شده یا همه‌جا؟ این هوک مخصوص یک فیچر است یا shared است؟ آیا می‌توانم این فیچر قدیمی را حذف کنم بدون اینکه جای دیگری خراب شود؟

ساختار feature-based کمک می‌کند سریع‌تر به این سؤال‌ها جواب دهیم.

کد Shared باید واقعاً Shared باشد

یکی از خطرهای ساختارهای مبتنی بر نوع فایل این است که همه‌چیز کم‌کم shared به نظر می‌رسد.

وقتی یک کامپوننت داخل src/components قرار می‌گیرد، توسعه‌دهنده‌ها ممکن است فکر کنند یک کامپوننت عمومی و قابل استفاده مجدد است.

اما همیشه این‌طور نیست.

گاهی آن کامپوننت فقط برای یک فیچر خاص معنی دارد.

مثلاً:

OrderStatusBadge ProductVariantSelector CustomerRiskLabel PaymentAttemptTimeline

این‌ها شاید شبیه کامپوننت‌های reusable به نظر برسند، اما معمولاً معنی بیزینسی خاصی دارند.

قرار دادن آن‌ها داخل فولدر global components می‌تواند باعث ابهام شود.

قانون بهتر:

کد مخصوص فیچر را داخل همان فیچر نگه دارید. فقط وقتی چیزی واقعاً مشترک است، آن را به shared منتقل کنید.

کد shared باید آگاهانه shared شود.

نه به صورت پیش‌فرض.

یک ساختار عملی برای پروژه‌های فرانت‌اند

ساختاری که برای بسیاری از اپلیکیشن‌های فرانت‌اند دوست دارم، شبیه این است:

src/ app/ providers/ routes/ layouts/ features/ auth/ orders/ products/ customers/ shared/ components/ hooks/ utils/ types/ lib/ api/ config/ constants/

اسم دقیق فولدرها به اندازه ایده اصلی مهم نیست.

یک جداسازی خوب می‌تواند این‌طور باشد:

app → تنظیمات و ترکیب‌بندی اصلی اپلیکیشن features → فیچرهای بیزینسی shared → UI و utilityهای واقعاً قابل استفاده مجدد lib → زیرساخت‌ها و helperهای فنی

این مدل ذهنی پروژه را واضح‌تر می‌کند.

فولدر app نشان می‌دهد اپلیکیشن چطور compose شده است.

فولدر features نشان می‌دهد محصول چه کار می‌کند.

فولدر shared چیزهایی را نگه می‌دارد که واقعاً reusable هستند.

فولدر lib helperها و زیرساخت‌های فنی را نگه می‌دارد.

چه چیزی باید داخل shared باشد؟

فولدر shared باید با دقت استفاده شود.

گزینه‌های مناسب برای shared:

Button Input Modal DatePicker formatDate helperهای className هوک generic مثل useDebounce API client عمومی validation helperهای عمومی

گزینه‌های نامناسب برای shared:

OrderStatusBadge CustomerPaymentSummary ProductInventoryWarning AdminUserPermissionPanel

این اسم‌ها معمولاً معنی بیزینسی دارند.

یعنی احتمالاً متعلق به یک فیچر هستند.

یک تست ساده:

اگر این فیچر را حذف کنم، آیا این فایل هم باید حذف شود؟

اگر جواب بله است، آن فایل را داخل همان فیچر نگه دارید.

Feature-based یعنی هر duplication بد نیست

بعضی توسعه‌دهنده‌ها خیلی زود کد را shared می‌کنند، چون از duplication می‌ترسند.

اما duplication کوچک گاهی بهتر از abstraction زودهنگام است.

اگر امروز دو فیچر کامپوننت‌های مشابه دارند، لزوماً به این معنی نیست که همین الان باید یک abstraction مشترک ساخته شود.

شاید این شباهت موقتی باشد.

شاید قوانین بیزینسی هفته بعد از هم جدا شوند.

شاید مجبور کردن دو فیچر به استفاده از یک کامپوننت مشترک، تغییر هر دو را سخت‌تر کند.

قانون خوب:

اگر معنی بیزینسی متفاوت است، اول duplication را بپذیرید. وقتی الگو ثابت شد، بعداً abstraction بسازید.

اشتراک‌گذاری زودهنگام coupling ایجاد می‌کند.

و coupling معمولاً از duplication گران‌تر است.

جهت وابستگی‌ها مهم است

ساختار feature-based وقتی بهتر کار می‌کند که جهت وابستگی‌ها واضح باشد.

مثلاً:

features/orders می‌تواند از shared استفاده کند features/products می‌تواند از shared استفاده کند shared نباید به features وابسته باشد features نباید بی‌دلیل به هم وابسته شوند

این نکته مهم است.

اگر هر فیچر از هر فیچر دیگری import کند، دوباره کدبیس درهم‌تنیده می‌شود.

قانون ساده:

کد shared می‌تواند توسط فیچرها استفاده شود. فیچرها بهتر است مستقیماً به فیچرهای دیگر وابسته نشوند.

اگر دو فیچر باید با هم ارتباط داشته باشند، معمولاً بهتر است از application-level state، routing، event یا یک abstraction مشترک استفاده شود، نه import عمیق از داخل همدیگر.

چه زمانی ساختار مبتنی بر نوع فایل هنوز خوب است؟

ساختار type-based همیشه بد نیست.

برای موارد زیر می‌تواند کاملاً قابل قبول باشد:

پروژه‌های کوچک prototypeها landing pageهای ساده admin panelهای کوچک پروژه‌های آموزشی

همچنین داخل خود یک فیچر هم می‌تواند خوب کار کند.

مثلاً داخل features/orders داشتن فولدرهای components، hooks، api و types کاملاً منطقی است.

مشکل استفاده از فولدرهای مبتنی بر نوع فایل نیست.

مشکل این است که از آن‌ها به‌عنوان معماری top-level برای یک محصول در حال رشد استفاده کنیم.

قانون سرانگشتی من

در سطح top-level، پروژه را بر اساس فیچرهای بیزینسی مرتب کنید.

داخل هر فیچر، اگر کمک می‌کند، بر اساس نوع فایل مرتب کنید.

مثلاً:

features/orders/components features/orders/hooks features/orders/api features/orders/types

این مدل بهترین بخش هر دو رویکرد را دارد.

پروژه بر اساس معنی محصول مرتب می‌شود.

و هر فیچر هم ساختار داخلی خودش را دارد.

جمع‌بندی

یک ساختار فولدر خوب باید به توسعه‌دهنده‌ها کمک کند محصول را بفهمند.

نه فقط نوع فایل‌ها را.

وقتی یک اپلیکیشن فرانت‌اند رشد می‌کند، سؤال مهم این می‌شود:

مالک این کد کیست؟

معماری feature-based مالکیت را واضح‌تر می‌کند.

فایل‌های مرتبط را نزدیک هم نگه می‌دارد.

تغییر، حذف و refactor فیچرها را ساده‌تر می‌کند.

جلوی shared شدن تصادفی کد را می‌گیرد.

به تیم‌ها کمک می‌کند مستقل‌تر کار کنند.

و باعث می‌شود کدبیس با رشد محصول قابل فهم‌تر بماند.

نوع فایل مفید است.

اما مالکیت فیچر معماری است.

اگر اپلیکیشن فرانت‌اند شما در حال رشد است و برای هر تغییر باید بین ده فولدر نامرتبط جابه‌جا شوید، شاید وقتش رسیده باشد که فقط بر اساس نوع فایل سازمان‌دهی نکنید.

بر اساس فیچر سازمان‌دهی کنید.

software engineeringsoftware developmentfrontend developmentsoftware architectureweb development
۲
۰
Farhad Adeli
Farhad Adeli
مهندس نرم‌افزار ارشد با ۱۶+ سال تجربه در فرانت‌اند، بک‌اند و سیستم‌های بلادرنگ؛ علاقه‌مند به معماری نرم‌افزار، WebRTC و یادگیری سریع با کمک AI.
شاید از این پست‌ها خوشتان بیاید