المدونة

تنظيم الكود في مشاريع React Native

9 فبراير 2023 7 دقائق للقراءة

أفضل الممارسات لتنظيم تطبيقات React Native الكبيرة وهيكلتها. تعرّف على بنية المجلدات وتنظيم المكونات وأنماط الكود سهلة الصيانة.

تنظيم الكود في مشاريع React Native
React Nativeالبنية المعماريةتنظيم الكودأفضل الممارسات

تنظيم الكود في مشروع React Native

دليل لبناء قاعدة كود قابلة للتوسع وسهلة الصيانة

في تطبيق React Native، يُعد تنظيم قاعدة الكود (codebase) أمرًا حاسمًا لسهولة الصيانة وقابلية التوسع. فالطريقة التي تهيكل بها ملفاتك ومجلداتك قد تؤثر كثيرًا في سهولة العمل على الكود مستقبلًا.

يستعرض هذا المقال بنية المجلدات القائمة على الميزات (feature-based) لتطبيق React Native، والغرض من كل مجلد.

المجلد src

المجلد src هو الدليل الجذري لكل الكود المصدري لتطبيقك. ستجد داخله عدة مجلدات فرعية، لكل منها غرض محدد.

Types

المجلد types هو المكان الذي تعرّف فيه الأنواع العامة لتطبيقك. ويشمل ذلك أنواع الوحدات (modules)، وتعريفات الواجهات (interfaces)، وأي أنواع مخصصة أخرى تحتاج إلى استخدامها في أنحاء التطبيق.

وجود مكان مركزي لكل أنواعك يسهّل إدارتها وصيانتها مع نمو التطبيق. كما يضمن استخدام الأنواع بشكل متسق في كل الميزات، ما يقلل خطر الأخطاء المتعلقة بالأنواع ويسهّل اكتشافها عندما تحدث.

Lib

المجلد lib هو المكان الذي تحفظ فيه أي ملفات خاصة بالتطبيق تُستخدم على مستوى التطبيق كله. وقد يشمل ذلك نسخة axios لإجراء استدعاءات الـ API، وخدمات معالجة الأخطاء، والثوابت، وإعداد query client في react-query، وغير ذلك.

وجود هذه الملفات في مكان مركزي يسهّل صيانتها ويضمن اتساقها في التطبيق كله.

Components

المجلد components هو المكان الذي تحفظ فيه كل مكوناتك القابلة لإعادة الاستخدام. يجب أن تكون هذه المكونات معزولة وغير خاصة بميزة أو مجال معين. ومن أمثلتها الترويسات (headers) والأزرار وعناصر القوائم.

فصل هذه المكونات عن المكونات الخاصة بالميزات يسهّل إدارتها وإعادة استخدامها في أنحاء التطبيق، ويقلل التكرار في الكود.

Hooks

المجلد hooks هو المكان الذي تحفظ فيه أي hooks مخصصة تُستخدم في أنحاء التطبيق. الـ hook نوع خاص من الدوال في React يتيح لك إعادة استخدام المنطق الذي يحمل حالة (stateful logic) عبر مكوناتك.

وجود كل الـ hooks المخصصة القابلة لإعادة الاستخدام والمستخدمة في أكثر من مكان في موقع مركزي يسهّل إدارتها وصيانتها، ويقلل خطر تكرار الكود، ويسهّل مشاركة الـ hooks بين أجزاء التطبيق المختلفة.

Localization

المجلد localization هو المكان الذي تحفظ فيه كل الملفات المتعلقة بالتدويل (internationalization) في تطبيقك. ويشمل ذلك ملفات اللغات، وثوابت النصوص، وأي موارد أخرى لازمة لدعم لغات متعددة.

وجود هذه الملفات في مكان مركزي يسهّل إدارتها وصيانتها، ويقلل خطر تكرار الكود، ويسهّل دعم لغات متعددة في تطبيقك.

Navigation

المجلد navigation هو المكان الذي تحفظ فيه كل الكود المتعلق بالتنقل في تطبيقك. ويشمل ذلك الـ stacks والأنواع والمسارات (routes) وأي مكونات أو دوال أخرى لازمة لدعم التنقل.

وجود كل كود التنقل في مكان مركزي يسهّل إدارته وصيانته، ويقلل خطر تكرار الكود، ويسهّل مشاركة وظائف التنقل بين أجزاء التطبيق المختلفة.

Services

المجلد services هو المكان الذي تحفظ فيه كل الكود المتعلق بالبنية التحتية لتطبيقك. ويشمل ذلك كود الإشعارات الفورية (push notifications)، ومراقبة الأخطاء، وأي خدمات أخرى تقدم الوظائف الأساسية التي يقوم عليها التطبيق.

Theme

المجلد theme هو المكان الذي ينبغي أن تحفظ فيه أنماط تطبيقك، مثل السمة الداكنة والفاتحة. حفظ ملفات الأنماط والسمات في مكان واحد يسهّل إدارة مظهر التطبيق وإحساسه وتحديثهما عند الحاجة.

Utils

يمكن أن تكون الدوال المساعدة (utility functions) جزءًا مهمًا من تطبيق React Native، لأنها توفر طريقة لإعادة استخدام كود يمكن الاستفادة منه في أجزاء متعددة من التطبيق. والمجلد utils مكان ممتاز لحفظ الدوال المساعدة المستخدمة في أنحاء التطبيق. وبجمع هذه الدوال في مكان واحد تضمن سهولة العثور عليها واستخدامها في أجزاء أخرى من الكود. ومثال ذلك: الدوال المساعدة المتعلقة بالتخطيط (layout) في react-native.

Features

عند بناء تطبيقات معقدة، من الضروري أن تكون لديك بنية مجلدات واضحة وموجزة تجمع الكود كله في مكان واحد. ووجود مجلد features يساعد على تحقيق ذلك لأنه يفصل الميزات المختلفة للتطبيق في فئات مستقلة. وهذا يتيح للمطورين العثور بسرعة على ميزة معينة وتعديلها من دون التأثير في أجزاء أخرى من التطبيق.

وفوق ذلك، مع نمو التطبيق وإضافة ميزات جديدة، تبقى بنية المجلدات منظمة، ما يسهّل على المطورين الجدد الانضمام وفهم طريقة عمل التطبيق. كما أن الفصل الواضح بين المسؤوليات (separation of concerns) يساعد على تقليل خطر الأخطاء ويحسّن الأداء العام للتطبيق.

إليك الشكل الذي قد يكون عليه مجلد auth:

    src/
    ├── ...
    └── features/
        ├── auth/
        |   ├── api/
        |   ├── helpers/
        |   ├── hooks/
        |   ├── screens/
        |   ├── services/
        |   └── store/
        └── ... (other features)

تكمن أهمية المجلد features في قدرته على المساعدة في تقسيم قاعدة الكود إلى أجزاء أصغر وأسهل في الإدارة. لكل ميزة مجلداتها الفرعية الخاصة بها، مثل api وhelpers (أو utils) وhooks وscreens وservices وstore. وهذا يسهّل فهم طريقة عمل كل ميزة، وكيف تتفاعل الميزات مع بعضها.

يحتوي المجلد api على كل الكود المتعلق بالـ API والخاص بالمصادقة. وهذا يسهّل إدارة استدعاءات الـ API وإبقاءها منظمة.

يحتوي المجلد helpers على الدوال المساعدة الخاصة بميزة المصادقة. ويمكن استخدامها حصريًا داخل هذه الميزة، ولا حاجة إلى مشاركتها مع أجزاء أخرى من التطبيق.

يحتوي المجلد hooks على الـ hooks المتعلقة بالمصادقة تحديدًا. وبما أن React يعتمد كثيرًا على الـ hooks، فهذا يسهّل إدارتها وإبقاءها منظمة.

يحتوي المجلد screens على كل شاشات ميزة المصادقة. ويشمل ذلك شاشة تسجيل الدخول، وشاشة إنشاء الحساب، وشاشة نسيان كلمة المرور، وغيرها.

يحتوي المجلد services على الخدمات الخاصة بميزة المصادقة. فمثلًا، قد تكون لديك خدمة مصادقة مسؤولة عن التعامل مع تسجيل دخول المستخدمين وإنشاء حساباتهم.

وأخيرًا، يحتوي المجلد store على كود إدارة الحالة الخاص بميزة المصادقة. وقد يكون store في Redux، أو store في Zustand، أو أي مكتبة إدارة حالة أخرى تفضلها.

بتقسيم التطبيق إلى أجزاء أصغر ومنظمة، يصبح من الأسهل بكثير إدارة الكود وتعديله عند الحاجة. كما يساعد ذلك على إبقاء الكود نظيفًا ومقروءًا، ما يسهّل على المطورين الآخرين فهمه والعمل عليه.

بنية نموذجية لمجلد ميزة auth

    src/
    └── features/
        └── auth/
            ├── api/
            |   ├── login.ts
            |   ├── signup.ts
            |   └── refresh-token.ts
            ├── helpers/
            |   ├── validateToken.ts
            |   └── dataTransformer.ts
            ├── screens/
            |   ├── Login.tsx
            |   └── Signup.tsx
            ├── services/
            |   └── validation.ts
            └── store/
                └── auth.ts

المجلد auth هو المجلد الفرعي المخصص لميزة المصادقة في تطبيقك. تتولى الملفات في هذا المجلد كل ما يتعلق بالمصادقة والتفويض (authorization)، من واجهات الـ API الخاصة بتسجيل الدخول وإنشاء الحساب، إلى شاشات الواجهة التي يتفاعل معها المستخدم.

يحتوي المجلد api على واجهات الـ API الخاصة بميزة المصادقة، مثل الملفين login.ts وsignup.ts اللذين يتعاملان مع الطلبات والاستجابات الخاصة بتسجيل دخول المستخدم وإنشاء حسابه. أما الملف refresh-token.ts فيتولى تحديث الـ token.

يحتوي المجلد helpers على دوال مساعدة تُستخدم في عملية المصادقة. فمثلًا، يُستخدم الملف validateToken.ts للتحقق من الـ token، ويحوّل الملف dataTransformer.ts البيانات من واجهات API المصادقة وإليها.

يحتوي المجلد screens على مكونات الواجهة التي يتفاعل معها المستخدم. فمثلًا، يحتوي الملفان Login.tsx وSignup.tsx على مكونات الواجهة الخاصة بتسجيل الدخول وإنشاء الحساب على التوالي.

يحتوي المجلد hooks على hooks مخصصة متعلقة بالمصادقة. فمثلًا، يحتوي الملفان useLoginAction.ts وuseSignupForm.ts على hooks تساعد في إدارة الحالة والإجراءات المتعلقة بنموذجي تسجيل الدخول وإنشاء الحساب على التوالي.

يحتوي المجلد services على خدمات متعلقة بالمصادقة، مثل الملف validation.ts الذي يحتوي على دوال للتحقق من مدخلات المستخدم.

يحتوي المجلد store على إدارة الحالة المتعلقة بالمصادقة. ويحتوي الملف auth.ts على الحالة والإجراءات المتعلقة بالمصادقة، باستخدام مكتبة لإدارة الحالة مثل Zustand أو Redux أو غيرهما.

تنبيه

من المهم ملاحظة أن أعراف تسمية المجلدات والملفات قد تختلف من مشروع لآخر ومن مطور لآخر. المهم هو بنية المجلدات وتنظيمها، لا الأسماء الدقيقة المستخدمة لكل مجلد. فمثلًا، يمكن أن يُسمى المجلد utils في جذر التطبيق helpers أو utilities، ويمكن أن يُسمى المجلد screens باسم pages أو أي اسم آخر منطقي للمشروع المعني. الهدف هو بنية واضحة ومتسقة تساعد المطورين على فهم تنظيم الكود، وتسهّل صيانة التطبيق وتوسيعه.

بنية المجلدات القائمة على النوع مقابل بنية المجلدات القائمة على الميزات

من الطرق المعتمدة على نطاق واسع أيضًا لتنظيم قاعدة كود المشروع بنية المجلدات القائمة على النوع (type-based)، ولها مزاياها وعيوبها. في القسم التالي سنقارن بين هاتين البنيتين بصريًا.

المقارنة

    Feature-based folder structure:

    src/
    └── features/
        ├── auth/
        |   ├── api/
        |   │     ├── register.tsx
        |   │     ├── login.tsx
        |   │     ├── types.tsx
        |   │     └── helpers.tsx
        |   ├── helpers/
        |   ├── hooks/
        |   └── screens/
        |   │     ├── LoginScreen.tsx
        |   │     ├── SignupScreen.tsx
        |   │     ├── WelcomeScreen.tsx
        |   │     └── HomeScreen.tsx
        |   ├── services/
        |   └── store/
        ├── todo/
        |   └── screens/
        |   │    └── TodoListScreen.tsx
        |   ├── services/
        |   └── store/
        └── ... (other features)

    Type-based folder structure:

    src/
    ├── screens/
    |   ├── LoginScreen.tsx
    |   ├── SignupScreen.tsx
    |   ├── TodoListScreen.tsx
    |   ├── WelcomeScreen.tsx
    |   └── HomeScreen.tsx
    ├── api/
    |   └── auth/
    |       ├── register.ts
    |       ├── login.ts
    |       ├── types.ts
    |       └── helpers.ts

كما يظهر أعلاه، في البنية القائمة على النوع تكون الشاشات منفصلة عن استدعاءات الـ API والدوال المساعدة، ما قد يجعل فهم قاعدة الكود أصعب. لاحظ كيف قد ينتهي بنا الأمر إلى وضع شاشات لا علاقة بينها، مثل LoginScreen.tsx وTodoListScreen.tsx، في المجلد نفسه في البنية القائمة على النوع. وإضافة إلى ذلك، قد يصعّب هذا أيضًا صيانة الكود، لأن الكود المترابط لا يكون مجمّعًا في مكان واحد. أما في البنية القائمة على الميزات، فكل الكود المتعلق بالمصادقة، بما في ذلك الشاشات واستدعاءات الـ API والدوال المساعدة والخدمات، مجمّع في مجلد auth واحد. وهذا يسهّل فهم قاعدة الكود، لأن كل الكود المترابط موجود في مكان واحد. ويتيح هذا النهج تغليفًا (encapsulation) أفضل للكود ويجعل المشروع قابلًا للتوسع ومرنًا أمام التغييرات المستقبلية.

الصورة النهائية مع بنية مجلدات قائمة على الميزات

فيما يلي الشكل النهائي مع بنية المجلدات القائمة على الميزات وملفات وهمية:

    Feature-based folder structure:

    src/
    ├── components/
    │   ├── Button.tsx
    │   └── Header.tsx
    ├── hooks/
    │   └── useHeader.ts
    ├── localization/
    │   ├── languages.ts
    │   └── locales.ts
    ├── lib/
    │   ├── axios-instance.ts
    │   └── constants.ts
    ├── navigation/
    │   ├── root-navigator.tsx
    │   └── auth-stack.tsx
    ├── services/
    │   ├── notification.ts
    │   └── logging.ts
    ├── theme/
    │   └── index.ts
    ├── types/
    │   ├── env.d.ts
    │   └── react-augment.d.ts
    ├── utils/
    │   └── layout.ts
    └── features/
        ├── auth/
        │   ├── api/
        │   │   ├── login.ts
        │   │   ├── signup.ts
        │   │   └── refresh-token.ts
        │   ├── helpers/
        │   │   ├── validateToken.ts
        │   │   └── dataTransformer.ts
        │   ├── hooks/
        │   │   ├── useLoginAction.ts
        │   │   └── useSignupForm.ts
        │   ├── screens/
        │   │   ├── Login.tsx
        │   │   └── Signup.tsx
        │   ├── services/
        │   │   └── validation.ts
        │   └── store/
        │       └── auth.ts (zustand, redux, jotai etc.)
        └── ... (other features)

الملفات التي أضيفت إلى المجلدات المختلفة أعلاه (مثل button.tsx وheader.tsx في المجلد components، وuseHeader.ts في المجلد hooks، وغيرها) هي أمثلة فقط ولا ينبغي اعتبارها دقيقة بنسبة 100%. الغرض من إدراج هذه الملفات هو تقديم تصور مرئي لبنية المجلدات والمساعدة على فهم تنظيم قاعدة الكود بشكل أفضل. وقد يختلف التنفيذ الفعلي حسب متطلبات المشروع. يركز هذا المقال على بنية المجلدات القائمة على الميزات وكيف تساعد على بناء قاعدة كود منظمة وقابلة للتوسع، لا على تفاصيل الملفات الفردية.


الخلاصة

في رأيي، بنية المجلدات القائمة على الميزات نهج مفيد لتنظيم مشاريع React وReact Native. فبتقسيم الكود إلى ميزات منفصلة، أجد أن صيانة التطبيق وفهمه وتطويره أصبحت أسهل. تتيح هذه البنية تغليفًا أفضل للكود، فتجعل المشروع قابلًا للتوسع ومرنًا أمام التغييرات المستقبلية. بالطبع هذا ليس حلًا واحدًا يناسب الجميع، وقد تختلف البنية الدقيقة حسب حجم المشروع وتعقيده. لكن الفكرة الأساسية هي الحفاظ على فصل واضح بين الميزات المختلفة ومكوناتها وخدماتها وبياناتها. ومن تجربتي، ساعدتني هذه البنية على بناء مشاريع منظمة وصيانتها، مشاريع قادرة على استيعاب النمو والتغيير مع الوقت. وأردت مشاركة هذا النهج مع من قد يجده مفيدًا أيضًا.

منشور أيضًا على

هذا المقال منشور أيضًا على: