ApplicationBuilder 类

定义

命名空间:

Microsoft.AspNetCore.Builder

程序集:

Microsoft.AspNetCore.Http.dll

包:

Microsoft.AspNetCore.App.Ref v8.0.0

Source:

ApplicationBuilder.cs

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

继承

Object

ApplicationBuilder

实现

IApplicationBuilder

构造函数

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)	将应用程序配置为从路径 pathPrefix为 Blazor WebAssembly 框架文件提供服务。 此路径必须与引用的 Blazor WebAssembly 应用程序项目相对应。
UseConcurrencyLimiter(IApplicationBuilder)	已过时. 添加 ConcurrencyLimiterMiddleware 以限制并发执行的请求数。
UseCookiePolicy(IApplicationBuilder)	将 CookiePolicyMiddleware 处理程序添加到指定的 IApplicationBuilder，从而启用 Cookie 策略功能。
UseCookiePolicy(IApplicationBuilder, CookiePolicyOptions)	将 CookiePolicyMiddleware 处理程序添加到指定的 IApplicationBuilder，从而启用 Cookie 策略功能。
UseCors(IApplicationBuilder)	将 CORS 中间件添加到 Web 应用程序管道，以允许跨域请求。
UseCors(IApplicationBuilder, Action<CorsPolicyBuilder>)	将 CORS 中间件添加到 Web 应用程序管道，以允许跨域请求。
UseCors(IApplicationBuilder, String)	将 CORS 中间件添加到 Web 应用程序管道，以允许跨域请求。
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>)	使用从配置的 IEndpointRouteBuilder生成的 EndpointDataSource 实例，将 Microsoft.AspNetCore.Routing.EndpointMiddleware 中间件添加到指定的 IApplicationBuilder。 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)	添加一个中间件，该中间件可以记录 W3C 格式的服务器日志的 HTTP 请求和响应。
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)	添加用于缓存 HTTP 响应的 Microsoft.AspNetCore.OutputCaching.OutputCacheMiddleware。
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)	添加用于缓存 HTTP 响应的 ResponseCachingMiddleware。
UseResponseCompression(IApplicationBuilder)	添加用于动态压缩 HTTP 响应的中间件。
UseRewriter(IApplicationBuilder)	检查给定 URL 是否与规则和条件匹配，并在匹配时修改 HttpContext。
UseRewriter(IApplicationBuilder, RewriteOptions)	检查给定 URL 是否与规则和条件匹配，并在匹配时修改 HttpContext。
UseRouter(IApplicationBuilder, IRouter)	使用指定的 IRouter将 RouterMiddleware 中间件添加到指定的 IApplicationBuilder。
UseRouter(IApplicationBuilder, Action<IRouteBuilder>)	使用从配置的 IRouteBuilder生成的 IRouter，将 RouterMiddleware 中间件添加到指定的 IApplicationBuilder。
Run(IApplicationBuilder, RequestDelegate)	将终端中间件委托添加到应用程序的请求管道。
UseSession(IApplicationBuilder)	添加 SessionMiddleware 以自动为应用程序启用会话状态。
UseSession(IApplicationBuilder, SessionOptions)	添加 SessionMiddleware 以自动为应用程序启用会话状态。
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)	在 Chromium 开发工具中添加调试 Blazor WebAssembly 应用程序所需的中间件。
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 服务找到。