C# WPF MVVM模式[经典]案例

01

—

前言

        Caliburn.Micro(简称CM)一经推出便备受推崇，作为一款MVVM开发模式的经典框架，越来越多的受到wpf开发者的青睐.我们看一下官方的描述：Caliburn是一个为Xaml平台设计的小型但功能强大的框架。Micro实现了各种UI模式，用于解决实际问题。突出显示的模式包括MVVM（表示模型）、MVP和MVC。目前CM框架还不不停的开发和迭代中，目前最新版本4.0.212，推出于2022年8月27日，已经可以支持.NET7。

02

—

项目介绍

解决方案由四个项目组成：见下图

HelloWorld：框架的搭建、容器注入相关；

HelloWorld.Core；放置数据模型，即mvvm中的M；

HelloWorld.ViewModels：模型视图，即VM;

HelloWorld.Views:V,即视图.

项目基于.NET5开发：

CM框架版本：4.0.212；

运行结果显示：

03

—

代码展示和讲解

① 首先是HelloWorld讲解，这里启动代码：Startup.CS

public class Startup : BootstrapperBase
    {
        SimpleContainer _container;
        public Startup()
        {
            Initialize();
        }


        protected override void Configure()
        {
            _container = new SimpleContainer()
                .Singleton<IWindowManager, WindowManager>()
                .Singleton<IEventAggregator, EventAggregator>();
            foreach (var asm in SelectAssemblies())
            {
                foreach (var vm in asm.GetTypes())
                {
                    if (vm.Name.EndsWith("VM"))
                    {
                        _container.RegisterPerRequest(vm, null, vm);
                    }
                }
            }


            var myRule = new TypeMappingConfiguration
            {
                ViewModelSuffix = "VM",
                ViewSuffixList = new() { "" }
            };
            ViewLocator.ConfigureTypeMappings(myRule);
            ViewModelLocator.ConfigureTypeMappings(myRule);
        }


        protected override void OnStartup(object sender, StartupEventArgs e)
        {
            base.OnStartup(sender, e);
            DisplayRootViewForAsync<IndexVM>();
        }


        protected override IEnumerable<Assembly> SelectAssemblies()
        {
            return new List<Assembly>
            {
                Assembly.Load("HelloWorld"),
                Assembly.Load("HelloWorld.Views"),
                Assembly.Load("HelloWorld.ViewModels"),
            };
        }
        protected override object GetInstance(Type service, string key)
        {
            return _container.GetInstance(service, key);
        }
    }

这里容器采用了CM自带的SimpleContainer：

开始先把窗口管理器和事件聚合器注册到了容器中：

_container = new SimpleContainer()
                .Singleton<IWindowManager, WindowManager>()
                .Singleton<IEventAggregator, EventAggregator>();

然后通过反射把下面三个程序集：

Assembly.Load("HelloWorld"),
                Assembly.Load("HelloWorld.Views"),
                Assembly.Load("HelloWorld.ViewModels"),

中vm结尾的视图模型文件注册到容器：

foreach (var asm in SelectAssemblies())
            {
                foreach (var vm in asm.GetTypes())
                {
                    if (vm.Name.EndsWith("VM"))
                    {
                        _container.RegisterPerRequest(vm, null, vm);
                    }
                }
            }

接下来是自定义了一套CM的VM和V的匹配规则，默认情况，CM的匹配规则是视图以View结尾，视图模型以ViewModel结尾，这里的规则是VM以VM结尾，View只要前缀和Viewmodel的一致就可以：

var myRule = new TypeMappingConfiguration
            {
                ViewModelSuffix = "VM",
                ViewSuffixList = new() { "" }
            };
            ViewLocator.ConfigureTypeMappings(myRule);
            ViewModelLocator.ConfigureTypeMappings(myRule);

②HelloWorld.Views，这里放的是视图，代码很简单，不展开了，比较新颖的用法是它通过load函数接在view的：

cal:Message.Attach="[Event Loaded]=[Loaded($view,$eventArgs)]"

public void Loaded(UserControl control, RoutedEventArgs @event)
        {
            Debug.WriteLine(control);
            Debug.WriteLine(@event);
        }

③ HelloWorld.ViewModels，视图模型：

LoginVM.cs这是登录窗体的后台逻辑：点击登录后发送背景线程异步事件更新进度条：

public async Task DoLogin()
        {
            await _eventAggregator.PublishOnBackgroundThreadAsync(new BusyMessage(true));


            await Task.Delay(1000);
            MessageBox.Show("Test Login Success");


            await _eventAggregator.PublishOnBackgroundThreadAsync(new BusyMessage(false));
        }

IndexVM.cs：继承IHandle<BusyMessage>，

接收事件更新进度条：

public Task HandleAsync(BusyMessage message, CancellationToken cancellationToken)
        {
            if (message.IsBusy)
            {
                BarValue = 50;
            }
            else
            {
                BarValue = 0;
            }
            return Task.CompletedTask;
        }

通过ioc容器获取VM:

 public LoginVM LoginVM { get; set; } = IoC.Get<LoginVM>();

public LoginVM LoginVM { get; set; } = IoC.Get<LoginVM>();
   public TableVM TableVM { get; set; } = IoC.Get<TableVM>();

TableVM.cs:

数据集合定义：  public ObservableCollection<Foo> Data { get; set; }

开线程更新集合数据：用 await Task.Delay(1000);演示一秒

Task.Run(async () =>
            {
                while (true)
                {
                    if (IsShow)
                    {
                        _data.Add(new Foo
                        {
                            Id = Guid.NewGuid(),
                            Name = "John" + new Random().Next(1, 100),
                            School = "上海大学"
                        });
                        Data = new ObservableCollection<Foo>(_data);
                    }


                    await Task.Delay(1000);
                }
            });

 [AddINotifyPropertyChangedInterface]：来源于，可以自动通知界面数据更新。

04

—

源码下载及声明

声明：首先感谢群友提供源码，需要和源码提供者本人直面交流的可以通过邮箱：xingrui_zhuang@asiasymbol.com 联系.

源码百度网盘链接


链接：https://pan.baidu.com/s/1BHkVEFWHwGQf6EwHpWCBKw
提取码：6666
技术群：添加小编微信并备注进群


小编微信：mm1552923   
公众号：dotNet编程大全