SuperAPI AI 工具集

wpf-rule-prohibitions

编程与开发

查看项目

更新于 10-18 02:39

技能介绍

用途

wpf-rule-prohibitions 是 wpf-dev-pack 的禁止项规则集,用于在代码生成、代码评审与重构过程中明确列出不得引入的 WPF 与 MVVM 模式。其目标是保证每个项目只保留一条 View 与 ViewModel 的匹配路径,并统一状态管理风格。

规则中涉及的术语(View First / ViewModel First 组合方式、Stateful / Stateless ViewModel)在 docs/TERMINOLOGY.md 中定义。

采用的两条组合路径

按所选 MVVM 框架,仅采用以下一种组合:

  • CommunityToolkit.Mvvm 路径:ViewModel First 组合 + Stateful ViewModel,使用 Mappings.xaml 与隐式 DataTemplate。
  • Prism 9 路径:View First 组合 + Stateful ViewModel,使用 RegisterForNavigation 与 IRegionManager.RequestNavigate。

主要禁止项

P-001:在同一项目中混用其它组合机制

  • P-001-a:禁止使用 Prism 的 ViewModelLocator.AutoWireViewModel,例如禁止在 Window 上写 prism:ViewModelLocator.AutoWireViewModel="True"。它属于 Prism 内部的另一种 View First 组合机制;Prism 路径的唯一匹配机制是 RegisterForNavigation + RequestNavigate,两者并用会形成两条并行匹配路径,增加维护与认知成本。
  • P-001-b:禁止在 View 后台代码中写 DataContext = new XxxViewModel()。在 CommunityToolkit 路径中唯一机制是 Mappings.xaml + 隐式 DataTemplate(ViewModel First),View 自行选择 VM 会破坏单路径策略;在 Prism 路径中同样破坏单路径。
  • P-001-c:禁止在 XAML 中内联声明 DataContext,例如 UserControl.DataContext 中直接写 <vm:XxxViewModel />。理由同 P-001-b,由 View 声明式指定 VM 类型仍属于 View 自选 VM。
  • P-001-d:禁止引入所选框架之外的任何其它 View-VM 匹配机制,如命名约定自动匹配、自定义定位器、基于反射的接线。目的是保证每个项目只有一条匹配路径。

P-002:ViewModel 类中引用 System.Windows.* UI 类型

禁止 ViewModel 类引用 System.Windows.* 下的 UI 类型(Visibility、Brush、ImageSource、Thickness、Window 等)。唯一允许的例外是 System.Windows.Input.ICommand(RelayCommand 与 DelegateCommand 均使用)。理由是保证 ViewModel 可测试性、隔离 WPF 框架依赖,符合“ViewModel 不感知 View”的 MVVM 原则;UI 类型转换应放在 View 层(转换器、触发器、值转换器)。

P-003:Stateless ViewModel + transient IoC 注册

禁止把所有 ViewModel 以 transient 生命周期注册到 IoC 容器,并把 ViewModel 状态委托给外部 Service/Manager。该模式属于 Stateless ViewModel 组合风格,常见于 Stylet、Caliburn.Micro 的推荐实践;wpf-dev-pack 在两条框架路径中统一采用 Stateful ViewModel,Stateless-VM 模式不在本插件范围内。

P-004:在同一项目中混用两条采用路径

禁止在同一项目内同时使用 Mappings.xaml(CommunityToolkit 路径)与 RegisterForNavigation + IRegionManager(Prism 路径)进行 View-VM 接线。每个项目只选一个 MVVM 框架,所选框架只对应一种匹配机制;混用会导致 View 解析不明确,破坏单匹配路径保证。

快速参考

  • Mappings.xaml 隐式 DataTemplate:ViewModel First(Stateful),采用(CommunityToolkit 路径)。
  • Prism RegisterForNavigation + RequestNavigate("View"):View First(Stateful),采用(Prism 路径)。
  • Prism ViewModelLocator.AutoWireViewModel:禁止(P-001-a)。
  • 后台代码 DataContext = new VM():禁止(P-001-b)。
  • XAML 内联 <UserControl.DataContext>:禁止(P-001-c)。
  • 命名约定 / 反射接线:禁止(P-001-d)。
  • ViewModel 中的 System.Windows.*(ICommand 除外):禁止(P-002)。
  • Stateless VM + transient IoC:禁止(P-003)。
  • 混用 Mappings.xaml 与 Prism RegionManager:禁止(P-004)。

适用场景

适合使用 Claude Code 等 AI 编码工具进行 WPF 项目开发时,作为生成、评审和重构的规则约束使用;也适合团队在选定 CommunityToolkit.Mvvm 或 Prism 9 后统一 MVVM 接线与状态管理方式。

限制

该页面只列出禁止项,不提供具体代码实现示例或迁移步骤。安装方式、收费与平台信息暂未提供。