Blog

Websocketi u Pythonu: rad u stvarnom vremenu u Djangu i Flasku

· Andrij Tkachenko · 8 min čitanja

Linija smotana poput zmije vodi od niza worker poslužitelja do oblaka, koji drži otvorene linije prema četiri prozora preglednika

Python može pokrenuti websocket poslužitelj u petnaestak redaka koda, kao asyncio proces koji svaku vezu drži otvorenom. Django i Flask na WSGI-ju te veze ne mogu držati sami, pa uz svoju aplikaciju ili pokrećete poslužitelj koji stalno radi ili ih prepuštate hostanoj usluzi, a vaši viewovi svaki događaj šalju jednim kratkim HTTP zahtjevom.

Ovaj članak pokazuje običan poslužitelj u Pythonu, zašto WSGI worker ne može isto, što je na vlastitim poslužiteljima potrebno Djangu, a što Flasku, te hostani način, s kodom koji radi za oba.

Websocket poslužitelj u običnom Pythonu

Websocket je dvosmjerna veza između preglednika i poslužitelja koja ostaje otvorena, pa svaka strana može slati u bilo kojem trenutku. Biblioteka websockets daje vam poslužiteljsku stranu za asyncio. Ovaj poslužitelj svaku poruku koju primi prosljeđuje svima koji su spojeni:

Python
import asyncio
from websockets.asyncio.server import broadcast, serve

connections = set()

async def handler(websocket):
    connections.add(websocket)
    try:
        async for message in websocket:
            broadcast(connections, message)
    finally:
        connections.discard(websocket)

async def main():
    server = await serve(handler, "", 8001)
    await server.serve_forever()

asyncio.run(main())

Stranica se spaja pomoću WebSocket API-ja koji ima svaki preglednik:

JavaScript
const socket = new WebSocket( 'ws://localhost:8001' );
socket.onopen = () => socket.send( 'hello' );
socket.onmessage = ( event ) => console.log( event.data );

Otvorite to u dvije kartice i svaka će ispisati ono što pošalje druga. Kad radi na javnoj adresi, naš WebSocket test povezuje se na njega iz preglednika i objašnjava svaki kod zatvaranja. Ako preglednik javlja samo da veza nije uspjela, naš članak o WebSocket pogrešci 1006 pokazuje kako pronaći uzrok. Ako se vaš Python kod spaja na tuđi poslužitelj, ista biblioteka ima i klijent, connect() u websockets.asyncio.client.

Dvije stvari u gornjem poslužitelju određuju sve što slijedi. Handler radi dok god je stranica otvorena, često satima. A connections živi u memoriji tog jednog procesa.

Zašto Django i Flask na WSGI-ju ne mogu držati websocket

Većina Django i Flask aplikacija radi na WSGI-ju, standardu između Python web poslužitelja i aplikacija. To je jedan poziv funkcije po zahtjevu: poslužitelj pozove vašu aplikaciju, a ona vrati odgovor. Nakon toga WSGI nema načina da nastavi razgovor s preglednikom.

Na Gunicornu, uobičajenom poslužitelju za takve aplikacije, to se u praksi vidi ovako:

  • Sinkroni worker obrađuje jedan zahtjev odjednom. Websocket koji se u njemu drži zauzimao bi ga dok god je stranica otvorena, pa web-stranica s četiri workera uz četiri otvorene stranice više ne bi mogla odgovoriti nikome drugome.
  • Worker koji zapne na jednom zahtjevu ponovno se pokreće. Sinkroni worker koji šuti dulje od timeouta, prema zadanim postavkama 30 sekundi, bude ugašen i ponovno pokrenut.
  • async def to ne mijenja. Dokumentacija za Flask to kaže izravno: ni asinkroni viewovi ne oslobađaju workera, nego svaki zahtjev i dalje zauzima po jednog. Dokumentacija za Django navodi da se pod WSGI-jem asinkroni view izvršava u vlastitom jednokratnom event loopu, bez prednosti asinkronog stacka.

Što je potrebno na vlastitim poslužiteljima

U Djangu sam prelazak na ASGI nije dovoljan, jer ASGI handler koji Django isporučuje prima samo HTTP. Projekt Django održava službeni dodatak za websockete. Dodate asgi.py, uz svoje viewove napišete consumere za veze, pokrenete ASGI poslužitelj, a ispred njega postavite proxy koji mu šalje websocket promet. Vaši obični viewovi mogu ostati na WSGI-ju.

U Flasku vam proširenje daje websocket rutu, a svaka otvorena veza drži jedan thread ili greenlet nekog workera. S threadovima --threads 100 u Gunicornu znači najviše 100 otvorenih stranica po workeru, uključujući obične zahtjeve. Workeri na geventu drže ih više, tako što patchaju blokirajuće funkcije samog Pythona.

U oba slučaja prati vas isti popis:

  • Dijeljenje svakog događaja. broadcast() preko veza u memoriji stiže samo do preglednika na tom jednom procesu. Čim je procesa više od jednog, svaki događaj mora proći kroz kanal koji svi dijele, obično Redis.
  • Znati tko se spaja. WebSocket u pregledniku prima adresu i podprotokole, a zaglavlje se ne može postaviti. Zato vaš poslužitelj čita kolačić sesije ili token u adresi i odlučuje što taj korisnik smije slušati.
  • Deploy. Ponovno pokretanje prekida sve veze, svi se preglednici odjednom ponovno spajaju, a stranica koja nije bila spojena propušta ono što je za to vrijeme poslano, osim ako to nešto ne čuva.
  • Proxyji. Zatvaraju veze koje izgledaju neaktivno, pa vam treba heartbeat, a svaki proxy na putu mora biti podešen tako da propušta websockete.

Članak FastAPI websocketi s više od jednog workera prolazi kroz taj popis s kodom, a websocketi u Laravelu pokazuju isti popis s PHP strane. Ništa od toga nije egzotično i mnogi timovi to dobro rade. Ipak, to je drugi sustav uz vašu aplikaciju, dok god aplikacija ima funkcije uživo.

Ili zadržite aplikaciju kakva jest

Hostana usluga za rad u stvarnom vremenu preuzima veze od vaših workera. Preglednici se spajaju na uslugu. Vaš view svaki događaj šalje jednim kratkim HTTPS zahtjevom, a usluga ga isporučuje svakoj stranici koja ga treba dobiti. Kratki zahtjevi upravo su ono u čemu je WSGI dobar, pa Gunicorn, vaši workeri i vaš hosting ostaju kakvi jesu.

Postava Što drži svaku vezu Što dodajete
Samo WSGI Ništa, pa nema websocketa Ništa
WSGI s threadovima ili geventom Thread ili greenlet nekog workera Zajednički kanal za više workera
ASGI Zadatak na event loopu ASGI poslužitelj, pravilo na proxyju, zajednički kanal
Hostana usluga Poslužitelji usluge Jedan zahtjev za svaki događaj

Django na WordPlus Cloudu

WordPlus Cloud u Django dolazi kao jedan paket, bez instaliranja Nodea:

Shell
pip install 'wordplus-realtime[django]'

Dodajte "wordplus_realtime.django" u INSTALLED_APPS, postavite WORDPLUS_SITE, WORDPLUS_SECRET i WORDPLUS_LOCAL_KEY u okruženju svog poslužitelja i jednom definirajte svoje sobe, svaku s pravilom o tome tko joj se smije pridružiti:

shop/realtime.py
from wordplus_realtime.django import realtime

from .models import Order

# The room of an order, order:1042: its customer may join, and the last 20 updates are kept.
def may_follow_order(user, p):
    return user is not None and Order.objects.filter(pk=p["id"], customer_id=user).exists()

realtime.room("order:{id}", may_follow_order, history=20)

Uvezite tu datoteku iz svog AppConfig.ready(), kako bi sobe postojale prije prvog zahtjeva. Jedan redak u urls.py dodaje rute koje odgovaraju stranicama kad traže da se pridruže sobi i poslužuju datoteke SDK-a za preglednik:

Python
path("api/realtime/", include("wordplus_realtime.django.routes")),

Korisnik dolazi iz sesije, a Djangova CSRF provjera za te rute ostaje uključena. {% wordplus_realtime %} u head dijelu predloška ispisuje postavke stranice za njezina prijavljenog korisnika, pa se stranica spaja bez ikakvog prethodnog zahtjeva.

Bilo koji view, na bilo kojem workeru, zatim šalje tek kad se njegova transakcija potvrdi, pa nitko ne vidi promjenu koja je poništena:

Python
from django.db import transaction

order.status = "shipped"
order.save()
transaction.on_commit(lambda: realtime.to(f"order:{order.pk}").emit("updated", {"status": order.status}))

Taj emit je jedan HTTPS zahtjev, napravljen u viewu. Asinkroni view čini isto s await realtime.to(…).aemit(…). Za mnogo događaja odjednom, ili kad zahtjev ne bi smio čekati na njih, šaljite ih iz Celeryja ili nekog drugog reda zadataka.

Flask na WordPlus Cloudu

U Flasku je to isti paket, jedan poziv i ista vrsta pravila:

Shell
pip install 'wordplus-realtime[flask]'
Python
from flask import Flask
import wordplus_realtime.flask
from wordplus_realtime import Realtime

realtime = Realtime.from_environment()   # WORDPLUS_SITE, WORDPLUS_SECRET, WORDPLUS_LOCAL_KEY

# The room of an order, order:1042: its customer may join, and the last 20 updates are kept.
realtime.room("order:{id}", lambda user, p: user is not None and owner_of(p["id"]) == user, history=20)

app = Flask(__name__)
wordplus_realtime.flask.init_app(app, realtime)

@app.post("/orders/<int:pk>/ship")
def ship(pk):
    order = mark_shipped(pk)
    realtime.to(f"order:{pk}").emit("updated", {"status": order.status})
    return {"ok": True}

Korisnik je current_user iz Flask-Logina ako ga vaša aplikacija ima, a inače session["user_id"]. {{ wordplus_realtime() }} u head dijelu predloška ispisuje postavke stranice.

Stranica je u oba slučaja ista

Vaš JavaScript pridružuje se sobi takav kakav jest, bez bundlera, jer te postavke navode klijent koji poslužuju vaše rute:

JavaScript
import { connect } from '@wordplus/realtime';

const rt = await connect( window.wordplusRealtimeConfig );
rt.join( 'order:1042' ).on( 'updated', ( data ) => showStatus( data.status ) );

To radi jednako s jednim workerom ili s četrdeset. Osim toga:

  • Ništa se ne gubi pri ponovnom spajanju. Soba čuva svoje zadnje događaje, pa stranica koja se vrati dobiva ono što je propustila, redom.
  • Sve stranice jednog korisnika. realtime.to_user(42).emit("notice", {"text": "Your order shipped"}) stiže do svake kartice i svakog uređaja koje korisnik ima otvorene, gdje god se u vašoj aplikaciji nalazio. Korisnik koji nema ništa otvoreno ne dobiva ništa, pa ono što do njega mora stići pošaljite e-poštom.
  • Jedna veza za sve kartice. Kartice jednog preglednika dijele jednu vezu, pa se osoba s tri otvorene kartice broji jednom.
  • Zapečaćeno na putu. Ono što vaš poslužitelj šalje u sobu s pravilom putuje šifrirano ključevima koje drže samo vaš poslužitelj i vaši korisnici.
  • Više od događaja. Tko je na mreži, pozivi koji zvone u svakoj kartici, grupni pozivi i prijenosi uživo dolaze na istoj vezi, s gotovim zaslonom poziva, chatom i playerom iz Better Messagesa ili s vašim vlastitim sučeljem na istom API-ju.

Kad vam bolje odgovara vlastiti poslužitelj

Hostana usluga nije prikladna za svaki posao. Vaš Python kod ono što stranice šalju čuje preko webhooka, HTTP zahtjeva koji može stići više puta, a ne kroz živu petlju sa svakom vezom. Igra ili sustav upravljanja u kojem Python na svaku poruku mora odgovoriti u roku od nekoliko milisekundi pripada na vlastiti asyncio poslužitelj, poput onoga na početku ovog članka.

Počnite sa svojim frameworkom

Vodič za Django i vodič za Flask sadrže cijelo podešavanje. Django demo i Flask demo male su trgovine izgrađene na svakom od njih, u kojima se narudžba, čim kliknete, u drugom prozoru označi kao poslana.

WordPlus Cloud for Apps ima cijenu prema istodobnim vezama, od 1.000 naviše, uz mjesečnu ili godišnju naplatu, a naš članak o cijenama usluga u stvarnom vremenu objašnjava kako funkcionira brojanje po vezi. Pogledajte što nudi aplikacijama ili cijene za aplikacije. Naša stranica o WebSocket API-ju prikazuje sobe, prisutnost i događaje u svakom stacku. Pitanja o vašoj integraciji? Pišite nam.