Прежде чем перейти к статье, хочу вам представить, экономическую онлайн игру Brave Knights, в которой вы можете играть и зарабатывать. Регистируйтесь, играйте и зарабатывайте!
Всем привет!
Меня зовут Михаил Копченин, я backend-разработчик сервиса биллинга #CloudMTS.
Сегодня я расскажу про то, как мы рефакторили один из проектов, опираясь на принципы чистой архитектуры.
На эксперименты с ЧА нас сподвиг модуль биллинга, который разросся до пухлого монолита. Так бывает, когда в mvp хочется быстрее добавлять новые фичи, а вопросы оптимальности архитектуры откладываются на потом.
Какие задачи хотели решить
Проблемный сервис работал по принципу стандартной трехзвенной архитектуры: с фронта (клиентской части приложения) прилетает запрос, он попадает в слой бизнес-логики (сервер приложений), который взаимодействует со слоем доступа данных (серверы баз данных).
Все функции были в одной куче, бизнес-логика зависела от инфраструктуры — все это «подарило» нам следующие проблемы:
Код было сложно тестировать из-за зависимости от слоя доступа к данным. Последний сложно мокать в тестах. Можно замокать работу Kafka или Redis, а вот с транзакциями баз данных это уже проблематично.
Для тестов приходилось поднимать всю инфраструктуру (Kafka, MongoDB, PostgreSQL) со всеми зависимостями. Это долго и неудобно.
Код из 3 000 срок сложно читать и поддерживать. Особенно это чувствуется, если приходит новичок в команду и ему нужно быстро разобраться в структуре проекта.
По сути в один файл вносили изменения сразу несколько разработчиков. Сложно было мерджить и разрешать конфликты.
В планах было распилить этот пухлый монолит, а для наведения порядка в коде мы решили воспользоваться принципами чистой архитектуры.
Про Clean-архитектуру (в нашем понимании)
Буквально в паре абзацев напомню, что собой представляет этот подход, предложенный Р. Мартином.
Основная идея чистой архитектуры заключается в создании слоистой архитектуры, в которой каждый слой имеет четкую и отдельную ответственность. Слои организованы таким образом, чтобы изменения в одном слое не влияли на другие.
Entities. Здесь содержится бизнес-логика, общая для многих приложений.
Use Cases (Interactors). Логика приложения, конкретная реализация бизнес-логики.
Это внутренние слои.
Внешние слои:
Frameworks. Слой, который содержит весь код, связанный с использованием сторонних фреймворков, библиотек и инструментов, которые необходимы для реализации внешних интерфейсов (UI) и инфраструктуры приложения (база данных, http-клиент и прочее).
Взаимодействие между внутренними слоями и внешним миром обеспечивает слой Interface Adapters. Эти компоненты преобразуют данные из формата, удобного для использования внутри приложения, в формат, удобный для использования внешними системами, и наоборот. Сюда попадают репозитории, gateways, контроллеры.
Еще один основополагающий момент чистой архитектуры — это принцип обратной зависимости (Dependency Inversion). Он про то, что внутренние слои не зависят от внешних. Взаимодействие между ними должно быть построено через абстракции, те же интерфейсы, о которых упоминали выше. Благодаря этому мы можем поменять БД, которую использует приложение, без изменений в бизнес-логике.
Более детально про ЧА расписано в этой статье.
В совокупности такой подход позволяет создавать более гибкие и переносимые системы, так как есть возможность менять реализацию модулей нижнего уровня без изменения модулей верхнего уровня. Также он облегчает тестирование, поскольку тесты могут использовать фиктивные объекты, реализующие абстракции, вместо реальных объектов.
Как раз то, что нужно нам, подумали мы, и устремились.
Как переходили на clean-архитектуру
Рефакторинг проводили в два подхода. На первом этапе мы постарались размотать образовавшийся клубок и поделить все на слои. Мы отделили бизнес-логику от слоя доступа к данным. Выделили юзкейсы. В отличие от канонического варианта, описанного выше, в роли entities у нас выступали модели данных. Это совсем простые модели, которые почти не содержат методов и бизнес-сценариев. Все бизнесовые сценарии сосредоточены в юзкейсах. Они взаимодействуют со слоем инфраструктуры через интерфейсы, которые реализуются через адаптеры. Адаптер реализует интерфейс, который объявлен на стороне юзкейса. То есть адаптер знает, как взаимодействовать с инфраструктурой. Раньше юзкейс напрямую ссылался на адаптер, то есть у него была зависимость от адаптера.
Теперь же граф зависимости изменился не юзкейс (бизнес-логика) ссылается на слой доступа к данным, а, наоборот, адаптер ссылается на юзкейс. Таким образом мы инверсировали зависимость.
На уровне организации кода всю бизнес-логику вынесли в папку Internal:
Модели.
Юзкейсы. В примере на скриншоте мы использовали абстрактные названия бизнес-функций. Так, internal.usecase.apple — каталог с юзкейсами по сущности apple. Содержат в себе .go файлы, которые отрабатывают юзкейсы, связанные с конкретной бизнес-функцией. К примеру, predict_apple_harvest.go обладает всеми методами для выполнения предсказания по урожаю. create.banana.go — то же самое.
Контроллеры, где собрано все, что связывает сервис с внешним миром, — http-хендлеры, консьюмеры Kafka, cronjobs и прочее.
Адаптеры ко всем внешним системам, начиная от БД и заканчивая всеми зависимыми внешними сервисами.
В cmd, каталоге с точками входа в приложение, также произошли изменения. Ранее там был единственный файл (main.go), который запускал все подсистемы приложения. В новом варианте каждая точка входа была выделена отдельно — cli, cron, grpc, http, kafka.
Это разделение облегчило нам написание тестов. Теперь мы могли тестировать юзкейс независимо от слоя доступа к данным: интерфейс легко замокать и передать туда все что угодно.
Если мы захотим поменять БД, например с PostgreSQL на MySQL, нам так же не придется трогать бизнес-логику. Чтобы тесты были максимально эффективными, мы внутри команды договорились по минимуму писать бизнес-логику в хендлерах и адаптерах.
На втором этапе мы поняли, что организация кода по типу файла не очень удобна. Это когда все юзкейсы разных бизнес-сущностей лежали в одной папке. Аналогичная история с моделями и адаптерами. Перемещаться по проекту было сложно.
Теперь в папке Internal под каждую бизнес-сущность был добавлен свой пакет. Например, у нас есть бизнес-домен apple. В одноименном пакете будет находится все, что связано с этим доменом: use cases, адаптеры, модели.
В этой версии мы также избавились от папки контроллеров и перенесли на уровень cmd в соответствующие разделы. Для каждой из точек входа была продумана единая структура:
app — ядро точки входа;
config.go — специфичные настройки конкретной точки входа;
bootstrapper.go — загрузчик приложения. Отвечает за инициализацию всех компонентов, связывает между собой handler и юзкейс, юзкейс и adapter.
В пакете handler, соответственно, лежат все хендлеры. У хендлера очень простая задача: законсюмить сообщение, десериализовать его, смапить в доменную модель, передать юзкейсу, залогировать ошибку от юзкейса.
Таким образом, разработчику, работающему над конкретной функцией, не нужно будет бродить по всему дереву и перебирать разные пакеты, а достаточно открыть одну папку.
Таким образом, разработчику, работающему над конкретной функцией, не нужно будет бродить по всему дереву и перебирать разные пакеты, а достаточно открыть одну папку.
Впечатления и результаты
Новый подход требует времени, чтобы адаптироваться.
Иногда было сложно определить, где бизнес-логика, а где нет, что положить в адаптер, что — в хендлер, а что — в юзкейс. Для себя мы выработали следующий критерий: если это нужно тестировать, то это относится к бизнес-логике. Кроме того, есть правило, что адаптеры и хендлеры должны быть максимально простыми, в них не должно быть никаких условий, кроме условий на проверку ошибок.
Еще поначалу было сложно пересилить себя и добавлять на каждый чих свой user case, состоящий из одной строки кода. Это казалось overhead’ом. Да, действительно приходится писать больше кода.
В краткосрочной перспективе это требует дисциплины, но уже через какое-то время новый подход перестал доставлять неудобства. А вот плюсы были видны практически сразу:
Код стал более гранулярным. Отсюда следует сразу несколько профитов:
проще реализовывать новые бизнес-требования. Не так страшно вносить изменения в существующий код;
есть разделение ответственности на уровне кода и видно, кто за что отвечает;
код легче читать: исходный файл на 3 000 строк разбился на 30 файликов по 100 строк, из которых легко и быстро понять контекст.
Нет тесной связности бизнес-логики и инфраструктуры: если мы захотим перейти на другую базу, то это не составит труда, так как мы работаем с инфраструктурным слоем через интерфейсы.
Нет тесной связности бизнес-логики и инфраструктуры: если мы захотим перейти на другую базу, то это не составит труда, так как мы работаем с инфраструктурным слоем через интерфейсы.
Появилась договоренность между разработчиками, где что лежит, унификация и снизился порог входа.
Наконец, писать юнит-тесты и тестировать код стало легче: не нужно поднимать всю инфраструктуру, задействовать базы данных и прочее.
Не то чтобы мы получили что-то неожиданное, в сравнении с тем, что обещает подход чистой архитектуры. Но было приятно, что ожидания совпали с реальностью. В связи с этим все новые сервисы мы создаем теперь по этим гайдлайнам.
