Посібник зі створення масштабованої кодової бази, яку легко підтримувати
У застосунку на React Native організація кодової бази вирішальна для підтримки й масштабування. Те, як ви розкладаєте файли й папки, дуже впливає на те, наскільки легко буде працювати з кодом у майбутньому.
У цій статті я розгляну структуру папок за фічами (feature-based) для застосунку на React Native і призначення кожної папки.
Папка src
Папка src є кореневою текою для всього вихідного коду застосунку. Усередині неї є кілька інших підпапок, і кожна має своє конкретне призначення.
Types
У папці types ви визначаєте глобальні типи застосунку. Сюди входять типи модулів, описи інтерфейсів та будь-які інші власні типи, які використовуються в усьому застосунку.
Коли всі типи зібрані в одному місці, ними простіше керувати й підтримувати їх у міру зростання застосунку. До того ж це гарантує, що типи однаково використовуються в усіх фічах, зменшує ризик помилок, пов'язаних із типами, і допомагає швидше їх виявляти, коли вони таки з'являються.
Lib
У папці lib можна тримати файли, специфічні для застосунку, які використовуються глобально в усьому застосунку. Це може бути інстанс axios для запитів до API, сервіси обробки помилок, константи, налаштування query client у react-query тощо.
Коли ці файли лежать в одному місці, їх простіше підтримувати, і вони залишаються узгодженими в усьому застосунку.
Components
У папці components ви зберігаєте всі компоненти для повторного використання. Ці компоненти мають бути ізольованими й не прив'язаними до якоїсь конкретної фічі чи предметної області. Приклади таких компонентів: хедери, кнопки та елементи списку.
Якщо тримати ці компоненти окремо від компонентів конкретних фіч, ними простіше керувати й повторно використовувати в усьому застосунку, а дублювання коду стає менше.
Hooks
У папці hooks ви зберігаєте власні хуки, які використовуються в усьому застосунку. Хук у React це особливий тип функції, що дає змогу повторно використовувати логіку зі станом у різних компонентах.
Коли всі ваші **повторно використовувані (тобто ті, що використовуються в кількох місцях) **власні хуки зібрані в одному місці, ними простіше керувати й підтримувати їх, ризик дублювання коду менший, а ділитися хуками між різними частинами застосунку легше.
Localization
У папці localization ви зберігаєте всі файли, пов'язані з інтернаціоналізацією застосунку. Сюди входять мовні файли, рядкові константи та будь-які інші ресурси, потрібні для підтримки кількох мов.
Коли ці файли лежать в одному місці, ними простіше керувати й підтримувати їх, ризик дублювання коду менший, а підтримувати кілька мов у застосунку легше.
Navigation
У папці navigation ви зберігаєте весь код, пов'язаний із навігацією в застосунку. Сюди входять стеки, типи, маршрути та будь-які інші компоненти чи функції, потрібні для навігації.
Коли весь код навігації зібраний в одному місці, ним простіше керувати й підтримувати його, ризик дублювання коду менший, а ділитися навігаційною функціональністю між різними частинами застосунку легше.
Services
У папці services ви зберігаєте весь код, пов'язаний із базовою інфраструктурою застосунку. Сюди входить код для роботи з push-сповіщеннями, моніторингом помилок та іншими сервісами, які забезпечують базову функціональність застосунку.
Theme
У папці theme варто зберігати стилі застосунку, наприклад темну й світлу тему. Коли файли стилів і теми лежать в одному місці, простіше керувати зовнішнім виглядом застосунку й оновлювати його за потреби.
Utils
Допоміжні функції можуть бути важливою частиною застосунку на React Native, бо дають змогу повторно використовувати код у кількох частинах застосунку. Папка utils чудово підходить для зберігання допоміжних функцій, які використовуються в усьому застосунку. Зібравши ці функції в одному місці, ви гарантуєте, що їх легко знайти й використати в інших частинах коду. Наприклад: допоміжні функції для layout у react-native.
Features
Коли йдеться про складні застосунки, дуже важливо мати чітку й лаконічну структуру папок, яка тримає весь код фічі в одному місці. Папка features допомагає цього досягти, бо розділяє різні фічі застосунку на окремі категорії. Так розробники можуть швидко знайти й змінити конкретну фічу, не зачіпаючи інших частин застосунку.
Крім того, коли застосунок росте й додаються нові фічі, структура папок залишається впорядкованою, і новим розробникам простіше влитися в роботу та зрозуміти, як усе влаштовано. Чітке розділення відповідальності також зменшує ризик помилок і покращує загальну роботу застосунку.
Ось як може виглядати папка 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 містить хуки, що стосуються саме автентифікації. Оскільки React сильно залежить від хуків, так простіше ними керувати й тримати їх у порядку.
Папка screens містить усі екрани фічі автентифікації. Серед них екран входу, екран реєстрації, екран відновлення пароля та інші.
Папка services містить сервіси, специфічні для фічі автентифікації. Наприклад, у вас може бути сервіс автентифікації, який відповідає за вхід і реєстрацію користувачів.
Нарешті, папка store містить код керування станом для фічі автентифікації. Це може бути стор Redux, стор 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 це підпапка, присвячена фічі автентифікації в застосунку. Файли в ній відповідають за все, що пов'язано з автентифікацією та авторизацією, від API для входу й реєстрації до UI-екранів, з якими взаємодіє користувач.
Папка api містить API фічі автентифікації, наприклад файли login.ts і signup.ts, які обробляють запити й відповіді для входу та реєстрації користувача. Файл refresh-token.ts відповідає за оновлення токена.
Папка helpers містить допоміжні функції, що використовуються в процесі автентифікації. Наприклад, файл validateToken.ts перевіряє токен, а файл dataTransformer.ts перетворює дані, які надходять до API автентифікації та від нього.
Папка screens містить UI-компоненти, з якими взаємодіє користувач. Наприклад, файли Login.tsx і Signup.tsx містять UI-компоненти для входу та реєстрації відповідно.
Папка hooks містить власні хуки, пов'язані з автентифікацією. Наприклад, файли useLoginAction.ts і useSignupForm.ts містять хуки, що допомагають керувати станом і діями форм входу та реєстрації відповідно.
Папка services містить сервіси, пов'язані з автентифікацією, наприклад файл validation.ts із функціями для перевірки введених користувачем даних.
Папка store містить керування станом, пов'язане з автентифікацією. Файл auth.ts містить стан і дії автентифікації на основі бібліотеки керування станом, як-от Zustand, Redux чи іншої.
ЗАСТЕРЕЖЕННЯ
Важливо пам'ятати, що правила іменування папок і файлів можуть відрізнятися від проєкту до проєкту й від розробника до розробника. Важлива саме структура й організація папок, а не точні назви кожної з них. Наприклад, папка utils у корені застосунку може називатися helpers чи utilities, а замість screens можна назвати папку pages або якось інакше, як має сенс для конкретного проєкту. Мета в тому, щоб мати чітку й послідовну структуру, яка допомагає розробникам зрозуміти організацію коду й полегшує підтримку та масштабування застосунку.
Структура папок за типами проти структури за фічами
Ще один поширений спосіб організувати кодову базу проєкту це структура папок за типами, яка має свої плюси й мінуси. У наступному розділі ми наочно порівняємо ці дві структури.
Порівняння
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. Так кодову базу простіше зрозуміти, бо весь пов'язаний код лежить в одному місці. Такий підхід дає кращу інкапсуляцію коду й робить проєкт масштабованим і гнучким для майбутніх змін.
Остаточна картина зі структурою папок за фічами
Ось як усе виглядатиме в результаті зі структурою за фічами та файлами-заглушками:
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. Коли код поділено на окремі фічі, мені простіше підтримувати, розуміти й розвивати застосунок. Така структура дає кращу інкапсуляцію коду й робить проєкт масштабованим і гнучким для майбутніх змін. Звісно, це не універсальне рішення, і точна структура може відрізнятися залежно від розміру та складності проєкту. Але головна ідея в тому, щоб чітко розділяти різні фічі та їхні компоненти, сервіси й дані. З мого досвіду, ця структура допомогла мені будувати й підтримувати добре організовані проєкти, які витримують зростання та зміни з часом. Я хотів поділитися цим підходом з іншими, кому він теж може стати в пригоді.
Опубліковано на
Ця стаття також опублікована на: