Dart — это язык программирования, созданный Google, в основном используемый для создания веб- и мобильных приложений. Как и на любом другом языке программирования, структурированная организация вашего проекта Dart важна для облегчения его поддержки и масштабирования. В этой статье мы обсудим рекомендуемую структуру проекта Dart, которую вы можете использовать в качестве ориентира для вашего проекта.

Навигация по статье

Общая структура

Вот пример рекомендуемой структуры проекта для Dart:

my_project/
├── bin/
│   ├── my_script.dart
│   └── main.dart
├── lib/
│   ├── src/
│   │   ├── models/
│   │   ├── services/
│   │   ├── utils/
│   │   └── widgets/
│   ├── views/
├── test/
├── assets/
├── pubspec.yaml
└── README.md

Давайте рассмотрим каждый из этих каталогов более подробно.

bin/

bin/ — Этот каталог содержит исполняемые скрипты, которые могут быть запущены из командной строки. Скрипты в этом каталоге часто используются для таких задач, как запуск тестов или развертывание приложения.

main.dart

main.dart — это важный файл в приложении, поскольку он служит точкой входа. Он содержит функцию main(), которая является отправной точкой для всего приложения.

main.dart обычно включает в себя несколько важных фрагментов кода, таких как импорт пакетов, определение функции main() и настройка структуры приложения.

lib/

Каталог lib/ — это место, где находится основной код Dart. Этот каталог должен содержать два подкаталога: src/ и views/.

src/

Каталог src/ — это место, где вы должны разместить свой основной код, который должен быть разделен на модули в зависимости от их функциональности. Внутри каталога src/ у вас должны быть следующие подкаталоги:

models/: Модели данных.
services/: Сервисы, которые взаимодействуют с внешними API или базами данных.
utils/: Служебные функции или классы.
widgets/: Повторно используемые виджеты.

Разделяя свою основную логику на модули, вы можете упорядочить свой код и упростить поиск и обслуживание отдельных фрагментов кода.

views/

Каталог views/ — это то место, где вы размещаете код для пользовательского интерфейса. Этот каталог должен содержать все экраны, виджеты и другие компоненты пользовательского интерфейса вашего приложения.

test/

В каталоге test/ размещается ваш тестовый код. Этот каталог содержит тесты для каждого модуля или функциональности вашего кода. Тесты должны быть написаны с использованием платформы тестирования, такой как flutter_test.

assets/

В каталог assets/ размещаются любые статические ресурсы, такие как изображения, шрифты или другие файлы, необходимые приложению для работы. На эти ресурсы можно ссылаться в вашем коде, используя относительные пути.

pubspec.yaml

В pubspec.yaml перечисляются зависимости для проекта. Этот файл используется менеджером пакетов Dart pub для загрузки зависимостей и управления ими.

README.md

В README.md содержится краткий обзор вашего проекта. Этот файл должен содержать информацию о том, что делает ваш проект, как его установить и запустить, а также любую другую соответствующую информацию.

Немного про отличие /bin от /lib

В Dart папки /bin и /lib служат разным целям:

Папка /bin содержит исполняемые файлы приложения, обычно включая точку(ы) входа, которые выполняются при запуске приложения.
Папка /lib содержит повторно используемый код, который может быть импортирован и использован другими частями приложения или внешними приложениями, обычно организованными в пакеты.

Таким образом, папка /bin предназначена для исполняемых файлов, в то время как папка /lib предназначена для многократно используемого кода, который может быть импортирован и использован другими частями приложения.

Вот пример того, как папки /bin и /lib могут использоваться в приложении Dart:

Допустим, мы создаем библиотеку, которая предоставляет утилиту для генерации случайных чисел. Вот как мы могли бы организовать папки /bin и /lib:

/bin
  |- example.dart   # содержит пример того, как использовать библиотеку
  
/lib
  |- random.dart    # содержит код для генерации случайных чисел

В этом примере папка /bin содержит исполняемый файл example.dart, который демонстрирует, как использовать библиотеку random.dart, в то время как папка /lib содержит повторно используемый код для генерации случайных чисел. Другие части приложения могут импортировать и использовать библиотеку random.dart по мере необходимости.

Заключение

Структурированная организация вашего проекта Dart может облегчить его чтение, обслуживание и масштабирование. Следуя рекомендуемой структуре проекта, описанной в этой статье, вы сможете сохранить свою кодовую базу организованной и удобной для навигации. Помните, что это всего лишь одна из возможных структур для проекта Dart, и вам, возможно, потребуется скорректировать ее в соответствии с конкретными потребностями вашего проекта.