ASP.NET Core MVC configure le préfixe de routage global

ASP.NET Core MVC configure le préfixe de routage global

Avant-propos

Bonjour à tous, aujourd'hui je vais vous présenter une nouvelle fonctionnalité d'ASP.NET Core MVC, qui consiste à ajouter un préfixe unifié de routage global. À proprement parler, ce n’est pas une nouvelle fonctionnalité, mais elle est propre à Core MVC.

Contexte de l'application

Je ne sais pas si vous avez déjà rencontré ce scénario lorsque vous créez des applications Web Api, c'est-à-dire que toutes les interfaces commencent par /api, ce que nous faisons. l'adresse de demande d'interface ressemble à ceci :

http://www.example.com/api/order/333

ou une telle exigence

http:/ /www.example.com/api/v2/order/333

Dans le passé, si nous voulions atteindre cette exigence, nous pouvions ajouter un [Route("/api /order")] Routage d'attributs, le framework MVC analysera votre table de routage pour correspondre à des requêtes telles que /api/order.

Mais pour la deuxième exigence avec un numéro de version, la définition de route du contrôleur d'origine était [Route("/api/v1/order")]. Il y en a des centaines de plus. L'interface doit être modifiée une par une, ce qui peut prêter à confusion.

Il existe désormais un moyen plus simple et plus élégant de procéder. Vous pouvez ajouter une balise de routage de préfixe global de manière unifiée. Jetons un coup d'œil ci-dessous.

Interface IApplicationModelConvention

Tout d'abord, nous devons utiliser l'interface IApplicationModelConvention, située sous l'espace de noms Microsoft.AspNetCore.Mvc.ApplicationModels.

public interface IApplicationModelConvention
{
 void Apply(ApplicationModel application);
}

Nous savons que le framework MVC a certaines conventions, cette interface est donc principalement utilisée pour personnaliser certaines des conventions MVC. Nous pouvons spécifier l'objet ApplicationModel en ajouter ou en modifier. conventions. Vous pouvez voir que l'interface fournit une méthode Apply, qui a un objet ApplicationModel. Nous pouvons utiliser cet objet pour modifier ce dont nous avons besoin. Le framework MVC lui-même injectera cette interface dans les services au démarrage, nous n'aurons donc qu'à implémenter cette interface. peut être légèrement configuré.

Ensuite, regardons ce que possède l'objet ApplicationModel :

public class ApplicationModel : IPropertyModel, IFilterModel, IApiExplorerModel
{
 public ApiExplorerModel ApiExplorer { get; set; }
 public IList<ControllerModel> Controllers { get; }
 public IList<IFilterMetadata> Filters { get; }
 
 public IDictionary<object, object> Properties { get; }
}

Vous pouvez voir qu'il y a ApiExplorer, des contrôleurs, des filtres, des propriétés et d'autres propriétés. .

ApiExplorerModel : configure principalement certains éléments de l'explorateur d'API MVC par défaut, notamment les informations de description de l'API, les informations de groupe, la visibilité, etc.

ControllerModel : principalement lié à la convention par défaut du contrôleur. Il y a beaucoup de choses là-dedans, donc je ne les présenterai pas une par une, nous configurerons l'une des choses plus tard.

IFilterMetadata : Interface vide, principalement utilisée comme marqueur.

Une autre chose que je dois vous dire est que vous pouvez voir que la propriété Controllers ci-dessus est un IList, ce qui signifie que cette liste enregistre les informations de tous les contrôleurs de votre programme. vous pouvez le définir pour une certaine partie ou un contrôleur via une traversée, y compris les informations sur les actions dans le contrôleur. Nous pouvons utiliser cette fonctionnalité pour transformer de manière très flexible le framework MVC, n'est-ce pas ?

Ensuite, nous utiliserons cette fonctionnalité pour implémenter notre thème aujourd'hui. Merci pour votre coup de pouce~ :)

Ajoutez un préfixe unifié pour le routage global

Fini les bêtises, allez directement dans le code, tout ce que vous voulez dire est dans le code :

//定义个类RouteConvention，来实现 IApplicationModelConvention 接口
public class RouteConvention : IApplicationModelConvention
{
 private readonly AttributeRouteModel _centralPrefix;
 
 public RouteConvention(IRouteTemplateProvider routeTemplateProvider)
 {
  _centralPrefix = new AttributeRouteModel(routeTemplateProvider);
 }
 
 //接口的Apply方法
 public void Apply(ApplicationModel application)
 {
  //遍历所有的 Controller
  foreach (var controller in application.Controllers)
  {
   // 已经标记了 RouteAttribute 的 Controller
   var matchedSelectors = controller.Selectors.Where(x => x.AttributeRouteModel != null).ToList();
   if (matchedSelectors.Any())
   {
    foreach (var selectorModel in matchedSelectors)
    {
     // 在 当前路由上 再 添加一个 路由前缀
     selectorModel.AttributeRouteModel = AttributeRouteModel.CombineAttributeRouteModel(_centralPrefix,
      selectorModel.AttributeRouteModel);
    }
   }
 
   // 没有标记 RouteAttribute 的 Controller
   var unmatchedSelectors = controller.Selectors.Where(x => x.AttributeRouteModel == null).ToList();
   if (unmatchedSelectors.Any())
   {
    foreach (var selectorModel in unmatchedSelectors)
    {
     // 添加一个 路由前缀
     selectorModel.AttributeRouteModel = _centralPrefix;
    }
   }
  }
 }
}

Ensuite, nous pouvons commencer à utiliser la classe que nous avons définie.

public static class MvcOptionsExtensions
{
 public static void UseCentralRoutePrefix(this MvcOptions opts, IRouteTemplateProvider routeAttribute)
 {
  // 添加我们自定义 实现IApplicationModelConvention的RouteConvention
  opts.Conventions.Insert(0, new RouteConvention(routeAttribute));
 }
}

Enfin, dans le fichier Startup.cs, ajoutez simplement la méthode d'extension ci-dessus.

public class Startup
{
 public Startup(IHostingEnvironment env)
 {
  //...
 }
 
 public void ConfigureServices(IServiceCollection services)
 {
  //...
   
  services.AddMvc(opt =>
  {
   // 路由参数在此处仍然是有效的，比如添加一个版本号
   opt.UseCentralRoutePrefix(new RouteAttribute("api/v{version}"));
  });
 }
 
 public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
 {
  //...
   
  app.UseMvc();
 }
}

Parmi eux, opt.UseCentralRoutePrefix est la méthode d'extension définie ci-dessus. Les paramètres de routage ici peuvent toujours être utilisés, donc par exemple, vous. peut vous donner L'interface spécifie quelque chose comme un numéro de version. Après cela, le RoteAttribute de tous vos contrôleurs sera ajouté avec ce préfixe, ce qui résout parfaitement l'exigence de numéro de version d'origine. Ils ressemblent à ceci :

[Route("order")]
public class OrderController : Controller
{
 // 路由地址 : /api/v{version}/order/details/{id}
 [Route("details/{id}")]
 public string GetById(int id, int version)
 {
  //上面是可以接收到版本号的，返回 version 和 id
  return $"other resource: {id}, version: {version}";
 }
}
 
public class ItemController : Controller
{
 // 路由地址： /api/v{version}/item/{id}
 [Route("item/{id}")]
 public string GetById(int id, int version)
 {
  //上面是可以接收到版本号的，返回 version 和 id
  return $"item: {id}, version: {version}";
 }
}

Résumé

Les mots en gras ci-dessus, j'espère que tout le monde pourra comprendre et utiliser cet exemple C'est juste un très petit scénario dans la demande réelle. Dans des projets spécifiques, il y aura diverses demandes normales ou anormales. Nous devons réfléchir davantage lors de la création d'une fonction. En fait, il y a encore beaucoup de choses à apprendre sur le cadre MVC, y compris sa conception. les idées, l’évolutivité et d’autres choses doivent toutes être comprises lentement. Si vous êtes intéressé par ASP.NET Core, vous pouvez me suivre. Je partagerai régulièrement certains de mes résultats d'apprentissage sur mon blog.

J'espère que cet article pourra aider tout le monde, merci pour votre soutien à ce site !

Pour plus d'articles liés à la configuration du préfixe de routage global par ASP.NET Core MVC, veuillez faire attention au site Web PHP chinois !