Как создать и развернуть приложение на Gin: быстрый и простой деплой с App Platform

Gin — это высокоэффективный HTTP-веб-фреймворк, написанный на языке программирования Go, который предоставляет разработчикам мощные инструменты для создания веб-приложений, RESTful API и микросервисов. Он выделяется среди других фреймворков своей высокой скоростью обработки запросов, гибкостью настройки и простотой использования.

Одним из ключевых преимуществ Gin является его производительность. Gin использует минималистичный подход к обработке HTTP-запросов, что позволяет ему быть одним из самых быстрых фреймворков на рынке. Он основан на модуле net/http стандартной библиотеки Go, что обеспечивает отличную интеграцию с существующей экосистемой Go и позволяет использовать возможности конкурентного программирования Go для обработки большого количества одновременных запросов.

Другим важным преимуществом Gin является его простота. Синтаксис и структура Gin интуитивно понятны, что снижает порог вхождения для разработчиков и ускоряет процесс разработки. Встроенная система маршрутизации позволяет легко определять и обрабатывать маршруты, а мощная система middlewares позволяет гибко управлять обработкой запросов.

Гибкость Gin также заслуживает особого внимания. Он предоставляет возможность расширения функциональности через плагины и middlewares, что позволяет адаптировать его под специфические требования проекта. Встроенная поддержка JSON и других форматов данных упрощает создание RESTful API, а инструменты для работы с запросами и ответами позволяют легко управлять данными.

В дополнение к этому, Gin обладает активным сообществом и хорошей документацией, что делает его отличным выбором для разработчиков, ищущих надежный и поддерживаемый фреймворк. Существует множество ресурсов, включая примеры кода, руководства и библиотеки, которые облегчают процесс обучения и разработки.

Создание приложения

Описание функционала

Наше приложение будет поддерживать основные CRUD-операции (создание, чтение, обновление, удаление) для заметок через RESTful API. В ходе разработки мы обсудим ключевые аспекты интеграции Gin и ORM-библиотеки GORM, а также продемонстрируем, как обеспечить безопасность и производительность нашего веб-приложения. Основные возможности нашего приложения включают:

1. Создание новой заметки:

• • Пользователь сможет добавить новую заметку, отправив POST-запрос с заголовком и содержимым заметки.
  • Приложение сохранит новую заметку в базе данных и вернет её уникальный идентификатор.

2. Получение всех заметок:

• • Пользователь сможет запросить список всех заметок, отправив GET-запрос.
  • Приложение вернет все заметки из базы данных в формате JSON.

3. Получение заметки по ID:

• • Пользователь сможет получить конкретную заметку по её идентификатору, отправив GET-запрос с указанным ID.
  • Приложение найдет заметку в базе данных и вернет её в формате JSON.

4. Обновление существующей заметки:

• • Пользователь сможет обновить существующую заметку, отправив PUT-запрос с новым заголовком и содержимым заметки.
  • Приложение обновит данные заметки в базе данных и вернет обновленную заметку.

5. Удаление заметки:

• • Пользователь сможет удалить заметку по её идентификатору, отправив DELETE-запрос с указанным ID.
  • Приложение удалит заметку из базы данных и вернет статус успешного выполнения операции.

Подготовка проекта

Подразумевается, что у вас установлен Go версии 1.22 (установить его можно, например, по одной из этих инструкций Windows, Ubuntu, MacOS). При использовании более ранних версий, в процессе запуска проекта могут возникнуть ошибки. Также у вас есть базовое представление о Git и аккаунт на одном из сервисов хостинга Git репозиториев (GitHub, GitLab, Bitbucket, Gitea и т.п.). 

1. Создадим директорию проекта командой:

И перейдем в нее, выполнив:

2. Инициируем новый модуль Go командой: 

3. Установим необходимые для проекта пакеты: Gin, GORM и SQLite для работы с базой данных, командами:

4. Создадим структуру проекта. Она должна выглядеть вот так:

Создать структуру вы можете средствами IDE или выполнив следующую команду в терминале:

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

• models/note.go

Определяет структуру данных для заметок. Модель Note описывает поля заметки и используется для работы с базой данных через ORM-библиотеку GORM.

• storage/database.go

Этот файл содержит функции для инициализации базы данных и получения экземпляра базы данных. Здесь используется ORM-библиотека GORM для работы с базой данных SQLite.

• storage/storage.go

Этот код обеспечивает выполнение основных операций CRUD (создание, чтение, обновление, удаление) для модели Note, используя GORM для взаимодействия с базой данных SQLite.

• handlers/note_handlers.go

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

• main.go

Этот файл является основной точкой входа в приложение. В нем происходит инициализация базы данных и настройка маршрутов для обработки HTTP-запросов с использованием веб-фреймворка Gin.

Теперь мы можем запустить приложение локально и протестировать его функциональность.

Для запуска используем команду:

Примеры curl-запросов для тестирования функционала

Создать новую заметку:

Получить все заметки:

Получить заметку по ID:

Обновить заметку по ID:

Удалить заметку по ID:

Деплой приложения в Timeweb Cloud App Platform

Для развертывания приложения с помощью App Platform, необходимо разместить проект в git-репозитории. В данном примере используется GitHub.

Создание и загрузка репозитория

Создайте новый репозиторий на GitHub и инициализируйте его локально в директории вашего проекта:

Теперь можем загрузить репозиторий на удаленный сервер, воспользовавшись командами, которые указаны при создании нового репозитория github:

Настройка Timeweb Cloud App Platform

• Перейдите в раздел App Platform и нажмите «Создать». 

• В разделе «Тип» выберите вкладку «Backend» и найдите фреймворк Gin.

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

• После подключения Github-аккаунта, разделе «Репозиторий» выберите ваш репозиторий с приложением.

• Выберите регион, в котором будет размещено приложение.

• В разделе «Конфигурация» выберите минимальные настройки, их будет достаточно для текущего проекта. При необходимости, конфигурацию можно будет изменить позже.

• В разделе «Настройки приложения» оставьте значения по умолчанию. В более сложных проектах можно указать переменные окружения и команду для сборки приложения.

• Укажите имя будущего приложения и нажмите «Запустить деплой».

Процесс деплоя может занять до 10 минут. После завершения вы увидите сообщение «Deployment successfully completed» в логах деплоя.

Перейдите в раздел «Настройки» на странице приложения, где будет указан домен, привязанный к вашему приложению. 

В этом же разделе можно изменить конфигурацию сервера, отредактировать настройки деплоя и изменить привязку домена. При подключении своего домена, для него автоматически будет установлен сертификат Let’s Encrypt, который будет автоматически продлеваться за 7 дней до истечения срока.

Для проверки, что приложение работает корректно, можем выполнить curl-запрос, изменив localhost на привязанный домен:

Заключение

Мы разработали базовое веб-приложение для управления заметками с использованием фреймворка Gin и библиотеки GORM. Созданный RESTful API поддерживает основные CRUD-операции, что делает приложение простым и удобным в использовании.

Gin показал себя как эффективный и простой в освоении инструмент. Его система маршрутизации и поддержка одновременных запросов упростили процесс разработки. GORM помог легко работать с базой данных, автоматизировав многие задачи.

Приложение успешно развернуто на платформе Timeweb Cloud App Platform, что сделало процесс деплоя быстрым и надежным. App Platform предоставляет все необходимые инструменты для комфортного управления приложением.

В будущем можно добавить новые функции, такие как аутентификация пользователей и улучшенные возможности поиска заметок.

Этот проект продемонстрировал, как современные инструменты разработки, такие как Gin и GORM, могут упростить создание веб-приложений.