ContextQMD
Back to Aspnetcore

Breaking change: HTTP: Kestrel and IIS BadHttpRequestException types marked obsolete and replaced

aspnetcore/breaking-changes/5/http-badhttprequestexception-obsolete.md

latest2.1 KB
Original Source

HTTP: Kestrel and IIS BadHttpRequestException types marked obsolete and replaced

Microsoft.AspNetCore.Server.Kestrel.BadHttpRequestException and Microsoft.AspNetCore.Server.IIS.BadHttpRequestException have been marked obsolete and changed to derive from Microsoft.AspNetCore.Http.BadHttpRequestException. The Kestrel and IIS servers still throw their old exception types for backwards compatibility. The obsolete types will be removed in a future release.

For discussion, see dotnet/aspnetcore#20614.

Version introduced

5.0 Preview 4

Old behavior

Microsoft.AspNetCore.Server.Kestrel.BadHttpRequestException and Microsoft.AspNetCore.Server.IIS.BadHttpRequestException derived from xref:System.IO.IOException?displayProperty=nameWithType.

New behavior

Microsoft.AspNetCore.Server.Kestrel.BadHttpRequestException and Microsoft.AspNetCore.Server.IIS.BadHttpRequestException are obsolete. The types also derive from Microsoft.AspNetCore.Http.BadHttpRequestException, which derives from System.IO.IOException.

Reason for change

The change was made to:

  • Consolidate duplicate types.
  • Unify behavior across server implementations.

An app can now catch the base exception Microsoft.AspNetCore.Http.BadHttpRequestException when using either Kestrel or IIS.

Replace usages of Microsoft.AspNetCore.Server.Kestrel.BadHttpRequestException and Microsoft.AspNetCore.Server.IIS.BadHttpRequestException with Microsoft.AspNetCore.Http.BadHttpRequestException.

Affected APIs

<!-- ### Category ASP.NET Core ### Affected APIs - `T:Microsoft.AspNetCore.Server.IIS.BadHttpRequestException` - `T:Microsoft.AspNetCore.Server.Kestrel.BadHttpRequestException` -->