Kaip sukurti maršruto apribojimus ASP.NET Core

Maršruto apribojimai ASP.NET Core naudojami norint filtruoti ar apriboti nepageidaujamus duomenis nuo jūsų valdiklio veiksmų. Norėdami sužinoti apie pagrindinį maršrutą „ASP.NET Core“, galite perskaityti mano ankstesnį straipsnį apie atributais pagrįstą maršrutizavimą, palyginti su konvencijomis pagrįstu maršruto parinkimu ASP.NET Core. Šis straipsnis peržengia pagrindinius dalykus, kad būtų galima ištirti išplėstines operacijas naudojant maršruto apribojimus.

Norėdami dirbti su šiame straipsnyje pateiktais kodų pavyzdžiais, sistemoje turite būti įdiegę „Visual Studio 2019“. Jei dar neturite kopijos, galite atsisiųsti „Visual Studio 2019“ čia.

Sukurkite ASP.NET Core MVC projektą „Visual Studio 2019“

Pirmiausia, sukurkime ASP.Net Core projektą „Visual Studio 2019“. Darant prielaidą, kad „Visual Studio 2019“ yra įdiegta jūsų sistemoje, atlikite toliau nurodytus veiksmus, kad sukurtumėte naują „ASP.Net Core“ projektą „Visual Studio“.

Paleiskite „Visual Studio IDE“.
Spustelėkite „Sukurti naują projektą“.
Lange „Kurti naują projektą“ iš rodomų šablonų sąrašo pasirinkite „ASP.NET Core Web Application“.
Spustelėkite Pirmyn.
Lange „Konfigūruoti naują projektą“ nurodykite naujo projekto pavadinimą ir vietą.
Pasirinktinai pažymėkite žymės langelį „Įdėti sprendimą ir projektą tame pačiame kataloge“, atsižvelgiant į jūsų pageidavimus.
Spustelėkite Sukurti.
Kitame rodomame lange „Sukurti naują ASP.NET Core žiniatinklio programą“ viršuje esančiame išskleidžiamajame sąraše pasirinkite .NET Core kaip vykdymo laiką ir ASP.NET Core 3.1 (ar naujesnę).
Norėdami sukurti naują ASP.NET Core MVC programą, kaip projekto šabloną pasirinkite „Web Application (Model-View-Controller)“.
Įsitikinkite, kad nepažymėti žymės langeliai „Įgalinti„ Docker “palaikymą“ ir „Konfigūruoti HTTPS“, nes čia nenaudosime tų funkcijų.
Įsitikinkite, kad autentifikavimas nustatytas kaip „Nėra autentifikavimo“, nes mes taip pat nenaudosime autentifikavimo.
Spustelėkite Sukurti.

Atlikę šiuos veiksmus, „Visual Studio 2019“ sukurs naują ASP.NET Core MVC projektą. Šį projektą naudosime toliau pateiktose skiltyse, kad parodytume, kaip mes galime naudoti maršruto apribojimus ASP.NET Core 3.1.

„RouteCollection“ klasė ASP.NET Core

ASP.NET Core „RouteTable“ klasėje yra ypatybė „Routes“, kuri visus maršrutus saugo kaip „RouteCollection“. „RouteCollection“ klasėje yra keletas plėtinių metodų, kuriuos galima naudoti žemėlapiams žymėti arba jų nepaisyti.

„MapRoute“ yra perkrautas metodas, kuris priima apribojimus kaip parametrą. Tai galite naudoti norėdami perduoti savo apribojimą maršrutui. Žemiau pateikiama „MapRoute“ metodo deklaracija.

public static Route MapRoute (tai „RouteCollection“ maršrutai, eilutės pavadinimas,
  eilutės URL, objekto numatytieji, objekto apribojimai);

„IRouteConstraint“ sąsaja ASP.NET Core

„IRouteConstraint“ sąsaja yra sutartis, kurioje pateikiama tik vieno metodo, pavadinto „Match“, deklaracija. Ši sąsaja turi būti išplėsta klase ir joje įdiegtu „Match“ metodu, kad būtų galima patikrinti, ar tam tikras URL parametras yra tinkamas apribojimui. Štai kaip apibrėžiama „IRouteConstraint“ sąsaja:

vardų sritis „Microsoft.AspNetCore.Routing“

{

viešoji sąsaja „IRouteConstraint“

{

„Bool Match“ (

„HttpContext httpContext“,

„IRouter“ maršrutas,

eilutės maršrutasKey,

„RouteValueDictionary“ vertės,

RouteDirection routeDirection);

}

„ConstraintMap“ žodynas ASP.NET Core

„ConstraintMap“ yra žodynas, kuriame yra maršruto apribojimų sąrašas, kuriame žemėlapio maršruto apribojimo raktai pateikiami į „IRouteConstraint“ įgyvendinimus. Žemiau pateiktas kodo fragmentas parodo, kaip galite pridėti pasirinktinius apribojimus į šį žodyną.

public void „ConfigureServices“ („IServiceCollection“ paslaugos)
{  
  paslaugos. Konfigūruoti (routeOptions =>
  { 
  routeOptions.ConstraintMap.Add ("emailconstraint", typeof (EmailRouteContraint));
  }); 
}

Įdiekite „IRouteConstraint Match“ metodą ASP.NET Core

Norėdami sukurti pasirinktinį maršruto apribojimą, turėtumėte sukurti klasę, pratęsiančią „IRouteConstraint“ sąsają ir įgyvendinančią jos „Match“ metodą. Apribojimas gali būti naudojamas norint užkirsti kelią nepageidaujamoms gaunamoms užklausoms ir neleisti suderinti maršruto, nebent įvykdyta konkreti sąlyga. Pvz., Galbūt norėsite užtikrinti, kad veiksmo metodui perduotas parametras visada būtų sveikasis skaičius.

Atitikties metodas priima šiuos parametrus:

„HttpContext“ - apima visą HTTP specifinę informaciją apie užklausą
„IRouter“ - reiškia maršrutizatorių, kuris taikys apribojimus
RouteKey - reiškia maršruto parametrą, kuris yra patvirtinamas
RouteDirection - sąrašas, kuriame yra dvi reikšmės, būtent „IncomingRequest“ ir „UrlGeneration“, ir naudojamas nurodyti, ar URL apdorojamas iš HTTP užklausos, ar generuojamas URL
RouteValues - yra URL parametrai

ASP.NET Core pasirinktinio maršruto apribojimo struktūra

Čia pateikiamas pasirinktinio maršruto apribojimo struktūros pavyzdys:

viešoji klasė „CustomRouteConstraint“: „IRouteConstraint“
    {
        viešoji „Bool Match“ („HttpContext httpContext“, „IRouter“ maršrutas,
        eilutės routeKey, RouteValueDictionary reikšmės,
        RouteDirection routeDirection)
        {
            mesti naują NotImplementedException ();
        }
    }

ASP.NET Core tinkinto maršruto apribojimo pavyzdys

Dabar įgyvendinkime pasirinktinį maršruto apribojimą, kuris gali patikrinti el. Pašto adresus. Pirmiausia sukurkite klasę, kuri pratęsia „IRouteConstraint“ sąsają ir įgyvendina „Match“ metodą. Šis kodo fragmentas rodo pasirinktą maršruto suvaržymo klasę, pavadintą „EmailRouteContraint“, kuri pratęsia „IRouteConstraint“ sąsają.

viešosios klasės „EmailRouteContraint“: „IRouteConstraint“

{

viešoji „Bool Match“ („HttpContext httpContext“, „IRouter“ maršrutas,

eilutės routeKey, RouteValueDictionary reikšmės,

RouteDirection routeDirection)

{

grįžti tiesa;

}

Šiame kodų sąraše rodoma „EmailRouteConstraint“ klasė su įdiegtu „Match“ metodu.

viešosios klasės „EmailRouteContraint“: „IRouteConstraint“
    {
  viešoji „Bool Match“ („HttpContext httpContext“, „IRouter“ maršrutas,
  eilutės routeKey, RouteValueDictionary reikšmės,
  RouteDirection routeDirection)
        {
  jei (reikšmės.TryGetValue (routeKey, out var routeValue))
            {
  var parametroValueString = Convert.ToString (routeValue,
   CultureInfo.InvariantCulture);
  grąžinti „IsEmailAddressValid“ (parametrasValueString);
            }
  grąžinti klaidingą;
        }
  privatus „Bool“ „IsEmailAddressValid“ (eilutės el. pašto adresas)
        {
  grįžti tiesa;
        }
    }

Atkreipkite dėmesį, kad čia pateiktas „IsEmailAddressValid“ metodas tiesiog pateikia „true“. Aš palieku jums parašyti reikiamą kodą, kad patvirtintumėte el. Pašto adresą.

Užregistruokite pasirinktinį maršruto apribojimą ASP.NET Core

Turėtumėte užregistruoti pasirinktinį maršruto apribojimą maršruto parinkimo sistemoje „Startup“ klasės „ConfigureServices“ metodu. Tai iliustruoja šis kodo fragmentas.

public void „ConfigureServices“ („IServiceCollection“ paslaugos)
      {
 paslaugos.AddControllersWithViews ();
 paslaugos. Konfigūruoti (routeOptions =>
          {
 routeOptions.ConstraintMap.Add („ERC“,
 typeof (EmailRouteContraint));
          });
      }

Taip pat turėtumėte sukonfigūruoti pasirinktinį maršruto apribojimą „Startup“ klasės konfigūravimo metodu, kaip parodyta žemiau esančiame kodo fragmente.

app.UseEndpoints (pabaigos taškai =>
{
  galutiniai taškai. „MapControllerRoute“ (
  pavadinimas: „numatytasis“,
  apribojimai: naujas {ERC = new EmailRouteContraint ()},
  modelis: "{controller = Home} / {action = Index} / {id?}");
});

Štai ir viskas. Dabar galite nurodyti apribojimą savo valdiklyje arba savo veiksmų metodus ir pradėti naudoti programą.

ASP.NET Core vykdymo laikas patikrinamas, jei apibrėžtas šablonas ir maršruto apribojimai atitinka gaunamos užklausos modelį ir vertes. Apribojimo patvirtinimo logika apibrėžta jūsų pritaikyto maršruto apribojimo „Match“ metode. Galite pasinaudoti apribojimais, kad išvengtumėte nereikalingų užklausų, taip pat patvirtinkite maršruto reikšmes prieš užklausą perduodant veiksmo metodui.