Руководство по созданию масштабируемой и поддерживаемой кодовой базы
В приложении на React Native организация кодовой базы критически важна для её поддержки и масштабирования. То, как вы раскладываете файлы и папки, сильно влияет на то, насколько легко будет работать с кодом в будущем.
В этой статье мы разберём feature-based структуру папок (по фичам) для приложения на React Native и назначение каждой папки.
Папка src
Папка src является корневой директорией для всего исходного кода приложения. Внутри неё находится несколько подпапок, у каждой из которых своя задача.
Types
В папке types вы определяете глобальные типы приложения. Сюда входят типы модулей, определения интерфейсов и любые другие собственные типы, которые используются по всему приложению.
Когда все типы лежат в одном месте, ими проще управлять и их проще поддерживать по мере роста приложения. Кроме того, это гарантирует, что типы используются одинаково во всех фичах: риск багов, связанных с типами, снижается, а если они всё же возникают, их легче поймать.
Lib
В папке lib можно хранить файлы, специфичные для приложения и используемые глобально. Это может быть экземпляр axios для API запросов, сервисы обработки ошибок, константы, настройка query client в react-query и т. д.
Когда эти файлы собраны в одном месте, их проще поддерживать, и они остаются согласованными во всём приложении.
Components
В папке components вы храните все переиспользуемые компоненты. Эти компоненты должны быть изолированными и не привязанными к конкретной фиче или домену. Примеры таких компонентов: заголовки (headers), кнопки и элементы списков.
Если держать такие компоненты отдельно от компонентов конкретных фич, их проще поддерживать и переиспользовать по всему приложению, а дублирования в коде становится меньше.
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 store, Zustand store или любая другая библиотека управления состоянием, которую вы предпочитаете.
Когда приложение разбито на небольшие упорядоченные части, кодом гораздо проще управлять и менять его по мере необходимости. Это также помогает сохранять код чистым и читаемым, и другим разработчикам проще в нём разобраться и с ним работать.
Пример структуры папки фичи 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 или любое другое название, которое имеет смысл для конкретного проекта. Цель в том, чтобы получить понятную и последовательную структуру, которая помогает разработчикам понимать организацию кода и упрощает поддержку и масштабирование приложения.
Структура папок по типам против структуры по фичам
Ещё один широко распространённый способ организовать кодовую базу проекта это структура папок по типам (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. Так в кодовой базе проще разобраться, потому что весь связанный код находится в одном месте. Такой подход обеспечивает лучшую инкапсуляцию кода и делает проект масштабируемым и гибким к будущим изменениям.
Итоговая картина со структурой по фичам
Ниже показано, как в итоге будет выглядеть структура по фичам с файлами для примера:
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 и т. д.), служат лишь примерами, и не стоит воспринимать их как абсолютно точные. Они добавлены, чтобы наглядно показать структуру папок и помочь лучше понять организацию кодовой базы. Реальная реализация может отличаться в зависимости от требований конкретного проекта. Статья посвящена структуре папок по фичам и тому, как она помогает строить масштабируемую и упорядоченную кодовую базу, а не деталям отдельных файлов.
Заключение
На мой взгляд, структура папок по фичам является полезным подходом к организации проектов на React и React Native. Когда код разбит на отдельные фичи, мне проще поддерживать, понимать и развивать приложение. Такая структура обеспечивает лучшую инкапсуляцию кода и делает проект масштабируемым и гибким к будущим изменениям. Конечно, это не универсальное решение, и конкретная структура может отличаться в зависимости от размера и сложности проекта. Но ключевая идея в том, чтобы сохранять чёткое разделение между фичами и их компонентами, сервисами и данными. По моему опыту, такая структура помогла мне строить и поддерживать хорошо организованные проекты, которые выдерживают рост и изменения со временем. Я хотел поделиться этим подходом с теми, кому он тоже может пригодиться.
Публикации
Эта статья также опубликована на: