Microsoft.AspNetCore.Mvc 命名空间
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
提供生成 MVC 应用所需的类型。
类
AcceptedAtActionResult |
一个 , ActionResult 返回包含 Location 标头的 Accepted (202) 响应。 |
AcceptedAtRouteResult |
一个 , ActionResult 返回包含 Location 标头的 Accepted (202) 响应。 |
AcceptedResult |
返回 ActionResult “已接受” (202) 具有 Location 标头的响应的 。 |
AcceptVerbsAttribute |
指定操作支持的 HTTP 方法。 |
ActionContext |
用于执行已选择为 HTTP 请求一部分的操作的上下文对象。 |
ActionContextAttribute |
指定在创建控制器时应使用 current ActionContext 设置控制器属性。 属性必须具有公共集方法。 |
ActionNameAttribute |
指定操作的名称。 |
ActionResult |
的默认实现 IActionResult。 |
ActionResult<TValue> |
包装 |
AntiforgeryValidationFailedResult |
BadRequestResult用于防伪造验证失败的 。 用于 IAntiforgeryValidationFailedResult 匹配 MVC 结果筛选器中的验证失败。 |
ApiBehaviorOptions |
用于配置使用 ApiControllerAttribute注释的类型的行为的选项。 |
ApiControllerAttribute |
指示使用类型和所有派生类型来提供 HTTP API 响应。 使用此属性修饰的控制器配置了旨在改善开发人员生成 API 体验的功能和行为。 在程序集上修饰时,程序集中的所有控制器都将被视为具有 API 行为的控制器。 有关详细信息,请参阅 ApiController 属性。 |
ApiConventionMethodAttribute |
要应用于控制器操作的 API 约定。 API 约定用于影响 ApiExplorer 的输出。 ApiConventionMethodAttribute 可用于指定应用于操作的确切约定方法。 ApiConventionTypeAttribute 有关在程序集或控制器级别应用约定的详细信息。 |
ApiConventionTypeAttribute |
要应用于包含 MVC 控制器或单个控制器的程序集的 API 约定。 API 约定用于影响 ApiExplorer 的输出。 约定必须是静态类型。 约定中的方法使用指定的 ApiConventionNameMatchAttribute 规则与操作方法匹配,这些规则可应用于方法名称或其参数,并 ApiConventionTypeMatchAttribute 应用于参数。 如果未找到指定行为的属性,MVC 将匹配方法名称,并使用 Exact 匹配参数名称,并使用 AssignableFrom匹配参数类型。 |
ApiDescriptionActionData |
表示用于生成 作为 的一 |
ApiExplorerSettingsAttribute |
控制关联控制器类或操作方法的可见性和组名称 |
AreaAttribute |
指定包含控制器或操作的区域。 |
AutoValidateAntiforgeryTokenAttribute |
导致验证所有不安全 HTTP 方法的防伪造令牌的属性。 GET、HEAD、OPTIONS 和 TRACE 以外的 HTTP 方法需要防伪造令牌。 |
BadRequestObjectResult |
执行 ObjectResult 时将生成错误请求 (400) 响应。 |
BadRequestResult |
执行 StatusCodeResult 时将生成错误请求 (400) 响应。 |
BindAttribute |
此属性可用于操作参数和类型,以指示模型级元数据。 |
BindPropertiesAttribute |
一个属性,它为修饰控制器或 Razor 页面模型定义的所有属性启用绑定。 |
BindPropertyAttribute |
一个属性,可以指定要用于绑定关联属性的 的模型名称或类型 IModelBinder 。 |
CacheProfile |
定义一组可用于响应缓存的设置。 |
ChallengeResult |
执行 ActionResult 时调用 的 HttpContext.ChallengeAsync。 |
ClientErrorData |
生成客户端错误的信息。 此类型用于配置 使用者生成的 ClientErrorMapping客户端错误。 |
ConflictObjectResult |
执行 ObjectResult 时将产生冲突 (409) 响应。 |
ConflictResult |
执行 StatusCodeResult 时将产生冲突 (409) 响应。 |
ConsumesAttribute |
一个筛选器,指定支持的请求内容类型。 ContentTypes 如果存在多个匹配项,则用于选择一个操作。 |
ContentResult |
执行 ActionResult 时将生成包含内容的响应的 。 |
Controller |
具有视图支持的 MVC 控制器的基类。 |
ControllerAttribute |
指示默认控制器发现机制将应用此属性的类型和任何派生类型视为控制器,除非 NonControllerAttribute 应用于层次结构中的任何类型。 |
ControllerBase |
无视图支持的 MVC 控制器的基类。 |
ControllerContext |
与控制器的当前请求关联的上下文。 |
ControllerContextAttribute |
指定在创建控制器时应使用 current ControllerContext 设置控制器属性。 属性必须具有公共集方法。 |
CookieTempDataProviderOptions |
为设置的 Cookie 提供编程配置 CookieTempDataProvider |
CreatedAtActionResult |
一个 , ActionResult 返回包含 Location 标头的 Created (201) 响应。 |
CreatedAtRouteResult |
一个 , ActionResult 返回包含 Location 标头的 Created (201) 响应。 |
CreatedResult |
一个 , ActionResult 返回包含 Location 标头的 Created (201) 响应。 |
DefaultApiConventions |
默认 API 约定。 |
DisableRequestSizeLimitAttribute |
禁用请求正文大小限制。 |
EmptyResult |
表示 ActionResult 执行时将不执行任何操作的 。 |
FileContentResult |
表示执行 ActionResult 时会将二进制文件写入响应的 。 |
FileResult |
表示 ActionResult 执行时将写入文件作为响应的 。 |
FileStreamResult |
表示 ActionResult 执行时会将文件从流写入响应的 。 |
ForbidResult |
执行 ActionResult 时调用 的 HttpContext.ForbidAsync。 |
FormatFilterAttribute |
一个筛选器,它将使用路由数据或查询字符串中的格式值来设置操作返回的 的 ObjectResult 内容类型。 |
FromBodyAttribute |
指定应使用请求正文绑定参数或属性。 |
FromFormAttribute |
指定应使用请求正文中的表单数据绑定参数或属性。 |
FromHeaderAttribute |
指定应使用请求标头绑定参数或属性。 |
FromQueryAttribute |
指定应使用请求查询字符串绑定参数或属性。 |
FromRouteAttribute |
指定应使用来自当前请求的路由数据绑定参数或属性。 |
FromServicesAttribute |
指定应使用请求服务绑定参数或属性。 |
HiddenInputAttribute |
指示应使用 <类型为“hidden”的输入> 元素编辑关联的属性或具有关联类型的所有属性。 |
HttpDeleteAttribute |
标识支持 HTTP DELETE 方法的操作。 |
HttpGetAttribute |
标识支持 HTTP GET 方法的操作。 |
HttpHeadAttribute |
标识支持 HTTP HEAD 方法的操作。 |
HttpOptionsAttribute |
标识支持 HTTP OPTIONS 方法的操作。 |
HttpPatchAttribute |
标识支持 HTTP PATCH 方法的操作。 |
HttpPostAttribute |
标识支持 HTTP POST 方法的操作。 |
HttpPutAttribute |
标识支持 HTTP PUT 方法的操作。 |
IgnoreAntiforgeryTokenAttribute |
跳过防伪造令牌验证的筛选器。 |
JsonOptions |
用于配置 SystemTextJsonInputFormatter 和 SystemTextJsonOutputFormatter的选项。 |
JsonPatchExtensions | |
JsonResult |
将给定对象的格式设置为 JSON 的操作结果。 |
LocalRedirectResult |
一个 , ActionResult 它返回 Found (302) 、已永久移动 (301) 、临时重定向 (307) 或永久重定向 (308) 响应,其中 Location 标头指向提供的本地 URL。 |
MiddlewareFilterAttribute |
执行 提供的 ConfigurationType中间件管道。 中间件管道将被视为异步资源筛选器。 |
MiddlewareFilterAttribute<T> |
执行 提供的 ConfigurationType中间件管道。 中间件管道将被视为异步资源筛选器。 |
ModelBinderAttribute |
一个属性,可指定要用于绑定的 IModelBinder 的模型名称或类型。 |
ModelBinderAttribute<TBinder> |
一个属性,可指定要用于绑定的 IModelBinder 的模型名称或类型。 |
ModelMetadataTypeAttribute |
此属性指定要与数据模型类关联的元数据类。 |
ModelMetadataTypeAttribute<T> |
此属性指定要与数据模型类关联的元数据类。 |
MvcJsonOptions |
为 MVC 框架中的 JSON 提供编程配置。 |
MvcNewtonsoftJsonOptions |
使用 Newtonsoft.JSON 为 JSON 格式化程序提供编程配置。 |
MvcOptions |
为 MVC 框架提供编程配置。 |
MvcViewOptions |
为 MVC 框架中的视图提供编程配置。 |
NoContentResult |
执行 StatusCodeResult 时将生成 204 无内容响应的 。 |
NonActionAttribute |
指示控制器方法不是操作方法。 |
NonControllerAttribute |
指示默认控制器发现机制不会将此属性应用于的类型和任何派生类型视为控制器。 |
NonViewComponentAttribute |
指示默认视图组件发现机制不会将应用此属性的类型和任何派生类型视为视图组件。 |
NotFoundObjectResult |
执行 ObjectResult 时将生成“找不到” (404) 响应的 。 |
NotFoundResult |
表示执行 StatusCodeResult 时将生成“找不到” (404) 响应的 。 |
ObjectResult |
执行 ActionResult 时将使用主机提供的机制将对象写入响应的 。 |
OkObjectResult |
执行 ObjectResult 时执行内容协商、设置实体正文格式的 ,如果协商和格式设置成功,将生成 Status200OK 响应。 |
OkResult |
执行 StatusCodeResult 时将生成空 Status200OK 响应的 。 |
PageRemoteAttribute |
一个 RemoteAttributeBase 用于 razor 页面处理程序的 ,它将不显眼的验证配置为将 Ajax 请求发送到网站。 调用的处理程序应返回指示值是否有效的 JSON。 |
PartialViewResult |
表示向 ActionResult 响应呈现分部视图的 。 |
PhysicalFileResult |
FileResult执行时将使用主机提供的机制将文件从磁盘写入响应。 |
ProblemDetails |
一种计算机可读格式,用于指定基于 https://tools.ietf.org/html/rfc7807的 HTTP API 响应中的错误。 |
ProducesAttribute |
一个筛选器,指定操作将返回的预期 Type 以及支持的响应内容类型。 值 ContentTypes 用于设置 ContentTypes。 |
ProducesAttribute<T> |
一个筛选器,指定操作将返回的预期 Type 以及支持的响应内容类型。 值 ContentTypes 用于设置 ContentTypes。 |
ProducesDefaultResponseTypeAttribute |
一个筛选器,它为 未涵盖ProducesResponseTypeAttribute的所有 HTTP 状态代码指定 Type 。 |
ProducesErrorResponseTypeAttribute |
指定默认由使用 批注的 ApiControllerAttribute控制器返回的类型。 Type 未提供任何值时,指定与 ProducesResponseTypeAttribute 客户端错误的 关联的错误模型类型, (HTTP 状态代码 4xx) 。 如果未指定任何值,则 MVC 假定客户端错误类型为 ProblemDetails,如果使用映射客户端错误 (ClientErrorMapping) 。 Attribute如果应用程序使用自定义错误类型进行响应,则使用此配置默认错误类型。 |
ProducesResponseTypeAttribute |
一个筛选器,指定操作返回的值和状态代码的类型。 |
ProducesResponseTypeAttribute<T> |
一个筛选器,指定操作返回的值和状态代码的类型。 |
RazorViewEngineOptionsSetup |
设置 的默认 RazorViewEngineOptions选项。 |
RedirectResult |
一个 , ActionResult 它返回 Found (302) 、已永久移动 (301) 、临时重定向 (307) 或永久重定向 (308) 响应,其位置标头指向提供的 URL。 |
RedirectToActionResult |
一个 , ActionResult 返回 Found (302) 、已永久移动 (301) 、临时重定向 (307) 或永久重定向 (308) 响应(带有 Location 标头)。 以控制器操作为目标。 |
RedirectToPageResult |
一个 , ActionResult 返回 Found (302) 或 Moved 永久 (301) 带 Location 标头的响应。 以已注册的路由为目标。 |
RedirectToRouteResult |
一个 , ActionResult 返回 Found (302) 、已永久移动 (301) 、临时重定向 (307) 或永久重定向 (308) 响应(带有 Location 标头)。 以已注册的路由为目标。 |
RemoteAttribute |
控制器的 , RemoteAttributeBase 用于配置不显眼验证以向网站发送 Ajax 请求。 调用的操作应返回指示值是否有效的 JSON。 |
RemoteAttributeBase |
一个 , ValidationAttribute 它将非干扰验证配置为向网站发送 Ajax 请求。 调用的终结点应返回 JSON,指示该值是否有效。 |
RequestFormLimitsAttribute |
将指定的限制设置为 Form。 |
RequestSizeLimitAttribute |
将请求正文大小限制设置为指定大小。 |
RequireHttpsAttribute |
确认通过 HTTPS 接收请求的授权筛选器。 |
ResponseCacheAttribute |
指定在响应缓存中设置相应标头所需的参数。 |
RouteAttribute |
指定控制器上的属性路由。 |
SerializableError |
定义用于存储 ModelState 信息的可序列化容器。 此信息存储为键/值对。 |
ServiceFilterAttribute |
在 中查找另一个筛选器的筛选器 IServiceProvider。 |
ServiceFilterAttribute<TFilter> |
在 中查找另一个筛选器的筛选器 IServiceProvider。 |
SignInResult |
执行 ActionResult 时调用 的 HttpContext.SignInAsync。 |
SignOutResult |
执行 ActionResult 时调用 的 HttpContext.SignOutAsync。 |
SkipStatusCodePagesAttribute |
阻止执行 StatusCodePages 中间件的筛选器。 |
StatusCodeResult |
表示执行 ActionResult 时将生成具有给定响应状态代码的 HTTP 响应的 。 |
TempDataAttribute |
用 TempDataAttribute 修饰的属性会将其值存储在 中,并从 中加载 ITempDataDictionary。 TempDataAttribute 控制器、Razor 页面和 Razor 页面模型的属性支持 。 |
TypeFilterAttribute |
一个筛选器,用于创建类型的 ImplementationType另一个筛选器,从依赖项注入中检索缺少的构造函数参数(如果可用)。 |
TypeFilterAttribute<TFilter> |
一个筛选器,用于创建类型的 ImplementationType另一个筛选器,从依赖项注入中检索缺少的构造函数参数(如果可用)。 |
UnauthorizedObjectResult |
执行 ObjectResult 时将生成未授权的 (401) 响应。 |
UnauthorizedResult |
表示执行 UnauthorizedResult 时将生成未授权 (401) 响应的 。 |
UnprocessableEntityObjectResult |
执行 ObjectResult 时将生成无法处理的实体 (422) 响应。 |
UnprocessableEntityResult |
一个 StatusCodeResult ,执行时将生成无法处理的实体 (422) 响应。 |
UnsupportedMediaTypeResult |
执行 StatusCodeResult 时将生成 UnsupportedMediaType (415) 响应的 。 |
UrlHelperExtensions |
URL 帮助程序扩展方法的静态类。 |
ValidateAntiForgeryTokenAttribute |
指定应用此属性的类或方法验证防伪令牌。 如果防伪令牌不可用,或者令牌无效,验证将失败,并且不会执行操作方法。 |
ValidationProblemDetails |
用于 ProblemDetails 验证错误的 。 |
ViewComponent |
视图组件的基类。 |
ViewComponentAttribute |
指示 类和所有子类都是视图组件。 (可选)指定视图组件的名称。 如果为多个视图组件定义基类,请将此属性与该基组件相关联。 |
ViewComponentResult |
一个 , IActionResult 它将视图组件呈现给响应。 |
ViewDataAttribute |
用 ViewDataAttribute 修饰的属性会将其值存储在 中,并从 中加载 ViewDataDictionary。 ViewDataDictionary 控制器和 Razor 页面处理程序的属性支持 。 |
ViewResult |
表示将 ActionResult 视图呈现给响应的 。 |
VirtualFileResult |
执行 FileResult 时使用主机提供的机制将指定的文件写入到响应的虚拟路径。 |
接口
IActionResult |
定义表示操作方法结果的协定。 |
IDesignTimeMvcBuilderConfiguration |
配置 IMvcBuilder。 实现此接口以启用设计时配置 (,例如在 预编译视图) IMvcBuilder期间。 |
IRequestFormLimitsPolicy |
筛选器的标记接口,用于定义对请求正文读取为窗体的限制的策略。 |
IRequestSizePolicy |
筛选器的标记接口,用于定义请求正文最大大小的策略。 |
IUrlHelper |
定义帮助程序在应用程序中为 ASP.NET MVC 生成 URL 的协定。 |
IViewComponentHelper |
支持在视图中呈现视图组件。 |
IViewComponentResult |
的结果类型 ViewComponent。 |
枚举
CompatibilityVersion |
指定由 MvcOptions配置的运行时行为的版本兼容性。 |
ResponseCacheLocation |
确定响应中“Cache-control”标头的值。 |
注解
有关 MVC 的简介,请参阅 ASP.NET Core MVC 概述。