Поделиться через


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)

Добавляет Microsoft.AspNetCore.OutputCaching.OutputCacheMiddleware для кэширования HTTP-ответов.

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>)

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

UseWebAssemblyDebugging(IApplicationBuilder)

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

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

Включает поддержку ПО промежуточного слоя разработки Webpack. В этом приложении размещается экземпляр компилятора Webpack в памяти, чтобы вы всегда могли обслуживать up-to-date 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.

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