Backend-common/README.md

47 lines
1.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Modules
## Installation via Gradle Composite Build
1. Add this repository as a
[git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules)
to your project
1. Add these lines to your `settings.gradle.kts`:
```kotlin
includeBuild("Backend-common")
```
1. Use TLK modules as dependencies of your project
```kotlin
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, включая логирование