Passer au contenu principal

Route Patterns

Ouvrir dans ChatGPT

Les modèles de route sont utilisés pour définir comment les URL correspondent à des vues spécifiques, y compris des segments dynamiques et optionnels, des expressions régulières et des jokers. Les modèles de route permettent au framework de faire correspondre les URL, d'extraire des paramètres et de générer des URL dynamiquement. Ils jouent un rôle critique dans la structuration de la navigation d'une application et du rendu des composants en fonction de la localisation du navigateur.

Syntaxe des modèles de route​

Les modèles de route dans webforJ sont très flexibles, prenant en charge les fonctionnalités suivantes :

  • Paramètres nommés : Dénotés par :paramName, ils sont requis sauf s'ils sont marqués comme optionnels.
  • Paramètres optionnels : Dénotés par :paramName?, ils peuvent être omis de l'URL.
  • Segments de joker : Représentés par *, ils capturent tous les segments restants de l'URL.
  • Contraintes d'expressions régulières : Des contraintes peuvent être ajoutées uniquement aux paramètres nommés (par exemple, :id<[0-9]+>).

Exemple de définitions de modèles de route​

@Route("customer/:id<[0-9]+>/named/:name/*")
public class CustomerView extends Composite<Div> implements DidEnterObserver {

  @Override
  public void onDidEnter(DidEnterEvent event, ParametersBag parameters) {
    int id = parameters.getInt("id").orElse(0);
    String name = parameters.getAlpha("name").orElse("Inconnu");
    String extra = parameters.getAlpha("*").orElse("");

    String result =
        "ID du client : " + id + "-" +
        "Nom : " + name + "-" +
        "* : " + extra;

    console().log(result);
  }
}

Dans cet exemple :

  • :id<[0-9]+> capture un ID client numérique.
  • :name capture un nom.
  • * capture tous les segments de chemin supplémentaires au-delà de named/:name.

Paramètres nommés​

Les paramètres nommés sont définis en préfixant deux-points : au nom du paramètre dans le modèle. Ils sont requis sauf s'ils sont marqués comme optionnels. Les paramètres nommés peuvent également avoir des contraintes d'expressions régulières pour valider les valeurs.

Exemple :​

@Route("product/:id")
public class ProductView extends Composite<Div> {
  // Logique du composant ici
}

Ce modèle correspond à des URL comme /product/123 où id est 123.

Paramètres optionnels​

Les paramètres optionnels sont indiqués en ajoutant un ? après le nom du paramètre. Ces segments ne sont pas requis et peuvent être omis de l'URL.

Exemple :​

@Route("order/:id?<[0-9]+>")
public class OrderView extends Composite<Div> implements DidEnterObserver {

  @Override
  public void onDidEnter(DidEnterEvent event, ParametersBag parameters) {
    parameters.getInt("id").ifPresentOrElse(
      id -> console().log("ID de la commande : " + id),
      () -> console().log("Aucun ID de commande n'a été fourni")
    );
  }
}

Ce modèle correspond à la fois à /order/123 pour inclure une valeur numérique, et à /order, permettant l'omission d'une valeur numérique lorsque /order est saisi.

Contraintes d'expressions régulières​

Vous pouvez appliquer des contraintes d'expressions régulières aux paramètres en les ajoutant dans des chevrons <>. Cela vous permet de spécifier des règles de correspondance plus strictes pour les paramètres.

Exemple :​

@Route("product/:code<[A-Z]{3}-[0-9]{4}>")
public class ProductView extends Composite<FlexLayout> implements DidEnterObserver {

  @Override
  public void onDidEnter(DidEnterEvent event, ParametersBag parameters) {
    parameters.get("code").ifPresentOrElse(
      code -> console().log("Code produit : " + code),
      () -> console().error("Code produit non trouvé"));
  }
}

Ce modèle ne correspond qu'aux codes produits au format ABC-1234. Par exemple, /product/XYZ-5678 correspondra, mais /product/abc-5678 ne correspondra pas.

Segments de joker​

Les jokers peuvent être utilisés pour capturer des chemins entiers suivant un segment de route spécifique, mais ils ne peuvent apparaître qu'en tant que dernier segment dans le modèle, résolvant toutes les valeurs subséquentes dans l'URL. Pour une meilleure lisibilité, les segments de joker peuvent être nommés. Cependant, contrairement aux paramètres nommés, les segments de joker ne peuvent avoir aucune contrainte.

Exemple :​

@Route("files/:pathname*")
public class FileManagerView extends Composite<Div> implements DidEnterObserver {

  @Override
  public void onDidEnter(DidEnterEvent event, ParametersBag parameters) {
    parameters.get("pathname").ifPresentOrElse(
      pathname -> console().log("FileManagerView : " + pathname),
      () -> console().log("FileManagerView : Aucun paramètre de chemin spécifié")
    );
  }
}

Ce modèle correspond à toute URL commençant par /files et capture le reste du chemin en tant que joker.

Priorité des routes​

Lorsque plusieurs routes correspondent à une URL donnée, l'attribut de priorité d'une route détermine laquelle est sélectionnée en premier. Cela est particulièrement utile lorsque deux routes ou plus se chevauchent dans leurs modèles de chemin, et que vous avez besoin d'un moyen de contrôler laquelle est privilégiée. L'attribut de priorité est disponible dans les annotations @Route et @RouteAlias.

Comment le système de priorité fonctionne​

L'attribut de priorité permet au routeur de déterminer l'ordre dans lequel les routes sont évaluées lorsque plusieurs routes pourraient correspondre à une URL donnée. Les routes sont triées en fonction de leurs valeurs de priorité, avec une priorité plus élevée (valeurs numériques plus basses) étant correspondue en premier. Cela garantit que les routes plus spécifiques prennent le pas sur celles plus générales.

Si deux routes partagent la même priorité, le routeur résout le conflit en sélectionnant la route qui a été enregistrée en premier. Ce mécanisme garantit que la route correcte est choisie, même lorsque plusieurs routes se chevauchent dans leurs modèles d'URL.

Priorité par défaut

Par défaut, toutes les routes se voient attribuer une priorité de 10.

Exemple : Routes conflictuelles​

Considérez un scénario où deux routes correspondent à des modèles d'URL similaires :

@Route(value = "products/:category", priority = 9)
public class ProductCategoryView extends Composite<Div> implements DidEnterObserver {
  @Override
  public void onDidEnter(DidEnterEvent event, ParametersBag parameters) {
    String category = parameters.get("category").orElse("inconnu");
    console().log("Affichage de la catégorie : " + category);
  }
}

@Route(value = "products/:category/:productId?<[0-9]+>")
public class ProductView extends Composite<Div> implements DidEnterObserver {
  @Override
  public void onDidEnter(DidEnterEvent event, ParametersBag parameters) {
    String productId = parameters.get("productId").orElse("inconnu");
    console().log("Affichage du produit : " + productId);
  }
}

Voici comment le système de priorité aide à résoudre les conflits :

  • ProductCategoryView correspond à des URL comme /products/electronics.
  • ProductView correspond à des URL plus spécifiques comme /products/electronics/123, où 123 est l'ID du produit.

Dans ce cas, les deux routes pourraient correspondre à l'URL /products/electronics. Cependant, parce que ProductCategoryView a une priorité plus élevée (priorité = 9), elle sera correspondue en premier lorsqu'il n'y a pas d'productId dans l'URL. Pour les URL comme /products/electronics/123, ProductView sera correspondue en raison de la présence du paramètre productId.