Kā izveidot maršruta ierobežojumus ASP.NET Core

Maršruta ierobežojumi ASP.NET Core tiek izmantoti, lai filtrētu vai ierobežotu nevēlamu datu nokļūšanu jūsu kontroliera darbībās. Lai uzzinātu, kā veikt maršrutēšanu ASP.NET Core, varat atsaukties uz manu iepriekšējo rakstu par maršrutēšanu uz atribūtiem un maršrutēšanu uz konvencijām, izmantojot ASP.NET Core. Šis raksts pārsniedz pamatus, lai izpētītu uzlabotās darbības, izmantojot maršruta ierobežojumus.

Lai strādātu ar šajā rakstā sniegtajiem kodu piemēriem, sistēmā jābūt instalētai Visual Studio 2019. Ja jums vēl nav kopijas, varat lejupielādēt Visual Studio 2019 šeit.

Izveidojiet ASP.NET Core MVC projektu Visual Studio 2019

Vispirms izveidosim ASP.Net Core projektu Visual Studio 2019. Pieņemot, ka Visual Studio 2019 ir instalēta jūsu sistēmā, veiciet tālāk norādītās darbības, lai izveidotu jaunu ASP.Net Core projektu Visual Studio.

Palaidiet Visual Studio IDE.
Noklikšķiniet uz “Izveidot jaunu projektu”.
Logā “Izveidot jaunu projektu” parādīto veidņu sarakstā atlasiet “ASP.NET Core Web Application”.
Noklikšķiniet uz Tālāk.
Logā “Konfigurēt jauno projektu” norādiet jaunā projekta nosaukumu un vietu.
Pēc izvēles atzīmējiet izvēles rūtiņu “Novietot risinājumu un projektu vienā direktorijā” atkarībā no jūsu vēlmēm.
Noklikšķiniet uz Izveidot.
Nākamajā logā “Izveidot jaunu ASP.NET Core tīmekļa lietojumprogrammu” augšdaļā esošajā nolaižamajā sarakstā atlasiet .NET Core kā izpildlaiku un ASP.NET Core 3.1 (vai jaunāku).
Atlasiet “Web Application (Model-View-Controller)” kā projekta veidni, lai izveidotu jaunu ASP.NET Core MVC lietojumprogrammu.
Pārliecinieties, vai nav atzīmētas izvēles rūtiņas “Iespējot Docker atbalstu” un “Konfigurēt HTTPS”, jo mēs šeit neizmantosim šīs funkcijas.
Pārliecinieties, vai autentifikācijai ir iestatīta vērtība “Nav autentifikācijas”, jo mēs arī neizmantosim autentifikāciju.
Noklikšķiniet uz Izveidot.

Veicot šīs darbības, Visual Studio 2019 tiks izveidots jauns ASP.NET Core MVC projekts. Mēs izmantosim šo projektu tālāk esošajās sadaļās, lai ilustrētu, kā mēs varam izmantot maršruta ierobežojumus ASP.NET Core 3.1.

RouteCollection klase ASP.NET Core

ASP.NET Core klasē RouteTable ir īpašums ar nosaukumu Routes, kas visus maršrutus saglabā kā RouteCollection. Klasē RouteCollection ir dažas paplašināšanas metodes, kuras var izmantot maršrutu kartēšanai vai to ignorēšanai.

MapRoute ir pārslogota metode, kas kā ierobežojumu pieņem ierobežojumus. To var izmantot, lai pārsūtītu ierobežojumu maršrutam. Šī ir MapRoute metodes deklarācija.

public static Route MapRoute (šī RouteCollection maršruti, virknes nosaukums,
  virknes URL, objekta noklusējumi, objekta ierobežojumi);

IRouteConstraint saskarne ASP.NET Core

IRouteConstraint interfeiss ir līgums, kas satur tikai vienas metodes, kuras nosaukums ir Match, deklarāciju. Šī saskarne jāpaplašina ar klasi un tajā jāievieš atbilstības metode, lai pārbaudītu, vai noteikts URL parametrs ir derīgs ierobežojumam. Lūk, kā tiek definēts IRouteConstraint interfeiss:

nosaukumvieta Microsoft.AspNetCore.Routing
{
  publiskā saskarne IRouteConstraint
    {
  bool Match (
  HttpContext httpContext,
  IRouter maršruts,
  virknes maršrutsKey,
  RouteValueDictionary vērtības,
  RouteDirection routeDirection);
    }
}

ConstraintMap vārdnīca ASP.NET Core

ConstraintMap ir vārdnīca, kas satur maršruta ierobežojumu sarakstu, kas kartē maršruta ierobežojuma taustiņus ar IRouteConstraint ieviešanu. Tālāk sniegtais koda fragments parāda, kā šai vārdnīcai varat pievienot pielāgotos ierobežojumus.

public void ConfigureServices (IServiceCollection pakalpojumi)
{  
  pakalpojumi. Konfigurēt (routeOptions =>
  { 
  routeOptions.ConstraintMap.Add ("emailconstraint", typeof (EmailRouteContraint));
  }); 
}

Īstenojiet IRouteConstraint Match metodi ASP.NET Core

Lai izveidotu pielāgotu maršruta ierobežojumu, jums jāizveido klase, kas paplašina IRouteConstraint saskarni un ievieš tās Match metodi. Ierobežojumu var izmantot, lai novērstu nevēlamus ienākošos pieprasījumus un novērstu maršruta saskaņošanu, ja vien nav izpildīts kāds konkrēts nosacījums. Piemēram, jūs varētu vēlēties, lai darbības metodei nodotais parametrs vienmēr būtu vesels skaitlis.

Atbilstības metode pieņem šādus parametrus:

HttpContext - ietver visu HTTP specifisko informāciju par pieprasījumu
IRouter - apzīmē maršrutētāju, kas piemēros ierobežojumus
RouteKey - apzīmē pārbaudāmo maršruta parametru
RouteDirection - uzskaite, kas satur divas vērtības, proti, IncomingRequest un UrlGeneration, un tiek izmantota, lai norādītu, vai URL tiek apstrādāts no HTTP pieprasījuma vai tiek ģenerēts URL
RouteValues - satur URL parametrus

ASP.NET Core pielāgota maršruta ierobežojuma struktūra

Šeit ir pielāgota maršruta ierobežojuma struktūras piemērs:

publiskā klase CustomRouteConstraint: IRouteConstraint
    {
        public bool Match (HttpContext httpContext, IRouter maršruts,
        virknes routeKey, RouteValueDictionary vērtības,
        RouteDirection routeDirection)
        {
            mest jaunu NotImplementedException ();
        }
    }

Pielāgota maršruta ierobežojuma piemērs ASP.NET Core

Tagad ieviesīsim pielāgotu maršruta ierobežojumu, kas var pārbaudīt e-pasta ID. Vispirms izveidojiet klasi, kas paplašina IRouteConstraint saskarni un ievieš Match metodi. Šis koda fragments parāda pielāgotu maršruta ierobežojuma klasi ar nosaukumu EmailRouteContraint, kas paplašina IRouteConstraint saskarni.

public class EmailRouteContraint: IRouteConstraint
    {
        public bool Match (HttpContext httpContext, IRouter maršruts,
        virknes routeKey, RouteValueDictionary vērtības,
        RouteDirection routeDirection)
        {
  atgriezties taisnība;
        }
    }

Šajā kodu sarakstā tiek parādīta klase EmailRouteConstraint ar ieviesto atbilstības metodi.

public class EmailRouteContraint: IRouteConstraint
    {
  public bool Match (HttpContext httpContext, IRouter maršruts,
  virknes routeKey, RouteValueDictionary vērtības,
  RouteDirection routeDirection)
        {
  ja (vērtības.TryGetValue (routeKey, out var routeValue))
            {
  var parametraValueString = Convert.ToString (routeValue,
   CultureInfo.InvariantCulture);
  atgriezt IsEmailAddressValid (parametraValueString);
            }
  atgriezties nepatiesa;
        }
  privātā bool IsEmailAddressValid (virknes e-pasta adrese)
        {
  atgriezties taisnība;
        }
    }

Ņemiet vērā, ka šeit izmantotā metode IsEmailAddressValid vienkārši atgriež vērtību “true”. Es atstāju jūsu ziņā uzrakstīt nepieciešamo kodu e-pasta adreses apstiprināšanai.

Reģistrējiet pielāgotu maršruta ierobežojumu ASP.NET Core

Pielāgotā maršruta ierobežojums jāreģistrē maršrutēšanas sistēmā Startup klases ConfigureServices metodē. Tālāk parādītais koda fragments to ilustrē.

public void ConfigureServices (IServiceCollection pakalpojumi)
      {
 pakalpojumi.AddControllersWithViews ();
 pakalpojumi. Konfigurēt (routeOptions =>
          {
 routeOptions.ConstraintMap.Add ("ERC",
 typeof (EmailRouteContraint));
          });
      }

Jums arī jākonfigurē pielāgotā maršruta ierobežojums Startup klases konfigurēšanas metodē, kā parādīts zemāk esošajā koda fragmentā.

app.UseEndpoints (galapunkti =>
{
  galapunkti. MapControllerRoute (
  nosaukums: "noklusējums",
  ierobežojumi: jauns {ERC = new EmailRouteContraint ()},
  modelis: "{controller = Home} / {action = Index} / {id?}");
});

Un viss. Tagad kontrolierī vai darbības metodēs varat norādīt ierobežojumu un sākt lietot lietojumprogrammu.

ASP.NET Core izpildlaiks tiek apstiprināts, ja definētais modelis un maršruta ierobežojumi sakrīt ar ienākošā pieprasījuma modeli un vērtībām. Ierobežojuma validācijas loģika ir definēta pielāgotā maršruta ierobežojuma atbilstības metodē. Varat izmantot ierobežojumus, lai izvairītos no nevajadzīgiem pieprasījumiem, kā arī lai apstiprinātu maršruta vērtības pirms pieprasījuma nodošanas darbības metodei.