Prism多Shell

乌龙茶原创2023年10月18日大约 3 分钟

使用Prism时，一个最常见的问题就是登录与主页面切换，启用只有一个Shell，如何切换到另外一个Shell。

Application.Current.MainWindow

通过Application.Current.MainWindow切换登录和主页面

LoginView为登录页面

ShellView为主页面

在Bootstrapper里设置登录页面启动

protected override DependencyObject CreateShell()
{
    return Container.Resolve<LoginView>();
}

登录成功后

注意

代码高亮处缺少时，无法使用IRegionManager中的导航功能

var shellView = _container.Resolve<ShellView>();
RegionManager.SetRegionManager(shellView, _regionManager);
RegionManager.UpdateRegions();
Application.Current.MainWindow.Hide();
Application.Current.MainWindow = shellView;
shellView.Show();

Region

通过Region添加LoginView和MainView

LoginView为登录布局

MainView为主页面布局

ShellView为主页面

在Bootstrapper里设置Shell页面启动

protected override DependencyObject CreateShell()
{
    return Container.Resolve<ShellView>();
}

ShellView页面

<Window x:Class="Regions.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/"
        Title="Shell"
        Width="525"
        Height="350">
    <Grid>
        <ContentControl prism:RegionManager.RegionName="ContentRegion" />
    </Grid>
</Window>

登录成功后

注意

无法在VM构造函数里直接使用_regionManager.Regions["ContentRegion"]

可以替换为_regionManager.RegisterViewWithRegion("ContentRegion", typeof(MainView))

var region = _regionManager.Regions["ContentRegion"];
var hasView = region.GetView(nameof(MainView));
var mainView=_region.Resolve<MainView>()
if (hasView == null)
{
    region.Add(mainView, nameof(MainView));
}
else
{
    region.Activate(hasView);
}

一个潜在的问题在于，登录布局页面与主页面布局大小可能不一致。但是启动时的Shell大小已定。

这里可以使用IEventAggregator，让Shell来调整页面大小。

InitializeShell

LoginView为登录页面

ShellView为主页面

在Bootstrapper里设置Shell页面启动

protected override DependencyObject CreateShell()
{
    return Container.Resolve<ShellView>();
}

在Bootstrapper里初始化Shell，设置登录页启动

protected override void InitializeShell(DependencyObject shell)
{
    var login = new LoginView();
    if (login.DataContext is LoginViewModel ctx)
    {
        ctx.LoginResult += (bool ret,string message) =>
        {
            if (ret)
            {
                base.InitializeShell(shell);
            }
            else
            {
                MessageBox.Show(message);
            }
        };
    }
    if (login.ShowDialog() != true)
    {
        Application.Current.Shutdown(-1);
    }
}

自定义窗体

提示

需要安装预览版的Prism

LoginWindowView:登录窗体载体

LoginView:登录窗体内的用户控件

ShellWindowView:主窗体

登录窗体

登录窗体为一个空白的窗体。

在启动项重写RegisterTypes方法，注入登录窗体和登录用户控件。

protected override void RegisterTypes(IContainerRegistry containerRegistry)
{
    containerRegistry.RegisterDialogWindow<LoginWindowView>();
    containerRegistry.RegisterDialog<LoginView, LoginViewModel>();
}

需要在LoginWindowView.xaml.cs继承IDialogWindow接口

public partial class LoginWindowView: IDialogWindow
{
    public IDialogResult Result { get; set ; }
    public LoginWindowView()
    {
        InitializeComponent();
    }
}

为了实现LoginWindowView里的导航功能，也需要更新RegionManger

public partial class LoginWindowView: IDialogWindow
{
    public IDialogResult Result { get; set ; }

    public LoginWindowView(IRegionManager regionManager)
    {
        InitializeComponent();
        RegionManager.SetRegionManager(this, regionManager);
        RegionManager.UpdateRegions();
    }
}

注入需要的导航用户控件

protected override void RegisterTypes(IContainerRegistry containerRegistry)
{
    containerRegistry.RegisterForNavigation<...>();
}

启动登录窗体

在启动项PrismApplication里重写OnInitialized方法

这里设置了OK代表登录成功，None或者Cancel代表退出登录窗体

protected override async void OnInitialized()
{
    var dialogService = Container.Resolve<IDialogService>();
    var result = await dialogService.ShowDialogAsync(nameof(LoginView));
    switch (result.Result)
    {
        case ButtonResult.OK:
            base.OnInitialized();
            return;
        case ButtonResult.None:
        case ButtonResult.Cancel:
            Environment.Exit(0);
            break;
    }
}

登录用户控件

最后在登录用户控件LoginView的VM里继承BindableBase和IDialogAware

一些通用的对话框代码如下

在CloseDialog方法里添加自己的登录逻辑处理结果

public class LoginViewModel : BindableBase, IDialogAware
{
    private readonly IRegionManager _regionManager;
    private readonly IContainerExtension _container;
    public LoginViewModel(IEventAggregator eventAggregator,
        IRegionManager regionManager,
        IContainerExtension container)
    {
        _eventAggregator = eventAggregator;
        _regionManager = regionManager;
        _container = container;
    }

    private string _title = "登录";
    public string Title
    {
        get { return _title; }
        set { SetProperty(ref _title, value); }
    }

    public DialogCloseListener RequestClose { get; }

    protected virtual void CloseDialog(bool ret)
    {
        ButtonResult result = ButtonResult.None;
        if(ret){
            result=ButtonResult.Ok;
        }else{
            result=ButtonResult.Ignore;
        }
        RaiseRequestClose(new DialogResult(result));
    }

    public virtual void RaiseRequestClose(IDialogResult dialogResult)
    {
        RequestClose.Invoke(dialogResult);
    }

    public virtual bool CanCloseDialog()
    {
        return true;
    }

    public virtual void OnDialogClosed(){}

    public virtual void OnDialogOpened(IDialogParameters parameters){}
}