[FastAPI] Background Task

 

🐰 FastAPI 공식문서를 보면서 개인적으로 정리한 글 입니다.

 

FastAPI에서 Back Ground Task는 무거운 작업을 Back Ground로 돌려서 처리할 때 사용한다.

ex. 작업 수행후 이메일 전송, 데이터 처리

이러한 작업들은 별도로 천천히 처리해도 되는 작업들에게 사용한다.

 

* 엄청 무거운 작업들은 완전 별도(Multi Processing)로 처리하는 것이 좋다.

 

 

사용방법은 fastapi에 BackgroundTasks 개체에 add_task()에 작업(함수)을 매개변수로 전달한다.

 

백그라운드 작업에 대한 의존성도 추가할 수 있다.

from typing import Union

from fastapi import BackgroundTasks, Depends, FastAPI

app = FastAPI()


def write_log(message: str):
    with open("log.txt", mode="a") as log:
        log.write(message)


def get_query(background_tasks: BackgroundTasks, q: Union[str, None] = None):
    if q:
        message = f"found query: {q}\n"
        background_tasks.add_task(write_log, message)
    return q


@app.post("/send-notification/{email}")
async def send_notification(
    email: str, background_tasks: BackgroundTasks, q: str = Depends(get_query)
):
    message = f"message to {email}\n"
    background_tasks.add_task(write_log, message)
    return {"message": "Message sent"}

 

메시지를 보내면 background 작업에 대한 log가 저장된다.