Browse Source
Co-authored-by: Sebastián Ramírez <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>pull/2351/merge
committed by
GitHub
2 changed files with 106 additions and 0 deletions
@ -0,0 +1,102 @@ |
|||
# Фоновые задачи |
|||
|
|||
Вы можете создавать фоновые задачи, которые будут выполнятся *после* возвращения ответа сервером. |
|||
|
|||
Это может быть полезно для функций, которые должны выполниться после получения запроса, но ожидание их выполнения необязательно для пользователя. |
|||
|
|||
К примеру: |
|||
|
|||
* Отправка писем на почту после выполнения каких-либо действий: |
|||
* Т.к. соединение с почтовым сервером и отправка письма идут достаточно "долго" (несколько секунд), вы можете отправить ответ пользователю, а отправку письма выполнить в фоне. |
|||
* Обработка данных: |
|||
* К примеру, если вы получаете файл, который должен пройти через медленный процесс, вы можете отправить ответ "Accepted" (HTTP 202) и отправить работу с файлом в фон. |
|||
|
|||
## Использование класса `BackgroundTasks` |
|||
|
|||
Сначала импортируйте `BackgroundTasks`, потом добавьте в функцию параметр с типом `BackgroundTasks`: |
|||
|
|||
```Python hl_lines="1 13" |
|||
{!../../../docs_src/background_tasks/tutorial001.py!} |
|||
``` |
|||
|
|||
**FastAPI** создаст объект класса `BackgroundTasks` для вас и запишет его в параметр. |
|||
|
|||
## Создание функции для фоновой задачи |
|||
|
|||
Создайте функцию, которую хотите запустить в фоне. |
|||
|
|||
Это совершенно обычная функция, которая может принимать параметры. |
|||
|
|||
Она может быть как асинхронной `async def`, так и обычной `def` функцией, **FastAPI** знает, как правильно ее выполнить. |
|||
|
|||
В нашем примере фоновая задача будет вести запись в файл (симулируя отправку письма). |
|||
|
|||
Так как операция записи не использует `async` и `await`, мы определим ее как обычную `def`: |
|||
|
|||
```Python hl_lines="6-9" |
|||
{!../../../docs_src/background_tasks/tutorial001.py!} |
|||
``` |
|||
|
|||
## Добавление фоновой задачи |
|||
|
|||
Внутри функции вызовите метод `.add_task()` у объекта *background tasks* и передайте ему функцию, которую хотите выполнить в фоне: |
|||
|
|||
```Python hl_lines="14" |
|||
{!../../../docs_src/background_tasks/tutorial001.py!} |
|||
``` |
|||
|
|||
`.add_task()` принимает следующие аргументы: |
|||
|
|||
* Функцию, которая будет выполнена в фоне (`write_notification`). Обратите внимание, что передается объект функции, без скобок. |
|||
* Любое упорядоченное количество аргументов, которые принимает функция (`email`). |
|||
* Любое количество именованных аргументов, которые принимает функция (`message="some notification"`). |
|||
|
|||
## Встраивание зависимостей |
|||
|
|||
Класс `BackgroundTasks` также работает с системой встраивания зависимостей, вы можете определить `BackgroundTasks` на разных уровнях: как параметр функции, как завимость, как подзависимость и так далее. |
|||
|
|||
**FastAPI** знает, что нужно сделать в каждом случае и как переиспользовать тот же объект `BackgroundTasks`, так чтобы все фоновые задачи собрались и запустились вместе в фоне: |
|||
|
|||
=== "Python 3.6 и выше" |
|||
|
|||
```Python hl_lines="13 15 22 25" |
|||
{!> ../../../docs_src/background_tasks/tutorial002.py!} |
|||
``` |
|||
|
|||
=== "Python 3.10 и выше" |
|||
|
|||
```Python hl_lines="11 13 20 23" |
|||
{!> ../../../docs_src/background_tasks/tutorial002_py310.py!} |
|||
``` |
|||
|
|||
В этом примере сообщения будут записаны в `log.txt` *после* того, как ответ сервера был отправлен. |
|||
|
|||
Если бы в запросе была очередь `q`, она бы первой записалась в `log.txt` фоновой задачей (потому что вызывается в зависимости `get_query`). |
|||
|
|||
После другая фоновая задача, которая была сгенерирована в функции, запишет сообщение из параметра `email`. |
|||
|
|||
## Технические детали |
|||
|
|||
Класс `BackgroundTasks` основан на <a href="https://www.starlette.io/background/" class="external-link" target="_blank">`starlette.background`</a>. |
|||
|
|||
Он интегрирован в FastAPI, так что вы можете импортировать его прямо из `fastapi` и избежать случайного импорта `BackgroundTask` (без `s` на конце) из `starlette.background`. |
|||
|
|||
При использовании `BackgroundTasks` (а не `BackgroundTask`), вам достаточно только определить параметр функции с типом `BackgroundTasks` и **FastAPI** сделает все за вас, также как при использовании объекта `Request`. |
|||
|
|||
Вы все равно можете использовать `BackgroundTask` из `starlette` в FastAPI, но вам придется самостоятельно создавать объект фоновой задачи и вручную обработать `Response` внутри него. |
|||
|
|||
Вы можете подробнее изучить его в <a href="https://www.starlette.io/background/" class="external-link" target="_blank">Официальной документации Starlette для BackgroundTasks</a>. |
|||
|
|||
## Предостережение |
|||
|
|||
Если вам нужно выполнить тяжелые вычисления в фоне, которым необязательно быть запущенными в одном процессе с приложением **FastAPI** (к примеру, вам не нужны обрабатываемые переменные или вы не хотите делиться памятью процесса и т.д.), вы можете использовать более серьезные инструменты, такие как <a href="https://docs.celeryproject.org" class="external-link" target="_blank">Celery</a>. |
|||
|
|||
Их тяжелее настраивать, также им нужен брокер сообщений наподобие RabbitMQ или Redis, но зато они позволяют вам запускать фоновые задачи в нескольких процессах и даже на нескольких серверах. |
|||
|
|||
Для примера, посмотрите [Project Generators](../project-generation.md){.internal-link target=_blank}, там есть проект с уже настроенным Celery. |
|||
|
|||
Но если вам нужен доступ к общим переменным и объектам вашего **FastAPI** приложения или вам нужно выполнять простые фоновые задачи (наподобие отправки письма из примера) вы можете просто использовать `BackgroundTasks`. |
|||
|
|||
## Резюме |
|||
|
|||
Для создания фоновых задач вам необходимо импортировать `BackgroundTasks` и добавить его в функцию, как параметр с типом `BackgroundTasks`. |
Loading…
Reference in new issue