FastAPI를 사용하여 실시간 알람 서비스 개발하기

25 Sep 2023

FastAPI

FastAPI는 파이썬으로 작성된 빠르고 간편한 웹 프레임워크입니다. 이번 기사에서는 FastAPI를 사용하여 실시간 알람 서비스를 개발하는 방법에 대해 설명하겠습니다.

알람 서비스 아키텍처

실시간 알람 서비스를 구현하기 위해 아래와 같은 아키텍처를 사용할 것입니다.

사용자는 웹 브라우저를 통해 웹 애플리케이션에 접속합니다.
웹 애플리케이션은 FastAPI를 통해 클라이언트의 요청을 처리합니다.
사용자가 원하는 알람을 설정하면, FastAPI는 해당 알람을 저장합니다.
서비스는 알람을 처리하는 작업자로부터 데이터를 받아오고, 변경사항이 있을 때마다 알람을 업데이트합니다.
알람이 발생하면, FastAPI는 WebSocket을 사용하여 해당 알람을 실시간으로 사용자에게 전달합니다.

FastAPI 및 WebSocket 설정

먼저 FastAPI 프로젝트를 생성하고 필요한 의존성을 설치합니다.

pip install fastapi
pip install uvicorn

다음으로, FastAPI 애플리케이션 파일을 만들고 기본 설정을 추가합니다.

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def read_root():
    return {"Hello": "World"}

WebSocket을 사용하기 위해 websockets 패키지를 설치합니다.

pip install websockets

FastAPI 애플리케이션에 WebSocket 라우터를 추가합니다.

import websockets

@app.websocket("/ws")
async def websocket_endpoint(websocket: websockets.WebSocket):
    await websocket.accept()
    while True:
        message = await websocket.receive_text()
        await websocket.send_text(f"Received message: {message}")

알람 설정 및 실시간 업데이트

알람 설정을 위한 API 엔드포인트를 추가합니다.

from pydantic import BaseModel

class Alarm(BaseModel):
    id: int
    name: str

alarms = []

@app.post("/alarms/")
async def create_alarm(alarm: Alarm):
    alarms.append(alarm)
    return {"message": "Alarm created successfully"}

알람 업데이트를 위한 background 작업자 함수를 작성합니다.

import asyncio

async def update_alarms():
    while True:
        for alarm in alarms:
            # 알람 처리 로직 작성
            await asyncio.sleep(1)

# 애플리케이션 시작 시 background 작업자 실행
@app.on_event("startup")
async def startup_event():
    asyncio.create_task(update_alarms())

마지막으로, WebSocket을 사용하여 알람을 실시간으로 전송합니다.

import websockets

@app.websocket("/ws")
async def websocket_endpoint(websocket: websockets.WebSocket):
    await websocket.accept()
    while True:
        message = await websocket.receive_text()
        await websocket.send_text(f"Received message: {message}")
        # 알람 업데이트를 위한 처리 코드 작성

결론

이제 FastAPI를 사용하여 실시간 알람 서비스를 개발하는 방법을 알게 되었습니다. FastAPI의 간결함과 빠른 성능을 활용하여 실시간 기능을 쉽게 구현할 수 있습니다. Happy coding!

#FastAPI #실시간알람서비스