Prism IDialogService

1 阅读1分钟

不用 Prism 时,弹窗是这样写的:

var win = new ConfirmWindow();   // 直接 new 一个窗口
win.ShowDialog();

这在普通写法里没问题,但 Prism 用的是 MVVM 模式,它有一条规矩:

ViewModel(写逻辑的地方)不应该知道界面长什么样,更不能直接 new 窗口。

原因是一旦 ViewModel 里出现了 new ConfirmWindow(),逻辑就和界面绑死了:换界面要改逻辑代码,也没法单独测试逻辑。

可业务上又确实需要弹窗(比如点"删除"要先确认),于是矛盾来了:ViewModel 想弹窗,但又不能碰窗口。

IDialogService 就是来解决这个矛盾的中间人。ViewModel 只需要说一句"帮我弹出名叫 ConfirmDialog 的对话框",至于窗口怎么创建、怎么显示、怎么关闭,全由 Prism 负责。

使用方式:

IDialogService 有ShowDialog Show 两种调用方式。

两者的区别

ShowDialog(模态)Show(非模态)
主窗口能否点击不能,必须先关掉对话框能
界面是否卡死不会,对话框正常响应不会
UI 线程是否冻结否否

调用之后的代码什么时候执行

顺序函数含义执行时机谁调用你要写什么
1OnDialogOpened(parameters)初始化方法,接收调用方传入的参数ShowDialog 之后、窗口显示之前,只执行一次Prism 自动调用从 parameters 取数据,赋值给自己的属性
2Title窗口标题栏的文字窗口显示时Prism 自动读取返回一个字符串
3RequestClose事件,通知 Prism 关闭对话框并交出结果由你决定,通常在"确定"”取消"按钮的命令里你自己触发RequestClose?.Invoke(new DialogResult(ButtonResult.OK, 返回参数));
4CanCloseDialog()判断是否允许关闭窗口即将关闭时(触发 RequestClose 或点右上角 X 都会经过)Prism 自动调用返回 true 允许关闭,false 阻止关闭;无特殊要求写 return true;
5OnDialogClosed()关闭后的收尾方法窗口关闭之后、调用方回调执行之前,只执行一次Prism 自动调用释放资源、取消订阅等;没有就留空

5 个成员中只有 RequestClose 需要你主动触发,其余 4 个都是 Prism 在固定时机自动调用,你只负责填写内容。

1. 详细使用:注册对话框

在 App.xaml.cs 里把 View 和 ViewModel 配对注册。View 是一个 UserControl(不是 Window,Prism 会自动套一个窗口)也可以使用windows,注册方式为RegisterDialogWindow

protected override void RegisterTypes(IContainerRegistry containerRegistry)
{
    containerRegistry.RegisterDialog<ConfirmDialog, ConfirmDialogViewModel>();
    // 默认名字就是 "ConfirmDialog",也可以自己起名:
    // containerRegistry.RegisterDialog<ConfirmDialog, ConfirmDialogViewModel>("confirm");

}

2. 对话框的 ViewModel 实现 IDialogAware

public class ConfirmDialogViewModel : BindableBase, IDialogAware
{
    public string Title => "确认";                        // 窗口标题
    public event Action<IDialogResult> RequestClose;      // 调用它来关闭对话框

    private string _message;
    public string Message { get => _message; set => SetProperty(ref _message, value); }

    public DelegateCommand OkCommand { get; }
    public DelegateCommand CancelCommand { get; }

    public ConfirmDialogViewModel()
    {
        OkCommand = new DelegateCommand(() =>
        {
            var p = new DialogParameters { { "result", "用户点了确定" } };
            RequestClose?.Invoke(new DialogResult(ButtonResult.OK, p));
        });
        CancelCommand = new DelegateCommand(() =>
            RequestClose?.Invoke(new DialogResult(ButtonResult.Cancel)));
    }

    public bool CanCloseDialog() => true;                 // 返回 false 可阻止关闭
    public void OnDialogClosed() { }                      // 关闭后做清理
    public void OnDialogOpened(IDialogParameters parameters)   // 打开时接收参数
    {
        Message = parameters.GetValue<string>("message");
    }
}

3. 在调用方注入 IDialogService 并弹出

public class MainViewModel
{
    private readonly IDialogService _dialogService;

    public MainViewModel(IDialogService dialogService)    // 构造函数注入
    {
        _dialogService = dialogService;
    }

    private void Delete()
    {
        var p = new DialogParameters { { "message", "确定要删除吗?" } };

        _dialogService.ShowDialog("ConfirmDialog", p, r =>
        {
            if (r.Result == ButtonResult.OK)
            {
                var text = r.Parameters.GetValue<string>("result");
                // 执行删除...
            }
        });
    }
}

4. ShowDialog三个参数的含义

参数作用对应到对话框那边
name注册时的名字RegisterDialog 的名字
parameters传进去的数据(键值对),不需要可传 nullOnDialogOpened 里接收
callback关闭后的回调,拿到按钮结果和返回数据RequestClose 传出的 DialogResult