Шаблоны разработки – берём готовое, адаптируем под себя

Чтобы не писать один и тот же код заново, мы собираем решения в отдельный репозиторий на GitHub. Это шаблоны разработки. Ниже – главное, что нужно знать о том, что это и как их внедрить в свой проект.

Предназначение шаблонов

Шаблон разработки – это решение для типовых задач, которые регулярно появляются на проектах внедрения. «Каталог» шаблонов формируется на основе реального опыта внедрения Directum RX. Шаблон закрывает целый бизнес-процесс или его часть и готов для повторного использования. Шаблоны разработки выделяются, если «писать» то же самое с нуля повторно дольше 10 часов.

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

Вот адрес публичного репозитория-«каталога»: https://github.com/DirectumCompany/DirectumContribIndex.

Обратите внимание: в репозитории найдутся не только шаблоны разработки, но и различные примеры кода, прототипы и полезные утилиты.

Инструкция по применению

Шаг 1. Понять, подходит ли шаблон для решения задачи.

Для выполнения шага понадобится ReadMe репозитория.

Решаемая задача может быть описана прямо в тексте:

Или будет указана ссылка на документацию:

Шаг 2. Оценить, как установка шаблона повлияет на текущую разработку.

Одна из важных характеристик шаблонов – минимизировано количество перекрытий для исключения конфликтов публикации, набор объектов разработки можно поставить обособлено от прочей реализации. Чтобы понять, что появится дополнительно или будет перекрыто, ищем в ReadMe раздел с составом объектов разработки:

Шаг 3. Разобраться, как адаптировать шаблон.

Для выполнения шага снова понадобится ReadMe или инструкция. В них описаны:

• логика работы функциональности с указанием ключевых сущностей и функций:
• инструкции по доработке и использованию сущностей и функций:
• примеры доработки:
• доработки, которые можно выполнить, чтобы шаблон научился делать что-то дополнительное к заявленному:

Шаг 4. Установить шаблон.

В конце текста ReadMe всегда есть описание нескольких способов установки шаблона. Выбор способа зависит от цели, с которой ставится шаблон.

Обратите внимание: сначала рекомендуется установить шаблон на отдельный стенд для тестирования и анализа применимости.

Способы установки:

а) Установка для ознакомления с шаблоном. Рекомендуется как первый шаг перед внедрением. Разверните шаблон на отдельном стенде, чтобы:

• проверить его работу в исходном виде;
• оценить применимость к задачам проекта.

b) Установка для использования и адаптации шаблона. Выбираем способ после выполнения следующих условий:

• ознакомились с шаблоном;
• приняли решение по результатам исследования, что шаблон может решить поставленную на проекте задачу;
• спроектировали адаптацию шаблона под решаемую задачу.

 Рекомендуемый вариант установки шаблона:

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

Поддержка версионности

Шаблоны разработки регулярно обновляются с выходом каждой новой версии Directum RX. Самая свежая реализация хранится в ветке main/master. Реализацию под предыдущие версии всегда можно найти в ветках с названием, соответствующим версии:

Поддерживаемые версии можно уточнить в ReadMe:

Обратите внимание: совместимость версий шаблонов разработки при обновлении не поддерживается, поэтому если в новой версии шаблона появится новая функциональность или будут изменены какие-либо функции / сущности, может понадобиться адаптация шаблона для проекта после обновления.

Обратная связь и предложения

Пожелания и замечания можно добавить к каждому шаблону через Issues:

Список шаблонов разработки готов пополняться, поэтому если у вас есть идеи для разработки нового шаблона, то добро пожаловать в раздел Идеи!