循序漸進介紹基於CommunityToolkit.Mvvm 和HandyControl的WPF應用端開發(2)

来源:https://www.cnblogs.com/wuhuacong/archive/2023/09/11/17687905.html
-Advertisement-
Play Games

在前面隨筆《循序漸進介紹基於CommunityToolkit.Mvvm 和HandyControl的WPF應用端開發(1)》中介紹了Mvvm 的開發，以及一些界面效果，本篇隨筆繼續深入探討基於CommunityToolkit.Mvvm 和HandyControl的WPF應用端開發，介紹如何整合Sql... ...


在前面隨筆《循序漸進介紹基於CommunityToolkit.Mvvm 和HandyControl的WPF應用端開發(1)》中介紹了Mvvm 的開發，以及一些界面效果，本篇隨筆繼續深入探討基於CommunityToolkit.Mvvm 和HandyControl的WPF應用端開發，介紹如何整合SqlSugar框架的基礎介面，通過基類繼承的方式，簡化實際項目的開發代碼處理。

1、View模塊中的XAML格式說明

在介紹MVVM幾個部分內容之前，我們先連接一下View模塊中的Xaml格式的說明，我們知道Xaml也是一個xml的擴展，屬於標記語言的一種，編輯器為了更好的驗證格式以及提出上下文的智能提示，必然需要確定對應標記元素的格式，這個就是通過Xaml的頭部定義確立了，如下所示。

<Page
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
    xmlns:local="clr-namespace:WHC.SugarProject.WpfUI.Views.Pages"

    x:Class="WHC.SugarProject.WpfUI.Views.Pages.UserListPage"
    d:DataContext="{d:DesignInstance local:UserListPage,
                                     IsDesignTimeCreatable=False}"
    d:DesignHeight="450"
    d:DesignWidth="800"
    mc:Ignorable="d">

其中紅色部分基本上是約定需要輸入的定義了，主要是通過xmlns來定義定義XML的校驗格式，類似我們常用的命名空間的引用地址了。

    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"

而下麵 xmlns:local 也是定義了本地的XML命名空間。

xmlns:local="clr-namespace:WHC.SugarProject.WpfUI.Views.Pages"

便於在界面元素標記中引用對應的控制項等。而x:Class則是確定XAML的後臺代碼文件的全名稱，使用過早期ASPX的都知道，ASPX文件有一個後臺代碼文件，同理XAML也是類似的概念。

x:Class="WHC.SugarProject.WpfUI.Views.Pages.UserListPage"

而d:開始的那些設置，是指設計樣式下的一些屬性定義，如下所示定義設計窗體的大小，實際運行可能和這個不一樣，因為WPF是屬於矢量的尺寸標記的。

    d:DesignHeight="450"
    d:DesignWidth="800"

而d:DataContext則是聲明View和模型綁定的一個重要的說明，界面視圖View可以綁定模型的命令Command，也可以綁定對應的集合或者屬性等。其中local:UserListPage，就是通過簡寫命名控制項local和UserListPage類的組合，實現一個全名稱的快速定義。而IsDesignTimeCreatable則是說明設計狀態下的數據處理方式。

    d:DataContext="{d:DesignInstance local:UserListPage,
                                     IsDesignTimeCreatable=False}"

有時候，我們可能在視窗或者頁面視圖的定義中，還會看到一些其他命名空間的定義或者屬性的定義，如下代碼所示。

<Page
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
    xmlns:local="clr-namespace:WHC.SugarProject.WpfUI.Views.Pages"

    xmlns:ui="http://schemas.lepo.co/wpfui/2022/xaml"
    xmlns:helpers="clr-namespace:WHC.SugarProject.WpfUI.Helpers"
    xmlns:hc="https://handyorg.github.io/handycontrol"
    xmlns:Controls="clr-namespace:WHC.SugarProject.WpfUI.Controls"

    x:Class="WHC.SugarProject.WpfUI.Views.Pages.UserListPage"
    d:DataContext="{d:DesignInstance local:UserListPage,
                                     IsDesignTimeCreatable=False}"
    d:DesignHeight="450"
    d:DesignWidth="800"
    mc:Ignorable="d">

例如上面的紅色部分，就是一般根據實際情況增加的一些控制項的命名空間的定義，便於引用對應的界面控制項進行使用。

<hc:UniformSpacingPanel
    Margin="0,0,0,20"
    HorizontalAlignment="Right"
    Orientation="Horizontal"
    Spacing="10">
    <Button
        Width="60"
        Height="40"
        Command="{Binding SaveCommand}"
        Content="保存"
        Style="{StaticResource ButtonPrimary}" />
    <Button
        Width="60"
        Height="40"
        Command="{Binding ViewModel.BackCommand}"
        CommandParameter="test"
        Content="關閉" />
</hc:UniformSpacingPanel>

有時候可能還會看到一些屬性設置，如背景色，以及是否滾動頁面等設置。

    Background="{DynamicResource RegionBrush}"
    ScrollViewer.CanContentScroll="true"

 

2、MVVM應用中包括Model、View、ViewModel三者內容中的處理

 前面我們見到，View視圖中綁定ViewModel模型的時候，使用d:DataConext進行定義設置，確定視圖模型的內容，我們剛纔介紹的定義是如下所示。

    d:DataContext="{d:DesignInstance local:UserListPage,
                                     IsDesignTimeCreatable=False}"

這裡你看到的它映射向其本身，而非具體的Viewmodel，這裡沒有錯誤，有些MVVM的設置指向具體的ViewModel定義。

我們來看看這個UserListPage的後端類的定義，如下所示。

首先我們看到一個如下所示。

namespace WHC.SugarProject.WpfUI.Views.Pages;

/// <summary>
/// UserListPage.xaml 交互邏輯
/// </summary>
public partial class UserListPage : INavigableView<UserListViewModel>
{
    /// <summary>
    /// 視圖模型對象
    /// </summary>
    public UserListViewModel ViewModel { get; }

    /// <summary>
    /// 構造函數
    /// </summary>
    /// <param name="viewModel">視圖模型對象</param>
    public UserListPage(UserListViewModel viewModel)
    {
        ViewModel = viewModel;
        DataContext = this;

        InitializeComponent();
    }
}

這裡通過泛型介面的方式，定義一個具體類型的視圖模型給視圖View使用。

其中INavigableView介面的定義如下。

public interface INavigableView<out T>
{
    /// <summary>
    /// 視圖的 ViewModel
    /// </summary>
    T ViewModel { get; }
}

這樣我們在Xaml視圖裡面，就可以綁定屬性，也可以綁定相應的Command命令了，可以是類的，也可以是ViewModel的內容。

例如我們在綁定查詢條件處理數據查詢的操作的時候，

 其中界面查詢條件定義了一個文本框名稱的控制項，如下所示。

<TextBox
    Margin="5"
    hc:TitleElement.Title="用戶賬號"
    hc:TitleElement.TitlePlacement="Left"
    Style="{StaticResource TextBoxExtend}"
    Text="{Binding ViewModel.PageDto.Name, UpdateSourceTrigger=PropertyChanged}">
    <TextBox.InputBindings>
        <KeyBinding Key="Enter" Command="{Binding ViewModel.SearchCommand}" />
    </TextBox.InputBindings>
</TextBox>

我們通過 {Binding ViewModel.PageDto.Name, UpdateSourceTrigger=PropertyChanged} 的方式綁定文本的界面顯示內容和後端模型屬性的，並且在綁定的控制項屬性變化的時候觸發更新。這樣只要界面上輸入的內部發生變化，後端綁定的查詢屬性馬上得到更新，我們就可以即時的通過查詢觸發獲得相應條件的記錄了。

另外通過 InputBindings 的方式，接收Enter內容後馬上觸發查詢處理的命令。

查詢的時候，我們在視圖模型上定義一個RelayCommand的特性標註，聲明這個生成的Command為視圖提供處理命令的。

    /// <summary>
    /// 觸發查詢處理命令
    /// </summary>
    /// <returns></returns>
    [RelayCommand]
    private async Task Search()
    {
        //切換第一頁
        this.PagerInfo.CurrentPageIndex = 1;

        //轉換下分頁信息
        ConvertPagingInfo();
        //查詢更新
        await GetData();
    }

然後我們通過轉換分頁條件的信息，獲得查詢條件後進行服務介面的調用，獲取相應條件的數據即可。

這個介面的後端就是SqlSugar框架的標準請求介面了。

    /// <summary>
    /// 根據分頁和查詢條件查詢，請求數據
    /// </summary>
    /// <returns></returns>
    public virtual async Task GetData()
    {
        var result = await service.GetListAsync(this.PageDto);
        if (result != null)
        {
            this.Items = result.Items?.ToList();
            this.PagerInfo.RecordCount = result.TotalCount;
        }
    }

我們看到，由於框架的通用性抽象處理，因此上面的介面應該是可以實現更高層次的抽象處理的，因此我們設計了幾個視圖基類，用於減少代碼的處理。

 其中 ObservableObject 基類是CommunityToolkit.Mvvm模塊裡面定義的視圖模型基類，我們定義的通用基類也是基於它繼承過來即可。

其中BaseViewModel用來處理一些通用的視圖模型操作方式，如跳轉或者返回等。

而BaseListViewModel則是根據查詢列表處理的操作界面所需要的視圖模型處理封裝。

我們看到類定義和我們SqlSugar很多基類定義類似，都是需要通過泛型傳入一些相關的參數，實現更加通用的控制的。

public abstract partial class BaseListViewModel<TEntity, TKey, TGetListInput> : BaseViewModel, INavigationAware
        where TEntity : class, IEntity<TKey>, new()
        where TGetListInput : IPagedAndSortedResultRequest, new()

由於.net的開發方式，現在基本上都是以介面註入方式來處理，這個也是一樣，我們通過註入一個常規服務介面的類，來實現一些常規的請求處理。視圖模型類的介面註入如下所示。

    /// <summary>
    /// 通用基礎操作介面
    /// </summary>
    protected IMyCrudService<TEntity, TKey, TGetListInput> service { get; set; }

    /// <summary>
    /// 構造函數
    /// </summary>
    /// <param name="service">操作介面</param>
    /// <param name="navigationService">視圖導航服務介面</param>
    public BaseListViewModel(IMyCrudService<TEntity, TKey, TGetListInput> service)
    {
        this.service = service;
    }

這樣我們在分頁控制項的頁碼變化的時候，就可以觸發這個基類的命令處理了。

    /// <summary>
    /// 觸發的分頁處理命令
    /// </summary>
    /// <param name="info"></param>
    /// <returns></returns>
    [RelayCommand]
    private async Task PageUpdated(FunctionEventArgs<int> info)
    {
        //根據分頁頁碼展示
        this.PagerInfo.CurrentPageIndex = info.Info;

        //轉換下分頁信息
        ConvertPagingInfo();
        //查詢更新
        await GetData();
    }

它的分頁控制項部分的視圖界面的代碼如下所示。

<hc:Pagination
    Margin="0,10,0,10"
    DataCountPerPage="{Binding ViewModel.PagerInfo.PageSize}"
    IsJumpEnabled="True"
    MaxPageCount="{Binding ViewModel.PagerInfo.MaxPageCount}"
    MaxPageInterval="5"
    PageIndex="{Binding ViewModel.PagerInfo.CurrentPageIndex}">
    <hc:Interaction.Triggers>
        <hc:EventTrigger EventName="PageUpdated">
            <hc:EventToCommand Command="{Binding ViewModel.PageUpdatedCommand}" PassEventArgsToCommand="True" />
        </hc:EventTrigger>
    </hc:Interaction.Triggers>
</hc:Pagination>

而我們查詢命令，也可以通過下麵的基類函數來處理了。

    /// <summary>
    /// 觸發查詢處理命令
    /// </summary>
    /// <returns></returns>
    [RelayCommand]
    private async Task Search()
    {
        //切換第一頁
        this.PagerInfo.CurrentPageIndex = 1;

        //轉換下分頁信息
        ConvertPagingInfo();
        //查詢更新
        await GetData();
    }

這樣我們在前面介紹的文本框的TextBox的InputBindings處理就可以直接使用這個RelayCommand聲明的命令函數了。

    <TextBox.InputBindings>
        <KeyBinding Key="Enter" Command="{Binding ViewModel.SearchCommand}" />
    </TextBox.InputBindings>

當然，這個基類裡面還可以定義其他通用用到的一些常規處理，如導入導出、刪除和批量刪除等常規的介面。

而我們在這個用戶業務模型裡面所需要做的就是做一下繼承關係的處理即可，如下代碼所示。

namespace WHC.SugarProject.WpfUI.ViewModels;

/// <summary>
/// 用戶列表-視圖模型對象
/// </summary>
public partial class UserListViewModel : BaseListViewModel<UserInfo, int, UserPagedDto>
{
    /// <summary>
    /// 構造函數
    /// </summary>
    /// <param name="service">業務服務介面</param>
    public UserListViewModel(IUserService service) : base(service)
    {
    }
}

這樣 UserListViewModel 就具有了一些通用的業務處理對象和命令了，包括常規的查詢、刪除、批量刪除、導入、導出的處理，都可以了。

同理，對於編輯具體單個記錄的處理，我們也可以使用通用的抽象業務類封裝來實現，如下代碼所示。

/// <summary>
/// 用戶新增、編輯-視圖模型
/// </summary>
public partial class UserEditViewModel : BaseEditViewModel<UserInfo, int, UserPagedDto>
{
    /// <summary>
    /// 構造函數
    /// </summary>
    /// <param name="service"></param>
    public UserEditViewModel(IUserService service) : base(service)
    {
        this.Title = "用戶信息";
    }
}

至此，整個視圖模型ViewModel的繼承關係如下所示。對於不同的業務類，我們也只需要根據實際情況，生成對應的業務視圖模型類即可。

DataGrid列表展示的處理代碼，主要就是基類觸發查詢更新後，屬性ViewModel.Items 的記錄獲得更新，這樣DataGrid就可以順利的顯示對應的數據了，如下界面所示。

 

3、界面的統一處理和代碼生成處理

對於界面上的處理，我們常規的列表和編輯/新增界面，基本上可以滿足大多數的要求，如下是列表界面的效果，包括查詢條件、常規處理按鈕、列表展示、分頁信息展示等幾個部分，如下所示。

 對於一些編輯界面，也是類似下麵的佈局即可。

 當然可以根據資料庫欄位進行設置展示那些輸入信息最好了。如對於系統參數設置模塊的信息，我們界面如下所示。

 這些內容相對比較標準和統一，可以結合資料庫表信息使用統一的方式快速生成即可，因此我把它的生成規則結合到我們的代碼生成工具（Database2Sharp）中進行生成處理，通過選擇那些欄位來實現更加精確的界面處理。

 視圖界面代碼如下所示，包括Xaml和後端類的代碼。

 對應有兩個視圖模型ViewModel的繼承類。

 這樣實現，可以極大程度的減少子類的代碼，以及通過代碼生成工具快速定義生成的方式，又可以極大的提高開發效率，雙管齊下，可以提高整個項目的開發效率。

專註於代碼生成工具、.Net/.NetCore 框架架構及軟體開發，以及各種Vue.js的前端技術應用。著有Winform開發框架/混合式開發框架、微信開發框架、Bootstrap開發框架、ABP開發框架、SqlSugar開發框架等框架產品。
  轉載請註明出處：撰寫人：伍華聰  http://www.iqidi.com 
    
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Spring Cloud Gateway：新一代微服務 API 網關，用起來真優雅！
    1.網關介紹 如果沒有網關，難道不行嗎？功能上是可以的，我們直接調用提供的介面就可以了。那為什麼還需要網關？ 因為網關的作用不僅僅是轉發請求而已。我們可以試想一下，如果需要做一個請求認證功能，我們可以接入到 API 服務中。但是倘若後續又有服務需要接入，我們又需要重覆接入。這樣我們不僅代碼要重覆編寫 ...
  • 記一次 Redisson 線上問題 → ERR unknown command 'WAIT' 的排查與分析
    開心一刻 昨晚和一個朋友聊天 我：處對象嗎，咱倆試試？ 朋友：我有對象 我：我不信，有對象不公開？ 朋友：不好公開，我當的小三 問題背景 程式在生產環境穩定的跑著 直到有一天，公司執行組件漏洞掃描，有漏洞的 jar 要進行升級修複 然後我就按著掃描報告將有漏洞的 jar 修複到指定的版本 自己在開發 ...
  • Unity 性能優化Shader分析處理函數：ShaderUtil.GetShaderGlobalKeywords用法
    Unity 性能優化Shader分析處理函數：ShaderUtil.GetShaderGlobalKeywords用法 點擊封面跳轉下載頁面 簡介 Unity 性能優化Shader分析處理函數：ShaderUtil.GetShaderGlobalKeywords用法 在Unity開發中，性能優化是一 ...
  • C# try catch 使用
    try catch使用場景： 1. 一般線上程，委托中使用， 線上程與委托中使用是因為，如果線程和委托中出現異常在程式外部是捕獲不到的，需要在內部做單獨處理。 2. 程式的外層使用，比如程式的入口處加一個全局異常捕獲，這樣整個程式發生的異常都可以捕獲到。 3. 在事件或者主體方法中使用，一些小的公共 ...
  • .NET C#基礎（9）：資源釋放 - 需要介入的資源管理
    1. 什麼是IDisposable？ IDisposable介面是一個用於約定可進行釋放資源操作的介面，一個類實現該介面則意味著可以使用介面約定的方法Dispose來釋放資源。其定義如下： public interface IDisposable { void Dispose(); } 上述描述中可 ...
  • iNeuOS工業互聯網操作系統V5，視圖建模（WEB組態）升級
    針對工業來講，特殊是流程行業，視圖建模（Web組態）是必不可少應用場景，因為有很多工序要直觀的展示工藝流程圖。該功能也廣泛應用在：鋼鐵、煤炭、水務、中醫葯、能源、航天、加工製造、風電、儲能等領域。 ...
  • 【23種設計模式】組合模式（八）
    前言 組合模式，英文名稱是：Composite Pattern。當我們談到這個模式的時候，有一個物件和這個模式很像，也符合這個模式要表達的意思，那就是“俄羅斯套娃”。“俄羅斯套娃”就是大的瓷器娃娃裡面裝著一個小的瓷器娃娃，小的瓷器娃娃裡面再裝著更小的瓷器娃娃，直到最後一個不能再裝更小的瓷器娃娃的那個 ...
  • C#為什麼非要把函數叫方法？
    引子 "某呼"網友提問“C#為什麼非要把函數叫方法？”，看到這個問題還真不知道怎麼回答。要想知道C#為什麼叫方法，還得從傳統面向過程語言說起。 方法的由來 函數（function）是面向過程編程語言里，對可以獨立調用代碼段的另一種叫法，因為通常有數個輸入和一個輸出，很像數學里的那個函數。比如C語言中 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類