FastAPI는 현대적인 Python 웹 프레임워크로, 비동기 프로그래밍 기능과 데이터 유효성 검사를 매우 효율적으로 처리할 수 있는 강력한 도구입니다. 이 글에서는 FastAPI에서의 의존성 주입(Dependency Injection, DI)의 개념과 이를 구현하는 방법에 대해 심도 있게 다루겠습니다.
1. 의존성 주입(Dependency Injection) 개념
의존성 주입은 소프트웨어 개발에서 객체의 의존성을 관리하는 패턴입니다. 이는 객체가 필요한 의존성을 스스로 생성하는 것이 아니라, 외부에서 주입받는 방식입니다. 이러한 접근 방식은 코드의 재사용성을 높이고, 테스트 용이성을 향상시키며, 유지보수성을 강화합니다.
1.1 의존성 주입의 장점
- 유지보수성: 의존성을 외부로 분리함으로써 코드의 유동성을 증가시키고, 변경의 영향을 최소화합니다.
- 테스트 용이성: 의존성을 주입받기 때문에, 모의 객체(mock object)를 사용하여 단위 테스트를 쉽게 작성할 수 있습니다.
- 재사용성: 각 구성 요소가 독립적으로 설계되므로, 코드의 재사용성이 높아집니다.
2. FastAPI에서의 의존성 주입 구현
FastAPI는 의존성 주입을 지원하는 강력한 기능을 제공합니다. FastAPI에서 의존성을 정의하려면 다음의 세 가지 단계로 나눌 수 있습니다:
- 의존성 함수 정의하기
- 의존성을 라우트에 주입하기
- 의존성을 사용하는 서비스 구현하기
2.1 의존성 함수 정의하기
의존성 함수는 다른 라우트에서 재사용할 수 있는 공통적인 기능을 정의합니다. 아래의 예제에서는 데이터베이스 연결을 의존성으로 설정하는 방법을 보여줍니다:
from fastapi import Depends, FastAPI
app = FastAPI()
# 의존성 함수 정의
def get_db():
db = "데이터베이스 연결"
try:
yield db
finally:
print("데이터베이스 연결 종료")
2.2 의존성을 라우트에 주입하기
의존성 함수를 정의한 후, 이를 라우트에서 사용할 수 있습니다. 아래의 샘플 코드에서는 앞서 정의한 get_db 함수를 라우트에 주입합니다:
@app.get("/items/")
async def read_items(db: str = Depends(get_db)):
return {"message": "항목 정보를 가져왔습니다.", "db_connection": db}
2.3 의존성을 사용하는 서비스 구현하기
의존성 주입을 통해 서비스 계층을 구성할 수 있습니다. FastAPI에서는 이러한 서비스를 쉽게 구현할 수 있게 도와줍니다. 다음 예제에서는 의존성 주입을 통해 사용자 정보를 처리하는 서비스를 제공합니다:
class UserService:
def __init__(self, db: str):
self.db = db
def get_user(self, user_id: int):
# 사용자 정보를 데이터베이스에서 가져오는 로직
return {"user_id": user_id, "db_connection": self.db}
@app.get("/users/{user_id}")
async def read_user(user_id: int, db: str = Depends(get_db)):
service = UserService(db)
return service.get_user(user_id)
3. FastAPI에서의 의존성 주입 사용 예제
3.1 예제: 간단한 게시판 API
아래는 FastAPI를 사용하여 간단한 게시판 API를 구현하는 예제입니다. 이 예제에서는 의존성 주입을 사용하여 데이터베이스 연결과 게시물 서비스를 관리합니다.
from fastapi import FastAPI, Depends
from typing import List
app = FastAPI()
# 가상 데이터베이스
posts_db = []
# 의존성 함수
def get_db():
return posts_db
# 게시물 모델
class Post:
id: int
title: str
content: str
# 게시물 서비스
class PostService:
def __init__(self, db: List[Post]):
self.db = db
def create_post(self, title: str, content: str):
post = Post(id=len(self.db) + 1, title=title, content=content)
self.db.append(post)
return post
def get_posts(self):
return self.db
# 게시물 생성 API
@app.post("/posts/", response_model=Post)
async def create_post(title: str, content: str, db: List[Post] = Depends(get_db)):
service = PostService(db)
return service.create_post(title, content)
# 모든 게시물 조회 API
@app.get("/posts/", response_model=List[Post])
async def read_posts(db: List[Post] = Depends(get_db)):
service = PostService(db)
return service.get_posts()
4. 테스트와 활용
의존성 주입을 활용하여 각 성공적인 테스트를 작성할 수 있습니다. 예를 들어, PostService의 인스턴스를 모의 객체로 주입하여, 데이터베이스와의 의존성을 줄이면서도 서비스 로직을 테스트할 수 있습니다.
4.1 pytest를 활용한 테스트 예제
리얼 데이터베이스 대신 간단한 목(mock) 데이터를 사용해 테스트하는 방법을 보여드립니다:
from fastapi.testclient import TestClient
client = TestClient(app)
def test_create_post():
response = client.post("/posts/", json={"title": "테스트 제목", "content": "테스트 내용"})
assert response.status_code == 200
assert response.json()["title"] == "테스트 제목"
def test_read_posts():
response = client.get("/posts/")
assert response.status_code == 200
assert len(response.json()) > 0
5. 결론
FastAPI에서의 의존성 주입은 애플리케이션의 구조를 명확히 하고, 코드의 가독성을 높이며, 유지보수 및 테스트를 쉽게 만들어 줍니다. 의존성 주입의 개념을 이해하고, 이를 FastAPI에서 효과적으로 활용할 수 있도록 하는 것이 중요합니다. 본 글에서 제공한 예제와 개념들이 여러분의 웹 애플리케이션 개발에 많은 도움이 되길 바랍니다. FastAPI를 통한 서버 개발을 통하여 여러분의 프로젝트를 한 단계 더 발전시켜 보세요!