Homework Y_LAB: Training Diary

Приложение для ведения дневника тренировок. Скоро лето и еще не поздно привести себя в порядок! Данное приложение поможет вам нагнать темп и следить за своим здоровьем. Записывайте свои тренировки, чтобы анализировать свой прогресс. И помните, что главное - это регулярность.

Ссылки на PR

1. Link PR №1
2. Link PR №2
3. Link PR №3

Ссылки на ТЗ

1. Link HW №1
2. Link HW №2
3. Link HW №3

Important

Создано с помощью:

• Java 17
• Lombok
• Mapstruct
• JUnit 5
• Mockito 5
• Maven
• Docker
• Test-containers
• Servlet API
• Jackson
• AOP: AspectJ
• Postman

Note

Что это? Это REST API приложение для тренировок. Оно позволяет вести учет своих тренировок. Вы сможете запрашивать важную для вас статистику, например количество потраченных калорий в течение тренировки, ваш вес, длительность тренировки, сколько вы отдыхали и сколько подходов/км сделали/прошли. Это приложение поможет достичь результата с помощью регулярности. Мы не стоим на месте и развиваемся дальше, поэтому уже сегодня наше приложение можно запустить на любой машине, где есть Java 17 и Docker.

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

Архитектура приложения

Взаимодействие разрешений для групп

Разрешения для групп могут использоваться в разных вариациях:

• Для блокирования View определенных частей веб приложения обращаясь в сервис GroupPermissionsService (например, можно скрывать часть меню для определенных групп и открывать для других).
• Для реализации любого сервиса предусмотреть блокировку операций и частей сервисов в зависимости от выставленных разрешений

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

• Для нормального функционирования приложения требуется, чтобы в базу загрузились все первоначально-задуманные данные (Пользователь admin, группы разрешений для пользователей и админа, базовые типы тренировки). Все это делается автоматически с помощью миграций Liquibase.

Диаграмма взаимодействия в БД

Tip

Что можно улучшить:

• перевести на микросервисную архитектуру
• перевести на Spring Boot
• увеличить покрытие кода тестами
• перевести остальную часть компонентов на @Slf4j

Сборка и запуск

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

• Java 17
• Docker version 24.0.5
• Docker Compose version v2.20
• Postman

Действия для запуска:

• Переименовываем файл переменных окружения.env1 в .env(если требуется, внесите изменения)
• Запустить Docker
• Находясь в главном каталоге с помощью Maven собрать проект mvn clean install Проект соберется и запустятся автоматические тесты. Обратите внимание, в тестах используются тест-контейнеры, поэтому будет запускаться образ в докере для тестов. После того как тесты отработают, контейнер для тестов сам деактивируется.
• В главном каталоге командой docker-compose up -d собрать образ СУБД PostgreSQL и образ Tomcat, в который автоматически зальется наше приложение перед стартом и запустятся Docker контейнеры.
• После всех проделанных выше действий есть 2 варианта проверить работу проекта:
• 1). С помощью любого REST клиента проверить работающие эндпоинты(встроенный в IDEA, Insomnia, Postman и т.д.)
• 2). Запустить установленный Postman и импортировать в него готовые тесты, которые находятся в папке postman Важно! Тесты в postman нужно запускать на чистой БД, которая только создалась. Если в нее что-то добавить, то логика работы тестов может поломаться. После отработки, можно с помощью любого клиента подключиться к Postgre БД и проверить наполнение данными.

• Бывает очень редко, но все же, если вдруг контейнер с приложением Tomcat не смог подключиться к БД после первого старта, его нужно перезапустить, тогда он нормально инициализирует миграцию.