WPF之Prism框架

Prism框架中的Region管理、MVVM架构与对话框操作详解
原创 已于 2024-03-11 01:54:05 修改 · 置顶 · 1.9k 阅读 · 32 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#wpf #ui

于 2024-03-11 01:38:26 首次发布

1.Region（区域管理）

在最常见的开发模式当中, 我们去设计某个页面的时候, 实际上界面元素在设计的时候已经被固定。
举个简单的例子,当我们去设计如下页面, 它包含Header、Menu、Content内容。

 1.1定义Region

可以使用XAML或代码创建定义Region

XAML：

<Window
    x:Class="HT.PrismApp.Views.MainWindow"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:prism="http://prismlibrary.com/"
    Width="525"
    Height="350"
    prism:ViewModelLocator.AutoWireViewModel="True">
    <Grid ShowGridLines="True">
        <Grid.RowDefinitions>
            <RowDefinition Height="50" />
            <RowDefinition />
        </Grid.RowDefinitions>
        <ContentControl Grid.Row="0" prism:RegionManager.RegionName="HeaderRegion" />
        <Grid Grid.Row="1" ShowGridLines="True">
            <Grid.ColumnDefinitions>
                <ColumnDefinition Width="100" />
                <ColumnDefinition Width="*" />
            </Grid.ColumnDefinitions>
            <ContentControl Grid.Column="0" prism:RegionManager.RegionName="MenuRegion" />
            <ContentControl Grid.Column="1" prism:RegionManager.RegionName="ContentRegion" />
        </Grid>
    </Grid>
</Window>

C#定义:RegionManager.SetRegionName("控件名","区域名称");

1.2注册区域视图

using HT.PrismApp.Views;
using Prism.Mvvm;
using Prism.Regions;

namespace HT.PrismApp.ViewModels
{
    public class MainWindowViewModel : BindableBase
    {
        public MainWindowViewModel(IRegionManager regionManager)
        {
            regionManager.RegisterViewWithRegion("HeaderRegion",typeof(HeaderView));
            regionManager.RegisterViewWithRegion("MenuRegion", typeof(MenuView));
            regionManager.RegisterViewWithRegion("ContentRegion", typeof(ContentView));
        }
    }
}

2.ViewModelLocator

在WPF当中,需要为View与ViewModel建立连接, 我们需要找到View的DataContext, 如下所示：

XAML的方式:

 <UserControl.DataContext>
        <.../>
 </UserControl.DataContext>

代码的方式:

    public partial class ViewA : UserControl
    {
        public ViewA()
        {
            InitializeComponent();
            this.DataContext = null; //设定
        }
    }

在Prism当中, 你可以基于命名约定, 便能够轻松的将View/ViewModel建议关联。如下所示:

假设你已经为项目添加Views和ViewModels文件夹。此时, 你的页面为ViewA, 则对应的ViewModel名称为 ViewAViewModel。

错误命名例子：假如你的页面为PageView，对应的ViewModel名称为PageViewModel，而不是PageViewViewModel。

3.MVVM

众所周知, 如果你了解WPF当中的ICommand, INotifyPropertyChanged的作用, 就会发现
众多框架都是基于这些进行扩展, 实现其通知、绑定、命令等功能。

3.1通知

Prism继承Prism.Mvvm.BindableBase,进行调用RaisePropertyChanged方法即可。

3.2命令

Prism继承Prism.Mvvm.BindableBase,进行使用DelegateCommand即可。

3.3拓展

对于单个Command而言, 只是触发单个对应的功能, 而复合命令是Prism当中非常强大的功能, CompositeCommand简单来说是一个父命令, 它可以注册N个子命令。

using Prism.Commands;
using Prism.Mvvm;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Input;

namespace HT.PrismApp.ViewModels
{
    public class ContentViewModel : BindableBase
    {
        public ContentViewModel() 
        {
            ACommamd = new DelegateCommand(() =>
            {
                Title += "ACommamd";
            });
            BCommamd = new DelegateCommand(() =>
            {
                Title += "BCommamd";
            });
            //复合命令
            ClickAllCommand = new CompositeCommand();
            ClickAllCommand.RegisterCommand(ACommamd);
            ClickAllCommand.RegisterCommand(BCommamd);
        }
        private string title="测试";
        public string Title
        {
            get
            {
                return title;
            }
            set
            {
                title = value;
                RaisePropertyChanged(nameof(Title));
            }
        }
        public DelegateCommand ACommamd;
        public DelegateCommand BCommamd;
     
        public DelegateCommand SaveCommamd
        {
            get
            {
                return new DelegateCommand(() =>
                {

                });
            }
        }
        public CompositeCommand ClickAllCommand { get; set; }
    }
}

3.4IEventAggregator（事件通讯）

发布：

using Prism.Commands;
using Prism.Events;
using Prism.Mvvm;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Input;

namespace HT.PrismApp.ViewModels
{
    public class ContentViewModel : BindableBase
    {
        private readonly IEventAggregator _eventAggregator;
        public ContentViewModel(IEventAggregator eventAggregator)
        {
            _eventAggregator = eventAggregator;
        }
        private string msg;
        public string Msg
        {
            get
            {
                return msg;
            }
            set
            {
                msg = value;
                RaisePropertyChanged(nameof(Msg));
            }
        }
        public DelegateCommand SendCommamd
        {
            get
            {
                return new DelegateCommand(() =>
                {
                    _eventAggregator.GetEvent<PubSubEvent<string>>().Publish(Msg);
                });
            }
        }
    }
}

订阅： 

using Prism.Events;
using Prism.Mvvm;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace HT.PrismApp.ViewModels
{
    public class HeaderViewModel : BindableBase
    {
        public HeaderViewModel(IEventAggregator eventAggregator)
        {
            eventAggregator.GetEvent<PubSubEvent<string>>().Subscribe(ReceiveMessage, ThreadOption.PublisherThread, false, msg =>
            {
                //过滤
                return true;
            });
        }
        private void ReceiveMessage(string msg)
        {
            Text = msg;
        }
        private string text;
        public string Text
        {
            get
            {
                return text;
            }
            set
            {
                text = value;
                RaisePropertyChanged(nameof(Text));
            }
        }
    }
}

4.Navigation（导航）

4.1导航的基本条件：注册显示区域、注册导航页面

（1）注册导航

using HT.PrismApp.ViewModels;
using HT.PrismApp.Views;
using Prism.Ioc;
using System.Windows;

namespace HT.PrismApp
{
    /// <summary>
    /// Interaction logic for App.xaml
    /// </summary>
    public partial class App
    {
        protected override Window CreateShell()
        {
            return Container.Resolve<MainWindow>();
        }

        protected override void RegisterTypes(IContainerRegistry containerRegistry)
        {
            //注册导航
            containerRegistry.RegisterForNavigation<ContentView>();
            containerRegistry.RegisterForNavigation<MenuView>();
            //指定VieModel
            //containerRegistry.RegisterForNavigation<ContentView, ContentViewModel>();
            //containerRegistry.RegisterForNavigation<MenuView, MenuViewModel>();
        }
    }
}

2.使用导航

using HT.PrismApp.Views;
using Prism.Commands;
using Prism.Events;
using Prism.Mvvm;
using Prism.Regions;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows;

namespace HT.PrismApp.ViewModels
{
    public class HeaderViewModel : BindableBase
    {
        private IRegionManager _regionManager;
        public HeaderViewModel(IRegionManager regionManager)
        {
            _regionManager = regionManager;
        }
        public DelegateCommand NavigationA
        {
            get
            {
                return new DelegateCommand(() =>
                {
                    //使用导航
                    _regionManager.RequestNavigate("ContentRegion", nameof(ContentView));

                });
            }
        }
        public DelegateCommand NavigationB
        {
            get
            {
                return new DelegateCommand(() =>
                {
                    //使用导航
                    _regionManager.RequestNavigate("ContentRegion", nameof(MenuView));
                });
            }
        }
    }
}

拓展：

        public DelegateCommand NavigationA
        {
            get
            {
                return new DelegateCommand(() =>
                {
                    //带参数,ViewModel继承INavigationAware
                    //OnNavigatedTo: 导航完成前, 此处可以传递过来的参数以及是否允许导航等动作的控制。
                    //IsNavigationTarget: 调用以确定此实例是否可以处理导航请求。否则新建实例
                    //OnNavigatedFrom: 当导航离开当前页时, 类似打开A, 再打开B时, 该方法被触发。

                    //还有可以继承IConfirmNavigationRequest
                    //拦截导航请求
                    //public void ConfirmNavigationRequest(NavigationContext navigationContext, Action<bool> continuationCallback)
                    //{
                    //    bool result = true;

                    //    if (MessageBox.Show("确认导航?", "温馨提示", MessageBoxButton.YesNo) == MessageBoxResult.No)
                    //        result = false;

                    //    //通过回调当前返回的确认结果,决定是否启动该导航
                    //    continuationCallback(result);
                    //}
                    var param = new NavigationParameters();
                    param.Add("Parameter", param);
                    _regionManager.RequestNavigate("ContentRegion", nameof(ContentView), param);
                    //类似URL地址传递参数
                    //_regionManger.RequestNavigate("ContentRegion", $"{nameof(ContentView)}?id=1&Name=xiaoming");
                });
            }
        }

3.Navigation Journal导航日志

using HT.PrismApp.Views;
using Prism.Commands;
using Prism.Events;
using Prism.Mvvm;
using Prism.Regions;
using Prism.Services.Dialogs;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows;

namespace HT.PrismApp.ViewModels
{
    public class HeaderViewModel : BindableBase
    {
        private IRegionManager _regionManager;
        private IRegionNavigationJournal _journal;
        public HeaderViewModel(IRegionManager regionManager, IRegionNavigationJournal journal)
        {
            _regionManager = regionManager;
            _journal = journal;
        }
        public DelegateCommand NavigationA
        {
            get
            {
                return new DelegateCommand(() =>
                {
                    _regionManager.RequestNavigate("ContentRegion", nameof(ContentView), args =>
                    {
                        //***导航日志
                        _journal = args.Context.NavigationService.Journal;
                    });
                });
            }
        }
        public DelegateCommand NavigationB
        {
            get
            {
                return new DelegateCommand(() =>
                {
                    //使用导航
                    _regionManager.RequestNavigate("ContentRegion", nameof(MenuView), args =>
                    {
                        //***导航日志
                        _journal = args.Context.NavigationService.Journal;
                    });
                });
            }
        }
        public DelegateCommand GoBack
        {
            get
            {
                return new DelegateCommand(() =>
                {
                    _journal.GoBack();
                });
            }
        }
        public DelegateCommand GoForward
        {
            get
            {
                return new DelegateCommand(() =>
                {
                    _journal.GoForward();
                });
            }
        }
    }
}

5.Dialog（对话框）

对话框实际上是我们应用程序经常用到的一个功能, 类如: Show、ShowDialog。
可以弹出一个我们指定的窗口, 仅此而已, 那么在Prism当中, Dialog指的是什么?

Prism提供了一组对话服务, 封装了常用的对话框组件的功能, 例如:

  • RegisterDialog/IDialogService (注册对话及使用对话)
  • 打开对话框传递参数/关闭对话框返回参数
  • 回调通知对话结果

5.1创建对话框,通常是一组用户控件 ,并且实现 IDialogAware

using Prism.Commands;
using Prism.Mvvm;
using Prism.Services.Dialogs;
using System;

namespace HT.PrismApp.ViewModels
{
    public class MessageDialogViewModel : BindableBase, IDialogAware
    {
        public string Title => "对话框服务";

        public event Action<IDialogResult> RequestClose;

        public bool CanCloseDialog()
        {
            return true;
        }
        /// <summary>
        /// 对话框关闭时
        /// </summary>
        public void OnDialogClosed()
        {
        }
        /// <summary>
        /// 对话框打开时
        /// </summary>
        /// <param name="parameters"></param>
        public void OnDialogOpened(IDialogParameters parameters)
        {

        }
        public DelegateCommand SaveCommand
        {
            get
            {
                return new DelegateCommand(() =>
                {
                    RequestClose?.Invoke(new DialogResult(ButtonResult.OK));
                });
            }
        }
        public DelegateCommand CancelCommand
        {
            get
            {
                return new DelegateCommand(() =>
                {
                    RequestClose?.Invoke(new DialogResult(ButtonResult.Cancel));
                });
            }
        }
    }
}

5.2注册对话框 RegisterDialog

using HT.PrismApp.ViewModels;
using HT.PrismApp.Views;
using Prism.Ioc;
using System.Windows;

namespace HT.PrismApp
{
    /// <summary>
    /// Interaction logic for App.xaml
    /// </summary>
    public partial class App
    {
        protected override Window CreateShell()
        {
            return Container.Resolve<MainWindow>();
        }

        protected override void RegisterTypes(IContainerRegistry containerRegistry)
        {
            containerRegistry.RegisterDialog<MessageDialog, MessageDialogViewModel>();
        }
    }
}

5.3使用IDialogService接口 Show/ShowDialog 方法调用对话框

using HT.PrismApp.Views;
using Prism.Commands;
using Prism.Events;
using Prism.Mvvm;
using Prism.Regions;
using Prism.Services.Dialogs;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows;

namespace HT.PrismApp.ViewModels
{
    public class HeaderViewModel : BindableBase
    {
        private IRegionManager _regionManager;
        private IRegionNavigationJournal _journal;
        private IDialogService _dialogService;
        public HeaderViewModel(IRegionManager regionManager, IRegionNavigationJournal journal, IDialogService dialogService)
        {
            _regionManager = regionManager;
            _journal = journal;
            _dialogService= dialogService;
        }
        public DelegateCommand NavigationA
        {
            get
            {
                return new DelegateCommand(() =>
                {
                    _regionManager.RequestNavigate("ContentRegion", nameof(ContentView), args =>
                    {
                        //***导航日志
                        _journal = args.Context.NavigationService.Journal;
                    });
                });
            }
        }
        public DelegateCommand NavigationB
        {
            get
            {
                return new DelegateCommand(() =>
                {
                    //使用导航
                    _regionManager.RequestNavigate("ContentRegion", nameof(MenuView), args =>
                    {
                        //***导航日志
                        _journal = args.Context.NavigationService.Journal;
                    });
                });
            }
        }
        public DelegateCommand GoBack
        {
            get
            {
                return new DelegateCommand(() =>
                {
                    _journal.GoBack();
                });
            }
        }
        public DelegateCommand GoForward
        {
            get
            {
                return new DelegateCommand(() =>
                {
                    _journal.GoForward();
                });
            }
        }
        public DelegateCommand OpenDialog
        {
            get
            {
                return new DelegateCommand(() =>
                {
                    _dialogService.ShowDialog(nameof(MessageDialog));
                });
            }
        }
    }
}

WPF超好用的框架Prism入门使用,上位机赶紧学起来!
Documentlv的博客
04-27 7657
WPF框架Prism是一种用于开发模块化、可重用和可测试的WPF应用程序的框架。它提供了一种简单而强大的方式来管理复杂应用程序的代码和构建高度可扩展的应用程序。
Prism8.0 框架入门
lk5861656110的博客
07-13 3049
Prism8.0Prism简介Prism.CoreMVVMBindableBaseCommandEventAggregatorModuleRegionContainerPrism.WpfPrism.DryIoc.WpfPrism.Unity.WpfPrism与其他框架区别源码路径 Prism简介 Prism 是一个用于在 WPF、Xamarin Forms、WinUI 和 Uwp Uno中构建松耦合、可维护和可测试的 XAML 应用的框架。 它最初由Microsoft Patterns&Practi
WPF Prism框架
07-08
很漂亮的界面，内含各种控件的样式及模板，下载把
Prism 模块化详解：推进 WPF 上位机开发
最新发布
专注于前沿技术的探索与实践，热衷于从代码逻辑、架构设计到行业应用等多维度深挖技术本质。期待在技术之路上与你共同成长～
09-20 865
每个模块是一个独立项目，引用Prism.Wpf和核心库。Prism 的模块化功能通过解耦和动态加载极大提升了 WPF 上位机的开发效率和可维护性。核心步骤包括定义模块、配置 Bootstrapper、使用事件聚合器通信和区域导航。结合 Modbus/OPC UA 等协议，可快速构建工业级 HMI 系统。如果需要特定功能（如动态加载配置文件、特定 PLC 协议集成）或代码调试，告诉我更多细节，我可以提供针对性代码或优化建议！
【WPF之Prism框架】
xiaochuideai的博客
08-08 7396
融合官方文档和个人理解并参考其他博主的相关文章，对prism框架下的各个功能模块进行了较为详细的整理，并通过案例代码的方式更加直观的呈现相关函数的功能。以方便与自我复习和理解。
WPF框架介绍---Prism框架（万字长文一篇文章带你弄懂Prism）
热门推荐
white_papers的博客
03-13 1万+
Prism 是一个开源的、跨平台的框架，专为构建复杂的 XAML 应用（如 WPF、Xamarin.Forms、UWP）而设计。它基于 MVVM 模式，通过 依赖注入、模块化、区域管理 和 事件聚合器 等核心功能，帮助开发者实现松耦合、可扩展的应用架构。
WPF,Prism框架
05-28
**WPF与Prism框架详解** Windows Presentation Foundation（WPF），是Microsoft开发的一种用户界面框架，用于构建桌面应用程序。它是.NET Framework的一部分，提供了丰富的图形层、数据绑定、样式和模板等特性，...
WPF, Prism框架下的串口调试助手
05-30
标题“WPF, Prism框架下的串口调试助手”表明这是一个使用Windows Presentation Foundation（WPF）技术和Prism框架开发的应用程序，主要功能是帮助开发者进行串口通信的调试工作。WPF是.NET Framework中的一个UI框架...
wpf之prism框架
04-21
### WPF 中 Prism 框架的使用指南 #### 1. Prism 框架简介 Prism 是由 Microsoft 推出的一个开源框架，旨在为 WPF 和其他 .NET 平台提供模块化的解决方案[^2]。该框架的核心理念是通过 MVVM（Model-View-ViewModel...
(源码)基于WPF和Prism框架的物料入仓管理系统.zip
11-15
# 基于WPF和Prism框架的物料入仓管理系统 ## 项目简介 物料入仓管理系统是一个基于WPF和Prism框架的应用程序，旨在管理和跟踪物料的入仓和存储过程。该系统提供了用户登录、主界面导航、存储数据初始化、存储状态...
WPF的Prism框架的使用
蒋劲豪的博客
02-15 557
安装Prism.DryIoc库。
Prism框架WPF主界面列子,还带各种样式风格,Prism程序结构的划分
05-05
Prism框架WPF主界面列子,还带各种样式风格,各种事件的列子,Prism程序结构的划分
【WPF】Prism框架基础
weixin_52360147的博客
04-23 7656
Prism框架： 初识： 我们创建一个基于net5.0的WPF应用程序 创建完之后在VS里面添加相关的包 修改app继承的基类 public partial class App : PrismApplication { } 这时候会报错，我们去修改前台的代码 <prism:PrismApplication x:Class="PrisimDemo.App" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presen
WPF--Prism框架详解
Blue
09-18 1358
WPF--Prism框架详解
Prism for WPF初探（构建简单的模块化开发框架）
weixin_30889885的博客
12-15 330
　　先简单的介绍一下Prism框架，引用微软官方的解释： Prism provides guidance to help you more easily design and build, flexible, and easy-to-maintain client business apps that run on Windows Runtime, Windows Presentation Fo...
WPF Prism框架学习
weixin_45936067的博客
06-27 4394
在 WPF 中，我们需要将普通属性转换为依赖属性，以便在属性值发生变化时通知 UI 进行更新。BindableBase 的主要作用是将普通属性转换为依赖属性，并在属性值发生变化时通知 UI 进行更新。如果需要在 WPF 中使用数据绑定，那么继承自 BindableBase 是一个很好的选择。2)、RegisterTypes 方法是 Prism 框架中用于注册视图模型的方法。它支持使用区域名称作为属性值来指定要显示的内容所在的区域。这些控件都是Prism框架内置的，可以直接在WPF应用程序中使用。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值