循序渐进介绍基于CommunityToolkit.Mvvm 和HandyControl的WPF应用端开发(2)--视图模型的基类设计

在前面随笔《循序渐进介绍基于CommunityToolkit.Mvvm 和HandyControl的WPF应用端开发(1)》中介绍了Mvvm 的开发，以及一些界面效果，本篇随笔继续深入探讨基于CommunityToolkit.Mvvm 和HandyControl的WPF应用端开发，介绍如何整合SqlSugar框架的基础接口，通过基类继承的方式，简化实际项目的开发代码处理。

1、View模块中的XAML格式说明

在介绍MVVM几个部分内容之前，我们先连接一下View模块中的Xaml格式的说明，我们知道Xaml也是一个xml的扩展，属于标记语言的一种，编辑器为了更好的验证格式以及提出上下文的智能提示，必然需要确定对应标记元素的格式，这个就是通过Xaml的头部定义确立了，如下所示。

ini 复制代码

<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的校验格式，类似我们常用的命名空间的引用地址了。

ini 复制代码

    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命名空间。

ini 复制代码

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

便于在界面元素标记中引用对应的控件等。而x:Class则是确定XAML的后台代码文件的全名称，使用过早期ASPX的都知道，ASPX文件有一个后台代码文件，同理XAML也是类似的概念。

ini 复制代码

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

而d:开始的那些设置，是指设计样式下的一些属性定义，如下所示定义设计窗体的大小，实际运行可能和这个不一样，因为WPF是属于矢量的尺寸标记的。

ini 复制代码

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

而d:DataContext则是声明View和模型绑定的一个重要的说明，界面视图View可以绑定模型的命令Command，也可以绑定对应的集合或者属性等。其中local:UserListPage，就是通过简写命名控件local和UserListPage类的组合，实现一个全名称的快速定义。而IsDesignTimeCreatable则是说明设计状态下的数据处理方式。

ini 复制代码

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

有时候，我们可能在窗口或者页面视图的定义中，还会看到一些其他命名空间的定义或者属性的定义，如下代码所示。

ini 复制代码

<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">

例如上面的红色部分，就是一般根据实际情况增加的一些控件的命名空间的定义，便于引用对应的界面控件进行使用。

ini 复制代码

<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>

有时候可能还会看到一些属性设置，如背景色，以及是否滚动页面等设置。

ini 复制代码

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

2、MVVM应用中包括Model、View、ViewModel三者内容中的处理

前面我们见到，View视图中绑定ViewModel模型的时候，使用d:DataConext进行定义设置，确定视图模型的内容，我们刚才介绍的定义是如下所示。

ini 复制代码

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

这里你看到的它映射向其本身，而非具体的Viewmodel，这里没有错误，有些MVVM的设置指向具体的ViewModel定义。

我们来看看这个UserListPage的后端类的定义，如下所示。

首先我们看到一个如下所示。

csharp 复制代码

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接口的定义如下。

csharp 复制代码

public interface INavigableView<out T>
{
    /// <summary>
    /// 视图的 ViewModel
    /// </summary>
    T ViewModel { get; }
}

这样我们在Xaml视图里面，就可以绑定属性，也可以绑定相应的Command命令了，可以是类的，也可以是ViewModel的内容。

例如我们在绑定查询条件处理数据查询的操作的时候，

其中界面查询条件定义了一个文本框名称的控件，如下所示。

ini 复制代码

<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为视图提供处理命令的。

csharp 复制代码

    /// <summary>
    /// 触发查询处理命令
    /// </summary>
    /// <returns></returns>
    [RelayCommand]
    private async Task Search()
    {
        //切换第一页
        this.PagerInfo.CurrentPageIndex = 1;

        //转换下分页信息
        ConvertPagingInfo();
        //查询更新
        await GetData();
    }

然后我们通过转换分页条件的信息，获得查询条件后进行服务接口的调用，获取相应条件的数据即可。

这个接口的后端就是SqlSugar框架的标准请求接口了。

csharp 复制代码

    /// <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很多基类定义类似，都是需要通过泛型传入一些相关的参数，实现更加通用的控制的。

csharp 复制代码

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

由于.net的开发方式，现在基本上都是以接口注入方式来处理，这个也是一样，我们通过注入一个常规服务接口的类，来实现一些常规的请求处理。视图模型类的接口注入如下所示。

csharp 复制代码

    /// <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;
    }

这样我们在分页控件的页码变化的时候，就可以触发这个基类的命令处理了。

csharp 复制代码

    /// <summary>
    /// 触发的分页处理命令
    /// </summary>
    /// <param name="info"></param>
    /// <returns></returns>
    [RelayCommand]
    private async Task PageUpdated(FunctionEventArgs<int> info)
    {
        //根据分页页码展示
        this.PagerInfo.CurrentPageIndex = info.Info;

        //转换下分页信息
        ConvertPagingInfo();
        //查询更新
        await GetData();
    }

它的分页控件部分的视图界面的代码如下所示。

ini 复制代码

<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>

而我们查询命令，也可以通过下面的基类函数来处理了。

csharp 复制代码

    /// <summary>
    /// 触发查询处理命令
    /// </summary>
    /// <returns></returns>
    [RelayCommand]
    private async Task Search()
    {
        //切换第一页
        this.PagerInfo.CurrentPageIndex = 1;

        //转换下分页信息
        ConvertPagingInfo();
        //查询更新
        await GetData();
    }

这样我们在前面介绍的文本框的TextBox的InputBindings处理就可以直接使用这个RelayCommand声明的命令函数了。

xml 复制代码

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

当然，这个基类里面还可以定义其他通用用到的一些常规处理，如导入导出、删除和批量删除等常规的接口。

而我们在这个用户业务模型里面所需要做的就是做一下继承关系的处理即可，如下代码所示。

csharp 复制代码

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 就具有了一些通用的业务处理对象和命令了，包括常规的查询、删除、批量删除、导入、导出的处理，都可以了。

同理，对于编辑具体单个记录的处理，我们也可以使用通用的抽象业务类封装来实现，如下代码所示。

csharp 复制代码

/// <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的继承类。

这样实现，可以极大程度的减少子类的代码，以及通过代码生成工具快速定义生成的方式，又可以极大的提高开发效率，双管齐下，可以提高整个项目的开发效率。