Architecture Course Home / Архитектурные шаблоны / Шаблоны низшего порядка / Шаблоны переиспользования общего кода

Shared library pattern

Проблема

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

Решение

Одним из наиболее распространенных методов использования общего кода будет использование общих библиотек. Упакуйте общий код во внешний артифакт (например, JAR-файл, DLL и т. д.), содержащий исходный код, используемый несколькими сервисами.

image2023-5-11_15-45-25.png

Основные две проблемы с которыми придется столкнуться:

Управление зависимостями и контроль изменений

Рассмотрим общую библиотеку, проиллюстрированную на рисунке ниже. Обратите внимание, что, хотя управление зависимостями относительно просто (каждая служба использует единую общую библиотеку), управление изменениями - не будет такой же тривиальной задачей. Если происходит изменение в любом из файлов классов в большой общей библиотеке, каждый сервис, независимо от того, нужны ему эти изменения или нет, должен в конечном итоге применить это изменение из-за устаревания версии общей библиотеки. Это порождает ненужное повторное тестирование и развертывание всех сервисов, использующих эту библиотеку.

Решение

Разбейте общего кода на более мелкие общие библиотеки на основе функциональности (такие как безопасность, форматеры, аннотации, калькуляторы и т. д.) это лучше для контроля изменений и общей ремонтоспособности, но, к сожалению, создает беспорядок с точки зрения управления зависимостями. Как показано на рисунке ниже, изменение общего класса C7 влияет только на сервис D и сервис E, но управление матрицей зависимости между общими библиотеками и сервисами быстро начинает выглядеть как большой шар распределенной грязи.

Стратегия версионирования

Чтобы проиллюстрировать проблему, рассмотрим общую библиотеку, содержащую общие правила проверки полей Validation.jar, которая используется 10 сервисами. Предположим, что один из этих сервисов нуждается в немедленном изменении одного из правил проверки. Путем версионирования файла Validation.jar сервис, нуждающаяся в изменении, может немедленно включить новую версию Validation.jar и сразу же быть развернутым в производство без какого-либо влияния на остальные 9 сервисов. Без управления версиями все 10 сервисов должны быть протестированы и развернуты, тем самым увеличивая время и координацию для изменения общей библиотеки.

Одной из первых сложностей управления версиями общей библиотеки является коммуникация об изменении версии. В высокораспределенной архитектуре с несколькими командами часто бывает трудно сообщить об изменении версии в общую библиотеку. Откуда другие команды знают, что Validation.jar только что перешла на версию 1.5? Какие были изменения? Какие сценарии затронуты? Какие команды пострадали? Даже с множеством инструментов, позволяющих упростить работу с версионированием, изменения версий, тем не менее, должны быть согласованы с всеми сервисами использующими общую библиотеку.

Решение

Настройте процесс уведомления заинтересованных о изменениях в общей библиотеки. Контролируйте количество версий общей библиотеки и уведомляйте потребителей о прекращении поддержки старых версий. Не используйте LATEST версии. Они делают вашу систему недетерминированной.

Когда использовать

Шаблон общей библиотеки является хорошим подходом для однородных сред, где изменение общего кода является низким или умеренным. Возможность версии (хотя иногда и сложной) обеспечивает хороший уровень гибкости при внесении общих изменений в код. Поскольку общие библиотеки обычно привязаны к сервису во время компиляции, такие эксплуатационные характеристики, как производительность, масштабируемость и отказоустойчивость.

Trade-Offs

ПреимуществаНедостатки

Возможность изменения версии

Управление зависимостями будет трудной задачей

Общий код основан на компиляции, что снижает количество ошибок во время выполнения.

Дублирование кода в разнородных кодовых базах

Хорошая гибкость для изменений кода с общим кодом

Устаревание версии может быть проблемой


Версионирование может стать проблемой

Оригинал на wiki