Проект “Погода” #

Веб-приложение для просмотра текущей погоды. Пользователь может зарегистрироваться и добавить в коллекцию одну или несколько локаций (городов, сёл, других пунктов), после чего главная страница приложения начинает отображать список локаций с их текущей погодой.

Что нужно знать #

Java - коллекции, ООП
Паттерн MVC(S)
Maven/Gradle
Backend
- Spring MVC
- HTTP - GET и POST запросы, HTTP заголовки, cookies
- Thymeleaf
Базы данных
- SQL
- Hibernate
- Миграции
Frontend - HTML/CSS, Bootstrap
Тесты - интеграционное тестирование, моки, JUnit 5
Деплой - облачный хостинг, командная строка Linux, Tomcat

Мотивация проекта #

Использование cookies и сессий для авторизации пользователей
Знакомство со Spring
Работа с внешними API

Функционал приложения #

Работа с пользователями:

Регистрация
Авторизация
Logout

Работа с локациями:

Поиск
Добавление в список
Просмотр списка локаций, для каждой локации отображается название и температура
Удаление из списка

Интерфейс приложения #

Для вёрстки предлагаю пользоваться Bootstrap 5.

Главная страница #

Заголовок
- Для неавторизованных пользователей - кнопки регистрации и авторизации
- Для авторизованных пользователей - логин текущего пользователя и кнопка Logout
Контент
- Поле ввода для поиска локации по названию
- Список добавленных локаций. Каждый элемент списка отображает название, текущую температуру и кнопку “удалить”

Страница результатов поиска локаций по названию #

Переход на эту страницу осуществляется в результате заполнения поля ввода на главной странице, либо на странице результатов поиска.

Содержимое:

Заголовок, такой же как на главной странице
Поле ввода для поиска по названию - такое же, как на главной странице, чтобы не возвращаться туда для каждого нового поиска
Список найденных локаций с кнопкой “добавить”. При нажатии на кнопку происходит переход на главную страницу

Остальное #

Страницы с формами регистрации и авторизации

Работа с сессиями и cookies #

Чтобы реализовать авторизацию пользователя и позволить браузеру “запоминать” авторизован ли текущий пользователь, необходимы сессии и cookies. Подразумевается, что студент имеет общее представление об этих понятиях.

При авторизации пользователя бэкенд приложение создаёт сессию с идентификатором, и устанавливает этот идентификатор в cookies HTTP ответа, которым приложение отвечает на POST запрос формы авторизации. К тому же, сессия содержит в себе ID авторизовавшегося юзера.

Дефолтным JSESSIONID не пользуемся!

Далее, при каждом запросе к любой странице, бэкенд приложение анализирует cookies из запроса и определяет, существует ли сессия для ID из cookies. Если есть - страница рендерится для того пользователя, ID которого соответствует ID сессии из cookies.

Фреймворки, в том числе Spring, умеют управлять всем этим. Цель этого проекта - поработать с cookies и сессиями вручную, чтобы понимать, как они работают, поэтому принципиально советую не ипользовать Spring Security, Spring Session.

Spring MVC #

Какие компоненты Spring пригодятся в проекте:

Beans, Dependency Injection
Контроллеры
Профили
Интеграция с Thymeleaf, Flyway/Liquibase
Spring Tests
RestTemplate / WebClient

База данных #

В этом проекте предлагаю использовать Postgres/MySQL/MariaDB. Создавать таблицы будем не через Hibernate, как в предыдущем проекте, а с помощью инструмента миграций - Flyway/Liquibase.

Таблица `Users` #

Колонка	Тип	Комментарий
ID	int	Айди пользователя, автоинкремент, первичный ключ
Login	Varchar	Логин пользователя, username или email
Password	Varchar	Хранить пароль в открытом виде небезопасно, лучше использовать шифрование, например BCrypt

Таблица `Locations` #

Локации пользователя, в которых он хочет знать погоду. Одна и та же локация может повторяться для нескольких пользователей.

Колонка	Тип	Комментарий
ID	int	Айди локации, автоинкремент, первичный ключ
Name	Varchar	Название
UserId	int	Пользователь, добавивший эту локацию
Latitude	Decimal	Широта локации
Longitude	Decimal	Долгота локации

Таблица `Sessions` #

Колонка	Тип	Комментарий
ID	Varchar	Айди сессии, GUID, первичный ключ
UserId	int	Пользователь, для которого сессия создана
ExpiresAt	Datetime	Время истечения сессии. Равно времени создания сессии плюс `N` часов

Получение информации о погоде с помощью OpenWeatherMap API #

В предыдущих проектах мы писали своё API, в этом будем пользоваться чужим. Нам нужно искать локации по названию и получать погоду для локации.

OpenWeather #

Существует множество сервисов, предоставляющих API с таким функционалом, один из них - https://openweathermap.org/. Я выбрал этот вариант, потому что он позволяет бесплатно совершать 60 запросов в минуту.

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

Зарегистрироваться на https://openweathermap.org/
Создать бесплатный ключ с лимитом 60 запросов в минуту
Дождаться активации ключа (

Работа с API #

Документация - https://openweathermap.org/api.

Нам нужно 2 метода API:

Поиск локаций по названию - https://openweathermap.org/current#geocoding
Получение погоды по координатам локации - https://openweathermap.org/current#one

Первым делом следует поэкспериментировать с API вручную, чтобы понять как делать запросы, и что приходит в ответе. Сделать это можно в HTTP клиенте встроенном в Intellij IDEA, либо воспользоваться отдельным приложением, например https://insomnia.rest/.

Интеграция OpenWeather API с Java приложением #

Шаги:

Делаем запрос
Получаем ответ
Десериализуем ответ в объект Java

Для работы с API потребуется HTTP Client, например https://www.baeldung.com/java-9-http-client.

С десериализацией поможет JsonMapper из библиотеки Jackson.

Фронтенд #

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

Поэтому, для проекта существует готовая верстка, которую можно взять за основу. Если хотите расширить функционал проекта или сделать верстку с нуля - приветствую желание самостоятельно это сделать.

Репозиторий с версткой - https://github.com/zhukovsd/weather-viewer-html-layouts.

Что внутри - макеты четырёх страниц, адаптивная верстка (десктопы, телефоны). Минимальный Javascript для показа меню навигации на телефонах.

Задеплоенные на GitHub Pages страницы для демонстрации:

Главная страница с 5 карточками погоды
Результаты поиска
Авторизация, дополнительный вариант с ошибками валидации
Регистрация, дополнительный вариант с ошибками валидации
Страница с ошибкой

Как пользоваться:

Перенести в проект нужные для веб-страниц ресурсы - CSS, картинки
На основе HTML верстки создать шаблонизированные страницы с добавлением тегов Thymeleaf

Тесты #

Интеграционные тесты сервисов по работе с пользователями и сессиями #

Покроем тестами связку слоя данных с классами-сервисами, отвечающими за пользователей и сессии.

Пример - вызов метода регистрации в классе-сервисе, отвечающем за работу с пользователями, должен привести к тому, что в таблице Users появляется новая запись. Если при регистрации автоматически создается сессия, так же можем проверить, что она была создана.

Что ещё стоит проверить тестами:

Регистрация юзера с неуникальным логином приводит к exception
Истекание сессии

Детали:

Для тестов должна использоваться БД, отдельная от основной (in-memory БД или независимая schema в основной БД), которая пересоздается (или очищается) перед каждым тест кейсом
Понадобится 2 конфигурации приложения - основная (для разработки и деплоя) и для прогона тестов. Конфигурации могут отличаться настройками доступа к БД для Hibernate, настройками приложения (длительность сессии, например)

Интеграционные тесты для сервиса по работе с OpenWeather API #

Покроем тестами связку HTTP клиента и класса-сервиса, который пользуется этим клиентом для получения данных. Для того чтобы не делать настоящие запросы к API во время прогона тестов, следует использовать мок HTTP клиента и его ответов.

Пример - запрашиваем список локаций у сервиса, мок HTTP клиента возвращает заданный в тесте ответ (в виде строки, например), сервис его парсит и возвращает коллекцию объектов-моделей. Проверяем, что коллеция содержит ожидаемую локацию.

Что ещё стоит проверить тестами:

В случай ошибки (статусы 4xx, 5xx) от OpenWeather API сервис выбрасывает ожидаемый тип исключения

Деплой #

Будем вручную деплоить war артефакт в Tomcat, установленный на удалённом сервере. Потребуется установка внешней SQL БД по выбору.