0
0

WPF入门到跪下 第十一章 Prism（六）跨模块交互

跨模块交互

一、事件聚合器

Prism中的事件聚合器相当于MvvmToolkit中的

Messenger

，可以进行订阅、发布等。

在Prism框架中，有一些类型对象是一开始就内置在IOC容器中的，例如接下来用到的

IEventAggregator

事件集合器对象。

1、IEventAggregator

IEventAggregator

：Prism框架中的内置于IOC容器中的事件聚合器类型，通过

IEventAggregator

对象可以进行事件的注册以及从IOC容器中获取事件对象。

常用成员

TEventType GetEvent<TEventType>()

：获取容器中指定类型的事件对象。

  • 泛型中指定的事件对象必须是EventBase类型的子类，一般会通过继承EventBase的子类PubSubEvent<TPayload>或PubSubEvent来创建事件类型。

2、PubSubEvent与PubSubEvent

PubSubEvent<TPayload>

：

EventBase

的子类，可以通过泛型来指定发布的信息类型。

常用成员

SubscriptionToken Subscribe(Action<TPayload> action)

：

PubSubEvent<TPayload>

的实例方法，传入有参的

Action

委托（事件执行方法），来订阅事件。

Publish(TPayload payload)

：

PubSubEvent<TPayload>

的实例方法，发布事件，

TPayload

发布的消息对象，要与创建事件类型时，继承

PubSubEvent<TPayload>

所指定的泛型类型一致。

Unsubscribe(Action<TPayload> subscriber)

：

PubSubEvent<TPayload>

的实例方法，取消订阅，只有在订阅时

keepSubscriberReferenceAlive

参数为

true

才需要调用，默认情况下是不需要的。

PubSubEvent

：

EventBase

的子类，可以定义无参事件。

常用成员

SubscriptionToken Subscribe(Action action)

：

PubSubEvent

的实例方法，传入无参

Action

委托（事件执行方法），来订阅事件。

Publish()

：

PubSubEvent

的实例方法，发布事件。

Unsubscribe(Action subscriber)

：

PubSubEvent

的实例方法，取消订阅，只有在订阅时keepSubscriberReferenceAlive参数为

true

才需要调用，默认情况下是不需要的。

3、完整实现

  • 创建事件类型一般会在程序集中新建Events文件夹，将事件类型统一放在里面。如果仅仅是为了发布，而不需要携带任何信息，可以直接继承非范型的PubSubEvent即可。publicclassMessageEvent:PubSubEvent<string>{}
  • ViewModel层中订阅、发布事件通过IEventAggregator的GetEvent<TEventType>()注册或获取IOC容器中指定类型的事件对象。通过PubSubEvent<TPayload>的Subscribe(Action<TPayload> action)方法和Publish(TPayload payload)方法进行事件的订阅与发布。publicclassMainWindowViewModel:BindableBase{privatestring _message;publicstring Message {get{return _message;}set{SetProperty(ref _message,value);}}privateIEventAggregator _eventAggregator;//构造函数方式的IOC依赖注入，注入事件聚合器对象publicMainWindowViewModel(IEventAggregator eventAggregator){ _eventAggregator = eventAggregator;//进行事件的注册及订阅 _eventAggregator.GetEvent<MessageEvent>().Subscribe(EventHandle);}privatevoidEventHandle(string msg){//事件的执行内容 Message = msg;}//定义命令来出发事件（发布）publicICommand BtnCommand {get=>newDelegateCommand(()=>{ _eventAggregator.GetEvent<MessageEvent>().Publish("this is my first prism message");});}}
  • View层中绑定命令，触发事件发布<Window ......><Grid><StackPanel><TextBlock Text="{Binding Message}"/><Button Content="Send message" Command="{Binding BtnCommand}"/></StackPanel></Grid></Window>

4、订阅的参数设置

在订阅时，可以通过

Subscribe

方法，进行以下设置。

设置执行线程

Subscribe(Action<TPayload> action, ThreadOption threadOption)

：threadOption用于设置action在哪种线程上调用，为

ThreadOption

枚举。

  • ThreadOption.PublisherThread：在发布者的执行线程上执行action。
  • ThreadOption.UIThread：不管在哪个线程发布，action都在UI线程中执行。
  • ThreadOption.BackgroundThread：不管在哪个线程发布，action都在新建的后台线程中执行。

订阅卸载

Subscribe(Action<TPayload> action, bool keepSubscriberReferenceAlive)

：keepSubscriberReferenceAlive用于设置当窗口关闭时，是否保持订阅，默认为

false

，也就是当窗口关闭时就会取消action对该事件的订阅，下次打开窗口又重新订阅。设置为

true

时，则保持订阅，会增加一丢丢效率，注意设置为true后要主动调用

Unsubscribe

方法才可以取消订阅。一般使用默认的

false

就可以了。

消息过滤器

Subscribe(Action<TPayload> action, Predicate<TPayload> filter)

：filter用于对发送的消息进行过滤，返回

true

时顺利发送，否则拦截。filter是一个返回

bool

值的带参委托。

  • 注意，无参事件无法设置消息过滤器。
_eventAggregator.GetEvent<MessageEvent>().Subscribe(EventHandle,(msg)=> msg.Contains("我想过滤啥就过滤啥"));

二、弹出窗口

在开发过程中，有些情况需要跨模块弹出窗口，接下来学习一下在View层以外的地方实现窗口的弹出。

1、简单实现

①、创建用户控件

跨模块的窗口弹出，只需要创建窗口的内容即可，也就是用户控件，这里是在Views文件夹下，创建DialogContentView用户控件。

需要注意的是，默认情况下，如果需要对弹出窗口进行样式设置的话，需要通过

prism:Dialog.WindowStyle

来进行设置。

  • 具体代码<UserControlx:Class="Zhaoxi.PrismDialog.Views.DialogContentView"xmlns:prism="http://prismlibrary.com/"......><prism:Dialog.WindowStyle><StyleTargetType="Window"> <Setter Property="Width" Value="500"/> <Setter Property="Height" Value="400"/> <!--设置WindowStyle方式的无边款--> <!--<Setter Property="WindowStyle" Value="None"/> <Setter Property="AllowsTransparency" Value="True"/>--> <!--设置WindowChrome的无边款--> <Setter Property="WindowChrome.WindowChrome"> <Setter.Value> <WindowChrome GlassFrameThickness="-1"/> </Setter.Value> </Setter> </Style></prism:Dialog.WindowStyle></UserControl>

②、创建ViewModel

在ViewModels文件夹中创建DialogContentViewModel类并实现

IDialogAware

接口。

  • 具体代码publicclassDialogContentViewModel:IDialogAware{publicstring Title =>"跨域弹出来的子窗口标题";//关闭弹窗的操作publiceventAction<IDialogResult> RequestClose;//是否允许关闭窗口publicboolCanCloseDialog(){//可以根据情况做一下业务判断returntrue;}//窗口关闭或主动触发RequestClose事件时调用publicvoidOnDialogClosed(){}//窗口打开时调用publicvoidOnDialogOpened(IDialogParameters parameters){}}

③、注册View

在App的

RegisterTypes

方法中通过调用

IContainerRegistry

对象的

RegisterDialog

方法进行DialogContentView的注册

RegisterDialog<TView>(string name = null)

：注册对话类型，可以传入

string

作为使用时的key。

  • 需要注意的是，如果没有传入name参数，使用ShowDialog展示时，则根据注册的对话类型名称来查找。如果传入了name，则必须根据name来查找。
  • 具体代码publicpartialclassApp:PrismApplication{protectedoverrideWindowCreateShell(){return Container.Resolve<Views.MainWindow>();}protectedoverridevoidRegisterTypes(IContainerRegistry containerRegistry){//注册一个窗口类型 containerRegistry.RegisterDialog<Views.DialogContentView>();}}

④、定义弹出窗口命令

通过IOC依赖注入，获得

IDialogService

属性对象。

定义命令，在命令中调用

IDialogService

对象的

ShowDialog

方法来展示串口。

ShowDialog(string name)

：展示模态对话框，如果注册时，指定了对话名称，则根据名称在IOC的对话容器中查找。否则就根据对话类型的名称进行查找。至于对话的父类窗口，默认情况下会自动使用Prism内置的默认窗口对象。

  • Show(string name)：的用法与ShowDialog(string name)用法一样，只不过展示的是非模态对话框。
  • 具体代码publicclassMainWindowViewModel:BindableBase{privatestring _btnContent ="跨域弹窗";publicstring BtnContent {get{return _btnContent;}set{SetProperty(ref _btnContent,value);}}//IOC依赖注入[Dependency]publicIDialogService _dialogService {get;set;}publicICommand BtnCommand {get=>newDelegateCommand(()=>{//展示窗口 _dialogService.ShowDialog("DialogContentView");});}}

⑤、主窗口中绑定命令

  • 具体代码<Window ......><Grid><StackPanel><Button Content="{Binding BtnContent}" Command="{Binding BtnCommand}"/></StackPanel></Grid></Window>

2、注册父类窗口

在上面的实现过程中，我们只创建了用户控件，而用户控件的父类容器，即弹出来的窗口对象则使用了Prism中默认的Dialog窗口。也因此，默认情况下，如果需要对弹出的窗口进行设置，要在用户控件中通过

prism:Dialog.WindowStyle

来进行默认窗口的样式设置。

然而通过

prism:Dialog.WindowStyle

来进行窗口的样式设置的做法本来就不是很符合xaml的设计规范，而且这只能对当前的用户控件起效果，如果有多个控件希望进行统一的窗口样式处理的话，在每个用户控件中都编写一样的代码会显得很冗余。较好的解决方案就是重新创建并设置好一个父类窗体，然后注册到IOC的对话窗口容器中。

成功为对话设置了父类窗口后，父类窗口的样式就可以跟平常的WPF窗口一样直接在XAML中进行设置了。其在XAML中设置的样式的优先级高于

prism:Dialog.WindowStyle

。

①、创建父类窗体

在程序集中新建DialogBase文件夹（文件夹名称并不重要，甚至可以不用创建）并在其中创建DialogWindowBase窗口。

在后台代码实现

IDialogWindow

，简化一下

Result

属性

  • 具体代码xaml代码<Window......WindowStartupLocation="CenterScreen"Background="Transparent"ResizeMode="NoResize"Title="DialogWindowBase"Height="300"Width="500"><WindowChrome.WindowChrome><WindowChromeGlassFrameThickness="-1"/></WindowChrome.WindowChrome><Grid></Grid></Window>后台代码publicpartialclassDialogWindowBase:Window,IDialogWindow{publicDialogWindowBase(){InitializeComponent();}publicIDialogResult Result {get;set;}}

②、注册父类窗体类型

通过

RegisterDialogWindow

进行对话父类窗口类型的注册后，会优先使用，而不会自动使用默认的对话窗口类型对象。

RegisterDialogWindow<TWindow>([string name])

：注册对话的父类窗口类型。

  • 当注册多个父类窗口类型时，可以传入name方便后面展示时通过key来指定窗口类型，需要注意注册时一旦指定了name，展示时就必须要指定name，否则找不到对应的父类窗口对象。

需要注意的是，要进行注册的对话父类窗口的后台代码中都必须实现

IDialogWindow

接口，否则无法注册。

  • 具体代码publicpartialclassApp:PrismApplication{protectedoverrideWindowCreateShell(){return Container.Resolve<Views.MainWindow>();}protectedoverridevoidRegisterTypes(IContainerRegistry containerRegistry){//注册一个对话类型 containerRegistry.RegisterDialog<DialogContentView>();//注册一个对话父类窗口类型 containerRegistry.RegisterDialogWindow<DialogWindowBase>();//还可以注册多个父类窗口类型，然后根据key来指定}}

③、展示窗口

通过IOC依赖注入，获得

IDialogService

属性对象。

定义命令，在命令中调用

IDialogService

对象的

ShowDialog

方法来展示串口。

  • 当注册的对话父类窗口类型只有一个且没有指定名称时，prism会自动去使用，因此只要指定对话类型即可。
  • 具体代码publicclassMainWindowViewModel:BindableBase{......[Dependency]publicIDialogService _dialogService {get;set;}publicICommand BtnCommand {get=>newDelegateCommand(()=>{ _dialogService.ShowDialog("DialogContentView");});}}

3、指定父类窗体

当注册了多个父类窗体时，可以通过名称来区分。

①、注册多个父类窗口

  • 具体代码publicpartialclassApp:PrismApplication{protectedoverrideWindowCreateShell(){return Container.Resolve<Views.MainWindow>();}protectedoverridevoidRegisterTypes(IContainerRegistry containerRegistry){//注册一个对话类型 containerRegistry.RegisterDialog<DialogContentView>("DialogOne"); containerRegistry.RegisterDialog<DialogContentView>("DialogTwo");//这里为了方便就不再创建一个新的用户控件了//注册一个对话父类窗口类型 containerRegistry.RegisterDialogWindow<DialogWindowBase>("windowBase");//可以注册多个父类窗口类型，然后根据key来指定 containerRegistry.RegisterDialogWindow<DialogWindowOne>("windowOne");}}

②、指定展示

需要注意的是，如果注册的对话指定了名称，展示时没有使用匹配的名称会导致找不到而报异常；如果注册的窗体类型都指定了名称，展示时没有指定名称则会使用prism框架中默认的窗体类型。

  • 具体代码publicclassMainWindowViewModel:BindableBase{......[Dependency]publicIDialogService _dialogService {get;set;}publicICommand BtnCommand {get=>newDelegateCommand(()=>{//指定展示的对话及父类窗体 _dialogService.ShowDialog("DialogOne",null,null,"windowBase");});}}

4、数据传递

当需要向弹出窗体的内容（即我们创建的用户控件）传递一些数据的时候，可以通过

ShowDialog

方法来实现。

①、传递数据

ShowDialog(string name, IDialogParameters parameters, Action<IDialogResult> callback, string windowName)

：展示对话窗口。

  • parameters：向对话窗口传递的数据对象。
DialogParameters

：

IDialogParameters

的子类，用法跟字典是一样的，可以用

DialogParameters

对象封装数据后传递给对话窗口。

  • 具体代码publicclassMainWindowViewModel:BindableBase{......[Dependency]publicIDialogService _dialogService {get;set;}publicICommand BtnCommand {get=>newDelegateCommand(()=>{//创建数据载体var dialogParameters =newDialogParameters(); dialogParameters.Add("paramKey","paramValue");//展示窗口并进行数据传递 _dialogService.ShowDialog("DialogOne", dialogParameters,null,"windowBase");});}}

②、数据处理

传递的数据对象会在窗口打开时，传递给对应的

IDialogAware

子类对象（一般就是弹出窗口的ViewModel）的

OnDialogOpened

方法。因此，可以在

OnDialogOpened

方法中对数据进行处理。

  • 具体代码publicclassDialogContentViewModel:BindableBase,IDialogAware{......publicvoidOnDialogOpened(IDialogParameters parameters){ PassValue = parameters.GetValue<string>("paramKey");}privatestring _passValue;publicstring PassValue {get{return _passValue;}set{SetProperty(ref _passValue,value);}}}

5、回调函数

当弹出的窗口关闭时需要执行回调函数，也是通过

ShowDialog

方法来实现的。

①、设置回调函数

ShowDialog(string name, IDialogParameters parameters, Action<IDialogResult> callback, string windowName)

：展示对话窗口。

  • callback：对话窗口的回调函数，为一个接收IDialogResult类型参数的Action对象。设置后会自动挂载到对应的IDialogAware子类对象（一般就是弹出窗口的ViewModel）RequestClose事件上，也就是可以通过RequestClose事件来调用callback回调函数。
  • 需要注意的是RequestClose事件的触发，会先调用窗口的关闭函数，再执行回调函数。对话窗口的正常关闭也会执行回调函数。
  • 具体代码publicclassMainWindowViewModel:BindableBase{......[Dependency]publicIDialogService _dialogService {get;set;}publicICommand BtnCommand {get=>newDelegateCommand(()=>{var dialogParameters =newDialogParameters(); dialogParameters.Add("paramKey","paramValue"); _dialogService.ShowDialog("DialogOne", dialogParameters, DialogCallBack,"windowBase");});}//对话窗口的回调函数privatevoidDialogCallBack(IDialogResult result){//可以根据传过来的result做业务逻辑处理}}

②、调用回调函数
在对应的ViewModel上定义命令，触发

RequestClose

事件。

  • 具体代码publicclassDialogContentViewModel:BindableBase,IDialogAware{......publiceventAction<IDialogResult> RequestClose;publicICommand CallBackCommand {get=>newDelegateCommand(()=>{DialogResult dialogResult =newDialogResult(ButtonResult.OK); RequestClose?.Invoke(dialogResult);});}}
标签： wpf 交互
本文转载自: https://blog.csdn.net/jjailsa/article/details/135972127
版权归原作者 SchuylerEX 所有， 如有侵权，请联系我们删除。
登录后发布评论

“WPF入门到跪下 第十一章 Prism（六）跨模块交互”的评论:

还没有评论
关于作者
...
overfit同步小助手
文章同步
相关阅读

机器人技术在安全领域的重要作用

安全学习记录——网络篇（一）

图腾柱PFC：HP1010为您的电动两轮车之旅提供绿色，高效，安全的动力

单元测试数据库回滚问题

这才是单元测试，之前我们都错了

【C语言基础】：字符函数和字符串函数

ChatGPT-Next-Web SSRF漏洞+XSS漏洞复现(CVE-2023-49785)

文章导航