目录
1.Caliburn.Micro框架介绍
Caliburn.Micro(地址)作为一款非常流行的开源WPF MVVM框架,是一个轻量级、强大且灵活的框架,旨在帮助开发者更容易地在多种应用程序中实现MVVM(Model-View-ViewModel)模式,掌握他可以让我们的WPF开发效率更高,框架采用MIT宽松许可,可以免费商用。
2.Caliburn.Micro主要特点
- 简化MVVM实现:Caliburn.Micro专注于简化视图与视图模型的交互,处理事件绑定、命令执行、依赖注入等常见的MVVM场景。它提供了视图与视图模型之间的自动绑定约定,只要视图的名称和视图模型的名称遵循约定,Caliburn.Micro会自动关联它们。
- 自动绑定机制:通过内置的ActionMessage,Caliburn.Micro可以简化事件和命令绑定。开发者可以在视图的XAML中直接绑定到视图模型中的方法,而不需要依赖于ICommand。
- 依赖注入支持:Caliburn.Micro支持与依赖注入容器集成,允许开发者在应用程序中使用IoC容器(如SimpleInjector、Autofac等)进行对象的自动创建和管理,从而简化了复杂应用程序中的依赖管理。
- 导航管理:在构建多页面应用时,Caliburn.Micro提供了简便的导航管理功能,帮助开发者处理视图和视图模型的生命周期。通过Conductor和Screen类型,可以轻松管理多个页面或子视图。
- 协程支持:Caliburn.Micro支持协程,通过在视图模型中定义方法的返回值为IEnumerable,可以将复杂的异步操作以协程的方式进行处理,从而增强了异步编程的可读性。
3.如何使用
3.1 Caliburn.Micro安装
首先创建空的WPF程序:
选择基于.NET Framework的WPF应用:
选择.NET Framework 4.6.2框架,实际上Caliburn.Micro框架既支持.NET Framework框架,也支持跨平台的.net core平台。
使用Nuget管理器安装Caliburn.Micro框架
选择管理NuGet程序包:
点击浏览,输入Caliburn.Micro:
选择Caliburn.Micro,点击安装:
安装好后,我们在项目的引用中看到已安装的库:
至此,Caliburn.Micro已经成功安装。
3.2 配置Bootstrapper
Bootstrapper翻译为引导程序,他是最先启动的,引导WPF程序启动,我们新建一个Bootstrapper类,该类继承自BootstrapperBase,一般我们在该类里面实例化IoC容器,订阅全局未处理的异常,同时选择最先启动的视图模型,Bootstrapper类的代码如下:
internal class Bootstrapper : BootstrapperBase
{
private SimpleContainer _container;
public Bootstrapper()
{
// 订阅全局未处理异常
AppDomain.CurrentDomain.UnhandledException += CurrentDomain_UnhandledException;
Initialize();
}
private void CurrentDomain_UnhandledException(object sender, UnhandledExceptionEventArgs e)
{
// 可以选择写入日志文件,或者打印到控制台窗口
Console.WriteLine(e);
}
protected override void Configure()
{
_container = new SimpleContainer();
_container.Singleton<IEventAggregator, EventAggregator>();
_container.Singleton<IWindowManager, WindowManager>();
_container.PerRequest<MainWindowViewModel>();
}
protected override void OnStartup(object sender, StartupEventArgs e)
{
DisplayRootViewForAsync<MainWindowViewModel>();
}
protected override object GetInstance(Type service, string key)
{
return _container.GetInstance(service, key);
}
protected override IEnumerable<object> GetAllInstances(Type service)
{
return _container.GetAllInstances(service);
}
protected override void BuildUp(object instance)
{
_container.BuildUp(instance);
}
protected override void OnUnhandledException(object sender, DispatcherUnhandledExceptionEventArgs e)
{
// 可以选择写入日志文件,或者打印到控制台窗口
Console.WriteLine(e.Exception);
e.Handled = true; // 设置已处理异常,防止应用程序崩溃
}
}
在上面的示例中,我们创建了Bootstapper类,订阅了全局未处理异常事件,此处订阅了两处未处理异常事件,一个是复写了BootstrapperBase提供的OnUnhandledException虚函数,该虚函数仅能处理UI线程触发的未捕获异常,对于其他线程未捕获的异常,我们通过订阅AppDomain.CurrentDomain.UnhandledException来进行处理。
同时,我们选择了MainWindowViewModel作为程序的启动视图模型,在Caliburn.Micro框架中,所有视图模型都需要继承自PropertyChangedBase,以下是MainWindowViewModel的相关代码:
internal class MainWindowViewModel : PropertyChangedBase
{
}
3.3 配置App.xaml
App类作为WPF的启动类,原始的App.xaml如下:
可以看到,原始App.xaml最先启动MainWindow.xaml,要想让Caliburn.Micro接管整个启动流程,我们需要对App.xaml进行一些更改,让程序最先启动Bootstrapper类,App.xaml按照如下代码进行修改:
<Application x:Class="CaliburnMicroDemo.App"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:local="clr-namespace:CaliburnMicroDemo">
<Application.Resources>
<ResourceDictionary>
<ResourceDictionary.MergedDictionaries>
<ResourceDictionary>
<local:Bootstrapper x:Key="Bootstrapper" />
</ResourceDictionary>
</ResourceDictionary.MergedDictionaries>
</ResourceDictionary>
</Application.Resources>
</Application>
将StartupUri="MainWindow"进行删除,然后添加了<local:Bootstrapper x:Key=“Bootstrapper” />,这样Bootstrapper就接管了WPF的启动流程。
3.4 创建视图和视图模型
先运行一下程序,看看实际效果:
提示不能找到MainWindowViewModel对应的视图,这是因为Caliburn.Micro绑定视图和视图模型的规则是以文件名字为约定进行绑定,按照Caliburn.Micro框架的约定MainWindowViewModel视图模型对应的视图文件应该是MainWindowView,但实际目前我们工程里面的视图文件名字为MainWindow,所以我们需要修改一下MainWindow的名字(需要修改文件名和类名),首先修改文件名:
然后需改MainWindowView.xaml的类名:
再修改MainWindowView.xaml.cs中的类名:
然后再编译运行一下程序:
3.5 实现MVVM模式
还是以该系列第一篇文章中的商品管理程序为例,修改MainWindowView.xaml:
<Window x:Class="CaliburnMicroDemo.MainWindowView"
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:CaliburnMicroDemo"
mc:Ignorable="d"
Title="MainWindow" Height="450" Width="800">
<StackPanel>
<StackPanel Orientation="Horizontal" Margin="0, 4">
<TextBlock Text="Id:" MinWidth="100"/>
<TextBox x:Name="Id" MinWidth="100"/>
</StackPanel>
<StackPanel Orientation="Horizontal" Margin="0, 4">
<TextBlock Text="名称:" MinWidth="100"/>
<TextBox x:Name="Name" MinWidth="100"/>
</StackPanel>
<StackPanel Orientation="Horizontal" Margin="0, 4">
<TextBlock Text="价格:" MinWidth="100"/>
<TextBox x:Name="Price" MinWidth="100"/>
</StackPanel>
<Button Content="保存" x:Name="Save"/>
</StackPanel>
</Window>
从代码中我们可以看出,没有Binding关键字,Button也没有绑定命令,这就是Caliburn.Micro的强大之处,我们只需要给控件起一个名字,框架会自动将x:Name定义的名字与后台视图模型中的属性进行绑定,大大减少了代码量,提高了编程效率,看一下视图模型相关的代码:
internal class MainWindowViewModel : PropertyChangedBase
{
private string _name;
public string Name
{
get { return _name; }
set
{
_name = value;
NotifyOfPropertyChange(nameof(Name));
}
}
private int _id;
public int Id
{
get { return _id; }
set
{
_id = value;
NotifyOfPropertyChange(nameof(Id));
}
}
private double _price;
public double Price
{
get { return _price; }
set
{
_price = value;
NotifyOfPropertyChange(nameof(Price));
}
}
public MainWindowViewModel()
{
}
/// <summary>
/// 保存修改
/// </summary>
public void Save()
{
// 实际应用的时候,保存可以保存到数据库、文件等,此处仅显示修改后的值
MessageBox.Show($"Id={Id},Name={Name},Price={Price}");
}
}
运行一下程序,修改商品参数并保存:
程序正常运行。我们搭建了最简单的Caliburn.Micro MVVM程序并成功运行,基于此最小框架,可以在上面创建复杂的业务逻辑,请大家自行探索。
4.总结
Caliburn.Micro是一个强大而灵活的MVVM框架,可帮助开发人员更轻松地构建现代化的WPF、UWP和Silverlight应用程序。它提供了丰富的功能和良好的可扩展性,使开发人员能够快速构建高质量的应用程序。