Архитектурная документация мобильного приложения: C4, ADR, онбординг

Новый разработчик пытается отладить crash при авторизации через Apple. Он не знает, где лежит логика, как устроен кеш и почему токен не обновляется. Код написан чисто, но без архитектурной документации разобраться за день невозможно. Команда тратит часы на устные объяснения вместо coding. Мы решаем эту проблему: создаём архитектурную документацию, которая превращает онбординг в чтение ADR и схемы C4. Новый член команды открывает репозиторий, читает пять записей и через два часа делает первый коммит.

Наш опыт — 10+ лет в мобильной разработке, 50+ задокументированных проектов. Качественная архитектурная документация сокращает онбординг на 70% (с двух недель до двух дней). Для приложений с 50+ экранами это критично. Без документации каждое изменение архитектуры — риск. Разработчики принимают решения, не зная контекста, и через полгода код превращается в «винегрет».

Почему архитектурная документация критична для мобильных приложений?

С ADR каждое решение фиксируется с причиной. Новый сотрудник читает 10 ADR и понимает эволюцию архитектуры за 30 минут. Это экономит до 40 часов на онбординг. Диаграммы C4 Model дают четыре уровня детализации: Context (приложение в окружении), Containers (iOS, Android, API, push), Components (модули), Code (классы). Инструмент Structurizr генерирует диаграммы из DSL — они всегда актуальны. В 80% проектов, где мы внедрили C4, онбординг сократился до одного дня.

Что входит в работу по архитектурной документации?

Как C4 Model и ADR решают проблему онбординга?

На одном проекте новый разработчик за два часа нашёл и исправил баг в background sync, прочитав ADR и последовательность потоков данных. Без документации это заняло бы неделю. 95% клиентов отмечают, что после внедрения ADR команды тратят на 30% меньше времени на код-ревью.

Architecture Decision Record — это стандарт фиксации решений, который мы используем.

Почему ADR важнее комментариев в коде?

Комментарии устаревают и не объясняют причин решений. ADR — это живой документ, который обновляется при каждом изменении. Например, если команда решает заменить RestKit на Alamofire, ADR фиксирует причину (скорость, поддержка Swift Concurrency). Это предотвращает одинаковые обсуждения в будущем.

Какие типичные ошибки допускают при документировании архитектуры?

Одна из частых ошибок — пытаться задокументировать всё сразу. Это приводит к огромным PDF, которые никто не читает. Другой минус — использовать только текстовые описания без диаграмм. Диаграммы C4 в Structurizr на порядок снижают когнитивную нагрузку при знакомстве с проектом. Третья ошибка — не обновлять документацию. Адаптивные CI-проверки, запускаемые при каждом коммите, решают эту проблему: они уведомляют команду об устаревших диаграммах или ADR.

Сравнение подходов к документированию

Structurizr лучше Draw.io в три раза по скорости поддержки актуальности — диаграммы обновляются вместе с кодом.

Процесс работы: от аудита до деплоя документации

1. Аналитика: Разбираем код, выделяем ключевые архитектурные решения, интервьюируем команду.
2. Проектирование: Создаём C4 Containers и Components в Structurizr DSL. Определяем нужные ADR.
3. Реализация: Пишем ADR, рисуем sequence diagrams, настраиваем CI-проверки актуальности.
4. Тестирование: Разработчик-новичок проходит онбординг по документации под нашим наблюдением.
5. Деплой и обучение: Документация вливается в main, команда получает воркшоп.

Сроки ориентировочно

Для приложения среднего размера (50+ экранов) — от 1 до 2 недель. Точный срок зависит от сложности и количества модулей. Стоимость рассчитывается индивидуально после аудита.

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

Архитектура мобильных приложений

Приложение собрано в одном ViewController на 2000 строк. Сетевые вызовы, бизнес-логика, обновление UI — всё в одном месте. Добавить новую фичу без регрессии сложно, написать тест невозможно. Это не «плохой код» — это отсутствие архитектуры. И это встречается чаще, чем можно ожидать, даже в production-приложениях с миллионом пользователей.

Мы проектируем архитектуру под ключ: от выбора паттерна до полной структуры проекта с тестами и документацией. За 7–10 дней получаете чистый модульный код, готовый к масштабированию.

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

MVVM: базовый паттерн

Model-View-ViewModel — стандарт для iOS (SwiftUI + Combine/async, UIKit + Combine) и Android (Jetpack ViewModel + StateFlow + Compose). ViewModel содержит состояние UI и бизнес-логику. View только отображает состояние и передаёт намерения пользователя в ViewModel. Model — данные и их источник.

Ключевое правило: ViewModel не знает об UIKit или Android View-классах. Нет импортов UIKit, нет Context-зависимостей (кроме Application context через Hilt). Это гарантирует тестируемость: ViewModel тестируется как чистый Kotlin/Swift-код без Android Instrumented Test.

MVVM закрывает 70% потребностей. Остальные 30% — где нужна строгая изоляция фич, масштабирование команды, сложный flow управления состоянием.

Clean Architecture: когда MVVM недостаточно

Добавляет слои поверх MVVM:

Domain-слой — бизнес-логика, независимая от платформы. UseCase (или Interactor) содержит одно бизнес-правило: GetUserOrdersUseCase, PlaceOrderUseCase. Зависит только от интерфейсов (protocol/interface), не от конкретных реализаций.

Data-слой — реализация репозиториев. OrderRepositoryImpl реализует OrderRepository из domain. Знает про Retrofit, Room, UserDefaults. ViewModel не знает, откуда данные — из сети или кеша.

Presentation-слой — ViewModel + View. Знает о Domain, не знает о Data.

Dependency rule: зависимости направлены только внутрь. Domain не зависит ни от чего. Data и Presentation зависят от Domain.

Presentation → Domain ← Data

Это даёт возможность подменять реализацию: тест использует in-memory репозиторий вместо сетевого, интерфейс остаётся тем же.

Практическая оговорка: Clean Architecture добавляет файлы и слои. Для небольшого приложения это overhead. Оправдан от ~15 фич и при команде 3+ разработчиков.

BLoC для Flutter: предсказуемый поток состояний

BLoC (Business Logic Component) — стандартный паттерн в Flutter-сообществе. Библиотека flutter_bloc реализует его через два типа: Bloc (Event → State) и Cubit (State без Events, только методы).

Bloc обрабатывает Event и эмитирует новый State через on<EventType> хендлеры. Состояние иммутабельно — новый объект на каждое изменение. BlocBuilder перерисовывает только ту часть дерева, где изменился state.

// Event
abstract class CartEvent {}
class AddItemToCart extends CartEvent {
  final String productId;
  AddItemToCart(this.productId);
}

// State
abstract class CartState {}
class CartLoaded extends CartState {
  final List<CartItem> items;
  CartLoaded(this.items);
}

// Bloc
class CartBloc extends Bloc<CartEvent, CartState> {
  CartBloc(this._cartRepository) : super(CartLoaded([])) {
    on<AddItemToCart>(_onAddItem);
  }

  Future<void> _onAddItem(AddItemToCart event, Emitter<CartState> emit) async {
    final current = state as CartLoaded;
    final updated = await _cartRepository.addItem(event.productId);
    emit(CartLoaded(updated));
  }
}

Преимущество BLoC — тестируемость. blocTest из bloc_test пакета позволяет проверить: при таком-то Event, с таким-то начальным State, BLoC должен эмитировать такой-то State. Без UI, без моков для Flutter-фреймворка.

VIPER: для крупных iOS-проектов

VIPER (View, Interactor, Presenter, Entity, Router) — наиболее строгое разделение обязанностей для iOS. Каждый компонент имеет протокол и конкретную реализацию.

• View — только UI, делегирует всё Presenter
• Interactor — бизнес-логика, работа с сетью и данными
• Presenter — посредник между View и Interactor, форматирует данные для View
• Entity — модели данных (чистые структуры)
• Router — навигация между модулями

Каждый модуль (экран или фича) — отдельный VIPER-модуль. Это исключает coupling между фичами и позволяет большим командам работать параллельно без конфликтов.

Цена: много файлов, много протоколов. Шаблонный код генерируется через Sourcery или кастомные Xcode-шаблоны. VIPER оправдан для приложений с 10+ разработчиками и 50+ экранами.

TCA (The Composable Architecture)

TCA от Point-Free — более современная альтернатива VIPER для iOS/macOS. Основные концепции: State (иммутабельное состояние фичи), Action (все возможные события), Reducer (State + Action → новый State + Effect), Store (хранит State, обрабатывает Actions).

Scope позволяет composable строить большие фичи из маленьких: родительский Reducer делегирует часть State дочернему. Каждая фича тестируется изолированно через TestStore с точным контролем над Effects.

TCA имеет крутую кривую обучения, но даёт предсказуемость, которую сложно получить другим способом: каждое изменение состояния — явный Action с конкретным источником.

Какой паттерн выбрать под вашу задачу?

Оценим проект за 1 день — подберём архитектуру с учётом размера команды, платформы и планов роста.

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

Что входит в нашу работу

• Аудит текущей архитектуры (если приложение уже существует) — выявим узкие места и регрессионные зоны.
• Проектирование модульной структуры с чёткими границами слоёв и правилами зависимостей.
• Создание каркаса проекта (Scaffold) с внедрением DI, организации папок и настройки линтеров.
• Написание юнит-тестов для слоя домена и ViewModel — минимум 80% покрытия ключевых use case.
• Подготовка документации — архитектурные диаграммы, README с правилами модификации кода, инструкция для онбординга новых разработчиков.
• Передача рабочего репозитория с CI-пайплайном (GitHub Actions / Bitrise), настроенным запуском тестов и статическим анализом.

Всё это входит в стоимость проектирования. Дополнительно — поддержка на этапе внедрения: консультации команды, code review первых pull request.

Что происходит без архитектуры

Типичный сценарий через 18 месяцев без архитектуры: 40% времени разработки уходит на дебаг регрессий. Новый разработчик разбирается в коде неделю перед тем, как сделать первый PR. Тесты не пишутся, «потому что сложно мокировать». Добавление новой фичи требует понимания половины кодовой базы.

Выбор архитектуры на старте — это инвестиция с возвратом через 3–6 месяцев. По нашим данным, правильно спроектированная архитектура с MVVM + Clean даёт в 3 раза меньше регрессий по сравнению с монолитным ViewController. А затраты на её внедрение окупаются за 2–3 спринта.

Согласно рекомендациям Apple по проектированию приложений, разделение ответственности — ключевой фактор устойчивости кода (https://developer.apple.com/library/archive/featuredarticles/ViewControllerPGforiPhoneOS/ImplementingaViewController.html).

Почему стоит доверить архитектуру профессионалам?

Неправильный выбор паттерна на старте ведёт к переписыванию половины кода через год. Мы видели десятки проектов, где попытка сэкономить на архитектуре оборачивалась многомесячным рефакторингом. У нас за плечами 10+ лет коммерческой разработки, опыт работы с приложениями от 1 до 50 разработчиков. Мы помогаем избежать типовых ошибок:

• Overengineering для простого MVP (назначаем MVVM, а не VIPER).
• Отсутствие dependency injection — подключаем Hilt/Koin/Dagger уже на старте.
• Игнорирование тестируемости — закладываем протоколы/интерфейсы с первого коммита.

Оценим ваш проект бесплатно — пришлите описание текущего приложения или идеи, и мы подберём оптимальную архитектуру за 1 день. Пишите в Telegram или на почту — в ответ вы получите архитектурную схему, план внедрения и смету.

Дополнительная таблица: сравнение затрат на внедрение

Время указано для команды из 2–3 разработчиков. С нашим шаблоном (generator) стартовый каркас готов за 1 день вне зависимости от выбранного паттерна.