ApplicationBuilder Класс

Определение

Реализация по умолчанию для IApplicationBuilder.

public ref class ApplicationBuilder : Microsoft::AspNetCore::Builder::IApplicationBuilder
public class ApplicationBuilder : Microsoft.AspNetCore.Builder.IApplicationBuilder
type ApplicationBuilder = class
    interface IApplicationBuilder
Public Class ApplicationBuilder
Implements IApplicationBuilder
Наследование
ApplicationBuilder
Реализации

Конструкторы

ApplicationBuilder(IServiceProvider)

Инициализирует новый экземпляр ApplicationBuilder.

ApplicationBuilder(IServiceProvider, Object)

Инициализирует новый экземпляр ApplicationBuilder.

Свойства

ApplicationServices

Возвращает для IServiceProvider служб приложений.

Properties

Возвращает набор свойств для ApplicationBuilder.

ServerFeatures

Возвращает для IFeatureCollection компонентов сервера.

Методы

Build()

RequestDelegate Создает объект , который выполняет добавленные ПО промежуточного слоя.

New()

Создает копию этого построителя приложений.

Созданный клон имеет те же свойства, что и текущий экземпляр, но не копирует конвейер запроса.

Use(Func<RequestDelegate,RequestDelegate>)

Добавляет ПО промежуточного слоя в конвейер запросов приложения.

Методы расширения

UseAntiforgery(IApplicationBuilder)

Добавляет в конвейер ПО промежуточного слоя для защиты от подделки.

UseRequestLocalization(IApplicationBuilder)

RequestLocalizationMiddleware Добавляет , чтобы автоматически задавать сведения о языке и региональных параметрах для запросов на основе информации, предоставленной клиентом.

UseRequestLocalization(IApplicationBuilder, RequestLocalizationOptions)

RequestLocalizationMiddleware Добавляет , чтобы автоматически задавать сведения о языке и региональных параметрах для запросов на основе информации, предоставленной клиентом.

UseRequestLocalization(IApplicationBuilder, Action<RequestLocalizationOptions>)

RequestLocalizationMiddleware Добавляет , чтобы автоматически задавать сведения о языке и региональных параметрах для запросов на основе информации, предоставленной клиентом.

UseRequestLocalization(IApplicationBuilder, String[])

RequestLocalizationMiddleware Добавляет , чтобы автоматически задавать сведения о языке и региональных параметрах для запросов на основе информации, предоставленной клиентом.

UseAuthentication(IApplicationBuilder)

Добавляет в AuthenticationMiddleware указанный IApplicationBuilderобъект , который включает возможности проверки подлинности.

UseAuthorization(IApplicationBuilder)

Добавляет в AuthorizationMiddleware указанный IApplicationBuilderобъект , который включает возможности авторизации.

При авторизации ресурса, направляемого с помощью маршрутизации конечных точек, этот вызов должен отображаться между вызовами app.UseRouting() и app.UseEndpoints(...) для правильной работы ПО промежуточного слоя.

UseCertificateForwarding(IApplicationBuilder)

Добавляет в конвейер ПО промежуточного слоя, которое будет искать сертификат в заголовке запроса, декодирует его и обновляет HttpContext.Connection.ClientCertificate.

UseBlazorFrameworkFiles(IApplicationBuilder)

Настраивает приложение для обслуживания файлов платформы Blazor WebAssembly из корневого пути "/".

UseBlazorFrameworkFiles(IApplicationBuilder, PathString)

Настраивает приложение для обслуживания файлов платформы Blazor WebAssembly из пути pathPrefix. Этот путь должен соответствовать проекту приложения Blazor WebAssembly, на который ссылается ссылка.

UseConcurrencyLimiter(IApplicationBuilder)
Устаревшие..

Добавляет , ConcurrencyLimiterMiddleware чтобы ограничить количество одновременно выполняемых запросов.

UseConnections(IApplicationBuilder, Action<ConnectionsRouteBuilder>)
Устаревшие..

Добавляет поддержку обработчиков ASP.NET Core подключений в IApplicationBuilder конвейер выполнения запросов.

Этот метод устарел и будет удален в одном из будущих выпусков. Рекомендуется использовать MapConnections или MapConnectionHandler TConnectionHandler<> в Microsoft.AspNetCore.Builder.UseEndpoints(...).

UseCookiePolicy(IApplicationBuilder)

Добавляет обработчик в CookiePolicyMiddleware указанный IApplicationBuilderобъект , который включает возможности политики файлов cookie.

UseCookiePolicy(IApplicationBuilder, CookiePolicyOptions)

Добавляет обработчик в CookiePolicyMiddleware указанный IApplicationBuilderобъект , который включает возможности политики файлов cookie.

UseCors(IApplicationBuilder)

Добавляет ПО промежуточного слоя CORS в конвейер веб-приложения, чтобы разрешить междоменные запросы.

UseCors(IApplicationBuilder, Action<CorsPolicyBuilder>)

Добавляет ПО промежуточного слоя CORS в конвейер веб-приложения, чтобы разрешить междоменные запросы.

UseCors(IApplicationBuilder, String)

Добавляет ПО промежуточного слоя CORS в конвейер веб-приложения, чтобы разрешить междоменные запросы.

UseDatabaseErrorPage(IApplicationBuilder)
Устаревшие..

Записывает из конвейера синхронные и асинхронные исключения, связанные с базой данных, которые могут быть разрешены с помощью миграции Entity Framework. При возникновении этих исключений формируется HTML-ответ с подробными сведениями о возможных действиях для устранения проблемы.

UseDatabaseErrorPage(IApplicationBuilder, DatabaseErrorPageOptions)
Устаревшие..

Записывает из конвейера синхронные и асинхронные исключения, связанные с базой данных, которые могут быть разрешены с помощью миграции Entity Framework. При возникновении этих исключений формируется HTML-ответ с подробными сведениями о возможных действиях для устранения проблемы.

UseDefaultFiles(IApplicationBuilder)

Включает сопоставление файлов по умолчанию по текущему пути

UseDefaultFiles(IApplicationBuilder, DefaultFilesOptions)

Включает сопоставление файлов по умолчанию с заданными параметрами

UseDefaultFiles(IApplicationBuilder, String)

Включает сопоставление файлов по умолчанию для заданного пути запроса.

UseDeveloperExceptionPage(IApplicationBuilder)

Захватывает синхронные и асинхронные Exception экземпляры из конвейера и создает ответы на ошибки HTML.

UseDeveloperExceptionPage(IApplicationBuilder, DeveloperExceptionPageOptions)

Захватывает синхронные и асинхронные Exception экземпляры из конвейера и создает ответы на ошибки HTML.

UseDirectoryBrowser(IApplicationBuilder)

Включение просмотра каталогов по текущему пути

UseDirectoryBrowser(IApplicationBuilder, DirectoryBrowserOptions)

Включение просмотра каталогов с заданными параметрами

UseDirectoryBrowser(IApplicationBuilder, String)

Включает просмотр каталогов для заданного пути запроса.

UseEndpoints(IApplicationBuilder, Action<IEndpointRouteBuilder>)

Добавляет ПО промежуточного Microsoft.AspNetCore.Routing.EndpointMiddleware слоя в указанный IApplicationBuilder с EndpointDataSource экземплярами, созданными на основе настроенного IEndpointRouteBuilder. будет Microsoft.AspNetCore.Routing.EndpointMiddleware выполнять объект , связанный Endpoint с текущим запросом.

UseRouting(IApplicationBuilder)

Добавляет ПО промежуточного Microsoft.AspNetCore.Routing.EndpointRoutingMiddleware слоя в указанный IApplicationBuilderобъект .

UseExceptionHandler(IApplicationBuilder)

Добавляет в конвейер ПО промежуточного слоя, которое будет перехватывать исключения, регистрировать их и повторно выполнять запрос в альтернативном конвейере. Запрос не будет повторно выполнен, если ответ уже запущен.

UseExceptionHandler(IApplicationBuilder, ExceptionHandlerOptions)

Добавляет в конвейер ПО промежуточного слоя, которое будет перехватывать исключения, регистрировать их и повторно выполнять запрос в альтернативном конвейере. Запрос не будет повторно выполнен, если ответ уже запущен.

UseExceptionHandler(IApplicationBuilder, Action<IApplicationBuilder>)

Добавляет в конвейер ПО промежуточного слоя, которое будет перехватывать исключения, регистрировать их и повторно выполнять запрос в альтернативном конвейере. Запрос не будет повторно выполнен, если ответ уже запущен.

UseExceptionHandler(IApplicationBuilder, String)

Добавляет в конвейер ПО промежуточного слоя, которое будет перехватывать исключения, записывать их в журнал, сбрасывать путь запроса и повторно выполнять запрос. Запрос не будет повторно выполнен, если ответ уже запущен.

UseExceptionHandler(IApplicationBuilder, String, Boolean)

Добавляет в конвейер ПО промежуточного слоя, которое будет перехватывать исключения, записывать их в журнал, сбрасывать путь запроса и повторно выполнять запрос. Запрос не будет повторно выполнен, если ответ уже запущен.

UseFileServer(IApplicationBuilder)

Включение всего ПО промежуточного слоя статических файлов (кроме просмотра каталогов) для текущего пути запроса в текущем каталоге.

UseFileServer(IApplicationBuilder, FileServerOptions)

Включение всего ПО промежуточного слоя статических файлов с заданными параметрами

UseFileServer(IApplicationBuilder, Boolean)

Включение всего ПО промежуточного слоя статических файлов для текущего пути запроса в текущем каталоге.

UseFileServer(IApplicationBuilder, String)

Включает все ПО промежуточного слоя статических файлов (кроме просмотра каталогов) для данного путь запроса из каталога с тем же именем

UseForwardedHeaders(IApplicationBuilder)

Применяет перенаправленные заголовки к соответствующим полям в текущем запросе.

По соглашению http-прокси пересылают сведения от клиента в известных заголовках HTTP. Считывает ForwardedHeadersMiddleware эти заголовки и заполняет связанные поля в HttpContext.

UseForwardedHeaders(IApplicationBuilder, ForwardedHeadersOptions)

Применяет перенаправленные заголовки к соответствующим полям в текущем запросе.

По соглашению http-прокси пересылают сведения от клиента в известных заголовках HTTP. Считывает ForwardedHeadersMiddleware эти заголовки и заполняет связанные поля в HttpContext.

UseHeaderPropagation(IApplicationBuilder)

Добавляет ПО промежуточного слоя, которое собирает заголовки для распространения в HttpClient.

UseHealthChecks(IApplicationBuilder, PathString)

Добавляет ПО промежуточного слоя, которое предоставляет состояние проверка работоспособности.

UseHealthChecks(IApplicationBuilder, PathString, HealthCheckOptions)

Добавляет ПО промежуточного слоя, которое предоставляет состояние проверка работоспособности.

UseHealthChecks(IApplicationBuilder, PathString, Int32)

Добавляет ПО промежуточного слоя, которое предоставляет состояние проверка работоспособности.

UseHealthChecks(IApplicationBuilder, PathString, Int32, HealthCheckOptions)

Добавляет ПО промежуточного слоя, которое предоставляет состояние проверка работоспособности.

UseHealthChecks(IApplicationBuilder, PathString, String)

Добавляет ПО промежуточного слоя, которое предоставляет состояние проверка работоспособности.

UseHealthChecks(IApplicationBuilder, PathString, String, HealthCheckOptions)

Добавляет ПО промежуточного слоя, которое предоставляет состояние проверка работоспособности.

UseHostFiltering(IApplicationBuilder)

Добавляет ПО промежуточного слоя для фильтрации запросов по разрешенным заголовкам узла. Недопустимые запросы будут отклонены с кодом состояния 400.

UseHsts(IApplicationBuilder)

Добавляет ПО промежуточного слоя для использования HSTS, которое добавляет заголовок Strict-Transport-Security.

UseHttpLogging(IApplicationBuilder)

Добавляет ПО промежуточного слоя, которое может записывать HTTP-запросы и ответы.

UseW3CLogging(IApplicationBuilder)

Добавляет ПО промежуточного слоя, которое может регистрировать HTTP-запросы и ответы для журналов сервера в формате W3C.

UseHttpMethodOverride(IApplicationBuilder)

Позволяет входящий запрос POST переопределять тип метода с типом, указанным в заголовке. Это ПО промежуточного слоя используется, когда клиент ограничен отправкой методов GET или POST, но хочет вызвать другие методы HTTP. По умолчанию заголовок запроса X-HTTP-Method-Override используется для указания туннелируемого метода HTTP.

UseHttpMethodOverride(IApplicationBuilder, HttpMethodOverrideOptions)

Позволяет входящий запрос POST переопределять тип метода с типом, указанным в форме. Это ПО промежуточного слоя используется, когда клиент ограничен отправкой методов GET или POST, но хочет вызвать другие методы HTTP.

UseHttpsRedirection(IApplicationBuilder)

Добавляет ПО промежуточного слоя для перенаправления HTTP-запросов на HTTPS.

Map(IApplicationBuilder, PathString, Action<IApplicationBuilder>)

Ветвляет конвейер запроса на основе совпадений заданного пути запроса. Если путь запроса начинается с заданного пути, данная ветвь выполняется.

Map(IApplicationBuilder, PathString, Boolean, Action<IApplicationBuilder>)

Ветвляет конвейер запроса на основе совпадений заданного пути запроса. Если путь запроса начинается с заданного пути, данная ветвь выполняется.

Map(IApplicationBuilder, String, Action<IApplicationBuilder>)

Ветвляет конвейер запроса на основе совпадений заданного пути запроса. Если путь запроса начинается с заданного пути, данная ветвь выполняется.

MapWhen(IApplicationBuilder, Func<HttpContext,Boolean>, Action<IApplicationBuilder>)

Разветвляет конвейер запроса на основе результата заданного предиката.

UseMigrationsEndPoint(IApplicationBuilder)

Обрабатывает запросы для выполнения операций миграции. ПО промежуточного слоя будет прослушивать запросы, сделанные в DefaultPath.

UseMigrationsEndPoint(IApplicationBuilder, MigrationsEndPointOptions)

Обрабатывает запросы для выполнения операций миграции. ПО промежуточного слоя будет прослушивать запросы к пути, настроенного в options.

UseMvc(IApplicationBuilder)

Добавляет MVC в IApplicationBuilder конвейер выполнения запроса.

UseMvc(IApplicationBuilder, Action<IRouteBuilder>)

Добавляет MVC в IApplicationBuilder конвейер выполнения запроса.

UseMvcWithDefaultRoute(IApplicationBuilder)

Добавляет MVC в IApplicationBuilder конвейер выполнения запроса с маршрутом по умолчанию с именем default и следующим шаблоном: "{controller=Home}/{action=Index}/{id?}".

UseOutputCache(IApplicationBuilder)

Реализация по умолчанию для IApplicationBuilder.

UseOwin(IApplicationBuilder)

Добавляет конвейер OWIN в указанный IApplicationBuilderобъект .

UseOwin(IApplicationBuilder, Action<Action<Func<Func<IDictionary<String,Object>,Task>,Func<IDictionary<String,Object>,Task>>>>)

Добавляет конвейер ПО промежуточного слоя OWIN в указанный IApplicationBuilderобъект .

UseRateLimiter(IApplicationBuilder)

Включает ограничение скорости для приложения.

UseRateLimiter(IApplicationBuilder, RateLimiterOptions)

Включает ограничение скорости для приложения.

UseRequestDecompression(IApplicationBuilder)

Добавляет ПО промежуточного слоя для динамической распаковки тел HTTP-запросов.

UseRequestTimeouts(IApplicationBuilder)

Включает время ожидания запроса для приложения.

По умолчанию время ожидания не настроено. Их необходимо настроить в RequestTimeoutOptions, в RequestTimeoutAttribute конечных точках или с помощью расширений маршрутизации WithRequestTimeout.

UseResponseCaching(IApplicationBuilder)

Добавляет для ResponseCachingMiddleware кэширования HTTP-ответов.

UseResponseCompression(IApplicationBuilder)

Добавляет ПО промежуточного слоя для динамического сжатия HTTP-ответов.

UseRewriter(IApplicationBuilder)

Проверяет, соответствует ли заданный URL-адрес правилам и условиям, и изменяет httpContext при совпадении.

UseRewriter(IApplicationBuilder, RewriteOptions)

Проверяет, соответствует ли заданный URL-адрес правилам и условиям, и изменяет httpContext при совпадении.

UseRouter(IApplicationBuilder, IRouter)

Добавляет ПО промежуточного RouterMiddleware слоя в указанный IApplicationBuilder объект с указанным IRouter.

UseRouter(IApplicationBuilder, Action<IRouteBuilder>)

Добавляет ПО промежуточного RouterMiddleware слоя в указанный IApplicationBuilder объект со сборкой IRouter из настроенного IRouteBuilder.

Run(IApplicationBuilder, RequestDelegate)

Добавляет делегат ПО промежуточного слоя терминала в конвейер запросов приложения.

UseSession(IApplicationBuilder)

Добавляет для автоматического SessionMiddleware включения состояния сеанса для приложения.

UseSession(IApplicationBuilder, SessionOptions)

Добавляет для автоматического SessionMiddleware включения состояния сеанса для приложения.

UseSignalR(IApplicationBuilder, Action<HubRouteBuilder>)
Устаревшие..

Добавляет SignalR в IApplicationBuilder конвейер выполнения запроса.

Этот метод устарел и будет удален в одном из будущих выпусков. Рекомендуется использовать MapHub<THub> в Microsoft.AspNetCore.Builder.UseEndpoints(...).

UseSpa(IApplicationBuilder, Action<ISpaBuilder>)

Обрабатывает все запросы из этой точки в цепочке ПО промежуточного слоя, возвращая страницу по умолчанию для одностраничного приложения (SPA).

Это ПО промежуточного слоя должно быть помещено в конце цепочки, чтобы другое ПО промежуточного слоя для обслуживания статических файлов, действий MVC и т. д. имеет приоритет.

UseStaticFiles(IApplicationBuilder)

Включает обслуживание статических файлов для текущего пути запроса

UseStaticFiles(IApplicationBuilder, StaticFileOptions)

Включает обработку статических файлов с заданными параметрами

UseStaticFiles(IApplicationBuilder, String)

Включает обслуживание статических файлов для заданного пути запроса.

UseStatusCodePages(IApplicationBuilder)

Добавляет ПО промежуточного слоя StatusCodePages с обработчиком ответов по умолчанию, который проверяет ответы с кодами состояния от 400 до 599 без текста.

UseStatusCodePages(IApplicationBuilder, StatusCodePagesOptions)

Добавляет ПО промежуточного слоя StatusCodePages с заданными параметрами, которые проверяют ответы с кодами состояния от 400 до 599 без текста.

UseStatusCodePages(IApplicationBuilder, Action<IApplicationBuilder>)

Добавляет ПО промежуточного слоя StatusCodePages в конвейер с указанным альтернативным конвейером ПО промежуточного слоя для выполнения для создания текста ответа.

UseStatusCodePages(IApplicationBuilder, Func<StatusCodeContext,Task>)

Добавляет ПО промежуточного слоя StatusCodePages с указанным обработчиком, который проверяет ответы с кодами состояния от 400 до 599 без текста.

UseStatusCodePages(IApplicationBuilder, String, String)

Добавляет ПО промежуточного слоя StatusCodePages с указанным текстом ответа для отправки. Сюда может входить заполнитель "{0}" для кода состояния. ПО промежуточного слоя проверяет ответы с кодами состояния от 400 до 599, которые не имеют текста.

UseStatusCodePagesWithRedirects(IApplicationBuilder, String)

Добавляет ПО промежуточного слоя StatusCodePages в конвейер. Указывает, что ответы должны обрабатываться путем перенаправления с заданным шаблоном URL-адреса расположения. Сюда может входить заполнитель "{0}" для кода состояния. URL-адреса, начинаемые с "~", будут иметь префикс PathBase, где любой другой URL-адрес будет использоваться как есть.

UseStatusCodePagesWithReExecute(IApplicationBuilder, String, String)

Добавляет ПО промежуточного слоя StatusCodePages в конвейер. Указывает, что текст ответа должен создаваться путем повторного выполнения конвейера запросов с использованием другого пути. Этот путь может содержать заполнитель "{0}" кода состояния.

Use(IApplicationBuilder, Func<HttpContext,RequestDelegate,Task>)

Добавляет делегат ПО промежуточного слоя, определенный в строке, в конвейер запросов приложения. Если вы не вызываете следующую функцию, используйте Run(IApplicationBuilder, RequestDelegate) вместо нее .

Use(IApplicationBuilder, Func<HttpContext,Func<Task>,Task>)

Добавляет делегат ПО промежуточного слоя, определенный в строке, в конвейер запросов приложения. Если вы не вызываете следующую функцию, используйте Run(IApplicationBuilder, RequestDelegate) вместо нее .

Предпочитайте использовать Use(IApplicationBuilder, Func<HttpContext,RequestDelegate,Task>) для повышения производительности, как показано ниже.

app.Use((context, next) =>
{
    return next(context);
});
UseMiddleware(IApplicationBuilder, Type, Object[])

Добавляет тип ПО промежуточного слоя в конвейер запросов приложения.

UseMiddleware<TMiddleware>(IApplicationBuilder, Object[])

Добавляет тип ПО промежуточного слоя в конвейер запросов приложения.

UsePathBase(IApplicationBuilder, PathString)

Добавляет ПО промежуточного слоя, которое извлекает указанную базу пути из пути запроса и добавляет его в базу пути запроса.

UseWhen(IApplicationBuilder, Func<HttpContext,Boolean>, Action<IApplicationBuilder>)

Условно создает ветвь в конвейере запросов, которая повторно присоединена к конвейеру main.

UseWebAssemblyDebugging(IApplicationBuilder)

Добавляет ПО промежуточного слоя, необходимое для отладки приложений Blazor WebAssembly в Chromium средств разработки.

UseWebpackDevMiddleware(IApplicationBuilder, WebpackDevMiddlewareOptions)
Устаревшие..

Включает поддержку ПО промежуточного слоя для разработки Webpack. При этом экземпляр компилятора Webpack размещается в памяти приложения, чтобы вы всегда могли обслуживать актуальные ресурсы, созданные webpack, без необходимости запуска компилятора вручную. Так как экземпляр компилятора Webpack хранится в памяти, добавочная компиляция выполняется гораздо быстрее, чем повторный запуск компилятора с нуля.

Входящие запросы, соответствующие файлам, созданным webpack, будут обрабатываться путем возврата выходных данных компилятора Webpack напрямую, независимо от файлов на диске. Если компиляция выполняется при поступлении запроса, ответ будет приостановлен до тех пор, пока не будут готовы обновленные выходные данные компилятора.

UseWebSockets(IApplicationBuilder)

Добавляет в WebSocketMiddleware конвейер запроса.

UseWebSockets(IApplicationBuilder, WebSocketOptions)

Добавляет в WebSocketMiddleware конвейер запроса.

UseWelcomePage(IApplicationBuilder)

Добавляет WelcomePageMiddleware в конвейер.

UseWelcomePage(IApplicationBuilder, WelcomePageOptions)

Добавляет WelcomePageMiddleware в конвейер с заданными параметрами.

UseWelcomePage(IApplicationBuilder, PathString)

Добавляет WelcomePageMiddleware в конвейер по указанному пути.

UseWelcomePage(IApplicationBuilder, String)

Добавляет WelcomePageMiddleware в конвейер по указанному пути.

UseHttpLoggingMiddleware(IApplicationBuilder)

Регистрирует ПО промежуточного слоя для ведения журнала входящих HTTP-запросов в IApplicationBuilder.

UseRequestCheckpoint(IApplicationBuilder)

Регистрирует в конвейере ПО промежуточного слоя, связанные с контрольной точкой запроса.

UseRequestLatencyTelemetry(IApplicationBuilder)

Добавляет ПО промежуточного слоя телеметрии задержки запроса для IApplicationBuilder конвейера выполнения запроса.

UseSpaStaticFiles(IApplicationBuilder)

Настраивает приложение для обслуживания статических файлов для одностраничного приложения (SPA). Файлы будут находиться с помощью зарегистрированной ISpaStaticFileProvider службы.

UseSpaStaticFiles(IApplicationBuilder, StaticFileOptions)

Настраивает приложение для обслуживания статических файлов для одностраничного приложения (SPA). Файлы будут находиться с помощью зарегистрированной ISpaStaticFileProvider службы.

Применяется к