You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

О чём этот гайд

В этом документе описываются технологии, которые мы используем для написания бэкенд-части проекта (т.е. кода, который исполняется на сервере и отвечает за всю логическую работу: обработку данных, создание объектов и работу с базой данных, контроль за правами доступов, и т.д.). Здесь также описана структура папок/файлов бэкендовой части проекта и за что отвечает каждая конкретно папка-файл


Глоссарий

ТерминОпределение
Бизнес-логикаНабор правил (условий), которые описывают сущности внутри программы и их взаимодействие. По сути, это формальные "правила", по которым работает приложение 
Бэкенд

Программная часть сервиса, которая работает на сервере (а не в браузере или на компьютере).

Бэкенд отвечает за:

  • Хранение данных (в реляционной базе данных и/или на файловой системе)
  • Выдачу данных по запросу пользователя (с проверкой прав доступа пользователя к этим данным) (как правило в JSON формате)
  • Приём и обработку (а также проверку корректности и сохранение) пользовательских данных
Фронтенд

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

Задача фронтенда: отрисовывать интерфейс пользователя (страничку в браузере), реагировать на события интерфейса (нажатие кнопочек/переход между страницами/etc.) и взаимодействовать с бэкендом, запрашивая у него данные (или отправляя ему данные и получая результат операций)

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

Основные концепции

Сайт mipt.tech исповедует жесткое разделение на backend- и frontend-составляющие, которые взаимодействуют между собой по протоколу REST API.

Кратко работу протокола иллюстрирует следующая картинка (с тем лишь исключением, что в нашем случае REST API предоставляет сервер на Python, а клиентом - Application выступает браузер и приложение на NextJS/Typescript).

Для полноценного понимания, что такое REST API, настоятельно рекомендуется прочитать и понять следующую статью: https://cloud.yandex.ru/ru/docs/glossary/rest-api

Используемые технологии:

Для работы бэкенда используется язык программирования Python (как наиболее оптимальный с точки зрения простоты/известности/скорости разработки) и фреймворк Django REST Framework (как наиболее удобный за счёт наличия большинства необходимых функций "из коробки", будь то работа с СУБД/авторизация/кеширование/фоновые задания и т.д.)

Для хранения данных используется реляционная база данных PostgreSQL. При этом мы не пишем sql-запросы руками, вместо этого мы используем ORM (для ознакомления рекомендую эту статью) - фреймворк для работы с данными (конкретно мы используем ORM, включенную в библиотеку Django, она так и называется: Django ORM), который позволяет работать с сущностями, представленными в виде Python-классов и методами этих классов, вместо работы с таблицами БД и sql-запросами соответственно.

Например, для описания сущности "Фотография" и работы с этой сущностью мы будем использовать следующий код на Python:

from django.db import models
from accounts.models import User

class Photo(models.Model):  # Модель == сущность. Каждой модели соответствует таблица в БД, которая создаётся автоматически на основе атрибутов класса
    title = models.CharField(max_length=200)  # Каждый атрибут класса фактически является колонкой таблицы в БД.
    author = ForeignKey(User, verbose_name="Автор фотографии")  # Отношения () 

# Получить все фотографии, имеющиеся в БД (одна фотография == 1 строка с таблице БД == один объект класса Photo)
# По сути эквивалент sql-запроса "SELECT * FROM photo_table;"
photos: List[Photo] = Photo.objects.all()

# Получить все фотографии, для которых название равно "my photo"
# Эквивалент запроса SELECT * FROM photo_table WHERE title="my photo";
photos: List[Photo] = Photo.objects.filter(title="my_photo")

# Вывести название всех фотографий, хранящихся в БД
for photo in Photo.objects.all():
    print(photo.title)

# Создать новый объект фотографии
Photo.objects.create(title="New photo title", user=User.objects.get(username="admin"))


Мы очевидно взаимодействуем с базой данных, создавая/получая данные оттуда, но при этом не написали ни одного sql-запроса, а работаем с абстрактной сущностью (в дальнейшем "сущность" будем именовать "Моделью"). Для дальнейшего знакомства с Django ORM рекомендуется эта статья https://habr.com/ru/articles/503526/




  • No labels