Aller au contenu
Vérifié

Globals

Le programme que tous les autres programmes peuvent lire, pour l'état et la logique qui appartiennent à toute l'application plutôt qu'à un seul écran.

Chaque projet Xuda possède exactement un programme Globals. Il contient les constantes, les variables partagées et la logique de démarrage que tout programme Composant, Obtenir des données, Définir des données, Lot, JavaScript ou API du projet peut lire : ainsi, une valeur qui signifie la même chose partout (l'utilisateur connecté, un indicateur de fonctionnalité, le campus actif) a un seul foyer au lieu d'être copiée dans chaque écran qui en a besoin.

Globals s'exécute toujours côté client

Quoi que dise runAt ailleurs, le runtime force Globals sur client. C'est le seul type de programme qui ne s'exécute jamais sur le serveur ; ce n'est donc pas le bon endroit pour tout ce qui doit rester hors de l'appareil (secrets, lectures privilégiées). Utilisez pour cela un programme Obtenir des données ou Définir des données côté serveur.

Quand l'utiliser

Recourez à Globals quand une valeur ou un morceau de logique de démarrage est nécessaire à plus d'un Composant et que vous ne voulez pas la transmettre en paramètre à chacun : le nom de l'utilisateur connecté, un campus ou un locataire sélectionné, un indicateur de mode sombre, une adresse e-mail de support, un point central raise_event que plusieurs écrans sans rapport peuvent écouter.

Ne l'utilisez pas pour ce qui appartient à un seul écran (c'est un champ de Composant) ni pour ce qui doit s'exécuter côté serveur.

Propriétés

Le document se trouve à studio_meta.parentId: "globals", la racine de sa propre branche dans l'arborescence, séparée de programs, database et routes. Le document Globals d'un projet et la racine de l'arborescence ne peuvent pas être supprimés.

progFields

Chaque entrée déclare une variable, lisible partout sous la forme @field_id.

Des globals système sont toujours disponibles à côté des vôtres : @SYS_GLOBAL_OBJ_LOGIN_USER_INFO (l'objet de l'utilisateur connecté) et @SYS_GLOBAL_OBJ_REFS (les éléments enregistrés avec xu-ref, utilisés pour les états de chargement et de vide).

progEvents

Globals prend en charge la même forme progEvents que tout autre programme, mais tous les types d'événements de la plateforme ne s'y appliquent pas. Le vérificateur réserve screen_ready, on_refresh, on_unload et client_interval aux Composants ; en déclarer un sur un programme Globals est une erreur de validation bloquante. Ce que Globals prend réellement en charge :

Pas de client_interval ni de server_cron sur Globals

Une ancienne description de cette unité affirmait que Globals pouvait interroger à intervalle (client_interval) ou selon un planning cron serveur (server_cron). Aucun des deux ne tient face au vérificateur actuel : client_interval est validé comme réservé aux composants, et server_cron n'est pas du tout un type d'événement reconnu, sa seule trace dans le runtime est un gestionnaire mis en commentaire. Si un projet a besoin d'une interrogation récurrente aujourd'hui, placez le minuteur sur un Composant (client_interval y est réel et actif) plutôt que sur Globals.

Exemple concret

Déclarez l'état partagé

Ajoutez des champs pour les valeurs dont chaque écran a besoin : selected_campus_v, signed_in_user_v, dark_mode_v.

Lisez-les de partout

Tout Composant, programme ou expression du projet les lit de la même façon, avec @ : @selected_campus_v.

Déclenchez un événement transversal

Donnez à Globals un événement user_defined (par exemple campus_changed) et appelez-le avec raise_event depuis le Composant qui change le campus. Tout autre Composant ouvert qui a aussi déclaré un écouteur raise_event pour ce nom réagit, sans référence directe entre les deux écrans.

Dans l'arborescence de Studio, Globals est le nœud unique à la racine de sa propre branche (pas imbriqué sous Programmes). Ouvrez-le, ajoutez des lignes au tableau Champs pour chaque variable partagée avec un type et une valeur par défaut, et ajoutez des lignes à Événements pour on_load / on_exit / tout événement nommé, chacun avec son propre workflow.

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": {}
}