Kaip veikia priklausomybės injeksija (Depends)?

Question

Accepted Answer

FastAPI **priklausomybės injeksijos** sistema leidžia jums deklaruoti pakartotinai naudojamas priklausomybes (funkcijas/klases), kurias FastAPI iškviečia ir **įšvirkšto** į jūsų kelio operacijas per `Depends()`. Jis naudojamas bendrajam kodui, tokiam kaip duomenų bazės sesijos, autentifikacija ir bendri parametrai — kodą laiko DRY ir testiniu.

## Pagrindinė priklausomybė

```python
from fastapi import Depends

# a dependency is just a callable that returns something
def pagination(skip: int = 0, limit: int = 10):
    return {"skip": skip, "limit": limit}

@app.get("/items")
def list_items(params: dict = Depends(pagination)):   # FastAPI calls pagination() and injects the result
    return params
# the skip/limit query params are now handled by the reusable dependency
```

Deklararuoti `params = Depends(pagination)` pasako FastAPI iškviesti `pagination` (išspręsti *jos* parametrus iš užklausos) ir perduoti rezultatą į jūsų funkciją. Priklausomybė yra pakartotinai naudojama keliuose galuose.

## Priklausomybės su valymu (yield) — pvz., duomenų bazės sesijos

```python
def get_db():
    db = SessionLocal()
    try:
        yield db                  # provide the session to the endpoint
    finally:
        db.close()                # cleanup runs AFTER the response — guaranteed

@app.get("/users")
def list_users(db = Depends(get_db)):
    return db.query(User).all()    # uses the injected, auto-closed session
```

`yield` priklausomybė suteikia išteklių ir vykdo valymą po užklausos — standartinis modelis duomenų bazės sesijoms (atidarykite prieš, uždarykite po, automatiškai).

## Priklausomybės gali priklausyti nuo priklausomybių

```python
def get_current_user(token: str = Depends(get_token)):   # depends on another dependency
    return decode(token)

@app.get("/me")
def me(user: User = Depends(get_current_user)):           # auth via injection
    return user
```

Priklausomybės sudaro medį — FastAPI išsprendžia visą grandinę. Taip paprastai atliekama autentifikacija (`get_current_user` priklausomybė).

## Klasės priklausomybės ir pakartotinis naudojimas

```python
@app.get("/items", dependencies=[Depends(verify_api_key)])   # run a dependency without using its return
def items(): ...                                              # e.g. enforce auth as a side effect
```

## Kodėl tai svarbu

Priklausomybės injeksija yra viena iš galingiausių ir svarbiausių FastAPI funkcijų — tai yra būdas, kaip greitai ir pasimokyti logika keliuose galuose (duomenų bazės sesijos, autentifikacija, bendri užklausos parametrai, leidimų tikrinti) be pasikartojimo.

Supratimas yra esmingas, nes tai yra pagrindinių šablonų pamatas: **`yield` priklausomybė** yra standartinis būdas valdyti duomenų bazės sesijas (su garantuotu valiymu po kiekvienos užklausos), o **`get_current_user` priklausomybė** yra idiomatinis autentifikacijos įgyvendinimo būdas.

DI taip pat kodą daro labai **testiniu** — bandymuose galite pakeisti priklausomybes šaknimis.

Sistemos elegancija (priklausomybės išsprendžia savų parametrų iš užklausos, gali priklausyti nuo kitų priklausomybių, formuodamos medį, ir integruojasi su dokumentacija) daro jį universaliu įrankiu, skirtu tikrajai paraiškos struktūrizuoti, todėl valdyti `Depends` yra raktas į gerai suorganizuotų, palaikomų, testiavimo FastAPI programų kūrimą.