Prism 启动流程与导航时机详解
这篇笔记回答四个问题:
OnInitialized()是什么,为什么导航要写在它里面Container.Resolve<IRegionManager>().RequestNavigate(...)这行代码到底在做什么- 为什么写在 ShellViewModel 构造函数里就不行
- 原来的写法错在哪,正确写法为什么正确
本文对照的是 Prism.Wpf 8.1.97 的真实源码,不是凭印象的简化版。
一、先看现象
最初的两个文件是这样的:
1 | |
1 | |
运行结果:Shell 窗口出来了,但内容区一片空白,LoginView 没有出现。
这里其实同时埋了两个独立的坑,任何一个都足以让视图显示不出来:
| 坑 | 位置 | 后果 |
|---|---|---|
| 导航时机太早 | ShellViewModel 构造函数 |
区域还没注册,导航找不到目标 |
| 视图类型不对 | LoginView.xaml 用了 Window |
窗口无法作为子内容塞进 ContentControl |
下面逐个说明,重点是第一个——它是理解 Prism 的关键。
二、Prism 的完整启动时间线
1. 源码里到底发生了什么
Prism 的 PrismApplicationBase(你的 App 继承了它的子类 PrismApplication)里,启动流程是这样的:
1 | |
Initialize() 里的顺序(节选关键部分):
1 | |
2. 把时间线翻译成人话
1 | |
关键点全部集中在 ④⑤⑧ 三行的先后关系上:
- ViewModel 的构造函数在 ④,比区域注册(⑤)早。
- 区域注册在 ⑤,比 OnInitialized(⑧)早。
所以构造函数里导航必然失败,OnInitialized 里导航必然成功。
3. 一个容易忽略的细节
OnInitialized() 触发的时候,窗口其实还没显示。因为 Prism 的基类实现是这样的:
1 | |
这反而是一件好事:你在 base.OnInitialized() 之后导航,视图会被填进去,然后窗口第一次显示就已经是登录页了,不会出现「先白一下再跳转」的闪烁。
三、为什么构造函数里导航不行
1. 时序对比
1 | |
1 | |
2. 为什么这个错误特别难查
因为它很可能一声不响。
Prism 的导航失败不会直接抛到你脸上,而是走 NavigationFailed 事件。没人订阅这个事件,失败信息就飘走了。你看到的只有「界面空白」,没有任何报错信息。
这类「没有报错的失败」是最难排查的,所以真正要记住的不是某个 API,而是一条判断方法:
凡是依赖界面状态的代码(导航、找控件、改元素),都不能放在 ViewModel 的构造函数里。
构造函数只该做「不依赖外界」的准备工作:赋值、初始化集合、算初始值。
3. 那 ViewModel 里到底能不能导航
能,但不是构造函数。ViewModel 里导航的典型场景是「用户点了按钮」:
1 | |
四、逐段拆解那两行代码
1 | |
1. protected override void OnInitialized()
| 部分 | 含义 |
|---|---|
protected |
只能被子类访问,Prism 设计成这个样子,因为它属于「框架回调」而不是给外部调的 |
override |
覆写基类的虚方法。基类里已经有一个空的/默认的实现,你写的是「在它那个时机插入自己的代码」 |
void |
没有返回值 |
OnInitialized |
方法名,「初始化完成」的意思。由 Prism 在启动流程末尾自动调用 |
它不是事件,是模板方法。 框架提供「时机」,你填「内容」。这也是为什么你不需要在任何地方调用它——Prism 的 InitializeInternal() 会替你调。
可以重写的方法不止这一个,它们是同一条流水线上的「预留插槽」:
| 方法 | 时机 | 典型用途 |
|---|---|---|
CreateContainerExtension() |
最早 | 换用别的 DI 容器 |
RegisterTypes(IContainerRegistry) |
注册阶段 | 注册服务、RegisterForNavigation |
CreateShell() |
创建主窗口 | Container.Resolve<Shell>() |
InitializeShell(Window) |
窗口已创建 | 极少重写,默认只设 MainWindow |
OnInitialized() |
全部初始化完成 | 首次导航、加载初始数据 |
2. base.OnInitialized() 为什么必须写
因为基类里那一行是显示窗口:
1 | |
你写了 override,就等于把这行覆盖掉了。如果只写自己的导航、忘了 base.OnInitialized(),窗口会创建成功、区域也注册好了、视图也塞进去了——但窗口永远不会显示,程序看起来像卡死。
这条排查经验值得记住:覆盖框架的虚方法时,先看一眼基类做了什么,再决定要不要调用 base。
3. Container 是什么
Container 是 PrismApplicationBase 上的一个属性:
1 | |
- 类型是
IContainerProvider,本质是「依赖注入容器的统一入口」。 - 它是
PrismApplication(也就是你的App类)自带的属性,所以在App里可以直接用,不需要额外注入。 - 在别的类里就没有这个属性了,必须通过构造函数注入
IContainerExtension或别的服务——这也解释了为什么之前的 ShellViewModel 要写一个带参数的构造函数。
4. .Resolve<IRegionManager>() 是什么
Resolve<T>() 是服务定位:告诉容器「按类型给我一个实例」。
1 | |
等价于「把 IRegionManager 的实现类创建好(或取出已有的单例)交给我」。
IRegionManager 是 Prism 的区域管理器接口,职责很清晰:
| 能力 | 方法 | 作用 |
|---|---|---|
| 登记视图 | RegisterViewWithRegion |
视图和区域绑死,区域出现就填充 |
| 导航 | RequestNavigate |
按名字把视图导航进区域,可带参数 |
| 查区域 | Regions、RegionsOf |
拿到区域对象本身 |
注意这里是接口,不是具体类。Prism 默认注册的是 RegionManager 的实现,但你的代码只认接口——将来换实现不用改代码。
5. 为什么这里用 Resolve,而 ViewModel 里却用构造函数注入
两种都叫「拿到依赖」,但适用场景不同:
服务定位 Resolve |
构造函数注入 | |
|---|---|---|
| 写法 | container.Resolve<IX>() |
MyClass(IX x) |
| 依赖是否写在表面上 | 否,藏在方法体里 | 是,构造函数签名一目了然 |
| 适合谁 | 框架层、启动代码、实在没有别的地方能注入时 | 业务类(ViewModel、Service) |
| 缺点 | 依赖关系隐蔽,测试时不好替换 | 类多了要写很多构造函数参数 |
经验法则:能注入就注入,实在不好注入才 Resolve。
App.OnInitialized 是启动流程的末端,没有「被别人注入」的入口,所以这里 Resolve 是合理的。而 ViewModel 由容器创建,天然支持构造函数注入,就应该注入。
6. RequestNavigate 的两个参数
1 | |
| 参数 | 类型 | 含义 |
|---|---|---|
| 第一个 | string |
目标区域的名字,必须和 XAML 里 RegionName 的字符串一致 |
| 第二个 | string / Uri |
要显示的视图的名字,默认就是类型名 |
第二个参数里的 ** "LoginView" ** 是从哪来的? 来自这一行注册:
1 | |
RegisterForNavigation<T>() 做了两件事:
- 把
LoginView注册进容器,需要时能创建出来。 - 给它在导航系统里起了个名字,**默认就是类型名 **
"LoginView"。
如果想自己命名,可以传第二个参数:
1 | |
7. 一个可以改进的细节:字符串魔数
1 | |
第一个参数用了常量,很好;第二个参数还是硬编码字符串。同样的思路可以再推一步:
1 | |
nameof(LoginView) 在编译期就变成字符串 "LoginView",好处和常量一样:视图类改名时它跟着变,不会悄悄失效。
五、三种「把视图放进区域」的方式
| 方式 | 代码 | 时机 | 适用场景 |
|---|---|---|---|
| 绑定式 | RegisterViewWithRegion(区域名, typeof(LoginView)) |
区域一出现就自动填充 | 启动就固定的首页 |
| 主动导航 | RequestNavigate(区域名, "LoginView") |
由你决定什么时候切 | 页面切换、菜单、按钮跳转 |
| 绑定 + 导航混合 | 先注册再导航 | 视情况 | 需要给视图传参数时 |
两种方式的差别一句话:绑定式是「这个位置就显示它」,导航式是「现在跳到它」。
登录页这种「启动必须出现」的场景,其实两种都行。现在的代码用 OnInitialized + RequestNavigate,好处是后面做「登录成功 → 跳到主界面」时,同一套 API 能直接用。
六、原来的写法逐行诊断
1 | |
| 行 | 问题 | 后果 | 改法 |
|---|---|---|---|
构造函数里 RequestNavigate |
时机太早,区域未注册 | 导航失败,且常常没有报错 | 移到 App.OnInitialized() |
注入 IContainerExtension 只为 Resolve |
依赖关系藏在方法体里,视图模型和容器耦合 | 难测试、难读 | ViewModel 需要什么就注入什么(如 IRegionManager) |
private IContainerExtension Container; 字段命名 |
大写开头是属性/类型的惯例,私有字段应小写 | 只是风格问题,不影响运行 | _container 或 container |
视图 LoginView 是 Window |
窗口不能作为子内容 | 即使导航成功也会抛异常 | 根元素改成 UserControl |
另外那条 LoginView.xaml 的 Window 是第二个独立的问题,和时机无关。区域里装的东西必须是能被放进内容容器的元素(UserControl、Grid 等都行),而 Window 是顶层窗口,不能当子控件。判断标准很简单:这个页面是「一整个窗口」还是「窗口里的一块」? 后者一律用 UserControl。
七、现在的正确写法(完整对照)
App.xaml.cs
1 | |
ShellViewModel.cs
1 | |
LoginView.xaml(根元素是 UserControl)
1 | |
八、再往后的两个进阶点
1. 从 ViewModel 里发起导航
用户点登录按钮才跳转,用命令:
1 | |
XAML 里:
1 | |
2. 视图被导航进区域时,能收到通知
视图的 ViewModel 实现 INavigationAware,就能在「进入/返回」时做事:
1 | |
这是后面做多页面切换时一定会用到的接口,先记住名字即可。
九、常见报错与排查
| 现象 | 原因 | 排查 |
|---|---|---|
| 界面空白,无报错 | 导航时机太早 / 视图名对不上 | 把导航移到 OnInitialized,名字用 nameof |
| 抛「Window 必须是树的根」 | 视图用了 Window |
改成 UserControl |
| 抛「无法解析 XXX」 | 视图没 RegisterForNavigation |
检查 RegisterTypes |
| 窗口根本不显示 | OnInitialized 忘了 base.OnInitialized() |
补上 |
| 区域名对不上 | XAML 与 C# 两处字符串不一致 | 统一用 RegionNames 常量 |
| 页面显示但被标题栏压住 | 区域控件铺满整块、层级在后 | 用 Grid.Row 分区 |
十、术语小抄
| 术语 | 含义 |
|---|---|
| Shell | 外壳窗口,只放骨架(标题栏、区域) |
| Region | 区域,界面上的具名插槽 |
| RegionManager | 管理所有区域的服务,负责登记与导航 |
UpdateRegions() |
扫描 RegionName 附加属性、把区域登记下来的动作 |
| Service Locator(服务定位) | 通过容器按类型主动取实例,即 Resolve<T>() |
| 构造函数注入 | 依赖通过构造参数传进来,由容器负责创建 |
| 模板方法 | 框架定义流程、在固定时机调用你重写的方法 |
INavigationAware |
视图进入/离开区域时收到通知的接口 |
| 魔数 | 代码里直接出现的、没有解释的字符串或数字 |
十一、三个动手练习
- 验证 base 的作用:注释掉
base.OnInitialized();,运行。观察窗口是否显示、程序是不是像卡住。再恢复。这一条能让你永远记住基类里藏着Show()。 - 验证时机:把导航改回
ShellViewModel的构造函数,同时在NavigationFailed上订阅一个回调(或用调试器看IRegionManager.Regions.Count),观察区域名到底存不存在。亲眼看到「Count 为 0」比看十篇文章都管用。 - 两种方式对比:把
OnInitialized里的RequestNavigate换成RegisterViewWithRegion(RegionNames.MainRegion, typeof(LoginView)),比较运行效果与代码差异。再想想:如果登录成功后要切到主页,哪种方式更合适。
