Ugrás a fő tartalomhoz
Ön a fejlesztői dokumentációt nézi
Ez a dokumentáció a Base44 fejlesztői platformmal dolgozó fejlesztőknek szól.
Teljes referencia az alkalmazás backendjében futó Actor osztályhoz. A munkamenethez csatlakozó kliens-SDK-ról az actors SDK-referenciában olvashat. Az actorok fogalmairól és terminológiájáról az actorok áttekintésében olvashat.

Kötelező kezelők

Az Actor osztály absztrakt. Valósítsa meg az alábbi kezelők törzsét. A kezelők a kliensektől és az időzítőktől érkező eseményekre reagálnak.

Opcionális kezelők

Ha az actornak szüksége van rájuk, valósítsa meg ezeket a kezelőket. Ha a munkamenet tickel, állítsa be a tickIntervalMs értékét. Ha elhagyja a shouldTick() metódust, a munkamenet soha nem tickel. Ha azt szeretné, hogy az alkalmazás kódja csatlakozás nélkül futtathasson egy metódust egy munkameneten, sorolja fel a metódust a static callable tömbben.

Használható metódusok

Az actorosztály beépített funkciókat biztosít. Az actor kezelőinek megvalósításakor a következő metódusokat használhatja. Az entitások olvasásához és írásához használja a this.client klienst.

Osztálydeklaráció

Importálja az Actor osztályt a base44:runtime/actors modulból, és a base44/actors/<actor-name>/entry.ts fájlból alapértelmezett exportként exportáljon egy osztályt, amely kiterjeszti az Actor osztályt. A mappa neve lesz az actor neve az SDK-ban. A beállítás részleteiről lásd: actor létrehozása.
generic
A csatlakozott kliensektől érkező üzenetek típusát adja meg. A handleMessage() msg paraméterére vonatkozik.
generic
A csatlakozott klienseknek küldött üzenetek típusát adja meg. A conn.send() és a broadcast() metódusra vonatkozik.

Futásidejű API

Az actorok a base44:runtime/actors modulból importálják az Actor osztályt:
Az ActorError segítségével utasíthatja el egy hívható metódus hívását.

Titkos adatok olvasása

A secrets.get() metódussal olvashatja ki az alkalmazás környezeti változóit egy kezelőből. A metódus karakterláncként adja vissza az értéket, vagy undefined értéket, ha a titkos adat nincs beállítva. Importálja a secrets objektumot a base44:runtime modulból:
A titkos adatokat a CLI-ből a secrets set paranccsal konfigurálhatja. Javasoljuk, hogy a titkos adatot igénylő munkához hívjon meg egy backend-függvényt. A függvény kiolvassa a titkos adatot és visszaadja az eredményt, így az actor soha nem kapja meg a titkos adatot. Mintafolyamatot a backend-függvény hívása titkos adatot igénylő munkához részben talál.

Életciklus-kezelők

A Base44 ezeket a kezelőket a munkamenet kliensoldali tevékenységére reagálva hívja meg. Mindegyik törzsét Ön valósítja meg. További információ arról, hogyan működnek együtt az actorok és a kliensek. Mintafolyamatot a kliensek kapcsolatainak kezelése részben talál.
method
Minden alkalommal fut, amikor egy munkamenet aktiválódik, például:
  • Amikor a munkamenet először létrejön.
  • Amikor egy kliens tétlen munkamenethez csatlakozik.
  • Amikor üzenet érkezik egy tétlen munkamenetre.
  • Amikor elérkezik egy ütemezett időpont.
void vagy Promise<void> értéket ad vissza.
method
kötelező
Akkor fut, amikor egy kliens csatlakozik a munkamenethez. A conn.send() metódussal elküldheti az aktuális munkamenet-állapotot, vagy a conn.reject() metódussal elutasíthatja a kapcsolatot. void vagy Promise<void> értéket ad vissza.
method
kötelező
Akkor fut, amikor egy csatlakozott kliens üzenetet küld. A munkamenet-állapot módosítása vagy az alkalmazásadatok elérése előtt validálhatja az üzenetet. void vagy Promise<void> értéket ad vissza.
method
kötelező
Akkor fut, amikor egy kliens bontja a kapcsolatot. Ezzel a kezelővel távolíthatja el a kapcsolatazonosítóhoz tartozó munkamenet-állapotot. Az ugyanazt az azonosítót használó újracsatlakozás a handleClose() futtatása nélkül cseréli le a régi socketet. void vagy Promise<void> értéket ad vissza.

Időzítőkezelők és -beállítások

Ezek a kezelők és beállítások szabályozzák a munkamenet időzített munkáját. A Base44 akkor hívja meg őket, amikor elérkezik egy ütemezett időpont, nem a kliensoldali tevékenységre reagálva. További információ az ütemezett munkáról. Mintafolyamatokat a tickek futtatása és az ébresztések ütemezése részben talál.
method
kötelező
Időközönként egyszer fut, amíg a shouldTick() true értéket ad vissza, és a munkamenetnek legalább egy kliense van. void vagy Promise<void> értéket ad vissza.
number
A tickek közötti időközt adja meg ezredmásodpercben. Alapértelmezett érték: 100.
method
boolean értéket ad vissza. A true érték fenntartja a munkamenet tickelését, a false leállítja. Ez a metódus szinkron.Tartsa ezt a metódust gyorsnak és mellékhatásmentesnek. A Base44 minden csatlakozás, üzenet, kapcsolatbontás és tick után meghívja.
method
Egyszer fut, amikor elérkezik a schedule() metódussal beállított időpont. void vagy Promise<void> értéket ad vissza.
method
A handleWake() egyszeri futását ütemezi egy megadott időpontra. Olyan Promise értéket ad vissza, amely azután teljesül, hogy a Base44 eltárolta az ütemezést. Az ütemezés túléli a tétlen időszakot, és elindíthat egy tétlen munkamenetet. Ha ugyanazzal a kulccsal újra meghívja a metódust, az lecseréli az ütemezett időpontot.
method
Törli egy kulcshoz tartozó ütemezett ébresztést. Olyan Promise értéket ad vissza, amely azután teljesül, hogy a Base44 törölte az ütemezést.

Kapcsolatok

Ezek a tulajdonságok és metódusok a klienssel kapcsolatos életciklus-kezelőknek átadott conn objektumon érhetők el. Ezekkel olvashatja ki a kliens azonosságát, küldhet üzeneteket és kezelheti a kapcsolatot. Az üzenetküldés áttekintéséről lásd: valós idejű üzenetek. Mintafolyamatot a kliensek kapcsolatainak kezelése részben talál.
A conn a WebSocket backendoldali vége, a kliensben lévő Connection pedig ugyanannak a socketnek a másik vége. Az actorosztályban a conn objektumot használja. A kliensobjektumról az actors SDK-referenciában olvashat.
string
Ezt a kapcsolatot azonosítja. Megegyezik a kliens által csatlakozáskor átadott azonosítóval, vagy az SDK által generált azonosítóval.
object
Az ezen a kapcsolaton lévő klienst azonosítja. Minden kapcsolaton jelen van.
method
Üzenetet küld erre a kapcsolatra. void értéket ad vissza.
method
Elutasít egy kapcsolatot a handleConnect() kezelőből. void értéket ad vissza.
method
Üzenetet küld a munkamenet minden élő kapcsolatára. void értéket ad vissza.
method
A munkamenet élő conn objektumainak tömbjét adja vissza. Ezt a metódust a handleStart() kezelőben használja, hogy a visszaállított adatokat összepárosítsa a tétlen időszak alatt is csatlakozva maradt kliensekkel.
string
Munkamenetszintű tulajdonság. Azt a munkamenet-azonosítót tartalmazza, amellyel a kliens elérte ezt a munkamenetet.

Hívható metódusok

Az alkalmazás kódja csatlakozás nélkül is futtathat metódust egy munkameneten. Egy oldal a base44.actors.ActorName(sessionId).methodName(args) hívást használja, a szerverkód, például egy backend-függvény pedig a base44.asServiceRole.actors.ActorName(sessionId).methodName(args) hívást. Metódust egyirányú hívásra használjon egy munkamenetbe: amikor szerverkód frissítést küld a munkamenet klienseinek, vagy amikor egy oldal élő megjelenítés nélkül végez műveletet egy munkameneten, például egy adminisztrátor kiürít egy táblát. Csak akkor csatlakozzon, ha az oldal élőben mutatja a munkamenetet. A metódusok hívásához @base44/sdk 0.8.62 vagy újabb verzió szükséges. A hívható metódusok megjelenése előtt telepített actor minden hívást elutasít, amíg újra nem telepíti. Mintafolyamatot a munkamenet metódusának hívása részben talál.
Bármely kliens meghívhat egy metódust bármely munkameneten, amelyet meg tud nevezni. A munkamenet módosítása előtt minden metódusban ellenőrizze az identity értékét, ahogy a handleConnect() kezelőben a conn.identity értékét is ellenőrzi.
string[]
Felsorolja a hívók által futtatható metódusokat. Bármely más metódus hívása 404 hibával hiúsul meg. Kezelők és segédfüggvények így soha nem futnak, még akkor sem, ha szerepelnek a listán: a handle, on vagy _ kezdetű neveket a rendszer figyelmen kívül hagyja.
method
Egy static callable tömbben felsorolt metódus. Akkor fut, amikor az alkalmazás kódja meghívja, akkor is, ha egyetlen kliens sincs csatlakozva: egy tétlen munkamenet előbb aktiválódik, és lefuttatja a handleStart() kezelőt. A metódus olvashatja és módosíthatja a munkamenet-állapotot, használhatja a tárolót, és meghívhatja a broadcast() metódust. A hívónak szóló választ adja vissza, amelynek JSON-szerializálhatónak kell lennie. Az SDK-hívás erre az értékre teljesül.
class
Dobjon new ActorError(status, message) hibát egy hívható metódusból a hívás elutasításához. A hívó SDK-hívása ezzel az állapotkóddal utasítódik el. Használjon 4xx állapotkódot, például 401 vagy 403 értéket. A metódusból dobott bármely más hiba 500 hibaként jut el a hívóhoz.

Tároló

A this.storage segítségével olvashatja és írhatja a munkamenet adatait. Az osztálymezőkkel ellentétben a tároló túléli a tétlen időszakokat. A tároló és az osztálymezők közötti választásról lásd: tároló. Mintafolyamatot a munkamenetadatok megőrzése részben talál.
method
Kulcs alapján lekér egy értéket. Olyan Promise értéket ad vissza, amely a tárolt értékre teljesül, vagy undefined értékre, ha a kulcs nem létezik.
method
Kulcs alapján ment egy értéket. Lecseréli a kulcs alatt már tárolt értéket. Olyan Promise értéket ad vissza, amely az írás befejezésekor teljesül.
method
Kulcs alapján eltávolít egy értéket. Olyan Promise értéket ad vissza, amely true értékre teljesül, ha a kulcs létezett, egyébként false értékre.
method
Eltávolítja a munkamenet összes mentett adatát. Olyan Promise értéket ad vissza, amely akkor teljesül, amikor a tároló kiürült. Egy későbbi kapcsolat ugyanolyan üres tárolóval indul, mint egy új munkamenet.

Entitáshozzáférés

A this.client és a this.client.asServiceRole segítségével olvashatja és írhatja az alkalmazás entitásait egy actorkezelőből. Mintafolyamatot az entitásadatok írása munkamenetből részben talál.
Base44Client
Erre a munkamenetre korlátozott alkalmazáskliens. Ez a kliens névtelen hitelesítést használ, így az entitáshozzáférés ugyanazokat a szabályokat követi, mint egy kijelentkezett kliensé, és éles adatokat olvas.
Base44Client
Emelt szintű hozzáférést biztosít, amely megkerüli a sorszintű biztonságot. Az üzeneteket validálja, mielőtt ezt a klienst használná. Az írásokat tegye biztonságosan megismételhetővé, mert hiba után a munkamenet újra lefuttathat egy kezelőt.

Lásd még

Ezt az oldalt MI segítségével fordítottuk. A legpontosabb és legfrissebb információkért tekintse meg az angol nyelvű változatot.