FastAPI 에서 의존성 주입 이란? (Dependency Injection)

FastAPI의 "Dependency Injection"은 FastAPI 프레임워크에서 제공하는 핵심 기능 중 하나입니다. Dependency Injection은 의존성 주입이라고도 하며, 이는 코드의 결합도를 낮추고, 유지보수와 테스트가 용이하도록 도와주는 설계 패턴입니다. FastAPI에서는 이를 통해 더욱 깔끔하고 효율적으로 API를 개발할 수 있습니다.(재사용성, 효율성 증가의 효과)

Dependency Injection의 기본 원리

FastAPI에서 Dependency Injection을 사용하면, 함수나 클래스의 인스턴스를 직접 생성하지 않고, FastAPI가 실행 시간(runtime)에 의존성을 주입해줍니다. 이로써, 필요한 객체나 설정, 데이터베이스 연결 등을 효율적으로 관리하고 재사용할 수 있습니다. 즉, 필요한 기능을 직접 선언하여 사용할 수 있다는 의미입니다. 

예를 들면 데이터베이스 세션의 생성과 반환(close)을 자동화

 

사용 방법

1. 의존성 생성: 의존성은 일반적으로 함수로 정의됩니다. 이 함수는 필요한 객체나 값을 반환합니다.
   1. contextlib보다는 Depends를 사용하는 것이 더 간결하다. 

from fastapi import Depends, FastAPI

def get_db():
    db = "DB Connection"
    try:
        yield db
    finally:
        db.close()

 

1. 경로 작업에 의존성 주입: Depends를 사용하여 경로 작업 함수에 의존성을 주입합니다. FastAPI는 요청이 들어올 때마다 이 의존성 함수를 호출하고, 함수에서 반환한 값을 경로 작업 함수의 매개변수로 전달합니다.

@app.get("/items/")
async def read_items(db = Depends(get_db)):
    return {"db": db}

• 하위 의존성: 의존성 함수 내에서 다른 의존성을 사용할 수 있습니다. 이를 통해 여러 계층의 의존성을 구성할 수 있습니다.
• 의존성의 재사용과 오버라이딩: FastAPI는 의존성이 여러 경로에서 재사용될 때 마다 매번 새로운 인스턴스를 생성하지 않습니다. 필요하다면, 특정 경로에서만 의존성의 동작을 변경할 수도 있습니다.
• 자동으로 요청 데이터를 받는 의존성: 의존성 함수에서 직접 요청 객체를 받거나, Pydantic 모델을 사용하여 요청 데이터를 자동으로 검증하고 변환할 수 있습니다.

 

다른 활용 방법

https://fastapi.tiangolo.com/tutorial/dependencies/