Passer au contenu principal

Routes Registration

Ouvrir dans ChatGPT

En plus de l'enregistrement de routes à l'aide des annotations @Route, il est possible d'enregistrer, de mettre à jour ou de supprimer des routes dynamiquement à l'exécution en fonction de la logique de l'application, des rôles des utilisateurs ou d'autres conditions. Cette flexibilité vous permet de gérer la navigation de manière plus dynamique, plutôt que de définir statiquement les routes au moment de la compilation.

Enregistrement de routes dynamiquement​

Vous pouvez enregistrer une route dynamiquement en utilisant la classe RouteRegistry, qui est accessible via le Router. Cela vous permet d'ajouter de nouvelles routes pendant l'exécution, facilitant une navigation flexible.

Exemple : Enregistrement d'une route dynamique​

Router router = Router.getCurrent();
RouteRegistry registry = router.getRegistry();

// Enregistrer dynamiquement la route des paramètres
registry.register("/settings", SettingsView.class);

// Naviguer vers la vue des paramètres
router.navigate(SettingsView.class);

Dans cet exemple, la route /settings est enregistrée dynamiquement, et l'application navigue vers la vue nouvellement enregistrée.

Enregistrement conditionnel des routes​

Souvent, les routes doivent être ajoutées ou supprimées en fonction de conditions spécifiques telles que les rôles des utilisateurs ou l'état de l'application. Avec le routage dynamique, vous pouvez enregistrer ou désenregistrer des routes de manière conditionnelle à l'exécution.

Exemple : enregistrement conditionnel basé sur le rôle d'utilisateur​

Router router = Router.getCurrent();
RouteRegistry registry = router.getRegistry();

// Vérifier le rôle d'utilisateur et enregistrer les routes appropriées
if (user.hasRole("editor")) {
    registry.register("/editor/dashboard", EditorDashboardView.class);
} else if (user.hasRole("viewer")) {
    registry.register("/viewer/dashboard", ViewerDashboardView.class);
}

// Naviguer vers le tableau de bord approprié
if (user.hasRole("editor")) {
    router.navigate(EditorDashboardView.class);
} else if (user.hasRole("viewer")) {
    router.navigate(ViewerDashboardView.class);
}

Dans cet exemple :

  • La route /editor/dashboard ou /viewer/dashboard est enregistrée dynamiquement en fonction du rôle de l'utilisateur.
  • L'application navigue vers le tableau de bord approprié en fonction des droits d'accès de l'utilisateur.

Suppression de routes​

Tout comme les routes peuvent être ajoutées dynamiquement, elles peuvent également être supprimées à l'exécution lorsqu'elles ne sont plus nécessaires ou lorsque le contexte de l'application change.

Exemple : Suppression d'une route enregistrée​

Router router = Router.getCurrent();
RouteRegistry registry = router.getRegistry();

// Supprimer la route pour la vue des paramètres
registry.unregister("/settings");

// Optionnel, supprimer par classe de composant
registry.unregister(SettingsView.class);

Dans cet exemple, la route /settings est supprimée dynamiquement lorsqu'elle n'est plus requise.

Enregistrement de routes au démarrage de l'application​

Vous pouvez enregistrer des routes dynamiques lors de l'initialisation de l'application, permettant à certaines vues d'être disponibles en fonction de l'environnement ou de la configuration au démarrage.

Exemple : Enregistrement de routes lors du démarrage de l'application​

@Routify
public class Application extends App {

  @Override
  protected void onWillRun() {
    // Enregistrer une vue de débogage uniquement en mode développement
    if (Environment.getCurrent().isDebug()) {
      Router router = Router.getCurrent();
      RouteRegistry registry = router.getRegistry();

      registry.register("/debug", DebugView.class);
    }
  }
}

Dans cet exemple :

  • Une DebugView est enregistrée dynamiquement lors du démarrage de l'application, mais seulement si l'application fonctionne en mode développement.

Enregistrement de composants annotés @Route dynamiquement​

En plus de définir manuellement des routes, il est possible d'enregistrer dynamiquement des composants déjà annotés avec @Route. Ceci est utile lorsque vous souhaitez tirer parti de classes pré-annotées mais les enregistrer dynamiquement en fonction de la logique de l'application.

Exemple : Enregistrement d'un composant annoté @Route​

@Route("profile")
public class ProfileView extends Composite<Div> {
    // Logique de la vue de profil
}

Router router = Router.getCurrent();
RouteRegistry registry = router.getRegistry();

// Enregistrer dynamiquement le ProfileView avec son annotation @Route
registry.register(ProfileView.class);

// Naviguer vers le ProfileView
router.navigate(ProfileView.class);

Dans cet exemple :

  • La classe ProfileView est annotée avec @Route("profile").
  • La route est enregistrée dynamiquement à l'exécution à l'aide de registry.register(ProfileView.class).

Enregistrement de routes depuis un package entier​

Si votre application dispose d'un grand nombre de routes organisées dans un package, vous pouvez enregistrer tous les composants annotés @Route depuis le package dynamiquement.

Exemple : Enregistrement de toutes les routes depuis un package​

Router router = Router.getCurrent();
RouteRegistry registry = router.getRegistry();

// Enregistrer toutes les routes dans le package "com.myapp.admin"
RouteRegistry.ofPackage(new String[] { "com.myapp.admin" }, registry);

Dans cet exemple :

  • La méthode ofPackage analyse le package com.myapp.admin et enregistre toutes les classes annotées avec @Route.
  • Ceci est particulièrement utile pour les grandes applications avec de nombreuses routes organisées par packages.
Découverte personnalisée des routes

À partir de la version 25.11, les frameworks d'intégration peuvent fournir leur propre mécanisme de découverte des routes via le SPI RouteRegistryProvider. Cela permet des fonctionnalités spécifiques au framework comme l'injection de dépendances pour les routes enregistrées dynamiquement. Voir Route Registry Provider pour plus de détails.

Récupération des routes enregistrées​

Pour récupérer une liste de toutes les routes enregistrées dynamiquement, utilisez la classe RouteRegistry. Ceci est utile lorsque vous devez gérer ou afficher programmétiquement les routes disponibles.

Exemple : Récupération et affichage de toutes les routes enregistrées​

Router router = Router.getCurrent();
RouteRegistry registry = router.getRegistry();

List<RouteEntry> routes = registry.getAvailableRouteEntires();
routes.forEach(route -> console().log("Path: " + route.getPath()));

Dans cet exemple, l'application récupère toutes les routes actuellement enregistrées et imprime leurs chemins.

Gestion des alias de route dynamiquement​

webforJ vous permet d'enregistrer plusieurs alias pour une seule vue. Cela signifie que les utilisateurs peuvent accéder à la même vue par différents chemins URL.

Exemple : Enregistrement d'alias de route dynamiquement​

Router router = Router.getCurrent();
RouteRegistry registry = router.getRegistry();

// Enregistrer une route principale
registry.register("/contact", ContactView.class);

// Enregistrer des alias pour la vue de contact
registry.register("/support", ContactView.class);
registry.register("/help", ContactView.class);

Dans cet exemple, la ContactView est accessible via trois chemins différents : /contact, /support et /help.