ASP.NET Core MVC 之视图组件(View Component)

简介: ASP.NET Core MVC 之视图组件(View Component)1.视图组件介绍  视图组件是 ASP.NET Core MVC 的新特性,类似于局部视图,但它更强大。视图组件不使用模型绑定,并且仅依赖于调用它时所提供的数据。

ASP.NET Core MVC 之视图组件(View Component)
1.视图组件介绍

  视图组件是 ASP.NET Core MVC 的新特性,类似于局部视图,但它更强大。视图组件不使用模型绑定,并且仅依赖于调用它时所提供的数据。

  视图组件特点:

    呈块状,而不是整个响应

    包括在控制器和视图之间发现的相同的关注点和可测试性优点

    可以拥有参数和业务逻辑

    通常从布局页面调用

  视图组件可以用在任何需要重复逻辑且对局部视图来说过于复杂的情况,例如:

    动态导航菜单

    标签云(需要查询数据库)

    登录面板

    购物车

    最近发表的文章

    典型博客上的侧边栏内容

    将在每个页面上呈现的登录面板,根据用户的登录状态显示注销或者登录的链接

  视图组件有两部分组成,类(通常派生自 ViewComponent)和它返回的结果(通常是一个视图)。与控制器一样,视图组件可以是POCO,但大多数是利用 ViewComponent 派生的方法和属性。

2.创建视图组件

  (1)视图组件类

  一个视图组件类通常可以通过以下任一方式创建:

    派生自ViewComponent

    使用 [ViewComponent] 属性装饰类,或从具有 [ViewComponent] 属性的类派生

    创建一个名称后缀为 ViewComponent 结尾的类

  像控制器一样,视图组件必须是 public ,非嵌套和非抽象类。视图组件名称是删除了 ViewComponent 后缀的类名,可以使用 ViewComponentAttribute.Name 属性显示指定。

  

  视图组件类优点:

    完全支持构造函数依赖注入

    不参与控制器生命周期,这意味着不能在视图组件中使用过滤器

  (2) 视图组件方法

  视图组件在 InvokeAsync 方法中定义其逻辑,并返回 IViewComponentResult 。参数直接来自视图组件的调用,而不是来自模型绑定。视图组件从不直接处理请求。通常,视图组件通过调用 View 方法初始化模型并将其传递给视图。总之,视图组件有以下特点:

    定义一个 InvokeAsync 方法并返回 IViewComponentResult。

    通常通过调用 ViewComponent View 方法初始化模型并将其传递给视图。

    参数来自调用方法,而不是 HTTP,没有模型绑定。

    不能直接作为 HTTP 端点访问,它是从你的代码(通常在视图中)调用的。视图组件不处理请求。

    在签名上重载,而不是当前 HTTP 请求的任何细节。

  (3) 视图搜索路径

  运行时在以下路径搜索视图:

  Views//Components//

  Views/Shared/Components//

  视图组件的默认视图名称是 Default,这意味着你的视图文件通常名为 Default.cshtml。你可以在创建视图组件结果或调用 View 方法时指定其他的视图名称。

3.调用视图组件

   要使用视图组件,请从视图中调用 @Component.InvokeAsync("视图组件名称",<匿名参数>)。参数将传递到 InvokeAsync 方法。如下:

@await Component.InvokeAsync("TopicRankList",new { days=5})
  视图组件通常从视图中调用,但也可以从控制器方法中直接调用,虽然视图组件不像控制器那样定义终结点。

    public ActionResult Index()
    {
        return ViewComponent("TopicRankList", new { days = 5 });
    }

4.实战视图组件

  添加一个 ViewCompoents 文件夹,然后添加 UserRankList类:

复制代码

public class UserRankList : ViewComponent
{
    private readonly DataContext _db;
    private IMemoryCache _memoryCache;
    private string cacheKey = "topicrank";

    public UserRankList(DataContext db, IMemoryCache memoryCache)
    {
        _db = db;
        _memoryCache = memoryCache;
    }

    public IViewComponentResult Invoke(int days)
    {
        var items = new List<User>();
        if (!_memoryCache.TryGetValue(cacheKey, out items))
        {
            items = GetRankUsers(10, days);
        }
        _memoryCache.Set(cacheKey,items,TimeSpan.FromMinutes(10));
        return View(items);
    }

    private List<User> GetRankUsers(int top, int days)
    {
        return _db.User.OrderBy(o => o.Id).Take(top).ToList();
    }
}

复制代码
  视图组件类可以在项目的任何文件夹中。 [ViewComponent] 特性可以更改用于引用视图组件的名称,例如,可以命名类为 XYZ,并应用 [ViewComponent] 特性:

[ViewComponent(Name="UserRankTop")]
public calss XYZ:ViewComponent
  Invoke 方法返回列表,然后创建视图组件视图。

  创建 View/Shared/Components 文件夹。这个文件夹必须名为 Components。然后在里面创建 UserRankList 文件夹,添加 Default.cshtml 视图:

复制代码
@model List

user


@foreach (var item in Model)
{
    <label>@item.Name</label>
}


复制代码
  最后在视图中调用:@await Component.InvokeAsync("UserRankList", new { days=5})

原文地址https://www.cnblogs.com/afei-24/p/11317885.html

相关文章
|
24天前
|
开发框架 .NET 开发者
简化 ASP.NET Core 依赖注入(DI)注册-Scrutor
Scrutor 是一个简化 ASP.NET Core 应用程序中依赖注入(DI)注册过程的开源库,支持自动扫描和注册服务。通过简单的配置,开发者可以轻松地从指定程序集中筛选、注册服务,并设置其生命周期,同时支持服务装饰等高级功能。适用于大型项目,提高代码的可维护性和简洁性。仓库地址:&lt;https://github.com/khellang/Scrutor&gt;
40 5
|
3月前
|
存储 开发框架 JSON
ASP.NET Core OData 9 正式发布
【10月更文挑战第8天】Microsoft 在 2024 年 8 月 30 日宣布推出 ASP.NET Core OData 9,此版本与 .NET 8 的 OData 库保持一致,改进了数据编码以符合 OData 规范,并放弃了对旧版 .NET Framework 的支持,仅支持 .NET 8 及更高版本。新版本引入了更快的 JSON 编写器 `System.Text.UTF8JsonWriter`,优化了内存使用和序列化速度。
101 0
|
7天前
|
监控 前端开发 API
一款基于 .NET MVC 框架开发、功能全面的MES系统
一款基于 .NET MVC 框架开发、功能全面的MES系统
|
2月前
|
开发框架 .NET C#
在 ASP.NET Core 中创建 gRPC 客户端和服务器
本文介绍了如何使用 gRPC 框架搭建一个简单的“Hello World”示例。首先创建了一个名为 GrpcDemo 的解决方案,其中包含一个 gRPC 服务端项目 GrpcServer 和一个客户端项目 GrpcClient。服务端通过定义 `greeter.proto` 文件中的服务和消息类型,实现了一个简单的问候服务 `GreeterService`。客户端则通过 gRPC 客户端库连接到服务端并调用其 `SayHello` 方法,展示了 gRPC 在 C# 中的基本使用方法。
46 5
在 ASP.NET Core 中创建 gRPC 客户端和服务器
|
1月前
|
开发框架 缓存 .NET
GraphQL 与 ASP.NET Core 集成:从入门到精通
本文详细介绍了如何在ASP.NET Core中集成GraphQL,包括安装必要的NuGet包、创建GraphQL Schema、配置GraphQL服务等步骤。同时,文章还探讨了常见问题及其解决方法,如处理复杂查询、错误处理、性能优化和实现认证授权等,旨在帮助开发者构建灵活且高效的API。
28 3
|
9天前
|
开发框架 算法 中间件
ASP.NET Core 中的速率限制中间件
在ASP.NET Core中,速率限制中间件用于控制客户端请求速率,防止服务器过载并提高安全性。通过`AddRateLimiter`注册服务,并配置不同策略如固定窗口、滑动窗口、令牌桶和并发限制。这些策略可在全局、控制器或动作级别应用,支持自定义响应处理。使用中间件`UseRateLimiter`启用限流功能,并可通过属性禁用特定控制器或动作的限流。这有助于有效保护API免受滥用和过载。 欢迎关注我的公众号:Net分享 (239字符)
25 0
|
3月前
.NET 4.0下实现.NET4.5的Task类相似功能组件
【10月更文挑战第29天】在.NET 4.0 环境下,可以使用 `BackgroundWorker` 类来实现类似于 .NET 4.5 中 `Task` 类的功能。`BackgroundWorker` 允许在后台执行耗时操作,同时不会阻塞用户界面线程,并支持进度报告和取消操作。尽管它有一些局限性,如复杂的事件处理模型和不灵活的任务管理方式,但在某些情况下仍能有效替代 `Task` 类。
|
4月前
|
开发框架 监控 前端开发
在 ASP.NET Core Web API 中使用操作筛选器统一处理通用操作
【9月更文挑战第27天】操作筛选器是ASP.NET Core MVC和Web API中的一种过滤器,可在操作方法执行前后运行代码,适用于日志记录、性能监控和验证等场景。通过实现`IActionFilter`接口的`OnActionExecuting`和`OnActionExecuted`方法,可以统一处理日志、验证及异常。创建并注册自定义筛选器类,能提升代码的可维护性和复用性。
|
4月前
|
开发框架 .NET 中间件
ASP.NET Core Web 开发浅谈
本文介绍ASP.NET Core,一个轻量级、开源的跨平台框架,专为构建高性能Web应用设计。通过简单步骤,你将学会创建首个Web应用。文章还深入探讨了路由配置、依赖注入及安全性配置等常见问题,并提供了实用示例代码以助于理解与避免错误,帮助开发者更好地掌握ASP.NET Core的核心概念。
118 3
|
3月前
|
开发框架 JavaScript 前端开发
一个适用于 ASP.NET Core 的轻量级插件框架
一个适用于 ASP.NET Core 的轻量级插件框架