blazor 狀態管理

blazor 狀態管理

想像一下,您正在填寫世界上最長的表格。您已經花了30分鐘時間輸入詳細信息,從地址到您的生日,再到最近訪問過的七個國家/地區的列表。您單擊“提交”按鈕,將立即獲得“連接已丟失”消息。

最后更新 2022/4/18 下午7:53
寒冰屋
预计阅读 11 分钟
分类
Blazor
标签
.NET Blazor 狀態管理

想像一下,您正在填寫世界上最長的表格。您已經花了 30 分鐘時間輸入詳細信息,從地址到您的生日,再到最近訪問過的七個國家/地區的列表。您單擊“提交”按鈕,將立即獲得“連接已丟失”消息。不用擔心,對吧?只需單擊“後退”按鈕,… 哦,不!表格是空的。這看起來很野蠻,並且你保證不再再次訪問該站點了。

這不是您希望網站訪問者獲得的體驗。因此,了解如何在 blazor 應用程式中管理狀態非常重要。在管理狀態的同時儘量減少管理狀態所必須編寫的代碼量?“是的,求你了!”

观看相关视频:Blazor Apps 中的状态管理

1 blazor 狀態的定義

首先,讓我們弄清楚 blazor 應用中的“狀態”是什麼意思。為了獲得最佳的用戶體驗,當最終用戶的連接暫時中斷,刷新或導航回到頁面時,為最終用戶提供一致的體驗非常重要。經驗的組成部分包括:

  • 表示用戶界面(ui)的 html 文檔對象模型(dom)
  • 表示頁面上正在輸入和/或輸出的數據的欄位和屬性
  • 作為頁面代碼的一部分運行的註冊服務的狀態

在没有任何特殊代码的情况下,根据Blazor 托管模型,将状态保存在两个位置。对于 Blazor WebAssembly(客户端)应用程序,状态保持在浏览器内存中,直到用户刷新或导航离开页面为止。在 Blazor Server 应用程序中,状态保存在分配给每个称为电路的每个客户端会话的特殊“存储桶”中。这些电路在断开连接后超时时可能会丢失状态,甚至在服务器处于内存压力下的活动连接过程中也可能消失。

2. 參考應用程式

为了说明状态的细微差别,我从Blazor Health App开始:

从 Angular 到 Blazor:The Health App

在 blazor 中構建示例應用程式,blazor 是基於.net 的框架,用於構建可在瀏覽器中運行的 web 應用程式,並利用 c#和 razor 模板生成跨平台的,兼容 html5 的 webassembly 代碼。

我將其擴展為包括兩個頁面,以說明導航的一些細微差別。在相關的 github 存儲庫中:

JeremyLikness/BlazorState

有幾個示例項目。問題在 blazor webassembly 和 blazor server 項目中的體現是不同的。

3. blazor webassembly 中的狀態

在 blazor webassembly(客戶端項目)中,狀態保存在內存中。這意味著刷新或強制導航將破壞狀態。要查看實際效果:

  1. 设置BlazorState.Wasm为启动项目并运行它。
  2. 更新表單信息。
  3. 導航到“結果”並驗證是否存在相同的結果。
  4. 导航回“主页”并强制刷新(通常为CTRL+F5)。请注意该窗体还原为默认值。
  5. 更新表单信息,然后通过添加/results到浏览器中的 URL 栏来手动导航,然后按ENTER。请注意,它也使用默认值。

不好的經歷!與 blazor server 相比,它略有不同。

4. blazor 伺服器中的狀態

将启动项目更改为BlazorState.Server并运行该项目。请尝试执行与客户端版本相同的步骤,并注意保持了状态,因为该状态保存在服务器内存中。打开应用程序后,停止并重新启动 Web 服务器。您应该看到一个断开连接消息。服务器重新启动后,单击“重新加载”选项,请注意,尽管应用程序已恢复,但它会丢失所有状态。

現在我們有一個問題。讓我們來研究解決方案!

5. 解決方案架構

以下解决方案使用一种旨在最大化重用性的体系结构方法。Blazor.ViewModel 项目托管该应用程序的界面、属性和业务逻辑。它是Model-View-ViewModel(MVVM)模式的.NET Standard 库实现,可以从 WPF,Xamarin 甚至 Blazor 的任何类型的.NET Core 项目轻松引用。最大程度的重用!

对于 UI 和用户体验逻辑,以及可共享资产(例如图像,样式表,JavaScript 代码甚至 Razor 视图组件),Blazor.Shared都利用Razor类库。该解决方案实现了 HealthModelBase 避免重复的 MVVM 代码的功能。它还将此处描述的所有状态管理解决方案实现为可轻松应用于 Blazor WebAssembly 和 Blazor Server 项目的服务和/或组件。由于“宿主”项目仅提供一些结构来引用共享组件和资源,因此这进一步使代码重用最大化。

現在,我已經解決了問題和解決方案的方法,讓我們繼續在 blazor 應用程式中管理狀態!

6. 服務註冊

第一步可能并不那么明显,但是为了全面起见,我想介绍服务。要查看实际效果,请创建一个新的 Blazor 客户端应用程序并运行它。内置模板为几个页面提供了简单的导航。导航到Counter页面并增加计数器。现在,离开页面浏览并返回。计数器重置为零!这是因为计数器的状态保留在组件中,因此每次初始化组件时都会将其重置:

<h1>Counter</h1>
<p>Current count: @currentCount</p>
<button class="btn btn-primary" @onclick="IncrementCount">Click me</button>
private int currentCount = 0;
private void IncrementCount()
{
    currentCount++;
}

要維持“內存中”(或 blazor 伺服器“電路中”)狀態,可以創建計數器“服務”:

public class CounterService
{
    public int Count { get; private set; }
    public void Increment()
    {
        Count += 1;
    }
}

Startup.cs以下位置注册服务:

public void ConfigureServices(IServiceCollection services)
{
    services.AddSingleton<CounterService, CounterService>();
}

…然后删除@code块中的代码Counter.razor,注入计数器服务并直接进行数据绑定:

@inject CounterService Svc
<h1>Counter</h1>
<p>Current count: @Svc.Count</p>
<button class="btn btn-primary" @onclick="Svc.Increment">Click me</button>

當組件被銷毀/重新創建時,該服務將保留在內存中,即使在導航時也保持一致的計數。這是維持狀態的第一步。參考應用程式以此方式註冊主視圖模型。

7. 瀏覽器緩存

维护状态的一种方法是使用HTML5 Web Storage来利用浏览器缓存。该 API 非常简单。BlazorState.Shared中的stateManagement.js文件定义了一个简单的,可全局访问的界面。它使用localStorage JavaScript API,但您可以选择使用sessionStorage

window.stateManager = {
    save: function (key, str) {
        localStorage[key] = str;
    },
    load: function (key) {
        return localStorage[key];
    }
};

它包含在 Blazor WebAssembly 项目的index.html和 Blazor Server 项目的_Host.cshtml的根目录中。包括共享资产(shared assets)就像使用路径一样简单:

<script src="_content/BlazorState.Shared/stateManagement.js"></script>

Blazor 的组件模型使创建用于管理状态更改的“包装器”组件变得简单。这是在StorageHelper.razor中实现的。首先,using 语句引用视图模型,JavaScript 互操作性和 JSON 序列化程序。实现被注入。

@using Microsoft.JSInterop; @using System.Text.Json; @inject IJSRuntime
JsRuntime @inject IHealthModel Model

模板只是包裝子組件,並在加載狀態時呈現它們。

@if (hasLoaded) { @ChildContent } else {
<p>Loading...</p>
}

初始化組件後,代碼嘗試從緩存中加載視圖模型:

string vm;
try
{
    vm = await JsRuntime.InvokeAsync<string>("stateManager.load", nameof(HealthModel));
}
catch(InvalidOperationException)
{
    return;
}

在 Blazor 服务器中,组件已在服务器上预渲染。JavaScript 不可用,因此 interop 调用将抛出InvalidOperationException。这是第一次被发现。第二个调用是从客户端进行的,并且如果缓存了 viewmodel,它将成功。从高速缓存加载视图模型的 JSON 后,将对其进行反序列化,并将属性移至全局视图模型实例。

var viewModel = JsonSerializer.Deserialize<HealthModel>(vm);
if (viewModel != null)
{
    isDeserializing = true;
    Model.AgeYears = viewModel.AgeYears;
    Model.HeightInches = viewModel.HeightInches;
    Model.IsFemale = viewModel.IsFemale;
    Model.IsImperial = viewModel.IsImperial;
    Model.WeightPounds = viewModel.WeightPounds;
    isDeserializing = false;
}

isDeserializing标志对于避免无限循环很重要,正如您在下一个注册属性更改通知的代码中所看到的:

Model.PropertyChanged += async (o, e) =>
{
    if (isDeserializing)
    {
        return;
    }
    var vmStr = JsonSerializer.Serialize(((HealthModel)Model));
    await JsRuntime.InvokeAsync<object>(
        "stateManager.save", nameof(HealthModel), vmStr);
};
hasLoaded = true;

如果视图模型上的属性发生更改,则视图模型将被序列化并存储在缓存中。当由于初始加载而触发了属性更改时,将跳过此操作(因此会出现该isDeserializing标志,否则它将在尝试反序列化时进行序列化)。现在该组件可以使用了!Blazor.ServerLocalBlazor.WasmLocal都是的帮助类,它在App.razor中的实现方式相同:

<BlazorState.Shared.StorageHelper>
  <Router AppAssembly="@typeof(Program).Assembly">
    <Found Context="routeData">
      <RouteView RouteData="@routeData" DefaultLayout="@typeof(MainLayout)" />
    </Found>
    <NotFound>
      <LayoutView Layout="@typeof(MainLayout)">
        <p>Sorry, there's nothing at this address.</p>
      </LayoutView>
    </NotFound>
  </Router>
</BlazorState.Shared.StorageHelper>

通過包裝路由器,狀態管理無需編寫其他代碼即可處理應用程式中的所有頁面和組件。您可以打開瀏覽器開發人員工具並導航到應用程式“本地存儲”,以觀察值在更新表單時的變化。

重要的是要注意,用户可以访问其本地缓存,因此,如果您要存储敏感值,则应对它们进行加密。Microsoft.ASpNetCore.ProtectedBrowserStorage包提供了一个示例。

8. 伺服器端管理

处理状态的另一种方法是调用 API 并将其持久保存在服务器上。它的持久性取决于您:选择范围从 SQL,NoSQL 到简单的缓存(例如 Redis)。BlazorState.WasmRemote.Server是 ASP.NET 托管的 Blazor WebAssembly 应用程序。该StateController公开一个 API,它存储和检索使用的远程 IP 地址作为密钥对视图模型。这样做是为了保持演示简单。具有身份验证的生产应用程序可能会锁定用户和/或会话。

Blazor.Shared中的StateService处理 API 调用。构造函数接受全局 viewmodel 实例,提供 API 端点 URL 的IStateServiceConfig实例和HttpClient的实例。注入HttpClient而不是创建新实例非常重要,因为 Blazor WebAssembly 需要专门配置为在浏览器沙箱中运行的版本。构造函数从视图模型注册属性更改通知。

在初始化期间由页面组件调用InitAsync以加载视图模型状态。

public async Task InitAsync()
{
    _initializing = true;
    var vmJson = await _client.GetStringAsync(_config.Url);
    var vm = JsonSerializer.Deserialize<HealthModel>(vmJson, _options);
    _model.AgeYears = vm.AgeYears;
    _model.HeightInches = vm.HeightInches;
    _model.IsFemale = vm.IsFemale;
    _model.IsMetric = vm.IsMetric;
    _model.WeightPounds = vm.WeightPounds;
    _initializing = false;
}

該代碼與客戶端緩存方法非常相似,但是從 api 調用而不是本地緩存中檢索模型。屬性更改處理程式序列化模型並將模型發布到伺服器:

private async void Model_PropertyChanged(object sender,
    System.ComponentModel.PropertyChangedEventArgs e)
{
    if (_initializing || _config == null)
    {
        return;
    }
    var vm = JsonSerializer.Serialize(_model);
    var content = new StringContent(vm);
    content.Headers.ContentType = new MediaTypeHeaderValue("application/json");
    await _client.PostAsync(_config.Url, content);
}

设置BlazorState.WasmRemote.Server为启动项目并运行它以查看实际效果。您可能需要更新在.Client项目中IStateServiceConfigStartup.cs实现中的正确 URL(因为端口可能不同)。在运行解决方案的情况下,打开“网络”选项卡,并在更新表单时记下调用。

該服務已針對 blazor webassembly 進行了演示,但與 blazor server 相同。

9. 結論

Blazor 对您如何管理状态没有意见。服务和组件模型使实现项目范围的解决方案变得容易。这篇文章着重于 Model-View-ViewModel 模式的实现,并注册了属性更改通知以处理本地或通过 API 的序列化状态。如果您使用诸如Redux之类的不同方法,则相同的方法将起作用。重要的步骤是在属性发生变化时更新商店,并在组件初始化时从状态管理解决方案加载。剩下的就是浏览器的历史记录!

查看有关ASP.NET Core Blazor 状态管理的官方文档。

Keep Exploring

延伸阅读

更多文章
同分类 / 同标签 2024/2/29

winform中也可以這樣做數據展示

在做winform開發的過程中,經常需要做數據展示的功能,之前一直使用的是gridcontrol控制項,今天想通過一個示例,跟大家居間一下如何在winform blazor hybrid中使用ant design blazor中的table組件做數據展示。

继续阅读
同分类 / 同标签 2024/2/29

winform的界面也可以變好看?

前幾天跟大家居間了在winform中使用blazor hybrid,而且還說配上blazor的ui可以讓我們的winform程式設計的更加好看,接下來我想以一個在winform blazor hybrid中繪圖的例子來進行說明,希望對你有所幫助。

继续阅读
同分类 / 同标签 2024/1/7

碼坊“文章標題url別名生成器”上線

碼坊是站長新開的一個提供網頁在線工具、跨平台桌面和手機應用的開源項目。站長將終致力於為你帶來更高效、更便捷的使用體驗。今天,站長榮幸地推出“文章標題url別名生成器”,幫助你輕鬆創建文章標題的url別名,提升seo效果和用戶體驗。快來碼坊,探索更多實用工具吧!

继续阅读