devbox
神奇cpp
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

WPF之Prism框架_wpf prism开发框架示例

作者：神奇cpp | 2024-07-23 11:16:51

赞

踩

wpf prism开发框架示例

1.Region（区域管理）

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

 1.1定义Region

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

XAML：

  1. <Window
  2.     x:Class="HT.PrismApp.Views.MainWindow"
  3.     xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
  4.     xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
  5.     xmlns:prism="http://prismlibrary.com/"
  6.     Width="525"
  7.     Height="350"
  8.     prism:ViewModelLocator.AutoWireViewModel="True">
  9.     <Grid ShowGridLines="True">
  10.         <Grid.RowDefinitions>
  11.             <RowDefinition Height="50" />
  12.             <RowDefinition />
  13.         </Grid.RowDefinitions>
  14.         <ContentControl Grid.Row="0" prism:RegionManager.RegionName="HeaderRegion" />
  15.         <Grid Grid.Row="1" ShowGridLines="True">
  16.             <Grid.ColumnDefinitions>
  17.                 <ColumnDefinition Width="100" />
  18.                 <ColumnDefinition Width="*" />
  19.             </Grid.ColumnDefinitions>
  20.             <ContentControl Grid.Column="0" prism:RegionManager.RegionName="MenuRegion" />
  21.             <ContentControl Grid.Column="1" prism:RegionManager.RegionName="ContentRegion" />
  22.         </Grid>
  23.     </Grid>
  24. </Window>

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

1.2注册区域视图

  1. using HT.PrismApp.Views;
  2. using Prism.Mvvm;
  3. using Prism.Regions;
  4.  
  5. namespace HT.PrismApp.ViewModels
  6. {
  7.     public class MainWindowViewModel : BindableBase
  8.     {
  9.         public MainWindowViewModel(IRegionManager regionManager)
  10.         {
  11.             regionManager.RegisterViewWithRegion("HeaderRegion",typeof(HeaderView));
  12.             regionManager.RegisterViewWithRegion("MenuRegion", typeof(MenuView));
  13.             regionManager.RegisterViewWithRegion("ContentRegion", typeof(ContentView));
  14.         }
  15.     }
  16. }

2.ViewModelLocator

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

XAML的方式:

  1.  <UserControl.DataContext>
  2.         <.../>
  3.  </UserControl.DataContext>

代码的方式:

  1.     public partial class ViewA : UserControl
  2.     {
  3.         public ViewA()
  4.         {
  5.             InitializeComponent();
  6.             this.DataContext = null; //设定
  7.         }
  8.     }

在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个子命令。

  1. using Prism.Commands;
  2. using Prism.Mvvm;
  3. using System;
  4. using System.Collections.Generic;
  5. using System.Linq;
  6. using System.Text;
  7. using System.Threading.Tasks;
  8. using System.Windows.Input;
  9.  
  10. namespace HT.PrismApp.ViewModels
  11. {
  12.     public class ContentViewModel : BindableBase
  13.     {
  14.         public ContentViewModel() 
  15.         {
  16.             ACommamd = new DelegateCommand(() =>
  17.             {
  18.                 Title += "ACommamd";
  19.             });
  20.             BCommamd = new DelegateCommand(() =>
  21.             {
  22.                 Title += "BCommamd";
  23.             });
  24.             //复合命令
  25.             ClickAllCommand = new CompositeCommand();
  26.             ClickAllCommand.RegisterCommand(ACommamd);
  27.             ClickAllCommand.RegisterCommand(BCommamd);
  28.         }
  29.         private string title="测试";
  30.         public string Title
  31.         {
  32.             get
  33.             {
  34.                 return title;
  35.             }
  36.             set
  37.             {
  38.                 title = value;
  39.                 RaisePropertyChanged(nameof(Title));
  40.             }
  41.         }
  42.         public DelegateCommand ACommamd;
  43.         public DelegateCommand BCommamd;
  44.      
  45.         public DelegateCommand SaveCommamd
  46.         {
  47.             get
  48.             {
  49.                 return new DelegateCommand(() =>
  50.                 {
  51.  
  52.                 });
  53.             }
  54.         }
  55.         public CompositeCommand ClickAllCommand { get; set; }
  56.     }
  57. }

3.4IEventAggregator（事件通讯）

发布：

  1. using Prism.Commands;
  2. using Prism.Events;
  3. using Prism.Mvvm;
  4. using System;
  5. using System.Collections.Generic;
  6. using System.Linq;
  7. using System.Text;
  8. using System.Threading.Tasks;
  9. using System.Windows.Input;
  10.  
  11. namespace HT.PrismApp.ViewModels
  12. {
  13.     public class ContentViewModel : BindableBase
  14.     {
  15.         private readonly IEventAggregator _eventAggregator;
  16.         public ContentViewModel(IEventAggregator eventAggregator)
  17.         {
  18.             _eventAggregator = eventAggregator;
  19.         }
  20.         private string msg;
  21.         public string Msg
  22.         {
  23.             get
  24.             {
  25.                 return msg;
  26.             }
  27.             set
  28.             {
  29.                 msg = value;
  30.                 RaisePropertyChanged(nameof(Msg));
  31.             }
  32.         }
  33.         public DelegateCommand SendCommamd
  34.         {
  35.             get
  36.             {
  37.                 return new DelegateCommand(() =>
  38.                 {
  39.                     _eventAggregator.GetEvent<PubSubEvent<string>>().Publish(Msg);
  40.                 });
  41.             }
  42.         }
  43.     }
  44. }

订阅： 

  1. using Prism.Events;
  2. using Prism.Mvvm;
  3. using System;
  4. using System.Collections.Generic;
  5. using System.Linq;
  6. using System.Text;
  7. using System.Threading.Tasks;
  8.  
  9. namespace HT.PrismApp.ViewModels
  10. {
  11.     public class HeaderViewModel : BindableBase
  12.     {
  13.         public HeaderViewModel(IEventAggregator eventAggregator)
  14.         {
  15.             eventAggregator.GetEvent<PubSubEvent<string>>().Subscribe(ReceiveMessage, ThreadOption.PublisherThread, false, msg =>
  16.             {
  17.                 //过滤
  18.                 return true;
  19.             });
  20.         }
  21.         private void ReceiveMessage(string msg)
  22.         {
  23.             Text = msg;
  24.         }
  25.         private string text;
  26.         public string Text
  27.         {
  28.             get
  29.             {
  30.                 return text;
  31.             }
  32.             set
  33.             {
  34.                 text = value;
  35.                 RaisePropertyChanged(nameof(Text));
  36.             }
  37.         }
  38.     }
  39. }

4.Navigation（导航）

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

（1）注册导航

  1. using HT.PrismApp.ViewModels;
  2. using HT.PrismApp.Views;
  3. using Prism.Ioc;
  4. using System.Windows;
  5.  
  6. namespace HT.PrismApp
  7. {
  8.     /// <summary>
  9.     /// Interaction logic for App.xaml
  10.     /// </summary>
  11.     public partial class App
  12.     {
  13.         protected override Window CreateShell()
  14.         {
  15.             return Container.Resolve<MainWindow>();
  16.         }
  17.  
  18.         protected override void RegisterTypes(IContainerRegistry containerRegistry)
  19.         {
  20.             //注册导航
  21.             containerRegistry.RegisterForNavigation<ContentView>();
  22.             containerRegistry.RegisterForNavigation<MenuView>();
  23.             //指定VieModel
  24.             //containerRegistry.RegisterForNavigation<ContentView, ContentViewModel>();
  25.             //containerRegistry.RegisterForNavigation<MenuView, MenuViewModel>();
  26.         }
  27.     }
  28. }

2.使用导航

  1. using HT.PrismApp.Views;
  2. using Prism.Commands;
  3. using Prism.Events;
  4. using Prism.Mvvm;
  5. using Prism.Regions;
  6. using System;
  7. using System.Collections.Generic;
  8. using System.Linq;
  9. using System.Text;
  10. using System.Threading.Tasks;
  11. using System.Windows;
  12.  
  13. namespace HT.PrismApp.ViewModels
  14. {
  15.     public class HeaderViewModel : BindableBase
  16.     {
  17.         private IRegionManager _regionManager;
  18.         public HeaderViewModel(IRegionManager regionManager)
  19.         {
  20.             _regionManager = regionManager;
  21.         }
  22.         public DelegateCommand NavigationA
  23.         {
  24.             get
  25.             {
  26.                 return new DelegateCommand(() =>
  27.                 {
  28.                     //使用导航
  29.                     _regionManager.RequestNavigate("ContentRegion", nameof(ContentView));
  30.  
  31.                 });
  32.             }
  33.         }
  34.         public DelegateCommand NavigationB
  35.         {
  36.             get
  37.             {
  38.                 return new DelegateCommand(() =>
  39.                 {
  40.                     //使用导航
  41.                     _regionManager.RequestNavigate("ContentRegion", nameof(MenuView));
  42.                 });
  43.             }
  44.         }
  45.     }
  46. }

拓展：

  1.         public DelegateCommand NavigationA
  2.         {
  3.             get
  4.             {
  5.                 return new DelegateCommand(() =>
  6.                 {
  7.                     //带参数,ViewModel继承INavigationAware
  8.                     //OnNavigatedTo: 导航完成前, 此处可以传递过来的参数以及是否允许导航等动作的控制。
  9.                     //IsNavigationTarget: 调用以确定此实例是否可以处理导航请求。否则新建实例
  10.                     //OnNavigatedFrom: 当导航离开当前页时, 类似打开A, 再打开B时, 该方法被触发。
  11.  
  12.                     //还有可以继承IConfirmNavigationRequest
  13.                     //拦截导航请求
  14.                     //public void ConfirmNavigationRequest(NavigationContext navigationContext, Action<bool> continuationCallback)
  15.                     //{
  16.                     //    bool result = true;
  17.  
  18.                     //    if (MessageBox.Show("确认导航?", "温馨提示", MessageBoxButton.YesNo) == MessageBoxResult.No)
  19.                     //        result = false;
  20.  
  21.                     //    //通过回调当前返回的确认结果,决定是否启动该导航
  22.                     //    continuationCallback(result);
  23.                     //}
  24.                     var param = new NavigationParameters();
  25.                     param.Add("Parameter", param);
  26.                     _regionManager.RequestNavigate("ContentRegion", nameof(ContentView), param);
  27.                     //类似URL地址传递参数
  28.                     //_regionManger.RequestNavigate("ContentRegion", $"{nameof(ContentView)}?id=1&Name=xiaoming");
  29.                 });
  30.             }
  31.         }

3.Navigation Journal导航日志

  1. using HT.PrismApp.Views;
  2. using Prism.Commands;
  3. using Prism.Events;
  4. using Prism.Mvvm;
  5. using Prism.Regions;
  6. using Prism.Services.Dialogs;
  7. using System;
  8. using System.Collections.Generic;
  9. using System.Linq;
  10. using System.Text;
  11. using System.Threading.Tasks;
  12. using System.Windows;
  13.  
  14. namespace HT.PrismApp.ViewModels
  15. {
  16.     public class HeaderViewModel : BindableBase
  17.     {
  18.         private IRegionManager _regionManager;
  19.         private IRegionNavigationJournal _journal;
  20.         public HeaderViewModel(IRegionManager regionManager, IRegionNavigationJournal journal)
  21.         {
  22.             _regionManager = regionManager;
  23.             _journal = journal;
  24.         }
  25.         public DelegateCommand NavigationA
  26.         {
  27.             get
  28.             {
  29.                 return new DelegateCommand(() =>
  30.                 {
  31.                     _regionManager.RequestNavigate("ContentRegion", nameof(ContentView), args =>
  32.                     {
  33.                         //***导航日志
  34.                         _journal = args.Context.NavigationService.Journal;
  35.                     });
  36.                 });
  37.             }
  38.         }
  39.         public DelegateCommand NavigationB
  40.         {
  41.             get
  42.             {
  43.                 return new DelegateCommand(() =>
  44.                 {
  45.                     //使用导航
  46.                     _regionManager.RequestNavigate("ContentRegion", nameof(MenuView), args =>
  47.                     {
  48.                         //***导航日志
  49.                         _journal = args.Context.NavigationService.Journal;
  50.                     });
  51.                 });
  52.             }
  53.         }
  54.         public DelegateCommand GoBack
  55.         {
  56.             get
  57.             {
  58.                 return new DelegateCommand(() =>
  59.                 {
  60.                     _journal.GoBack();
  61.                 });
  62.             }
  63.         }
  64.         public DelegateCommand GoForward
  65.         {
  66.             get
  67.             {
  68.                 return new DelegateCommand(() =>
  69.                 {
  70.                     _journal.GoForward();
  71.                 });
  72.             }
  73.         }
  74.     }
  75. }

5.Dialog（对话框）

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

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

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

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

  1. using Prism.Commands;
  2. using Prism.Mvvm;
  3. using Prism.Services.Dialogs;
  4. using System;
  5.  
  6. namespace HT.PrismApp.ViewModels
  7. {
  8.     public class MessageDialogViewModel : BindableBase, IDialogAware
  9.     {
  10.         public string Title => "对话框服务";
  11.  
  12.         public event Action<IDialogResult> RequestClose;
  13.  
  14.         public bool CanCloseDialog()
  15.         {
  16.             return true;
  17.         }
  18.         /// <summary>
  19.         /// 对话框关闭时
  20.         /// </summary>
  21.         public void OnDialogClosed()
  22.         {
  23.         }
  24.         /// <summary>
  25.         /// 对话框打开时
  26.         /// </summary>
  27.         /// <param name="parameters"></param>
  28.         public void OnDialogOpened(IDialogParameters parameters)
  29.         {
  30.  
  31.         }
  32.         public DelegateCommand SaveCommand
  33.         {
  34.             get
  35.             {
  36.                 return new DelegateCommand(() =>
  37.                 {
  38.                     RequestClose?.Invoke(new DialogResult(ButtonResult.OK));
  39.                 });
  40.             }
  41.         }
  42.         public DelegateCommand CancelCommand
  43.         {
  44.             get
  45.             {
  46.                 return new DelegateCommand(() =>
  47.                 {
  48.                     RequestClose?.Invoke(new DialogResult(ButtonResult.Cancel));
  49.                 });
  50.             }
  51.         }
  52.     }
  53. }

5.2注册对话框 RegisterDialog

  1. using HT.PrismApp.ViewModels;
  2. using HT.PrismApp.Views;
  3. using Prism.Ioc;
  4. using System.Windows;
  5.  
  6. namespace HT.PrismApp
  7. {
  8.     /// <summary>
  9.     /// Interaction logic for App.xaml
  10.     /// </summary>
  11.     public partial class App
  12.     {
  13.         protected override Window CreateShell()
  14.         {
  15.             return Container.Resolve<MainWindow>();
  16.         }
  17.  
  18.         protected override void RegisterTypes(IContainerRegistry containerRegistry)
  19.         {
  20.             containerRegistry.RegisterDialog<MessageDialog, MessageDialogViewModel>();
  21.         }
  22.     }
  23. }

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

  1. using HT.PrismApp.Views;
  2. using Prism.Commands;
  3. using Prism.Events;
  4. using Prism.Mvvm;
  5. using Prism.Regions;
  6. using Prism.Services.Dialogs;
  7. using System;
  8. using System.Collections.Generic;
  9. using System.Linq;
  10. using System.Text;
  11. using System.Threading.Tasks;
  12. using System.Windows;
  13.  
  14. namespace HT.PrismApp.ViewModels
  15. {
  16.     public class HeaderViewModel : BindableBase
  17.     {
  18.         private IRegionManager _regionManager;
  19.         private IRegionNavigationJournal _journal;
  20.         private IDialogService _dialogService;
  21.         public HeaderViewModel(IRegionManager regionManager, IRegionNavigationJournal journal, IDialogService dialogService)
  22.         {
  23.             _regionManager = regionManager;
  24.             _journal = journal;
  25.             _dialogService= dialogService;
  26.         }
  27.         public DelegateCommand NavigationA
  28.         {
  29.             get
  30.             {
  31.                 return new DelegateCommand(() =>
  32.                 {
  33.                     _regionManager.RequestNavigate("ContentRegion", nameof(ContentView), args =>
  34.                     {
  35.                         //***导航日志
  36.                         _journal = args.Context.NavigationService.Journal;
  37.                     });
  38.                 });
  39.             }
  40.         }
  41.         public DelegateCommand NavigationB
  42.         {
  43.             get
  44.             {
  45.                 return new DelegateCommand(() =>
  46.                 {
  47.                     //使用导航
  48.                     _regionManager.RequestNavigate("ContentRegion", nameof(MenuView), args =>
  49.                     {
  50.                         //***导航日志
  51.                         _journal = args.Context.NavigationService.Journal;
  52.                     });
  53.                 });
  54.             }
  55.         }
  56.         public DelegateCommand GoBack
  57.         {
  58.             get
  59.             {
  60.                 return new DelegateCommand(() =>
  61.                 {
  62.                     _journal.GoBack();
  63.                 });
  64.             }
  65.         }
  66.         public DelegateCommand GoForward
  67.         {
  68.             get
  69.             {
  70.                 return new DelegateCommand(() =>
  71.                 {
  72.                     _journal.GoForward();
  73.                 });
  74.             }
  75.         }
  76.         public DelegateCommand OpenDialog
  77.         {
  78.             get
  79.             {
  80.                 return new DelegateCommand(() =>
  81.                 {
  82.                     _dialogService.ShowDialog(nameof(MessageDialog));
  83.                 });
  84.             }
  85.         }
  86.     }
  87. }

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/神奇cpp/article/detail/869606
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号