So beheben Sie Routing-Fehler in einer .NET Core 3.1 API

Erfahren Sie, wie Sie Routing-Fehler in Ihrer .NET Core 3.1 API effektiv behandeln, indem Sie einen benutzerdefinierten Model Binder für nullable GUIDs implementieren.
---
Dieses Video basiert auf der Frage https://stackoverflow.com/q/62189536/ gestellt von dem Nutzer 'Stanislav Angelov' ( https://stackoverflow.com/u/13678087/ ) sowie auf der Antwort https://stackoverflow.com/a/62213409/ bereitgestellt von dem Nutzer 'Stanislav Angelov' ( https://stackoverflow.com/u/13678087/ ) auf der Website 'Stack Overflow'. Vielen Dank an diese großartigen Nutzer und die Stackexchange-Community für ihre Beiträge.

Besuchen Sie diese Links, um den Originalinhalt und weitere Details zu sehen, z. B. alternative Lösungen, aktuelle Entwicklungen zum Thema, Kommentare, Versionsverlauf usw. Der ursprüngliche Titel der Frage lautete beispielsweise: How to change routing errors in .NET Core 3.1 API

Außerdem steht der Inhalt (außer Musik) unter der Lizenz CC BY-SA https://meta.stackexchange.com/help/l...
Der ursprüngliche Fragenbeitrag steht unter der Lizenz 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ), und der ursprüngliche Antwortbeitrag steht unter der Lizenz 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ).

Falls Ihnen irgendetwas auffällt oder Unstimmigkeiten bestehen, schreiben Sie mir bitte an vlogize [AT] gmail [DOT] com.
---
So beheben Sie Routing-Fehler in einer .NET Core 3.1 API

Der Wechsel von ASP.NET 4.7 zu .NET Core 3.1 kann für Entwickler verschiedene Herausforderungen mit sich bringen, insbesondere bei der Verarbeitung von Routing und Model Binding. Ein häufig auftretendes Problem betrifft den Umgang mit ungültigen GUIDs in einer API, insbesondere dann, wenn Anfragen aufgrund fehlerhafter Modelbindungslogik nicht die beabsichtigte Controller-Action erreichen. In diesem Beitrag besprechen wir, wie Sie diesen Routing-Fehler beheben und sicherstellen, dass Ihre Anwendung sich wie erwartet verhält.

Verständnis des Problems

Wenn eine ungültige GUID als Teil der URL für einen bestimmten API-Endpunkt übergeben wird, erlaubten frühere ASP.NET-Versionen die Ausführung, um den Wert der GUID zu prüfen und entsprechend zu reagieren. Mit .NET Core 3.1 hat sich dieses Verhalten geändert. Statt die Anfrage mit einer ungültigen GUID an den Controller weiterzuleiten, gibt .NET Core 3.1 einen Validierungsfehler zurück und verhindert die Ausführung Ihrer Action-Methode.

Beispiel-Szenario

Betrachten wir die folgende Action-Methode, die dazu dient, einen Kontakt anhand seiner ID aus dem System abzurufen:

[[Siehe Video, um diesen Text oder Codeausschnitt anzuzeigen]]

Wenn eine ungültige GUID wie contacts/6cb735b1-b2f0-45d1-a5b5-3a161b8c5eTESTINVALIDGUID übergeben wird, reagiert die API mit einem Validierungsfehler, anstatt die Action-Methode auszuführen. Dies ist ärgerlich, da der gewünschte Fehlerbehandlungscode nie ausgeführt wird.

Die Lösung: Benutzerdefinierter Model Binder

Nach Recherche zu ModelBinders habe ich eine effektive Implementierung eines benutzerdefinierten Model Binders entdeckt, der den Umgang mit nullbaren oder ungültigen GUIDs sauber ermöglicht. Nachfolgend eine detaillierte Anleitung zur Umsetzung dieser Lösung.

Schritt 1: Erstellen eines benutzerdefinierten Model Binders

Zunächst erstellen wir eine Klasse GuidModelBinder, die IModelBinder implementiert. Dieser Binder enthält die Logik zur Verarbeitung von GUID-Eingaben:

[[Siehe Video, um diesen Text oder Codeausschnitt anzuzeigen]]

Schritt 2: Erstellen eines Model Binder Providers

Als nächstes müssen wir den GuidModelBinder mit Guid?-Parametern in der gesamten Anwendung verknüpfen. Indem wir einen GuidModelBinderProvider implementieren, stellen wir sicher, dass nur nullable GUIDs von unserem Binder verarbeitet werden:

[[Siehe Video, um diesen Text oder Codeausschnitt anzuzeigen]]

Schritt 3: Registrierung des benutzerdefinierten Binders in Startup

Abschließend müssen Sie den GuidModelBinderProvider in Ihrer Startup.cs-Datei registrieren, damit er global in der Anwendung angewendet wird:

[[Siehe Video, um diesen Text oder Codeausschnitt anzuzeigen]]

Mit diesen Schritten kann Ihre Anwendung Aufrufe mit ungültigen GUIDs korrekt verarbeiten und die Controller-Aktionen gemäß Ihrer definierten Logik ausführen.

Fazit

Durch das Erstellen eines benutzerdefinierten Model Binders für GUID-Parameter in .NET Core 3.1 können Sie Validierungsfehler im Model Binding umgehen und Ihre Controller-Aktionen unabhängig von der Eingabe ausführen lassen. Dieser Ansatz löst nicht nur das unmittelbare Problem, sondern erhöht auch die Flexibilität Ihrer API bei der Migration von ASP.NET 4.7.

Wenn Sie ähnliche Probleme bei der Arbeit mit .NET Core APIs haben, kann der Einsatz benutzerdefinierter Model Binder eine robuste Lösung sein, um die Fehlerbehandlung zu verbessern und die Benutzererfahrung zu optimieren.