Kā rīkoties ar 404 kļūdām ASP.NET Core MVC

ASP.NET Core MVC ir ASP.NET MVC ietvara .NET Core partneris, lai izveidotu starpplatformas, mērogojamas, augstas veiktspējas tīmekļa lietojumprogrammas un API, izmantojot Model-View-Controller dizaina modeli. Pārsteidzoši, lai arī ASP.NET Core nodrošina daudz iespēju 404 kļūdu graciozai apstrādei, ASP.NET Core MVC izpildlaiks tās pēc noklusējuma neizmanto.

Rezultātā, ja tīmekļa lapa netiek atrasta un 404 kļūda tiek atgriezta lietojumprogrammā, ASP.NET Core MVC parāda tikai vispārīgu pārlūka kļūdu lapu (kā parādīts 1. attēlā zemāk). Šajā rakstā ir aplūkotas trīs ASP.NET Core iespējas, kuras mēs varam izmantot, lai graciozāk apstrādātu 404 kļūdas.

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

Vispirms izveidosim ASP.NET Core projektu Visual Studio. 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.
Nākamajā logā “Konfigurēt jauno projektu” norādiet jaunā projekta nosaukumu un vietu.
Noklikšķiniet uz Izveidot.
Logā “Izveidot jaunu ASP.NET Core Web 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, lai ilustrētu mūsu 404 kļūdu apstrādes iespējas šī raksta nākamajās sadaļās.

Izpildot ASP.NET Core MVC projektu, kuru esam izveidojuši iepriekšējā sadaļā, jūs redzēsiet lietojumprogrammas sākumlapu kopā ar sveiciena ziņojumu, kā parādīts 1. attēlā.

Tagad mēģināsim pārlūkot Web lapu, kas nepastāv. Lai to izdarītu, pārlūka adreses joslā ierakstiet // localhost: 6440 / welcome, kamēr programma tiek izpildīta. Kad ASP.NET Core MVC dzinējs nespēj atrast resursu norādītajam URL, tiks atgriezta kļūda 404, un jums tiks parādīta šāda kļūdas lapa. Tas nav ļoti eleganti, vai ne?

Pārbaudiet Response.StatusCode ASP.NET Core MVC

Ir vairāki veidi, kā jūs varat uzlabot šo vispārīgo kļūdu lapu. Vienkāršs risinājums ir pārbaudīt atbildē HTTP statusa kodu 404. Ja tiek atrasts, varat novirzīt vadību uz esošo lapu. Šis koda fragments parāda, kā startēšanas klases konfigurēšanas metodē var ierakstīt nepieciešamo kodu, lai novirzītu uz sākumlapu, ja ir notikusi kļūda 404.

 lietotne. Izmantojiet (async (context, next) =>
    {
  gaidīt nākamo ();
  ja (konteksts.atbilde.StatusCode == 404)
        {
   context.Request.Path = "/ Sākums";
  gaidīt nākamo ();
        }
    });

Tagad, ja izpildāt lietojumprogrammu un mēģināt pārlūkot URL // localhost: 6440 / welcome, jūs tiksiet novirzīts uz lietojumprogrammas sākumlapu.

Pilns konfigurēšanas metodes kods ir norādīts zemāk.

public void Configure (lietotne IApplicationBuilder, IWebHostEnvironment env)
        {
  ja (env.IsDevelopment ())
            {
  app.UseDeveloperExceptionPage ();
            }
  cits
            {
  app.UseExceptionHandler ("/ Sākums / Kļūda");
            }
  lietotne. Izmantojiet (async (context, next) =>
            {
  gaidīt nākamo ();
  ja (konteksts.atbilde.StatusCode == 404)
                {
  context.Request.Path = "/ Sākums";
  gaidīt nākamo ();
                }
            });
  app.UseStaticFiles ();
  app.UseRouting ();
  app.UseAuthorization ();
  app.UseEndpoints (galapunkti =>
            {
  galapunkti. MapControllerRoute (
  nosaukums: "noklusējums",
   modelis: "{controller = Home} / {action = Index} / {id?}");
            });
        }

ASP.NET Core MVC izmantojiet starpprogrammatūru UseStatusCodePages

Otrais risinājums 404 kļūdu apstrādei ASP.NET Core ir, izmantojot iebūvēto starpprogrammatūru UseStatusCodePages. Šis koda fragments parāda, kā jūs varat ieviest StatusCodePages Startup klases konfigurēšanas metodē.

public void Configure (lietotne IApplicationBuilder, IWebHostEnvironment env)
        {
  app.UseStatusCodePages ();
  // Cits kods
        }

Tagad, izpildot lietojumprogrammu un pārlūkojot neeksistējošo resursu, izvade būs līdzīga 3. attēlam.

Izmantojiet starpprogrammatūru UseStatusCodePagesWithReExecute ASP.NET Core MVC

Varat izmantot starpprogrammatūras UseStatusCodePagesWithReExecute priekšrocības, lai apstrādātu neveiksmes statusa kodus gadījumos, kad atbildes ģenerēšanas process nav sākts. Tādējādi šī starpprogrammatūra neapstrādās HTTP 404 statusa koda kļūdas - drīzāk, kad rodas 404 kļūda, vadība tiks nodota citai kontroliera darbībai, lai apstrādātu kļūdu.

Šis koda fragments parāda, kā jūs varat izmantot šo starpprogrammatūru, lai novirzītu uz citu darbības metodi.

app.UseStatusCodePagesWithReExecute ("/ Sākums / HandleError / {0}");

Lūk, kā darbības metode varētu izskatīties.

[Maršruts ("/ Sākums / HandleError / {kods: int}")]
public IActionResult HandleError (int kods)
{
  ViewData ["ErrorMessage"] = $ "Radās kļūda. ErrorCode ir: {code}";
  atgriezties View ("~ / Views / Shared / HandleError.cshtml");
}

Atstāju jums izveidot HandleError skatu, lai parādītu kļūdas ziņojumu.

Visbeidzot, iespējams, vēlēsities izveidot skatus tieši kļūdas kodam. Piemēram, varat izveidot tādus skatus kā Sākums / Kļūda / 500.cshtml vai Sākums / Kļūda / 404.cshtml. Pēc tam jūs varat pārbaudīt HTTP kļūdas kodu un novirzīt uz atbilstošo kļūdas lapu.

Vēl viens veids, kā apstrādāt lapas neatrastās kļūdas, ir pielāgota skata izmantošana un kļūdas koda atbilstoša iestatīšana. Kad jūsu lietojumprogrammā rodas kļūda, varat novirzīt lietotāju uz atbilstošo kļūdas lapu un parādīt pielāgoto kļūdas ziņojumu, kurā aprakstīta kļūda.