Routage vers les actions du contrôleur dans ASP.NET CoreRouting to controller actions in ASP.NET Core

Par Ryan Nowak et Rick AndersonBy Ryan Nowak and Rick Anderson

ASP.NET Core MVC utilise l’intergiciel de routage pour mettre en correspondance les URL des requêtes entrantes et les mapper à des actions.ASP.NET Core MVC uses the Routing middleware to match the URLs of incoming requests and map them to actions. Les routes sont définies dans le code de démarrage ou dans des attributs.Routes are defined in startup code or attributes. Les routes décrivent comment les chemins des URL doivent être mis en correspondance avec les actions.Routes describe how URL paths should be matched to actions. Les routes sont également utilisées pour générer des URL (pour les liens) envoyés dans les réponses.Routes are also used to generate URLs (for links) sent out in responses.

Les actions sont routées de façon conventionnelle ou routées par attribut.Actions are either conventionally routed or attribute routed. Le fait de placer une route sur le contrôleur ou sur l’action les rend « routés par attribut ».Placing a route on the controller or the action makes it attribute routed. Pour plus d’informations, consultez Routage mixte.See Mixed routing for more information.

Ce document explique les interactions entre MVC et le routage, et comment les applications MVC classiques utilisent les fonctionnalités du routage.This document will explain the interactions between MVC and routing, and how typical MVC apps make use of routing features. Pour plus d’informations sur le routage avancé, consultez Routage.See Routing for details on advanced routing.

Configuration de l’intergiciel de routageSetting up Routing Middleware

Dans votre méthode Configure, vous pouvez voir un code similaire à celui-ci :In your Configure method you may see code similar to:

app.UseMvc(routes =>
{
   routes.MapRoute("default", "{controller=Home}/{action=Index}/{id?}");
});

À l’intérieur de l’appel à UseMvc, MapRoute est utilisé pour créer une route, nous allons appeler route default.Inside the call to UseMvc, MapRoute is used to create a single route, which we'll refer to as the default route. La plupart des applications MVC utilisent une route avec un modèle similaire à la route default.Most MVC apps will use a route with a template similar to the default route.

Le modèle de route "{controller=Home}/{action=Index}/{id?}" peut correspondre à un chemin d’URL comme /Products/Details/5 et il extrait les valeurs { controller = Products, action = Details, id = 5 } de la route en décomposant le chemin en jetons.The route template "{controller=Home}/{action=Index}/{id?}" can match a URL path like /Products/Details/5 and will extract the route values { controller = Products, action = Details, id = 5 } by tokenizing the path. MVC tente de trouver un contrôleur nommé ProductsController et d’exécuter l’action Details :MVC will attempt to locate a controller named ProductsController and run the action Details:

public class ProductsController : Controller
{
   public IActionResult Details(int id) { ... }
}

Notez que dans cet exemple, la liaison de modèle utilise la valeur de id = 5 pour définir le paramètre id sur 5 lors de l’appel de cette action.Note that in this example, model binding would use the value of id = 5 to set the id parameter to 5 when invoking this action. Pour plus d’informations, consultez Liaison de modèle.See the Model Binding for more details.

Utilisation de la route default :Using the default route:

routes.MapRoute("default", "{controller=Home}/{action=Index}/{id?}");

Le modèle de route :The route template:

  • {controller=Home} définit Home comme controller par défaut.{controller=Home} defines Home as the default controller

  • {action=Index} définit Index comme action par défaut.{action=Index} defines Index as the default action

  • {id?} définit id comme étant facultatif.{id?} defines id as optional

Les paramètres de route par défaut et facultatifs n’ont pas besoin d’être présents dans le chemin d’URL pour qu’une correspondance soit établie.Default and optional route parameters don't need to be present in the URL path for a match. Pour une description détaillée de la syntaxe du modèle de route, consultez Informations de référence sur le modèle de route.See Route Template Reference for a detailed description of route template syntax.

"{controller=Home}/{action=Index}/{id?}" peut correspondre au chemin d’URL / et produit les valeurs de route { controller = Home, action = Index }."{controller=Home}/{action=Index}/{id?}" can match the URL path / and will produce the route values { controller = Home, action = Index }. Les valeurs de controller et action utilisent les valeurs par défaut, et id ne produit pas de valeur, car il n’existe pas de segment correspondant dans le chemin d’URL.The values for controller and action make use of the default values, id doesn't produce a value since there's no corresponding segment in the URL path. MVC utilisez ces valeurs de route pour sélectionner HomeController et l’action Index :MVC would use these route values to select the HomeController and Index action:

public class HomeController : Controller
{
  public IActionResult Index() { ... }
}

Avec cette définition de contrôleur et ce modèle de route, l’action HomeController.Index est exécutée pour tous les chemins d’URL suivants :Using this controller definition and route template, the HomeController.Index action would be executed for any of the following URL paths:

  • /Home/Index/17

  • /Home/Index

  • /Home

  • /

La méthode pratique UseMvcWithDefaultRoute :The convenience method UseMvcWithDefaultRoute:

app.UseMvcWithDefaultRoute();

Peut être utilisée pour remplacer :Can be used to replace:

app.UseMvc(routes =>
{
   routes.MapRoute("default", "{controller=Home}/{action=Index}/{id?}");
});

UseMvc et UseMvcWithDefaultRoute ajoutent une instance de RouterMiddleware au pipeline de l’intergiciel.UseMvc and UseMvcWithDefaultRoute add an instance of RouterMiddleware to the middleware pipeline. MVC n’interagit pas directement avec l’intergiciel et utilise le routage pour gérer les requêtes.MVC doesn't interact directly with middleware, and uses routing to handle requests. MVC est connecté aux routes via une instance de MvcRouteHandler.MVC is connected to the routes through an instance of MvcRouteHandler. Le code de UseMvc est similaire à ceci :The code inside of UseMvc is similar to the following:

var routes = new RouteBuilder(app);

// Add connection to MVC, will be hooked up by calls to MapRoute.
routes.DefaultHandler = new MvcRouteHandler(...);

// Execute callback to register routes.
// routes.MapRoute("default", "{controller=Home}/{action=Index}/{id?}");

// Create route collection and add the middleware.
app.UseRouter(routes.Build());

UseMvc ne définit directement aucune route, il ajoute un espace réservé à la collection de routes pour la route attribute.UseMvc doesn't directly define any routes, it adds a placeholder to the route collection for the attribute route. La surcharge UseMvc(Action<IRouteBuilder>) vous permet d’ajouter vos propres routes et prend également en charge le routage par attribut.The overload UseMvc(Action<IRouteBuilder>) lets you add your own routes and also supports attribute routing. UseMvc et toutes ses variations ajoutent un espace réservé pour la route d’attribut ; le routage par attribut est toujours disponible, quelle que soit la façon dont vous configurez UseMvc.UseMvc and all of its variations adds a placeholder for the attribute route - attribute routing is always available regardless of how you configure UseMvc. UseMvcWithDefaultRoute définit une route par défaut et prend en charge le routage par attribut.UseMvcWithDefaultRoute defines a default route and supports attribute routing. La section Routage par attribut comprend plus de détails sur le routage par attribut.The Attribute Routing section includes more details on attribute routing.

Routage conventionnelConventional routing

La route default :The default route:

routes.MapRoute("default", "{controller=Home}/{action=Index}/{id?}");

est un exemple de routage conventionnel.is an example of a conventional routing. Nous appelons ce style routage conventionnel, car il établit une convention pour les chemins d’URL :We call this style conventional routing because it establishes a convention for URL paths:

  • Le premier segment du chemin correspond au nom du contrôleur.the first path segment maps to the controller name

  • Le deuxième correspond au nom de l’action.the second maps to the action name.

  • Le troisième segment est utilisé pour un id facultatif utilisé pour le mappage à une entité du modèle.the third segment is used for an optional id used to map to a model entity

En utilisant cette route default, le chemin d’URL /Products/List mappe à l’action ProductsController.List, et /Blog/Article/17 mappe à BlogController.Article.Using this default route, the URL path /Products/List maps to the ProductsController.List action, and /Blog/Article/17 maps to BlogController.Article. Ce mappage est basé uniquement sur les noms de contrôleur et d’action ; il n’est pas basé sur les espaces de noms, les emplacements des fichiers sources ou les paramètres de méthode.This mapping is based on the controller and action names only and isn't based on namespaces, source file locations, or method parameters.

Conseil

L’utilisation du routage conventionnel avec la route par défaut vous permet de créer rapidement l’application sans avoir à élaborer un nouveau modèle d’URL pour chaque action que vous définissez.Using conventional routing with the default route allows you to build the application quickly without having to come up with a new URL pattern for each action you define. Pour une application avec des actions de style CRUD, le fait de disposer d’une cohérence pour les URL entre vos contrôleurs peut simplifier votre code et rendre votre interface utilisateur plus prévisible.For an application with CRUD style actions, having consistency for the URLs across your controllers can help simplify your code and make your UI more predictable.

Avertissement

id est défini comme étant facultatif par le modèle de route, ce qui signifie que vos actions peuvent s’exécuter sans l’ID fourni dans le cadre de l’URL.The id is defined as optional by the route template, meaning that your actions can execute without the ID provided as part of the URL. En général, si id est omis de l’URL, il est défini sur 0 par la liaison de modèle : aucune entité correspondant à id == 0 n’est donc trouvée dans la base de données.Usually what will happen if id is omitted from the URL is that it will be set to 0 by model binding, and as a result no entity will be found in the database matching id == 0. Le routage par attribut vous donne un contrôle précis pour rendre le code obligatoire pour certaines actions et pas pour d’autres.Attribute routing can give you fine-grained control to make the ID required for some actions and not for others. Par convention, la documentation inclut des paramètres facultatifs comme id quand ils sont susceptibles d’apparaître dans une utilisation correcte.By convention the documentation will include optional parameters like id when they're likely to appear in correct usage.

Routes multiplesMultiple routes

Vous pouvez ajouter plusieurs routes dans UseMvc en ajoutant plusieurs appels à MapRoute.You can add multiple routes inside UseMvc by adding more calls to MapRoute. Ceci vous permet de définir plusieurs conventions ou d’ajouter des routes conventionnelles qui sont dédiées à une action spécifique, comme :Doing so allows you to define multiple conventions, or to add conventional routes that are dedicated to a specific action, such as:

app.UseMvc(routes =>
{
   routes.MapRoute("blog", "blog/{*article}",
            defaults: new { controller = "Blog", action = "Article" });
   routes.MapRoute("default", "{controller=Home}/{action=Index}/{id?}");
});

La route blog est ici une route conventionnelle dédiée, ce qui signifie qu’elle utilise le système de routage conventionnel, mais qu’elle est dédiée à une action spécifique.The blog route here is a dedicated conventional route, meaning that it uses the conventional routing system, but is dedicated to a specific action. Comme controller et action n’apparaissent pas dans le modèle de route en tant que paramètres, ils peuvent seulement avoir les valeurs par défaut et par conséquent, cette route sera toujours mappée à l’action BlogController.Article.Since controller and action don't appear in the route template as parameters, they can only have the default values, and thus this route will always map to the action BlogController.Article.

Les routes de la collection de routes sont ordonnées et elles sont traitées dans l’ordre où elles sont ajoutées.Routes in the route collection are ordered, and will be processed in the order they're added. Ainsi, dans cet exemple, la route blog est essayée avant la route default.So in this example, the blog route will be tried before the default route.

Note

Les routes conventionnelles dédiées utilisent souvent des paramètres de route fourre-tout, comme {*article}, pour capturer la partie restante du chemin d’URL.Dedicated conventional routes often use catch-all route parameters like {*article} to capture the remaining portion of the URL path. Ceci peut rendre une route « trop globale », ce qui signifie qu’elle correspond à des URL qui devaient être mises en correspondance par d’autres routes.This can make a route 'too greedy' meaning that it matches URLs that you intended to be matched by other routes. Pour résoudre ce problème, placez les routes « globales » plus loin dans la table de routage.Put the 'greedy' routes later in the route table to solve this.

Processus de repliFallback

Dans le cadre du traitement des requêtes, MVC vérifie que les valeurs de route peuvent être utilisées pour rechercher un contrôleur et une action dans votre application.As part of request processing, MVC will verify that the route values can be used to find a controller and action in your application. Si les valeurs de route ne correspondent pas à une action, la route n’est pas considérée comme une correspondance, et la route suivante est essayée.If the route values don't match an action then the route isn't considered a match, and the next route will be tried. Ceci est appelé processus de repli et est conçu pour simplifier les cas où des routes conventionnelles se chevauchent.This is called fallback, and it's intended to simplify cases where conventional routes overlap.

Résolution des ambiguïtés pour les actionsDisambiguating actions

Quand deux actions correspondent via le routage, MVC doit résoudre l’ambiguïté pour choisir le « meilleur » candidat ou sinon lever une exception.When two actions match through routing, MVC must disambiguate to choose the 'best' candidate or else throw an exception. Exemple :For example:

public class ProductsController : Controller
{
   public IActionResult Edit(int id) { ... }

   [HttpPost]
   public IActionResult Edit(int id, Product product) { ... }
}

Ce contrôleur définit deux actions qui correspondraient au chemin d’URL /Products/Edit/17 et les données de routage { controller = Products, action = Edit, id = 17 }.This controller defines two actions that would match the URL path /Products/Edit/17 and route data { controller = Products, action = Edit, id = 17 }. Il s’agit d’un modèle classique pour les contrôleurs MVC, où Edit(int) montre un formulaire pour modifier un produit, et où Edit(int, Product) traite le formulaire envoyé.This is a typical pattern for MVC controllers where Edit(int) shows a form to edit a product, and Edit(int, Product) processes the posted form. Pour rendre cela possible, MVC doit choisir Edit(int, Product) quand la requête est POST HTTP, et Edit(int) quand le verbe HTTP est autre chose.To make this possible MVC would need to choose Edit(int, Product) when the request is an HTTP POST and Edit(int) when the HTTP verb is anything else.

HttpPostAttribute ([HttpPost]) est une implémentation de IActionConstraint qui permet la sélection de l’action seulement quand le verbe HTTP est POST.The HttpPostAttribute ( [HttpPost] ) is an implementation of IActionConstraint that will only allow the action to be selected when the HTTP verb is POST. La présence d’une IActionConstraint fait de Edit(int, Product) une correspondance « meilleure » que Edit(int), de sorte que Edit(int, Product) est essayé en premier.The presence of an IActionConstraint makes the Edit(int, Product) a 'better' match than Edit(int), so Edit(int, Product) will be tried first.

Vous devez écrire des implémentations personnalisées de IActionConstraint seulement dans des scénarios spécifiques, mais il est important de comprendre le rôle d’attributs comme HttpPostAttribute ; des attributs similaires sont définis pour les autres verbes HTTP.You will only need to write custom IActionConstraint implementations in specialized scenarios, but it's important to understand the role of attributes like HttpPostAttribute - similar attributes are defined for other HTTP verbs. Dans le routage conventionnel, il est courant que des actions utilisent un même nom d’action quand elles font partie d’un flux de travail show form -> submit form.In conventional routing it's common for actions to use the same action name when they're part of a show form -> submit form workflow. L’avantage de ce modèle devient plus évident après la lecture de la section Présentation d’IActionConstraint.The convenience of this pattern will become more apparent after reviewing the Understanding IActionConstraint section.

Si plusieurs routes correspondent et que MVC ne peut pas trouver une « meilleure » route, elle lève une AmbiguousActionException.If multiple routes match, and MVC can't find a 'best' route, it will throw an AmbiguousActionException.

Noms des routesRoute names

Les chaînes "blog" et "default" dans les exemples suivants sont des noms de routes :The strings "blog" and "default" in the following examples are route names:

app.UseMvc(routes =>
{
   routes.MapRoute("blog", "blog/{*article}",
               defaults: new { controller = "Blog", action = "Article" });
   routes.MapRoute("default", "{controller=Home}/{action=Index}/{id?}");
});

Les noms de routes donnent aux routes des noms logiques : le nom de route peut ainsi être utilisé pour la génération des URL.The route names give the route a logical name so that the named route can be used for URL generation. Ceci simplifie considérablement la création d’URL quand l’ordonnancement des routes peut rendre compliquée la génération des URL.This greatly simplifies URL creation when the ordering of routes could make URL generation complicated. Les noms de routes doivent être unique à l’échelle de l’application.Route names must be unique application-wide.

Les noms de routes n’ont pas d’impact sur la correspondance des URL ni sur le traitement des requêtes ; ils sont utilisés seulement pour la génération d’URL.Route names have no impact on URL matching or handling of requests; they're used only for URL generation. La section Routage contient des informations plus détaillées sur la génération d’URL, notamment la génération d’URL dans les helpers spécifiques à MVC.Routing has more detailed information on URL generation including URL generation in MVC-specific helpers.

Routage par attributsAttribute routing

Le routage par attributs utilise un ensemble d’attributs pour mapper les actions directement aux modèles de routes.Attribute routing uses a set of attributes to map actions directly to route templates. Dans l’exemple suivant, app.UseMvc(); est utilisé dans la méthode Configure et aucune route n’est passée.In the following example, app.UseMvc(); is used in the Configure method and no route is passed. HomeController va trouver des correspondances avec un ensemble d’URL similaires aux correspondances qui seraient trouvées par la route par défaut {controller=Home}/{action=Index}/{id?}:The HomeController will match a set of URLs similar to what the default route {controller=Home}/{action=Index}/{id?} would match:

public class HomeController : Controller
{
   [Route("")]
   [Route("Home")]
   [Route("Home/Index")]
   public IActionResult Index()
   {
      return View();
   }
   [Route("Home/About")]
   public IActionResult About()
   {
      return View();
   }
   [Route("Home/Contact")]
   public IActionResult Contact()
   {
      return View();
   }
}

L’action HomeController.Index() sera exécutée pour tous les chemins d’URL /, /Home ou /Home/Index.The HomeController.Index() action will be executed for any of the URL paths /, /Home, or /Home/Index.

Note

Cet exemple met en évidence une différence importante en termes de programmation entre le routage par attributs et le routage conventionnel.This example highlights a key programming difference between attribute routing and conventional routing. Le routage par attributs nécessite des entrées en plus grand nombre pour spécifier une route ; la route conventionnelle par défaut gère les routes de façon plus succincte.Attribute routing requires more input to specify a route; the conventional default route handles routes more succinctly. Cependant, le routage par attributs permet (et nécessite) un contrôle précis des modèles de routes qui s’appliquent à chaque action.However, attribute routing allows (and requires) precise control of which route templates apply to each action.

Avec le routage par attributs, le nom du contrôleur et les noms des actions ne jouent aucun rôle dans la sélection de l’action.With attribute routing the controller name and action names play no role in which action is selected. Cet exemple trouve une correspondance avec les mêmes URL que l’exemple précédent.This example will match the same URLs as the previous example.

public class MyDemoController : Controller
{
   [Route("")]
   [Route("Home")]
   [Route("Home/Index")]
   public IActionResult MyIndex()
   {
      return View("Index");
   }
   [Route("Home/About")]
   public IActionResult MyAbout()
   {
      return View("About");
   }
   [Route("Home/Contact")]
   public IActionResult MyContact()
   {
      return View("Contact");
   }
}

Note

Les modèles de routes ci-dessus ne définissent pas de paramètres de route pour action, area et controller.The route templates above don't define route parameters for action, area, and controller. En fait, ces paramètres de route ne sont pas autorisés dans les routes par attributs.In fact, these route parameters are not allowed in attribute routes. Comme le modèle de route est déjà associé à une action, cela n’aurait pas de sens d’analyser le nom de l’action à partir de l’URL.Since the route template is already associated with an action, it wouldn't make sense to parse the action name from the URL.

Routage par attributs avec des attributs Http[Verbe]Attribute routing with Http[Verb] attributes

Le routage par attributs peut aussi utiliser les attributs Http[Verb], comme HttpPostAttribute.Attribute routing can also make use of the Http[Verb] attributes such as HttpPostAttribute. Tous ces attributs peuvent accepter un modèle de route.All of these attributes can accept a route template. Cet exemple montre deux actions qui correspondent au même modèle de route :This example shows two actions that match the same route template:

[HttpGet("/products")]
public IActionResult ListProducts()
{
   // ...
}

[HttpPost("/products")]
public IActionResult CreateProduct(...)
{
   // ...
}

Pour un chemin d’URL comme /products, l’action ProductsApi.ListProducts est exécutée quand le verbe HTTP est GET, et ProductsApi.CreateProduct est exécutée quand le verbe HTTP est POST.For a URL path like /products the ProductsApi.ListProducts action will be executed when the HTTP verb is GET and ProductsApi.CreateProduct will be executed when the HTTP verb is POST. Le routage par attributs recherche d’abord une correspondance de l’URL par rapport à l’ensemble des modèles de routes défini par les attributs de la route.Attribute routing first matches the URL against the set of route templates defined by route attributes. Une fois qu’un modèle de route correspond, les contraintes de IActionConstraint sont appliquées pour déterminer quelles actions peuvent être exécutées.Once a route template matches, IActionConstraint constraints are applied to determine which actions can be executed.

Conseil

Lors de la création d’une API REST, il est rare de vouloir utiliser [Route(...)] sur une méthode d’action.When building a REST API, it's rare that you will want to use [Route(...)] on an action method. Il est préférable d’utiliser les Http*Verb*Attributes plus spécifiques pour plus de précision quant à ce qui est pris en charge par votre API.It's better to use the more specific Http*Verb*Attributes to be precise about what your API supports. Les clients des API REST doivent normalement connaître les chemins et les verbes HTTP qui correspondent à des opérations logiques spécifiques.Clients of REST APIs are expected to know what paths and HTTP verbs map to specific logical operations.

Dans la mesure où une route d’attribut s’applique à une action spécifique, il est facile de placer les paramètres nécessaires dans la définition du modèle de route.Since an attribute route applies to a specific action, it's easy to make parameters required as part of the route template definition. Dans cet exemple, id est obligatoire dans le chemin d’URL.In this example, id is required as part of the URL path.

public class ProductsApiController : Controller
{
   [HttpGet("/products/{id}", Name = "Products_List")]
   public IActionResult GetProduct(int id) { ... }
}

L’action ProductsApi.GetProduct(int) est exécutée pour un chemin d’URL comme /products/3, mais pas pour un chemin d’URL comme /products.The ProductsApi.GetProduct(int) action will be executed for a URL path like /products/3 but not for a URL path like /products. Consultez Routage pour obtenir une description complète des modèles de routes et des options associées.See Routing for a full description of route templates and related options.

Nom des routesRoute Name

Le code suivant définit un nom de route Products_List :The following code defines a route name of Products_List:

public class ProductsApiController : Controller
{
   [HttpGet("/products/{id}", Name = "Products_List")]
   public IActionResult GetProduct(int id) { ... }
}

Les noms de routes peuvent être utilisés pour générer une URL basée sur une route spécifique.Route names can be used to generate a URL based on a specific route. Les noms de routes n’ont pas d’impact sur le comportement de mise en correspondance des URL du routage et ils sont utilisés seulement pour la génération d’URL.Route names have no impact on the URL matching behavior of routing and are only used for URL generation. Les noms de routes doivent être unique à l’échelle de l’application.Route names must be unique application-wide.

Note

Comparez ceci avec la route par défaut conventionnelle, qui définit le paramètre id comme étant facultatif ({id?}).Contrast this with the conventional default route, which defines the id parameter as optional ({id?}). Cette possibilité de spécifier les API avec précision présente des avantages, par exemple de permettre de diriger /products et /products/5 vers des actions différentes.This ability to precisely specify APIs has advantages, such as allowing /products and /products/5 to be dispatched to different actions.

Combinaison de routesCombining routes

Pour rendre le routage par attributs moins répétitif, les attributs de route sont combinés avec des attributs de route sur les actions individuelles.To make attribute routing less repetitive, route attributes on the controller are combined with route attributes on the individual actions. Les modèles de routes définis sur le contrôleur sont ajoutés à des modèles de routes sur les actions.Any route templates defined on the controller are prepended to route templates on the actions. Placer un attribut de route sur le contrôleur a pour effet que toutes les actions du contrôleur utilisent le routage par attributs.Placing a route attribute on the controller makes all actions in the controller use attribute routing.

[Route("products")]
public class ProductsApiController : Controller
{
   [HttpGet]
   public IActionResult ListProducts() { ... }

   [HttpGet("{id}")]
   public ActionResult GetProduct(int id) { ... }
}

Dans cet exemple, le chemin d’URL /products peut être mis en correspondance avec ProductsApi.ListProducts et le chemin d’URL /products/5 peut être mis en correspondance avec ProductsApi.GetProduct(int).In this example the URL path /products can match ProductsApi.ListProducts, and the URL path /products/5 can match ProductsApi.GetProduct(int). Ces deux actions correspondent seulement à HTTP GET, car elles sont décorées avec HttpGetAttribute.Both of these actions only match HTTP GET because they're decorated with the HttpGetAttribute.

Les modèles de routes appliqués à une action qui commencent par / ne sont pas combinés avec les modèles de routes appliqués au contrôleur.Route templates applied to an action that begin with a / don't get combined with route templates applied to the controller. Cet exemple met en correspondance avec un ensemble de chemins d’URL similaires à la route par défaut.This example matches a set of URL paths similar to the default route.

[Route("Home")]
public class HomeController : Controller
{
    [Route("")]      // Combines to define the route template "Home"
    [Route("Index")] // Combines to define the route template "Home/Index"
    [Route("/")]     // Doesn't combine, defines the route template ""
    public IActionResult Index()
    {
        ViewData["Message"] = "Home index";
        var url = Url.Action("Index", "Home");
        ViewData["Message"] = "Home index" + "var url = Url.Action; =  " + url;
        return View();
    }

    [Route("About")] // Combines to define the route template "Home/About"
    public IActionResult About()
    {
        return View();
    }   
}

Ordonnancement des routes d’attributsOrdering attribute routes

Contrairement aux routes conventionnelles qui s’exécutent dans un ordre défini, le routage par attributs génère une arborescence et établit une correspondance simultanément avec toutes les routes.In contrast to conventional routes which execute in a defined order, attribute routing builds a tree and matches all routes simultaneously. Il se comporte comme-si les entrées des routes étaient placées dans un ordre idéal ; les routes les plus spécifiques ont ainsi plus de probabilités de s’exécuter avant les routes plus générales.This behaves as-if the route entries were placed in an ideal ordering; the most specific routes have a chance to execute before the more general routes.

Par exemple, une route comme blog/search/{topic} est plus spécifique qu’une route comme blog/{*article}.For example, a route like blog/search/{topic} is more specific than a route like blog/{*article}. D’un point de vue logique, la route blog/search/{topic} « s’exécute » par défaut en premier, car il s’agit du seul ordre sensé.Logically speaking the blog/search/{topic} route 'runs' first, by default, because that's the only sensible ordering. Avec le routage conventionnel, le développeur est responsable du placement des routes dans l’ordre souhaité.Using conventional routing, the developer is responsible for placing routes in the desired order.

Les routes d’attribut peuvent configurer un ordre en utilisant la propriété Order de tous les attributs de route fournis par le framework.Attribute routes can configure an order, using the Order property of all of the framework provided route attributes. Les routes sont traitées selon un ordre croissant de la propriété Order.Routes are processed according to an ascending sort of the Order property. L’ordre par défaut est 0.The default order is 0. La définition d’une route avec Order = -1 fait que cette route « s’exécute » avant les routes qui ne définissent pas d’ordre.Setting a route using Order = -1 will run before routes that don't set an order. La définition d’une route avec Order = 1 fait que cette route « s’exécute » après l’ordre des routes par défaut.Setting a route using Order = 1 will run after default route ordering.

Conseil

Évitez de dépendre de Order.Avoid depending on Order. Si votre espace d’URL nécessite des valeurs d’ordre explicites pour router correctement, il est probable qu’il prête également à confusion pour les clients.If your URL-space requires explicit order values to route correctly, then it's likely confusing to clients as well. D’une façon générale, le routage par attributs sélectionne la route correcte avec la mise en correspondance d’URL.In general attribute routing will select the correct route with URL matching. Si l’ordre par défaut utilisé pour la génération d’URL ne fonctionne pas, l’utilisation à titre de remplacement d’un nom de route est généralement plus simple que d’appliquer la propriété Order.If the default order used for URL generation isn't working, using route name as an override is usually simpler than applying the Order property.

Le routage de Razor Pages et celui du contrôleur MVC partagent une implémentation.Razor Pages routing and MVC controller routing share an implementation. Les informations relatives à l’ordre d’itinéraire dans les rubriques de Razor Pages sont disponibles à la page Conventions d’itinéraires et d’applications Razor Pages : ordre d’itinéraire.Information on route order in the Razor Pages topics is available at Razor Pages route and app conventions: Route order.

Remplacement de jetons dans les modèles de routes ([contrôleur], [action], [zone])Token replacement in route templates ([controller], [action], [area])

Pour plus de commodité, les routes d’attribut prennent en charge le remplacement de jetons, qui se fait via la mise entre crochets d’un jeton ([, ]).For convenience, attribute routes support token replacement by enclosing a token in square-braces ([, ]). Les jetons [action], [area] et [controller] sont remplacés par les valeurs du nom d’action, du nom de la zone et du nom du contrôleur de l’action où la route est définie.The tokens [action], [area], and [controller] are replaced with the values of the action name, area name, and controller name from the action where the route is defined. Dans l’exemple suivant, les actions correspondent aux chemins d’URL comme décrit dans les commentaires :In the following example, the actions match URL paths as described in the comments:

[Route("[controller]/[action]")]
public class ProductsController : Controller
{
    [HttpGet] // Matches '/Products/List'
    public IActionResult List() {
        // ...
    }

    [HttpGet("{id}")] // Matches '/Products/Edit/{id}'
    public IActionResult Edit(int id) {
        // ...
    }
}

Le remplacement des jetons se produit à la dernière étape de la création des routes d’attribut.Token replacement occurs as the last step of building the attribute routes. L’exemple ci-dessus se comporte comme le code suivant :The above example will behave the same as the following code:


public class ProductsController : Controller
{
    [HttpGet("[controller]/[action]")] // Matches '/Products/List'
    public IActionResult List() {
        // ...
    }

    [HttpGet("[controller]/[action]/{id}")] // Matches '/Products/Edit/{id}'
    public IActionResult Edit(int id) {
        // ...
    }
}

Les routes d’attribut peuvent aussi être combinées avec l’héritage.Attribute routes can also be combined with inheritance. Combiné avec le remplacement de jetons, c’est particulièrement puissant.This is particularly powerful combined with token replacement.

[Route("api/[controller]")]
public abstract class MyBaseController : Controller { ... }

public class ProductsController : MyBaseController
{
   [HttpGet] // Matches '/api/Products'
   public IActionResult List() { ... }

   [HttpPut("{id}")] // Matches '/api/Products/{id}'
   public IActionResult Edit(int id) { ... }
}

Le remplacement des jetons s’applique aussi aux noms de routes définis par des routes d’attribut.Token replacement also applies to route names defined by attribute routes. [Route("[controller]/[action]", Name="[controller]_[action]")] génère un nom de route unique pour chaque action.[Route("[controller]/[action]", Name="[controller]_[action]")] generates a unique route name for each action.

Pour faire correspondre le délimiteur littéral de remplacement de jetons [ ou ], placez-le en échappement en répétant le caractère ([[ ou ]]).To match the literal token replacement delimiter [ or ], escape it by repeating the character ([[ or ]]).

Utiliser un transformateur de paramètre pour personnaliser le remplacement des jetonsUse a parameter transformer to customize token replacement

Le remplacement des jetons peut être personnalisé à l’aide d’un transformateur de paramètre.Token replacement can be customized using a parameter transformer. Un transformateur de paramètre implémente IOutboundParameterTransformer et transforme la valeur des paramètres.A parameter transformer implements IOutboundParameterTransformer and transforms the value of parameters. Par exemple, un transformateur de paramètre SlugifyParameterTransformer personnalisé transforme la valeur de la route SubscriptionManagement en subscription-management.For example, a custom SlugifyParameterTransformer parameter transformer changes the SubscriptionManagement route value to subscription-management.

RouteTokenTransformerConvention est une convention de modèle d’application qui :The RouteTokenTransformerConvention is an application model convention that:

  • Applique un transformateur de paramètre à toutes les routes d’attribut dans une application.Applies a parameter transformer to all attribute routes in an application.
  • Personnalise les valeurs de jeton de route d’attribut quand elles sont remplacées.Customizes the attribute route token values as they are replaced.
public class SubscriptionManagementController : Controller
{
    [HttpGet("[controller]/[action]")] // Matches '/subscription-management/list-all'
    public IActionResult ListAll() { ... }
}

RouteTokenTransformerConvention est inscrit en tant qu’option dans ConfigureServices.The RouteTokenTransformerConvention is registered as an option in ConfigureServices.

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc(options =>
    {
        options.Conventions.Add(new RouteTokenTransformerConvention(
                                     new SlugifyParameterTransformer()));
    });
}

public class SlugifyParameterTransformer : IOutboundParameterTransformer
{
    public string TransformOutbound(object value)
    {
        if (value == null) { return null; }

        // Slugify value
        return Regex.Replace(value.ToString(), "([a-z])([A-Z])", "$1-$2").ToLower();
    }
}

Routes multiplesMultiple Routes

Le routage par attributs prend en charge la définition de plusieurs routes pour atteindre la même action.Attribute routing supports defining multiple routes that reach the same action. L’utilisation la plus courante de ceci est d’imiter le comportement de la route conventionnelle par défaut, comme le montre l’exemple suivant :The most common usage of this is to mimic the behavior of the default conventional route as shown in the following example:

[Route("[controller]")]
public class ProductsController : Controller
{
   [Route("")]     // Matches 'Products'
   [Route("Index")] // Matches 'Products/Index'
   public IActionResult Index()
}

Le fait de placer plusieurs attributs de route sur le contrôleur signifie que chacun d’eux se combine avec chacun des attributs de route sur les méthodes d’action.Putting multiple route attributes on the controller means that each one will combine with each of the route attributes on the action methods.

[Route("Store")]
[Route("[controller]")]
public class ProductsController : Controller
{
   [HttpPost("Buy")]     // Matches 'Products/Buy' and 'Store/Buy'
   [HttpPost("Checkout")] // Matches 'Products/Checkout' and 'Store/Checkout'
   public IActionResult Buy()
}

Quand plusieurs attributs de route (qui implémentent IActionConstraint) sont placés sur une action, chaque contrainte d’action se combine avec le modèle de route de l’attribut qui l’a défini.When multiple route attributes (that implement IActionConstraint) are placed on an action, then each action constraint combines with the route template from the attribute that defined it.

[Route("api/[controller]")]
public class ProductsController : Controller
{
   [HttpPut("Buy")]      // Matches PUT 'api/Products/Buy'
   [HttpPost("Checkout")] // Matches POST 'api/Products/Checkout'
   public IActionResult Buy()
}

Conseil

Si utiliser plusieurs routes sur des actions peut paître puissant, il est préférable de conserver l’espace d’URL de votre application simple et bien définie.While using multiple routes on actions can seem powerful, it's better to keep your application's URL space simple and well-defined. Utilisez plusieurs routes sur les actions seulement là où c’est nécessaire, par exemple pour prendre en charge des clients existants.Use multiple routes on actions only where needed, for example to support existing clients.

Spécification facultative de paramètres, de valeurs par défaut et de contraintes pour les routes d’attributSpecifying attribute route optional parameters, default values, and constraints

Les routes d’attribut prennent en charge la même syntaxe inline que les routes conventionnelles pour spécifier des paramètres, des valeurs par défaut et des contraintes facultatifs.Attribute routes support the same inline syntax as conventional routes to specify optional parameters, default values, and constraints.

[HttpPost("product/{id:int}")]
public IActionResult ShowProduct(int id)
{
   // ...
}

Pour une description détaillée de la syntaxe du modèle de route, consultez Informations de référence sur le modèle de route.See Route Template Reference for a detailed description of route template syntax.

Attributs de route personnalisés avec IRouteTemplateProviderCustom route attributes using IRouteTemplateProvider

Tous les attributs de route fournis dans le framework ([Route(...)], [HttpGet(...)], etc.) implémentent l’interface IRouteTemplateProvider.All of the route attributes provided in the framework ( [Route(...)], [HttpGet(...)] , etc.) implement the IRouteTemplateProvider interface. MVC recherche les attributs sur les classes de contrôleur et les méthodes d’action quand l’application démarre et utilise ceux qui implémentent IRouteTemplateProvider pour créer l’ensemble initial des routes.MVC looks for attributes on controller classes and action methods when the app starts and uses the ones that implement IRouteTemplateProvider to build the initial set of routes.

Vous pouvez implémenter IRouteTemplateProvider pour définir vos propres attributs de route.You can implement IRouteTemplateProvider to define your own route attributes. Chaque IRouteTemplateProvider vous permet de définir une route avec un modèle, un nom et un ordre de route personnalisés :Each IRouteTemplateProvider allows you to define a single route with a custom route template, order, and name:

public class MyApiControllerAttribute : Attribute, IRouteTemplateProvider
{
   public string Template => "api/[controller]";

   public int? Order { get; set; }

   public string Name { get; set; }
}

L’attribut de l’exemple ci-dessus définit automatiquement Template sur "api/[controller]" quand [MyApiController] est appliqué.The attribute from the above example automatically sets the Template to "api/[controller]" when [MyApiController] is applied.

Utilisation d’un modèle d’application pour personnaliser les routes d’attributUsing Application Model to customize attribute routes

Le modèle d’application est un modèle d’objet créé au démarrage avec toutes les métadonnées utilisée par MVC pour router et exécuter vos actions.The application model is an object model created at startup with all of the metadata used by MVC to route and execute your actions. Le modèle d’application inclut toutes les données collectées à partir des attributs de route (via IRouteTemplateProvider).The application model includes all of the data gathered from route attributes (through IRouteTemplateProvider). Vous pouvez écrire des conventions pour modifier le modèle d’application au moment du démarrage pour personnaliser le comporte du routage.You can write conventions to modify the application model at startup time to customize how routing behaves. Cette section montre un exemple simple de personnalisation du routage avec le modèle d’application.This section shows a simple example of customizing routing using application model.

using Microsoft.AspNetCore.Mvc.ApplicationModels;
using System.Linq;
using System.Text;
public class NamespaceRoutingConvention : IControllerModelConvention
{
    private readonly string _baseNamespace;

    public NamespaceRoutingConvention(string baseNamespace)
    {
        _baseNamespace = baseNamespace;
    }

    public void Apply(ControllerModel controller)
    {
        var hasRouteAttributes = controller.Selectors.Any(selector =>
                                                selector.AttributeRouteModel != null);
        if (hasRouteAttributes)
        {
            // This controller manually defined some routes, so treat this 
            // as an override and not apply the convention here.
            return;
        }

        // Use the namespace and controller name to infer a route for the controller.
        //
        // Example:
        //
        //  controller.ControllerTypeInfo ->    "My.Application.Admin.UsersController"
        //  baseNamespace ->                    "My.Application"
        //
        //  template =>                         "Admin/[controller]"
        //
        // This makes your routes roughly line up with the folder structure of your project.
        //
        var namespc = controller.ControllerType.Namespace;
        if (namespc == null)
            return;
        var template = new StringBuilder();
        template.Append(namespc, _baseNamespace.Length + 1,
                        namespc.Length - _baseNamespace.Length - 1);
        template.Replace('.', '/');
        template.Append("/[controller]");

        foreach (var selector in controller.Selectors)
        {
            selector.AttributeRouteModel = new AttributeRouteModel()
            {
                Template = template.ToString()
            };
        }
    }
}

Routage mixte : routage conventionnel et routage par attributsMixed routing: Attribute routing vs conventional routing

Les applications MVC peuvent combiner l’utilisation du routage conventionnel et du routage par attributs.MVC applications can mix the use of conventional routing and attribute routing. Il est courant d’utiliser des routes conventionnelles pour les contrôleurs délivrant des pages HTML pour les navigateurs, et le routage par attributs pour les contrôleurs délivrant des API REST.It's typical to use conventional routes for controllers serving HTML pages for browsers, and attribute routing for controllers serving REST APIs.

Les actions sont routées de façon conventionnelle ou routées par attribut.Actions are either conventionally routed or attribute routed. Le fait de placer une route sur le contrôleur ou sur l’action les rend « routés par attribut ».Placing a route on the controller or the action makes it attribute routed. Les actions qui définissent des routes d’attribut ne sont pas accessibles via les routes conventionnelles et vice versa.Actions that define attribute routes cannot be reached through the conventional routes and vice-versa. Tout attribut de route sur le contrôleur a pour effet que toutes les actions du contrôleur sont routées par attributs.Any route attribute on the controller makes all actions in the controller attribute routed.

Note

Ce qui distingue les deux types de systèmes de routage est le processus appliqué une fois qu’une URL correspond à un modèle de route.What distinguishes the two types of routing systems is the process applied after a URL matches a route template. Dans le routage conventionnel, les valeurs de route de la correspondance sont utilisées pour choisir l’action et le contrôleur dans une table de recherche comprenant toutes les actions routées de façon conventionnelle.In conventional routing, the route values from the match are used to choose the action and controller from a lookup table of all conventional routed actions. Dans le routage par attributs, chaque modèle est déjà associé à une action, et aucune recherche supplémentaire n’est nécessaire.In attribute routing, each template is already associated with an action, and no further lookup is needed.

Segments complexesComplex segments

Les segments complexes (par exemple, [Route("/dog{token}cat")]), sont traités par la mise en correspondance des littéraux de droite à gauche de manière non gourmande.Complex segments (for example, [Route("/dog{token}cat")]), are processed by matching up literals from right to left in a non-greedy way. Consultez le code source pour obtenir une description.See the source code for a description. Pour plus d’informations, consultez ce problème.For more information, see this issue.

Génération des URLURL Generation

Les applications MVC peuvent utiliser les fonctionnalités de génération d’URL de routage pour générer des liens URL vers des actions.MVC applications can use routing's URL generation features to generate URL links to actions. La génération d’URL élimine le codage en dur des URL, ce qui rend votre code plus robuste et plus facile à maintenir.Generating URLs eliminates hardcoding URLs, making your code more robust and maintainable. Cette section se concentre sur les fonctionnalités de génération d’URL fournies par MVC et couvre seulement les principes de base du fonctionnement de la génération d’URL.This section focuses on the URL generation features provided by MVC and will only cover basics of how URL generation works. Pour une description détaillée de la génération d’URL, consultez Routage.See Routing for a detailed description of URL generation.

L’interface IUrlHelper est l’élément d’infrastructure sous-jacent entre MVC et le routage pour la génération d’URL.The IUrlHelper interface is the underlying piece of infrastructure between MVC and routing for URL generation. Vous pouvez trouver une instance de IUrlHelper disponible via la propriété Url dans les composants controllers, views et view.You'll find an instance of IUrlHelper available through the Url property in controllers, views, and view components.

Dans cet exemple, l’interface IUrlHelper est utilisée via la propriété Controller.Url pour générer une URL vers une autre action.In this example, the IUrlHelper interface is used through the Controller.Url property to generate a URL to another action.

using Microsoft.AspNetCore.Mvc;

public class UrlGenerationController : Controller
{
    public IActionResult Source()
    {
        // Generates /UrlGeneration/Destination
        var url = Url.Action("Destination");
        return Content($"Go check out {url}, it's really great.");
    }

    public IActionResult Destination()
    {
        return View();
    }
}

Si l’application utilise la route conventionnelle par défaut, la valeur de la variable url est la chaîne de chemin d’URL /UrlGeneration/Destination.If the application is using the default conventional route, the value of the url variable will be the URL path string /UrlGeneration/Destination. Ce chemin d’URL est créé par le routage en combinant les valeurs de route de la requête en cours (valeurs ambiantes) avec les valeurs passées à Url.Action, et en remplaçant les valeurs dans le modèle de route :This URL path is created by routing by combining the route values from the current request (ambient values), with the values passed to Url.Action and substituting those values into the route template:

ambient values: { controller = "UrlGeneration", action = "Source" }
values passed to Url.Action: { controller = "UrlGeneration", action = "Destination" }
route template: {controller}/{action}/{id?}

result: /UrlGeneration/Destination

La valeur de chaque paramètre de route du modèle de route est remplacée en établissant une correspondance avec les valeurs et les valeurs ambiantes.Each route parameter in the route template has its value substituted by matching names with the values and ambient values. Un paramètre de route qui n’a pas de valeur peut utiliser une valeur par défaut s’il en a une, ou il peut être ignoré s’il est facultatif (comme dans le cas de id dans cet exemple).A route parameter that doesn't have a value can use a default value if it has one, or be skipped if it's optional (as in the case of id in this example). La génération d’URL échoue si un paramètre de route obligatoire n’a pas de valeur correspondante.URL generation will fail if any required route parameter doesn't have a corresponding value. Si la génération d’URL échoue pour une route, la route suivante est essayée, ceci jusqu’à ce que toutes les routes aient été essayées ou qu’une correspondance soit trouvée.If URL generation fails for a route, the next route is tried until all routes have been tried or a match is found.

L’exemple de Url.Action ci-dessus suppose un routage conventionnel, mais la génération d’URL fonctionne de façon similaire avec le routage par attributs, même si les concepts sont différents.The example of Url.Action above assumes conventional routing, but URL generation works similarly with attribute routing, though the concepts are different. Avec le routage conventionnel, les valeurs de route sont utilisées pour développer un modèle, et les valeurs de route pour controller et action apparaissent généralement dans ce modèle : ceci fonctionne car les URL mises en correspondance par le routage adhèrent à une convention.With conventional routing, the route values are used to expand a template, and the route values for controller and action usually appear in that template - this works because the URLs matched by routing adhere to a convention. Dans le routage par attributs, les valeurs de route pour controller et action ne sont pas autorisées à apparaître dans le modèle : au lieu de cela, elles sont utilisées pour rechercher le modèle à utiliser.In attribute routing, the route values for controller and action are not allowed to appear in the template - they're instead used to look up which template to use.

Cet exemple utilise le routage par attributs :This example uses attribute routing:

// In Startup class
public void Configure(IApplicationBuilder app)
{
    app.UseMvc();
}
using Microsoft.AspNetCore.Mvc;

public class UrlGenerationController : Controller
{
    [HttpGet("")]
    public IActionResult Source()
    {
        var url = Url.Action("Destination"); // Generates /custom/url/to/destination
        return Content($"Go check out {url}, it's really great.");
    }

    [HttpGet("custom/url/to/destination")]
    public IActionResult Destination() {
        return View();
    }
}

MVC génère une table de recherche de toutes les actions routées par attributs et recherche une correspondance avec les valeurs de controller et de action pour sélectionner le modèle de route à utiliser pour la génération d’URL.MVC builds a lookup table of all attribute routed actions and will match the controller and action values to select the route template to use for URL generation. Dans l’exemple ci-dessus, custom/url/to/destination est généré.In the sample above, custom/url/to/destination is generated.

Génération des URL par nom d’actionGenerating URLs by action name

Url.Action (IUrlHelper .Url.Action (IUrlHelper . Action) et toutes les surcharges associées sont tous basés sur cette idée que vous voulez spécifier ce à quoi vous liez en spécifiant un nom de contrôleur et un nom d’action.Action) and all related overloads all are based on that idea that you want to specify what you're linking to by specifying a controller name and action name.

Note

Quand vous utilisez Url.Action, les valeurs de route actuelles pour controller et action sont spécifiées pour vous : la valeur de controller et de action font partie des valeurs ambiantes et des valeurs.When using Url.Action, the current route values for controller and action are specified for you - the value of controller and action are part of both ambient values and values. La méthode Url.Action utilise toujours les valeurs actuelles de action et de controller, et génère un chemin d’URL qui route vers l’action actuelle.The method Url.Action, always uses the current values of action and controller and will generate a URL path that routes to the current action.

Le routage essaye d’utiliser les valeurs dans les valeurs ambiantes pour renseigner les informations que vous n’avez pas fournies lors de la génération d’une URL.Routing attempts to use the values in ambient values to fill in information that you didn't provide when generating a URL. En utilisant une route comme {a}/{b}/{c}/{d} et les valeurs ambiantes { a = Alice, b = Bob, c = Carol, d = David }, le routage a suffisamment d’informations pour générer une URL sans aucune autre valeur supplémentaire, car tous les paramètres de route ont une valeur.Using a route like {a}/{b}/{c}/{d} and ambient values { a = Alice, b = Bob, c = Carol, d = David }, routing has enough information to generate a URL without any additional values - since all route parameters have a value. Si vous avez ajouté la valeur { d = Donovan }, la valeur { d = David } est ignorée, et le chemin d’URL généré est Alice/Bob/Carol/Donovan.If you added the value { d = Donovan }, the value { d = David } would be ignored, and the generated URL path would be Alice/Bob/Carol/Donovan.

Avertissement

Les chemins d’URL sont hiérarchiques.URL paths are hierarchical. Dans l’exemple ci-dessus, si vous avez ajouté la valeur { c = Cheryl }, les deux valeurs { c = Carol, d = David } sont ignorées.In the example above, if you added the value { c = Cheryl }, both of the values { c = Carol, d = David } would be ignored. Dans ce cas nous n’avons plus de valeur pour d et la génération d’URL échoue.In this case we no longer have a value for d and URL generation will fail. Vous devez spécifier la valeur souhaitée de c et de d.You would need to specify the desired value of c and d. Vous vous attendez peut-être à rencontrer ce problème avec la route par défaut ({controller}/{action}/{id?}), mais vous rencontrerez rarement ce comportement en pratique, car Url.Action spécifie toujours explicitement une valeur pour controller et pour action.You might expect to hit this problem with the default route ({controller}/{action}/{id?}) - but you will rarely encounter this behavior in practice as Url.Action will always explicitly specify a controller and action value.

Les surcharges plus longues de Url.Action prennent également un objet supplémentaire de valeurs de route pour fournir des valeurs pour les paramètres de route autres que controller et action.Longer overloads of Url.Action also take an additional route values object to provide values for route parameters other than controller and action. Vous verrez ceci plus couramment utilisé avec un id comme Url.Action("Buy", "Products", new { id = 17 }).You will most commonly see this used with id like Url.Action("Buy", "Products", new { id = 17 }). Par convention, l’objet de valeurs de route objet est généralement un objet de type anonyme, mais il peut également être un IDictionary<> ou un objet .NET traditionnel.By convention the route values object is usually an object of anonymous type, but it can also be an IDictionary<> or a plain old .NET object. Toutes les valeurs de route supplémentaires qui ne correspondent pas aux paramètres de route sont placées dans la chaîne de requête.Any additional route values that don't match route parameters are put in the query string.

using Microsoft.AspNetCore.Mvc;

public class TestController : Controller
{
    public IActionResult Index()
    {
        // Generates /Products/Buy/17?color=red
        var url = Url.Action("Buy", "Products", new { id = 17, color = "red" });
        return Content(url);
    }
}

Conseil

Pour créer une URL absolue, utilisez une surcharge qui accepte un protocol :Url.Action("Buy", "Products", new { id = 17 }, protocol: Request.Scheme)To create an absolute URL, use an overload that accepts a protocol: Url.Action("Buy", "Products", new { id = 17 }, protocol: Request.Scheme)

Génération des URL par routeGenerating URLs by route

Le code ci-dessus a montré la génération d’une URL en passant le nom du contrôleur et le nom de l’action.The code above demonstrated generating a URL by passing in the controller and action name. IUrlHelper fournit également la famille de méthodes Url.RouteUrl.IUrlHelper also provides the Url.RouteUrl family of methods. Ces méthodes sont similaires à Url.Action, mais elle ne copient pas les valeurs actuelles de action et de controller vers les valeurs de route.These methods are similar to Url.Action, but they don't copy the current values of action and controller to the route values. L’utilisation la plus courante est de spécifier un nom de route pour utiliser une route spécifique pour générer l’URL, généralement sans spécifier un nom de contrôleur ou d’action.The most common usage is to specify a route name to use a specific route to generate the URL, generally without specifying a controller or action name.

using Microsoft.AspNetCore.Mvc;

public class UrlGenerationController : Controller
{
    [HttpGet("")]
    public IActionResult Source()
    {
        var url = Url.RouteUrl("Destination_Route"); // Generates /custom/url/to/destination
        return Content($"See {url}, it's really great.");
    }

    [HttpGet("custom/url/to/destination", Name = "Destination_Route")]
    public IActionResult Destination() {
        return View();
    }
}

Génération des URL en HTMLGenerating URLs in HTML

IHtmlHelper fournit les méthodes HtmlHelper Html.BeginForm et Html.ActionLink pour générer respectivement les éléments <form> et <a>.IHtmlHelper provides the HtmlHelper methods Html.BeginForm and Html.ActionLink to generate <form> and <a> elements respectively. Ces méthodes utilisent la méthode Url.Action pour générer une URL et ils acceptent les arguments similaires.These methods use the Url.Action method to generate a URL and they accept similar arguments. Les pendants de Url.RouteUrl pour HtmlHelper sont Html.BeginRouteForm et Html.RouteLink, qui ont des fonctionnalités similaires.The Url.RouteUrl companions for HtmlHelper are Html.BeginRouteForm and Html.RouteLink which have similar functionality.

Les TagHelpers génèrent des URL via le TagHelper form et le TagHelper <a>.TagHelpers generate URLs through the form TagHelper and the <a> TagHelper. Ils utilisent tous les deux IUrlHelper pour leur implémentation.Both of these use IUrlHelper for their implementation. Pour plus d’informations, consultez Utilisation des formulaires.See Working with Forms for more information.

Dans les vues, IUrlHelper est disponible via la propriété Url pour toute génération d’URL ad hoc non couverte par ce qui figure ci-dessus.Inside views, the IUrlHelper is available through the Url property for any ad-hoc URL generation not covered by the above.

Génération des URL dans les résultats d’actionGenerating URLS in Action Results

Les exemples précédents ont montré l’utilisation de IUrlHelper dans un contrôleur, alors que l’utilisation la plus courante dans un contrôleur est de générer une URL dans le cadre d’un résultat d’action.The examples above have shown using IUrlHelper in a controller, while the most common usage in a controller is to generate a URL as part of an action result.

Les classes de base ControllerBase et Controller fournissent des méthodes pratiques pour les résultats d’action qui référencent une autre action.The ControllerBase and Controller base classes provide convenience methods for action results that reference another action. Une utilisation typique est de rediriger après acceptation de l’entrée utilisateur.One typical usage is to redirect after accepting user input.

public IActionResult Edit(int id, Customer customer)
{
    if (ModelState.IsValid)
    {
        // Update DB with new details.
        return RedirectToAction("Index");
    }
    return View(customer);
}

Les méthodes de fabrique de résultats d’action suivent un modèle similaire aux méthodes sur IUrlHelper.The action results factory methods follow a similar pattern to the methods on IUrlHelper.

Cas spécial pour les routes conventionnelles dédiéesSpecial case for dedicated conventional routes

Le routage conventionnel peut utiliser un type spécial de définition de route appelé route conventionnelle dédiée.Conventional routing can use a special kind of route definition called a dedicated conventional route. Dans l’exemple ci-dessous, la route nommée blog est une route conventionnelle dédiée.In the example below, the route named blog is a dedicated conventional route.

app.UseMvc(routes =>
{
    routes.MapRoute("blog", "blog/{*article}",
        defaults: new { controller = "Blog", action = "Article" });
    routes.MapRoute("default", "{controller=Home}/{action=Index}/{id?}");
});

En utilisant ces définitions de route, Url.Action("Index", "Home") génère le chemin d’URL / avec la route default, mais pourquoi ?Using these route definitions, Url.Action("Index", "Home") will generate the URL path / with the default route, but why? Vous pouvez deviner que les valeurs de route { controller = Home, action = Index } seraient suffisantes pour générer une URL avec blog, et que le résultat serait /blog?action=Index&controller=Home.You might guess the route values { controller = Home, action = Index } would be enough to generate a URL using blog, and the result would be /blog?action=Index&controller=Home.

Les routes conventionnelles dédiées s’appuient sur un comportement spécial des valeurs par défaut qui n’ont pas de paramètre de route correspondant qui empêche la route d’être « trop globale » avec la génération d’URL.Dedicated conventional routes rely on a special behavior of default values that don't have a corresponding route parameter that prevents the route from being "too greedy" with URL generation. Dans ce cas, les valeurs par défaut sont { controller = Blog, action = Article }, et ni controller ni action n’apparaissent comme paramètre de route.In this case the default values are { controller = Blog, action = Article }, and neither controller nor action appears as a route parameter. Quand le routage effectue une génération d’URL, les valeurs fournies doivent correspondre aux valeurs par défaut.When routing performs URL generation, the values provided must match the default values. La génération d’URL avec blog échoue, car les valeurs { controller = Home, action = Index } ne correspondent pas à { controller = Blog, action = Article }.URL generation using blog will fail because the values { controller = Home, action = Index } don't match { controller = Blog, action = Article }. Le routage essaye alors d’utiliser default, ce qui réussit.Routing then falls back to try default, which succeeds.

Zones (Areas)Areas

Les zones sont une fonctionnalité de MVC utilisée pour organiser des fonctionnalités connexes dans un groupe sous la forme d’un espace de noms de routage distinct (pour les actions de contrôleur) et d’une structure de dossiers (pour les vues).Areas are an MVC feature used to organize related functionality into a group as a separate routing-namespace (for controller actions) and folder structure (for views). L’utilisation de zones permet à une application d’avoir plusieurs contrôleurs portant le même nom, pour autant qu’ils soient dans des zones différentes.Using areas allows an application to have multiple controllers with the same name - as long as they have different areas. L’utilisation de zones crée une hiérarchie qui permet le routage par ajout d’un autre paramètre de route, area, à controller et à action.Using areas creates a hierarchy for the purpose of routing by adding another route parameter, area to controller and action. Cette section explique comment le routage interagit avec les zones. Pour plus d’informations sur l’utilisation des zones avec des vues, consultez Zones.This section will discuss how routing interacts with areas - see Areas for details about how areas are used with views.

L’exemple suivant configure MVC pour utiliser la route conventionnelle par défaut et une route de zone pour une zone nommée Blog :The following example configures MVC to use the default conventional route and an area route for an area named Blog:

app.UseMvc(routes =>
{
    routes.MapAreaRoute("blog_route", "Blog",
        "Manage/{controller}/{action}/{id?}");
    routes.MapRoute("default_route", "{controller}/{action}/{id?}");
});

Lors de la mise en correspondance d’un chemin d’URL comme /Manage/Users/AddUser, la première route produit les valeurs de route { area = Blog, controller = Users, action = AddUser }.When matching a URL path like /Manage/Users/AddUser, the first route will produce the route values { area = Blog, controller = Users, action = AddUser }. La valeur de route area est produite par une valeur par défaut pour area ; en fait, la route créée par MapAreaRoute est équivalente à la suivante :The area route value is produced by a default value for area, in fact the route created by MapAreaRoute is equivalent to the following:

app.UseMvc(routes =>
{
    routes.MapRoute("blog_route", "Manage/{controller}/{action}/{id?}",
        defaults: new { area = "Blog" }, constraints: new { area = "Blog" });
    routes.MapRoute("default_route", "{controller}/{action}/{id?}");
});

MapAreaRoute crée une route avec à la fois une valeur par défaut et une contrainte pour area en utilisant le nom de la zone fournie, dans ce cas Blog.MapAreaRoute creates a route using both a default value and constraint for area using the provided area name, in this case Blog. La valeur par défaut garantit que la route produit toujours { area = Blog, ... }, et la contrainte nécessite la valeur { area = Blog, ... } pour la génération d’URL.The default value ensures that the route always produces { area = Blog, ... }, the constraint requires the value { area = Blog, ... } for URL generation.

Conseil

Le routage conventionnel est dépendant de l’ordre.Conventional routing is order-dependent. En général, les routes avec des zones doivent être placées plus haut dans la table de routage, car elles sont plus spécifiques que les routes sans zone.In general, routes with areas should be placed earlier in the route table as they're more specific than routes without an area.

Avec l’exemple ci-dessus, les valeurs de route seraient mises en correspondance avec l’action suivante :Using the above example, the route values would match the following action:

using Microsoft.AspNetCore.Mvc;

namespace MyApp.Namespace1
{
    [Area("Blog")]
    public class UsersController : Controller
    {
        public IActionResult AddUser()
        {
            return View();
        }        
    }
}

AreaAttribute est ce qui indique qu’un contrôleur fait partie d’une zone : nous disons que ce contrôleur est dans la zone Blog.The AreaAttribute is what denotes a controller as part of an area, we say that this controller is in the Blog area. Les contrôleurs sans attribut [Area] ne sont membres d’aucune zone et ne sont pas trouvés en correspondance quand la valeur de route area est fournie par le routage.Controllers without an [Area] attribute are not members of any area, and will not match when the area route value is provided by routing. Dans l’exemple suivant, seul le premier contrôleur répertorié peut correspondre aux valeurs de route { area = Blog, controller = Users, action = AddUser }.In the following example, only the first controller listed can match the route values { area = Blog, controller = Users, action = AddUser }.

using Microsoft.AspNetCore.Mvc;

namespace MyApp.Namespace1
{
    [Area("Blog")]
    public class UsersController : Controller
    {
        public IActionResult AddUser()
        {
            return View();
        }        
    }
}
using Microsoft.AspNetCore.Mvc;

namespace MyApp.Namespace2
{
    // Matches { area = Zebra, controller = Users, action = AddUser }
    [Area("Zebra")]
    public class UsersController : Controller
    {
        public IActionResult AddUser()
        {
            return View();
        }        
    }
}
using Microsoft.AspNetCore.Mvc;

namespace MyApp.Namespace3
{
    // Matches { area = string.Empty, controller = Users, action = AddUser }
    // Matches { area = null, controller = Users, action = AddUser }
    // Matches { controller = Users, action = AddUser }
    public class UsersController : Controller
    {
        public IActionResult AddUser()
        {
            return View();

        }
    }
}

Note

L’espace de noms de chaque contrôleur est montré ici par souci d’exhaustivité, sans quoi les contrôleurs auraient un conflit de noms et généreraient une erreur de compilateur.The namespace of each controller is shown here for completeness - otherwise the controllers would have a naming conflict and generate a compiler error. Les espaces de noms de classe n’ont pas d’effet sur le routage de MVC.Class namespaces have no effect on MVC's routing.

Les deux premiers contrôleurs sont membres de zones, et ils sont trouvés en correspondance seulement quand le nom de leur zone respective est fourni par la valeur de route area.The first two controllers are members of areas, and only match when their respective area name is provided by the area route value. Le troisième contrôleur n’est membre d’aucune zone et peut être trouvé en correspondance seulement quand aucune valeur pour area n’est fournie par le routage.The third controller isn't a member of any area, and can only match when no value for area is provided by routing.

Note

En termes de mise en correspondance avec aucune valeur, l’absence de la valeur area est identique à une valeur null ou de chaîne vide pour area.In terms of matching no value, the absence of the area value is the same as if the value for area were null or the empty string.

Lors de l’exécution d’une action à l’intérieur d’une zone, la valeur de route pour area est disponible en tant que valeur ambiante, que le routage peut utiliser pour la génération d’URL.When executing an action inside an area, the route value for area will be available as an ambient value for routing to use for URL generation. Cela signifie que par défaut, les zones agissent par attraction pour la génération d’URL, comme le montre l’exemple suivant.This means that by default areas act sticky for URL generation as demonstrated by the following sample.

app.UseMvc(routes =>
{
    routes.MapAreaRoute("duck_route", "Duck",
        "Manage/{controller}/{action}/{id?}");
    routes.MapRoute("default", "Manage/{controller=Home}/{action=Index}/{id?}");
});
using Microsoft.AspNetCore.Mvc;

namespace MyApp.Namespace4
{
    [Area("Duck")]
    public class UsersController : Controller
    {
        public IActionResult GenerateURLInArea()
        {
            // Uses the 'ambient' value of area
            var url = Url.Action("Index", "Home"); 
            // returns /Manage
            return Content(url);
        }

        public IActionResult GenerateURLOutsideOfArea()
        {
            // Uses the empty value for area
            var url = Url.Action("Index", "Home", new { area = "" }); 
            // returns /Manage/Home/Index
            return Content(url);
        }
    }
}

Présentation d’IActionConstraintUnderstanding IActionConstraint

Note

Cette section est une présentation détaillée des mécanismes internes du framework et de la façon dont MVC choisit une action à exécuter.This section is a deep-dive on framework internals and how MVC chooses an action to execute. Une application classique n’a pas besoin d’une IActionConstraint personnalisée.A typical application won't need a custom IActionConstraint

Vous avez probablement déjà utilisé IActionConstraint même si vous n’êtes pas familiarisé avec l’interface.You have likely already used IActionConstraint even if you're not familiar with the interface. L’attribut [HttpGet] et les attributs [Http-VERB] similaires implémentent IActionConstraint de façon à limiter l’exécution d’une méthode d’action.The [HttpGet] Attribute and similar [Http-VERB] attributes implement IActionConstraint in order to limit the execution of an action method.

public class ProductsController : Controller
{
    [HttpGet]
    public IActionResult Edit() { }

    public IActionResult Edit(...) { }
}

Dans l’hypothèse d’une route conventionnelle par défaut, le chemin d’URL /Products/Edit produirait les valeurs { controller = Products, action = Edit }, qui seraient en correspondance avec les deux actions montrées ici.Assuming the default conventional route, the URL path /Products/Edit would produce the values { controller = Products, action = Edit }, which would match both of the actions shown here. Dans la terminologie IActionConstraint, nous pouvons dire que ces deux actions sont considérées comme candidates, car elles correspondent toutes deux aux données de la route.In IActionConstraint terminology we would say that both of these actions are considered candidates - as they both match the route data.

Quand HttpGetAttribute s’exécute, il indique que Edit() est une correspondance pour GET et qu’il n’est une correspondance pour aucun des autres verbes HTTP.When the HttpGetAttribute executes, it will say that Edit() is a match for GET and isn't a match for any other HTTP verb. L’action Edit(...) n’a aucune contrainte définie et elle ne correspond donc à aucun verbe HTTP.The Edit(...) action doesn't have any constraints defined, and so will match any HTTP verb. Par conséquent, dans l’hypothèse d’un POST, seul Edit(...) est en correspondance.So assuming a POST - only Edit(...) matches. Cependant, pour un GET, les deux actions peuvent néanmoins être en correspondance, mais une action avec IActionConstraint est toujours considérée comme étant meilleure qu’une action sans.But, for a GET both actions can still match - however, an action with an IActionConstraint is always considered better than an action without. Par conséquent, comme Edit() a [HttpGet], elle est considérée comme étant plus spécifique et est sélectionnée si les deux actions peuvent correspondre.So because Edit() has [HttpGet] it's considered more specific, and will be selected if both actions can match.

D’un point de vue conceptuel, IActionConstraint est une forme de surcharge, mais au lieu de surcharger des méthodes portant le même nom, elle surcharge entre des actions qui correspondent à la même URL.Conceptually, IActionConstraint is a form of overloading, but instead of overloading methods with the same name, it's overloading between actions that match the same URL. Le routage par attributs utilise également IActionConstraint et peut aboutir à des actions de différents contrôleurs, toutes considérées comme candidates.Attribute routing also uses IActionConstraint and can result in actions from different controllers both being considered candidates.

Implémentation d’IActionConstraintImplementing IActionConstraint

La façon la plus simple d’implémenter une IActionConstraint est de créer une classe dérivée de System.Attribute et de la placer sur vos actions et vos contrôleurs.The simplest way to implement an IActionConstraint is to create a class derived from System.Attribute and place it on your actions and controllers. MVC découvre automatiquement les IActionConstraint qui sont appliquées en tant qu’attributs.MVC will automatically discover any IActionConstraint that are applied as attributes. Vous pouvez utiliser le modèle d’application pour appliquer des contraintes, et il s’agit probablement de l’approche la plus souple, car elle vous permet de programmer des méta-informations indiquant comment elles sont appliquées.You can use the application model to apply constraints, and this is probably the most flexible approach as it allows you to metaprogram how they're applied.

Dans l’exemple suivant, une contrainte choisit une action en fonction d’un code pays provenant des données de la route.In the following example a constraint chooses an action based on a country code from the route data. Exemple complet sur GitHub.The full sample on GitHub.

public class CountrySpecificAttribute : Attribute, IActionConstraint
{
    private readonly string _countryCode;

    public CountrySpecificAttribute(string countryCode)
    {
        _countryCode = countryCode;
    }

    public int Order
    {
        get
        {
            return 0;
        }
    }

    public bool Accept(ActionConstraintContext context)
    {
        return string.Equals(
            context.RouteContext.RouteData.Values["country"].ToString(),
            _countryCode,
            StringComparison.OrdinalIgnoreCase);
    }
}

Vous êtes responsable de l’implémentation de la méthode Accept et du choix d’un « ordre » pour l’exécution de la contrainte.You are responsible for implementing the Accept method and choosing an 'Order' for the constraint to execute. Dans ce cas, la méthode Accept retourne true pour indiquer que l’action est une correspondance quand la valeur de la route country correspond à la valeur.In this case, the Accept method returns true to denote the action is a match when the country route value matches. Ceci diffère d’un RouteValueAttribute, car elle permet à défaut d’appliquer une action sans attributs.This is different from a RouteValueAttribute in that it allows fallback to a non-attributed action. L’exemple montre que si vous définissez une action en-US, un code pays comme fr-FR passe à défaut à un contrôleur plus générique auquel [CountrySpecific(...)] n’est pas appliqué.The sample shows that if you define an en-US action then a country code like fr-FR will fall back to a more generic controller that doesn't have [CountrySpecific(...)] applied.

La propriété Order décide de l’étape dont la contrainte fait partie.The Order property decides which stage the constraint is part of. Les contraintes d’action s’exécutent dans des groupes en fonction de Order.Action constraints run in groups based on the Order. Par exemple, tous les attributs de méthode HTTP fournis par le framework utilisent la même valeur pour Order, de façon à ce qu’ils s’exécutent dans la même étape.For example, all of the framework provided HTTP method attributes use the same Order value so that they run in the same stage. Vous pouvez avoir autant d’étapes que nécessaire pour implémenter les stratégies souhaitées.You can have as many stages as you need to implement your desired policies.

Conseil

Pour décider d’une valeur pour Order, déterminez si votre contrainte doit ou non être appliquée avant les méthodes HTTP.To decide on a value for Order think about whether or not your constraint should be applied before HTTP methods. Les nombres les plus petits s’exécutent en premier.Lower numbers run first.