ArchGuard backend

ArchGuard — это инструмент управления архитектурой, который может анализировать архитектуру на уровне контейнеров, компонентов, кода, базы данных, создавать функции соответствия архитектуры и проверять правила архитектуры.

На китайском языке: ArchGuard — это рабочий стол/инструмент управления архитектурой для микросервисов (распределённых сценариев). Он может помочь архитекторам и разработчикам в самостоятельном анализе и понимании архитектуры, анализе удалённых сервисных зависимостей между системами, зависимостей баз данных, API-зависимостей и т. д. И на основе некоторых моделей управления архитектурой предложить улучшения для существующей системы.

Документ: https://archguard.org/ Дорожная карта: https://github.com/archguard/archguard/discussions/5 Вклад: https://archguard.org/contribution Подпроекты: * ArchGuard Frontend: https://github.com/archguard/archguard-frontend * Chapi: анализ исходного кода https://github.com/modernizing/chapi * Co-mate от ArchGuard: AI-помощник по архитектуре, инструменты проектирования и управления. https://github.com/unit-mesh/co-mate

Архитектура:

Можно использовать:

• Библиотеку ArchGuard в Maven Central для интеграции с вашим бэкэндом.
• Сканер CLI ArchGuard для сканирования вашего исходного кода, загрузки в ваш бэкэнд или бэкэнд ArchGuard.
• Gradle-плагин ArchGuard для сканирования исходного кода в CI/CD.
• Веб-сайт ArchGuard является бэкэндом ArchGuard и предоставляет RESTful API для внешнего интерфейса.

Особенности:

1. Состояние проектирования

• Архитектура, анализ и управление DSL.
• Feakin: https://github.com/feakin/fklang

2. Состояние разработки

• Схемы сканирования
  • Конфигурация сканирования
  • Настройка правил плагинов
  • Управление на основе правил: Code Smell, Test Code Smell, SQL Smell, API Smell, Documentation Smell и др.
• Визуализация архитектуры
  • Визуальный анализ на основе модели C4
    • Контекст: карта сервисов API (языки поддержки производителей API: Java, Kotlin, C#, языки поддержки потребителей API: TypeScript/JavaScript, Kotlin, Java и др.)
    • Анализ контейнеров. Карта базы данных (поддержка MyBatis, JDBI, JPA)
    • Компонентный анализ
    • Кодовый анализ: поддерживает четыре уровня модулей, пакетов, классов и методов.
  • Расширенный анализ + визуализация
    • Системный модуль анализа нестабильности.
    • Контейнерный анализ: точный тест/анализ изменений.

3. Показатели архитектуры (монолит DONE, распределённая система DOING)
   • Объёмная размерность: слишком большие компоненты.
   • Размерность сцепления: центральные компоненты, слишком глубокие вызовы, циклические зависимости.
   • Внутренняя размерность: взрывное изменение.
   • Избыточная размерность: избыточные элементы, чрезмерная генерализация.
   • Качество размерности: тестовая защита.
4. Анализ кода
   • CLOCO: сложность кода #79
   • SCA-анализ
   • OpenAPI-анализ
   • Архитектурный анализ
5. Рабочее состояние архитектуры

• APM (TODO)

6. Рабочий стол архитектуры