Weather Project

Описание

Этот проект представляет собой микросервисную архитектуру для работы с погодой и взаимодействия с Telegram ботом. Система позволяет пользователям получать информацию о погоде в их городах и получать уведомления о прогнозе погоды в их временной зоне. Проект состоит из нескольких микросервисов, включая сервис погоды, сервис пользователей и Telegram бот.

Технологии

• Java: Основной язык программирования.
• Spring Boot: Фреймворк для создания микросервисов.
• Hibernate: ORM для работы с базой данных.
• RabbitMQ: Message broker для асинхронного взаимодействия между микросервисами.
• Telegram Bots API: Для создания и управления Telegram ботом.
• PostgreSQL: СУБД для хранения данных.
• JUnit: Тестирование.
• GitHub Actions: CI/CD для автоматизации сборки и развертывания.
• Maven: Управление зависимостями и сборка проекта.
• Json-Simple: Для работы с JSON в некоторых частях проекта.

Структура проекта

1. Weather API Service: Микросервис, предоставляющий информацию о погоде. Использует RestAPI для получения запросов от других микросервисов, для отправки уведомлений использует RabbitMQ и RestAPI.
2. User Service: Микросервис для управления пользователями и хранения данных о пользователях, таких как их местоположение и состояние.
3. Telegram Bot Service: Бот для Telegram, который позволяет пользователям запрашивать информацию о погоде и получать уведомления. Использует REST API и RabbitMQ для взаимодействия с другими микросервисами.

Установка и запуск

1. Настройка базы данных

Создайте базу данных PostgreSQL и пользователя:

CREATE DATABASE weatherproject;
CREATE USER username WITH LOGIN PASSWORD 'password';
GRANT ALL PRIVILEGES ON DATABASE weatherproject TO username;

Создайте таблицы и триггер:

-- Таблица для хранения данных о погоде
CREATE TABLE city_weather
(
    id          SERIAL PRIMARY KEY,
    city        VARCHAR(255),
    temperature DOUBLE PRECISION,
    condition   VARCHAR(255),
    updated_at  TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);

ALTER TABLE city_weather
    OWNER TO username;

-- Таблица для хранения данных о пользователях
CREATE TABLE tguser
(
    chat_id BIGINT NOT NULL PRIMARY KEY,
    city    VARCHAR(255),
    state   VARCHAR(255)
);

ALTER TABLE tguser
    OWNER TO username;

-- Функция для проверки изменения температуры
CREATE FUNCTION fn_check_temp_change() RETURNS TRIGGER
    LANGUAGE plpgsql
AS
$$
DECLARE
    last_temp_1 FLOAT;
    last_temp_2 FLOAT;
    avg_temp    FLOAT;
    diff_temp   FLOAT;
    output      JSON;
BEGIN
    -- Получаем последние две температуры для данного города
    SELECT temperature
    INTO last_temp_1
    FROM city_weather
    WHERE city = NEW.city
    ORDER BY updated_at DESC
    LIMIT 1 OFFSET 1;

    SELECT temperature
    INTO last_temp_2
    FROM city_weather
    WHERE city = NEW.city
    ORDER BY updated_at DESC
    LIMIT 1 OFFSET 2;

    -- Если мы нашли хотя бы две предыдущие записи, вычисляем среднюю температуру
    IF last_temp_1 IS NOT NULL AND last_temp_2 IS NOT NULL THEN
        avg_temp := (last_temp_1 + last_temp_2) / 2;

        -- Вычисляем разницу между средней температурой и новой температурой
        diff_temp := ABS(avg_temp - NEW.temperature);

        -- Если разница больше или равна 2 градусам, возвращаем JSON
        IF diff_temp >= 2 THEN
            output := JSON_BUILD_OBJECT(
                    'city', NEW.city,
                    'last_temp', NEW.temperature,
                    'diff_temp', diff_temp
                      );
            RAISE NOTICE '%', output;
        END IF;
    END IF;

    RETURN NEW;
END;
$$;

ALTER FUNCTION fn_check_temp_change() OWNER TO username;

2. Конфигурация

Настройте параметры подключения и API-ключи в файле application.yml для каждого микросервиса:

spring:
  datasource:
    url: jdbc:postgresql://localhost:5432/weatherproject
    username: username
    password: password
  rabbitmq:
    host: localhost
    port: 5672
    username: guest
    password: guest
  weather:
    api:
      url: "http://api.weatherapi.com/v1/current.json?key=${WEATHER_API_KEY}&q={city}&aqi=no"

3. Настройка Systemd

Создайте файлы для управления сервисами:

• Weather API Service

  sudo nano /etc/systemd/system/weather-api-service.service

  [Unit]
  Description=Weather API Service
  After=network.target
  
  [Service]
  User=yourUsername
  ExecStart=/path/to/java -jar /home/yourUsername/weatherProject/weatherApiService/target/weatherApiService-0.0.1-SNAPSHOT.jar
  
  SuccessExitStatus=143
  Restart=always
  RestartSec=10
  Environment=SPRING_PROFILES_ACTIVE=prod
  Environment=WEATHER_API_KEY=<YOUR_API_KEY(e.g. from weatherapi.com/)>
  
  [Install]
  WantedBy=multi-user.target

• User Service

  sudo nano /etc/systemd/system/user-service.service

  [Unit]
  Description=User Service Spring Boot Application
  After=syslog.target
  
  [Service]
  User=xyl1gan4eg
  ExecStart=/path/to/java -jar /home/yourUsername/weatherProject/userService/target/userService-0.0.1-SNAPSHOT.jar
  
  SuccessExitStatus=143
  Restart=always
  RestartSec=10
  
  [Install]
  WantedBy=multi-user.target

• Telegram Bot Service

  sudo nano /etc/systemd/system/tg-bot-service.service

  [Unit]
  Description=Telegram bot Service
  After=network.target
  
  [Service]
  User=xyl1gan4eg
  ExecStart=/path/to/java -jar /home/yourUsername/weatherProject/tgBotService/target/TgBotService-0.0.1-SNAPSHOT.jar
  
  SuccessExitStatus=143
  Restart=always
  RestartSec=10
  Environment=SPRING_PROFILES_ACTIVE=prod
  Environment=TG_BOT_API_KEY=<YOUR_API_KEY (from @BotFather)>
  
  [Install]
  WantedBy=multi-user.target

4. Запуск микросервисов

Каждый микросервис можно запустить с помощью Maven:

mvn clean install

5. Развертывание

Для автоматического развертывания используйте GitHub Actions. Определите рабочие процессы в .github/workflows/:

e.g. deploy.yml:

name: Deploy to Ubuntu Server

on:
  push:
    branches:
      - main

jobs:
  cleanup:
    uses: ./.github/workflows/cleanup.yml
    secrets: inherit  # Наследовать секреты от основного workflow

  deploy_user_service:
    needs: cleanup
    uses: ./.github/workflows/deploy_user_service.yml
    secrets: inherit  # Наследовать секреты от основного workflow

  deploy_weather_service:
    needs: cleanup
    uses: ./.github/workflows/deploy_weather_service.yml
    secrets: inherit  # Наследовать секреты от основного workflow

  deploy_tg_bot_service:
    needs: cleanup
    uses: ./.github/workflows/deploy_tg_bot_service.yml
    secrets: inherit  # Наследовать секреты от основного workflow

e.g. cleanup.yml

name: Cleanup server

on:
  workflow_call:

jobs:
  cleanup:
    runs-on: ubuntu-latest
    steps:
      - name: SSH into server and clean up source code
        uses: appleboy/ssh-action@master
        with:
          host: ${{ secrets.SERVER_HOST }}
          username: ${{ secrets.SERVER_USERNAME }}
          key: ${{ secrets.CLIENT_PRIVATE_KEY }}
          script: |
            echo "Cleaning up source code..."
            sudo rm -Rf /home/user/javaProjects/weatherProject/  # Удалить исходный код с сервера
            echo "Cleanup completed."

e.g. deploy_tg_bot_service.yml

name: Deploy Telegram weather bot Service

on:
  workflow_call:

jobs:
  deploy_tg_bot_service:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Copy tgBotService source code via ssh
        uses: appleboy/[email protected]
        with:
          host: ${{ secrets.SERVER_HOST }}
          username: ${{ secrets.SERVER_USERNAME }}
          key: ${{ secrets.CLIENT_PRIVATE_KEY }}
          source: tgBotService/
          target: /home/xyl1gan4eg/myJavaProjects/weatherProject/

      - name: SSH into server and build tgBotService
        uses: appleboy/ssh-action@master
        with:
          host: ${{ secrets.SERVER_HOST }}
          username: ${{ secrets.SERVER_USERNAME }}
          key: ${{ secrets.CLIENT_PRIVATE_KEY }}
          script: |
            echo "Building tgBotService on server..."
            cd /home/xyl1gan4eg/myJavaProjects/weatherProject/tgBotService
            mvn clean install
            echo "Build completed."

      - name: Restart tgBotService
        uses: appleboy/ssh-action@master
        with:
          host: ${{ secrets.SERVER_HOST }}
          username: ${{ secrets.SERVER_USERNAME }}
          key: ${{ secrets.CLIENT_PRIVATE_KEY }}
          script: |
            sudo systemctl stop tg-bot-service.service
            sudo cp /home/xyl1gan4eg/myJavaProjects/weatherProject/tgBotService/*.jar /opt/tgBotService/
            sudo systemctl start tg-bot-service.service

e.g. deploy_user_service.yml

name: Deploy User Service

on:
  workflow_call:

jobs:
  deploy_user_service:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Copy userService source code via ssh
        uses: appleboy/[email protected]
        with:
          host: ${{ secrets.SERVER_HOST }}
          username: ${{ secrets.SERVER_USERNAME }}
          key: ${{ secrets.CLIENT_PRIVATE_KEY }}
          source: userService/
          target: /home/xyl1gan4eg/myJavaProjects/weatherProject/

      - name: SSH into server and build userService
        uses: appleboy/ssh-action@master
        with:
          host: ${{ secrets.SERVER_HOST }}
          username: ${{ secrets.SERVER_USERNAME }}
          key: ${{ secrets.CLIENT_PRIVATE_KEY }}
          script: |
            echo "Building userService on server..."
            cd /home/xyl1gan4eg/myJavaProjects/weatherProject/userService
            mvn clean install
            echo "Build completed."

      - name: Restart userService
        uses: appleboy/ssh-action@master
        with:
          host: ${{ secrets.SERVER_HOST }}
          username: ${{ secrets.SERVER_USERNAME }}
          key: ${{ secrets.CLIENT_PRIVATE_KEY }}
          script: |
            sudo systemctl stop user-service.service
            sudo cp /home/xyl1gan4eg/myJavaProjects/weatherProject/userService/*.jar /opt/userService/
            sudo systemctl start user-service.service

e.g. deploy_weather_api_service.yml

name: Deploy Weather Api Service

on:
  workflow_call:

jobs:
  deploy_weather_api_service:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Copy weatherApiService source code via ssh
        uses: appleboy/[email protected]
        with:
          host: ${{ secrets.SERVER_HOST }}
          username: ${{ secrets.SERVER_USERNAME }}
          key: ${{ secrets.CLIENT_PRIVATE_KEY }}
          source: weatherApiService/
          target: /home/xyl1gan4eg/myJavaProjects/weatherProject/

      - name: SSH into server and build weatherApiService
        uses: appleboy/ssh-action@master
        with:
          host: ${{ secrets.SERVER_HOST }}
          username: ${{ secrets.SERVER_USERNAME }}
          key: ${{ secrets.CLIENT_PRIVATE_KEY }}
          script: |
            echo "Building weatherApiService on server..."
            cd /home/xyl1gan4eg/myJavaProjects/weatherProject/weatherApiService
            mvn clean install
            echo "Build completed."

      - name: Restart weatherApiService
        uses: appleboy/ssh-action@master
        with:
          host: ${{ secrets.SERVER_HOST }}
          username: ${{ secrets.SERVER_USERNAME }}
          key: ${{ secrets.CLIENT_PRIVATE_KEY }}
          script: |
            sudo systemctl stop weather-api-service.service
            sudo cp /home/xyl1gan4eg/myJavaProjects/weatherProject/weatherApiService/*.jar /opt/weatherApiService/
            sudo systemctl start weather-api-service.service

Примеры использования

Получение погоды

Отправьте запрос на /weather/city с параметром city, чтобы получить информацию о погоде в заданном городе:

curl -X GET "http://localhost:8080/weather/city?city=Paris"

Отправка геолокации через Telegram бот

Используйте кнопку с запросом геолокации в Telegram бот для отправки вашей геолокации.

Тестирование

Для тестирования используйте JUnit. Для отключения тестов при сборке используйте Maven:

mvn clean package -DskipTests

Паттерны проектирования

Паттерны проектирования

В проекте применяются следующие паттерны проектирования:

• Команда: Для обработки команд и коллбеков в Telegram боте.
• Observer: Для уведомлений о прогнозе погоды.
• Strategy: Для обработки разных типов запросов и команд.

TODO

• Улучшение кода: Переписать и улучшить текущий код.
• Добавление тестов: Увеличить покрытие тестами.
• Прогноз погоды: Перейти на другой API для получения прогноза погоды

---