Backend-common/README.md

Modules

Installation via Gradle Composite Build

1. Add this repository as a git submodule to your project

2. Add these lines to your settings.gradle.kts:

   includeBuild("Backend-common")
   

3. Use TLK modules as dependencies of your project

   dependencies {
       implementation("ru.touchin:common")
   }
   

common

Набор утилит, структур данных, исключений без привязки к spring

• ExecutionContext - класс для хранения/получения данных из текущего потока
• SecureRandomStringGenerator - генератор случайной строки по словарю
• errors.* - базовые исключения
• <type>.*Utils - утилиты для различных типов данных

common-spring

Набор утилит, структур данных для spring, без привязки к доп. модулям, таким как jpa и web

common-spring-jpa

• models.* - базовые Entity
• repositories - утилиты и доп. интерфейсы для репозиториев
• EnableJpaAuditingExtra - подключение JpaAuditing с поддержкой типа ZoneDateTime

common-spring-web

• request.Utils - различные extensions для работы с HttpServletRequest
• errors.* - исключения и типы данных для web
• webclient.* - классы для расширения webclient, включая логирование

common-spring-test

Утилиты для тестирования в среде spring-test

common-spring-test-jpa

Утилиты для тестирования репозиториев

logger

Основные компоненты логирования:

• layout
• context
• format

logger-spring

Встраивание системы логирования в spring

• autologging
• serializer

logger-spring-web

Interceptor для логирования запросов/ответов.

exception-handler-spring-web

Перехватывает ошибки сервера, определяет код ошибки и возвращает их в правильный response

exception-handler-logger-spring-web

Добавляет логирование в обработку ошибок

version-spring-web

Добавляет возможность задавать версию апи через properties без необходимости явно указывать в каждом маппинге