MASA Blazor 入门这一篇就够了

2022 年 3 月 22 日
本文字数：4775 字
阅读完需：约 16 分钟

1.什么是 Blazor? 有什么优势？

Blazor 是一个使用 Blazor 生成交互式客户端 Web UI 的框架：

使用 C# 代替 JavaScript 来创建信息丰富的交互式 UI。
共享使用 .NET 编写的服务器端和客户端应用逻辑。
将 UI 呈现为 HTML 和 CSS，以支持众多浏览器，其中包括移动浏览器。
与新式托管平台（如 Docker）集成。

Blazor 优势：

  1. 使用 C# 代替 JavaScript 来编写代码。  2. 利用现有的 .NET 库生态系统。  3. 在服务器和客户端之间共享应用逻辑。  4. 受益于 .NET 的性能、可靠性和安全性。  5. 在 Windows、Linux 和 macOS 上使用 Visual Studio 保持高效工作。  6. 以一组稳定、功能丰富且易用的通用语言、框架和工具为基础来进行生成。

复制代码

2.为什么选择 MASA Blazor？能用来干什么？

MASA Blazor 是一个基于 Blazor Component 和 Material Design 的 UI 组件库。dotNET 开发者不需要懂得 javascript 就能开发一个企业级中后台系统。MASA Blazor 优势：

丰富组件：包含 Vuetify 1:1 还原的基础组件，以及很多实用的预置组件和.Net 深度集成功能，包括 Url、面包屑、导航三联动，高级搜索，i18n 等。
UI 设计语言：设计风格现代，UI 多端体验设计优秀。
简易上手：丰富详细的上手文档，免费的视频教程（制作中）。
社区活跃鼓励：用户参与实时互动，做出贡献加入我们，构建最开放的开源社区。
长期支持：全职团队维护，并提供企业级支持。
专业示例：MASA Blazor Pro 提供多种常见场景的预设布局。

MASA Blazor Pro 预设布局示例：

看到这里是不是有同学对此感兴趣起来了呢！那么这样的布局页面是怎么构建出来的呢？我们自己能不能也搭建一个这样的布局呢！嘿嘿！不要着急、我们接着往下看。

3.使用 MASA Blazor 模板创建第一个 Blazor 程序

1.首先安装 Masa.Template 模板

（1）检查本机.Net SDK 版本，请确保已安装.NET6.0

（2）安装 Masa.Template 模板,包含 MASA 系列所有项目模板 dotnet new --install Masa.Template

2.创建项目

dotnet new masab -o MasaBlazorApp 默认为 Server 模式可通过参数--Mode WebAssembly 创建 WebAssembly 模式项目

3.配置 MASA Blazor（由于我这里使用了模板，以下配置在模板中都已经帮我们配好了，安装模板后直接 dotnet run 即可；未安装模板的同学，按下面步骤配置即可）

（1）安装 NuGet 包

dotnet add package Masa.Blazor

复制代码

（2）引入资源文件（我这里为 Blazor Server）

在 Pages/_Layout.cshtml 中引入资源文件

（3）注入相关服务

在 Program.cs 中添加 Masa.Blazor 相关服务

builder.Services.AddMasaBlazor();

复制代码

（4）修改 _Imports.razor 文件,添加以下内容:

  @using Masa.Blazor

复制代码

（5）运行项目

到这里一个简单的 MASA Blazor 项目就搭建完成啦。当然这只是最基础的，接下来我们将一步一步使用 MASA Blazor 项目组件来丰富我们的项目。

3.使用 MASA Blazor 组件配置项目

示例：

（1）Blazor 应用结构介绍

首先我们先来看看 Blazor 项目结构，分析主要几个文件的作用。（概念定义比较枯燥，想直接体验的同学可以直接跳过此部分，直接上手实践即可，但不推荐这么做，有句话说得好“磨刀不误砍柴工”

Program.cs

Blazor 服务器应用的入口点在 Program.cs 文件中定义，与控制台应用一样。当应用执行时，它会使用特定于 Web 应用的默认值创建并运行 Web 主机实例。 Web 主机会管理 Blazor 服务器应用的生命周期，并设置主机级别服务。
在 Blazor 服务器应用中，显示的 Program.cs 文件用于为 Blazor 在客户端浏览器与服务器之间使用的实时连接设置终结点。在 BlazorWebAssembly 应用中，Program.cs 文件定义应用的根组件及其呈现位置：

在 Program.cs 文件中我们先主要关注几个点：

1.在依赖注入中，因为我们利用了 Razor 来实现 C#和 html 的混合编码以及我们使用的是 ServerSide 的 Blazor，注入代码如下：

中间件如下：

_Host.cshtml

在 Blazor 服务器应用中，根组件的主机页面在_Host.cshtml 文件中定义。这个文件定义一个 Razor 页面，而不是一个组件。Razor Pages 使用 Razor 语法定义服务器可寻址页面。
在 Program.cs 文件中会自动去我们配置的_Host.cshtml 文件中寻找根组件这是默认使用 App 组件作为根组件（这是启动 Blazor 应用的必要条件之一）

那么 render-mode 特性是用来干什么的呢?让我们来看看官方文档解释：

App.razorBlazor 应用的根组件，里面通常包含 Router 组件用来处理 Blazor 中的路由

那么 Router 组件中的这些参数比如 AppAssembly、Found、NotFound 都有什么作用呢？

通过阅读官方文档我们可以发现：

Router 组件会在指定的 AppAssembly 和 AdditionalAssemblies（可选）中发现可路由组件。浏览器进行导航时，如果有路由与地址匹配，Router 会拦截导航并呈现其 Found 参数的内容和提取的 RouteData，否则 Router 会呈现其 NotFound 参数。
RouteView 组件负责呈现由 RouteData 指定的匹配组件及其布局（如果有）。如果匹配组件没有布局，则使用可选择指定的 DefaultLayout。
LayoutView 组件在指定布局内呈现其子内容

也就是说我们在配置完.razor 页面的路由后，Router 组件会在浏览器进行导航时将路由与地址匹配，能够匹配到的，Router 就会拦截导航并呈现其 Found 参数指定的匹配组件和布局（我们这里指定 MainLayout 布局页面），反之，则呈现 NotFound 参数。

_Layout.cshtml

在之前的_Host.cshtml 文件中我们默认指定启用了_Layout.cshtml 布局页

_Layout.cshtml 是 Blazor 应用的主机页（相当于一个根页面布局文件），里面包含应用的初始化 HTML 及其组件，它使得我们所有页面布局保持的外观变得更加的容易。

MainLayout.razor

在 Blazor 中，使用布局组件处理页面布局。布局组件继承自 LayoutComponentBase,后者定义类型 RenderFragment 的单个 Body 属性，该属性可用于呈现页面的内容。

_Imports.razor 全局导入配置，在这里使用 using 引入后，相当于在所有 razor 文件中都进行了引入。

好了，废话有点多, 到这里 Blazor 应用部分主要结构概念差不多已经介绍完了，感兴趣的同学可自行移步官网进行阅读面向 Web Forms ASP.NET Web Forms 开发人员的 Blazor接下来我们直接开始撸代码

（2）使用 App bars（应用栏）与 Navigation drawers（导航抽屉）配置导航栏与菜单栏

上述页面展示中我们看到了三个菜单页面，这几个页面都分别配置了对应路由 Home 对应页面为 Index.razor、路由为"/"

Counter 对应页面为 Counter.razor、路由为"/counter"

Fetch Data 页面对应 FetchData.razor 页面路由，路由为"/fetchdata"在 Shared/MainLayout.razor 页面中我们可以看到配置。

接下来我们直接移步MASA Blazor 官网地址找到我们需要的组件示例：

我们直接将示例代码拷贝至 Shared/MainLayout.razor 页面中的 MAppBar 组件中即可

dotnet run 看下效果

接下来我们 MASA Blazor 组件库中找到 Navigation drawers 组件，将 razor 页面代码与 C#代码拷贝至<MNavigationDrawer>组件中即可

我们对代码稍作修改

dotnet run 看下效果

下一步我们来实现动态菜单栏伸缩功能找到 Navigation drawers 组件的迷你模式

接下来我们来改造我们的代码

dotnet run 看下效果

是不是感觉超级简单呢！当然这只是入门写法，抛砖引玉，感兴趣的同学可以动手试试，举一反三解锁更多组件的用法与写法

（3）使用 DataTable、Dialog 等组件实现一个基础的数据交互页

首先我们先初始化 Fetch.razor，只留一个最简单<MDataTable>组件

DataTable 组件需要至少绑定一个 Headers（表头）和数据源所以下一步我们先定义 Headers 与 Items（实际调用 API 获取数据即可，这里默认死数据仅作参考）我们先建一个 Fetch.razor 页的分部类，定义部分代码

dotnet run 看看效果

在上述代码截图中会发现我们用到了 OnInitializedAsync()方法，那么这个方法是用来干什么的呢？说到这个问题，我们需要先了解了解 Razor 组件的生命周期ASP.NET Core Razor 组件生命周期

先来看个 Component lifecycle diagram（组件生命周期图）

SetParametersAsync - 设置参数时

每当父级呈现时，都会执行此方法。传入组件的参数包含在ParameterView中。这是根据传入组件的状态对服务器进行异步调用(例如)的好时机。在重写中调用base.SetParametersAsync(Parameters)时，会为组件的[Parameter]属性赋值。它也是指定默认参数值的正确位置。

OnInitialized / OnInitializedAsync - 组件初始化

将ParameterCollection中的状态分配给组件的[Parameter]属性后，将执行这些方法。这与SetParametersAsync的用法相同，不同之处在于可以使用组件的状态。

该方法仅在组件首次创建时执行一次。如果父级稍后更改组件的参数，则跳过此方法。注意：当组件是 @page，并且 Blazor 应用程序导航到呈现同一页面的新 URL 时，Blazor 将为该页面重用当前对象实例。因为该对象是同一实例，所以 Blazor 不会对该对象调用 IDisposable.Dispose，也不会再次执行其 OnInitialized 方法。

OnParametersSet / OnParametersSetAsync - 参数设置后

如果这是组件的新实例，则此方法将在OnInitializedAsync之后立即执行。如果它是因为其父组件正在重新呈现而正在重新呈现的现有组件，则不会执行OnInitialized*方法，而是在SetParametersAsync之后立即执行此方法。

OnAfterRender / OnAfterRenderAsync - 组件渲染后

这两个方法在 Blazor 每次重新生成组件的RenderTree时执行。这可能是因为组件的父级重新呈现、用户与组件交互(例如，鼠标单击)，或者如果组件执行其 StateHasChanged 方法来调用重新呈现。

了解 Razor 组件的生命周期后，我们来继续撸代码

我们给数据表格增加操作列

看下效果：

接下来我们给增加一个 MDialog 对话框用来做增加修改操作直接将官网的示例拿过来即可

在这过程中我们需要给 Dialog 组件以及组件中的其他组件使用 Bind-Value（双向绑定）绑上值。

接下来我们给数据表格的 Action 操作列增加 OnClick 点击事件

对应绑定分部类中 EditItem 方法

我们先运行看下效果：

这两个按钮分别对应<MCardActions>两个 Button

Close 直接绑定后台关闭 Dialog 方法

Save 方法则是用来做最终修改数据等操作 DB 的方法这里就不做演示，感兴趣的同学可自行结合业务做相应的操作。

（4）使用预置组件应对常用业务的场景

在我们实际项目中，难免会碰到需要你开发多个模块或者多个管理页面，这样一来每个页面不可避免的会有一些需要你重复编码的地方，那么你是选择每个页面 copy 一份相同的代码还是选择封装一个业务组件呢？毫无疑问，聪明的同学肯定会选择后者，当然新入门的同学可以先来看看 MASA Blazor 提供预置组件，拿来即用，后期同学们登堂入室后可自行根据当前业务封装业务组件。

我们先来看看通用页头预置组件：