Przejdź do treści
Zweryfikowano

Zmienne globalne

Jeden program, z którego może czytać każdy inny program, dla stanu i logiki należących do całej aplikacji, a nie do jednego ekranu.

Każdy projekt Xuda ma dokładnie jeden program Zmienne globalne. Przechowuje stałe, wspólne zmienne i logikę startową, które może czytać każdy program Component, Get Data, Set Data, Batch, JavaScript lub API w projekcie, więc wartość, która wszędzie znaczy to samo (zalogowany użytkownik, flaga funkcji, aktywny kampus), ma dokładnie jedno miejsce zamiast być kopiowana na każdy ekran, który jej potrzebuje.

Zmienne globalne zawsze działają po stronie klienta

Cokolwiek runAt mówi gdzie indziej, środowisko uruchomieniowe wymusza dla Zmiennych globalnych client. To jedyny typ programu, który nigdy nie wykonuje się na serwerze, więc to złe miejsce na wszystko, co musi zostać poza urządzeniem (sekrety, odczyty z uprawnieniami). Użyj do tego programu Get Data lub Set Data po stronie serwera.

Kiedy z nich korzystać

Sięgnij po Zmienne globalne, gdy wartość lub fragment logiki startowej jest potrzebny więcej niż jednemu Component i nie chcesz przekazywać go jako parametru w każdym z nich: imię zalogowanego użytkownika, wybrany kampus lub najemca, flaga trybu ciemnego, adres e-mail wsparcia, węzeł raise_event, którego może słuchać kilka niezwiązanych ze sobą ekranów.

Nie używaj ich do niczego, co należy do jednego ekranu (to pole Component), ani do niczego, co musi działać po stronie serwera.

Właściwości

Dokument znajduje się pod studio_meta.parentId: "globals", w korzeniu własnej gałęzi drzewa, oddzielnej od programs, database i routes. Dokumentu Zmiennych globalnych projektu ani korzenia drzewa nie można usunąć.

progFields

Każdy wpis deklaruje jedną zmienną, czytelną wszędzie jako @field_id.

Obok Twoich własnych zawsze dostępne są zmienne systemowe: @SYS_GLOBAL_OBJ_LOGIN_USER_INFO (obiekt zalogowanego użytkownika) i @SYS_GLOBAL_OBJ_REFS (elementy zarejestrowane przez xu-ref, używane dla stanów ładowania i pustych).

progEvents

Zmienne globalne obsługują ten sam kształt progEvents co każdy inny program, ale nie każdy typ zdarzenia na platformie ma tu zastosowanie. Weryfikator ogranicza screen_ready, on_refresh, on_unload i client_interval wyłącznie do Component; zadeklarowanie któregoś z nich w programie Zmienne globalne to twardy błąd walidacji. To, co Zmienne globalne faktycznie obsługują:

Brak client_interval i server_cron w Zmiennych globalnych

Starszy opis tej jednostki twierdził, że Zmienne globalne mogą odpytywać w interwale (client_interval) albo według harmonogramu crona serwera (server_cron). Żadne z tych twierdzeń nie wytrzymuje porównania z obecnym weryfikatorem: client_interval jest walidowany jako tylko dla Component, a server_cron w ogóle nie jest rozpoznawanym typem zdarzenia, a jedynym jego śladem w środowisku uruchomieniowym jest zakomentowana obsługa. Jeśli projekt potrzebuje dziś cyklicznego odpytywania, umieść zegar w Component (client_interval jest tam prawdziwy i działa), a nie w Zmiennych globalnych.

Przykład krok po kroku

Zadeklaruj wspólny stan

Dodaj pola dla wartości, których potrzebuje każdy ekran: selected_campus_v, signed_in_user_v, dark_mode_v.

Czytaj je skądkolwiek

Każdy Component, program lub wyrażenie w projekcie czyta je tak samo, przez @: @selected_campus_v.

Wywołaj zdarzenie przekrojowe

Nadaj Zmiennym globalnym zdarzenie user_defined (na przykład campus_changed) i wywołaj je przez raise_event z dowolnego Component, który zmienia kampus. Każdy inny otwarty Component, który też ustawił nasłuch raise_event na tę nazwę, zareaguje bez bezpośredniego odniesienia między dwoma ekranami.

W drzewie Studio Zmienne globalne to pojedynczy węzeł w korzeniu własnej gałęzi (nie zagnieżdżony pod Programami). Otwórz go, dodaj wiersze do tabeli Pola dla każdej wspólnej zmiennej z typem i wartością domyślną oraz dodaj wiersze do Zdarzeń dla on_load / on_exit / dowolnego nazwanego zdarzenia, każde z własnym przepływem pracy.

xml
<meta lang="json5">
{
  id: "school_globals",
  menuTitle: "School Globals"
}
</meta>

<fields lang="json5">
{
  selected_campus_v: { type: "string", value: "Boston Campus" },
  signed_in_user_v: { type: "string", value: "Avery Walker" },
  support_email_v: { type: "string", value: "[email protected]" },
  dark_mode_v: { type: "boolean", value: false }
}
</fields>
json
{
  "properties": {
    "menuType": "globals",
    "menuName": "School Globals",
    "progDescription": "Campus and operator state shared across the app."
  },
  "progFields": [
    {
      "id": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
      "data": { "field_id": "selected_campus_v", "type": "virtual" },
      "props": { "fieldType": "string", "fieldValue": "Boston Campus" }
    }
  ],
  "progEvents": [
    { "id": "d4e5f6a7-b8c9-4d0e-af1a-3b4c5d6e7f8a", "data": { "type": "on_load", "parameters": [], "condition": "" }, "workflow": [] }
  ],
  "progDataSource": {}
}