WPF Prism介绍和简单实例(基于.net framework)

无熵~

已于 2023-06-01 11:15:50 修改

阅读量6.3k

点赞数 4

分类专栏： WPF 文章标签： wpf

于 2022-03-28 16:59:41 首次发布

本文链接：https://blog.csdn.net/lvxingzhe3/article/details/123796909

版权

WPF 专栏收录该内容

54 篇文章 18 订阅

订阅专栏

Prism框架定义：

Prism为程序设计提供指导,旨在帮助用户更加容易的设计和构建丰富、灵活、易于维护WPF桌面应用程序。Prism使用设计模式（如MVVM,复合视图,事件聚合器），帮助你创建一个松耦合的程序。遵循这些设计模式原则，将目标程序解耦成独立的模块。这些类型的应用程序被称为复合应用程序。

实例链接：https://download.csdn.net/download/lvxingzhe3/85048213

Prism出现背景：

大多数企业级应用程序都是相当复杂的,以至于需要不止一个开发人员,甚至是一个大型包括UI设计人员和本地化人员的开发团队。这时，如何设计程序使得多个开发者或者是多个子团队能够独立有效的开发程序子模块，并且能够在子模块完成之后顺利无缝集成到应用程序中去，是一个相当大的挑战。

一个行之有效的解决方法是将复杂的程序拆分成许多离散的、松耦合的、半独立的组件，并且这些组件能够轻松的在shell中组合成一套解决方案。按这种设计构建的程序通常称为复合程序。
使用复合程序有如下好处：
1、允许由不同的个人或团队进行模块的单独开发、测试和部署;更容易被修改或添加新功能,从而使应用程序更易于扩展和维护。注意,独立开发者也能从复合程序开发中获得好处，因为能够创建更易测试、可维护的应用程序使用复合的方法。
2、提供了一个通用的由许多松耦合的模块支撑UI组件组成的Shell。减少了多个程序员添加同一个新功能到UI时的冲突，使得程序能够呈现出一个统一的外观。
提高了重用性。在代码逻辑和业务逻辑之间提供了一个干净的视点。让你能够更容易的管理组件之间的依赖关系和交互逻辑。
3、能够根据开发者或开发团队的焦点或专业技能不同，分配不同的任务或功能。特定的说，能够让UI和程序的业务逻辑分开。也就是说UI可以更专注的开发丰富的用户界面。
复合程序特别适合创建各种客户端程序系列。例如多个后端系统创建多个终端软件。下图展示了典型的此类复合程序。

Prism关键概念：

Bootstrapper：Bootstrapper组件是用来初始化Prism的组件和服务的。它用来初始化Dependency injection container来书册任何应用程序级的组件和服务。同时他还配置和初始模块目录以及Shell的View和View Model。

Container: 依赖注入容器。
Shell：Shell就是模块的宿主程序。Shell定义了总的布局以及程序结构，但是通常不知道具体寄宿在其中的是什么模块。它通常实现了公共程序服务和基本代码，但是大多数功能和内容则是在模块中实现的。Shell通常也提供了顶层的窗口或者虚拟元素用来承载模块提供的不同UI组件。
Views：View是封装了程序特定特性或功能的UI控件。View使用了MVVM模式来连接UI和后台逻辑代码及数据。View通常封装了UI界面并且定义了用户交互行为，使得View能够脱离功能地更新和替换。视图使用数据绑定来同Model层交互。
View models：View model是封装了程序界面逻辑和状态的类，属于MVVM模式。View model封装了大部分的程序功能。View model定义了属性、命令、事件，View通过数据绑定来访问这些属性、命令和事件。
Models：Model层的类封装程序的数据和业务逻辑，也是MVVM模式中的一部分。Model封装了数据以及任何与数据有关的认证或逻辑规则，以保证数据的完整性和一致性。
Commands：命令封装了程序的功能。使用命令能够让这些功能脱离UI界面地声明和测试。命令能够在View model层定义。Prism提供了DelegateCommand类和CompositeCommand类。CompositeCommand是用来表示一个能够相互调用的命令的集合。
Modules：模块是一些功能的集合，能够被单独地开发、测试和部署。在大多数情况下，模块是被不同的团队开发维护。一个典型的Prism程序是由多个模块组成的。模块用来表示特定业务相关的功能（例如配置文档管理），并且封装实现该功能需要的所有视图，服务，和数据模型。模块也可以用来封装程序中可以重用的通用程序代码或服务（例如登陆或异常管理服务）。
Module catalog：在复合程序中，模块(modules)必须由宿主程序(host application)动态地发现和加载。Prism中，模块目录是用来指定哪些模块需要被加载，加载时按照什么顺序加载。模块目录是有模块管理(module manager)组件和模块加载(module loader)组件使用。为了初始化模块，这两个组件需要下载模块（如果是远程模块的话），加载模块到程序的域中。Prism中可以使用多种方式指定模块目录，直接在代码中编写、使用XAML声明，或者是使用配置文件。如果有必要，你也可以实现一个自定义的模块目录。
Region：Region是一个逻辑占位，在Shell或者是View中定义。Region使得程序UI布局被更新而不需要去更改程序逻辑。许多通用控件可以被当成Region使用，比如ContentControl、ItemsControl、ListBox或者是TabControl。View能够在Region中自动显示或者是编程控制View显示。Prism能够让你通过Region实现导航。Region能够被其他的组件通过RegionManager组件指定位置。RegionManager使用RegionAdapter和RegionBehavior组件来整合显示在指定Region中的View。
Navigation：导航是一个改变程序UI来放映用户和程序交互的结果或者是程序内部状态变化的过程。Prism支持两种导航：一种是基于状态的导航，现有View的状态被更新来实现简单的导航；一种是View-Switching导航，新的View创建，来替换掉原来的View。View-Switching使用URI配合Region来实现灵活的导航。
EventAggregator：复合程序中的组件通常要与其他组件或者服务通过松耦合的方式通信。为了实现这个功能，Prism提供了EventAggregator组件。通过发布-订阅机制，实现组件发布和订阅事件，而不需要互相引用。EventAggregator通常用来支持定义在不同Module中的组件通信。
Dependency injection container：Prism使用依赖注入模式管理组件之间的依赖。依赖注入使得组件之间的依赖能够动态的实现，并且是可扩展，可测试的。Prism支持的依赖注入有Unity和MEF，也可以使用其他的依赖注入容器通过ServiceLocator。
Services：Service封装UI无关的功能，例如登录、异常处理和数据获取。Service能直接在程序中定义或者是在模块中定义。Service通常由Dependency injection container注册，这样能够被其他依赖于Service的组件请求创建。
Controllers：Controller是用来定义结构和初始化将要显示在Region中的View的类。Controller封装了哪些Views将被显示的逻辑。Controller使用View-Switching的导航机制。

Prism被设计成可以使用上述的功能或设计模式，你可以根据需要使用一种或多种。如果你想充分发挥Prism的优点，您通常会使用Prism的许多功能和设计模式相互结合。下面的插图显示了一个典型的Prism应用程序体系结构，展示了Prism的多种功能如何在复合应用程序一起工作。

大部分Prism程序有一个Shell程序和共享服务组成。Shell程序定义了Region来显示顶层的View，共享服务能够被加载的模块访问。Shell定义了一个合适的目录来决定哪些模块将在启动时被加载更合适。同时一个依赖注入容器也被定义，来动态的实现组件依赖。Bootstrapper在程序启动时注册共享服务和组件。

单独的模块封装了程序的部分功能，使用一个单独的呈现模式例如MVVM。当模块被加载时，模块中定义的View会在Shell中定义的Region里显示。在初始化完成之后，用户被导航到各种不同的View去。

一个典型的Prism程序由一个Shell工程和多个Module工程组成。下图展示了使用Prism开发符合程序会用到的活动。

创建Bootstrapper：

Bootstrapper使用Prism Library Services和Unity Container或MEF Container同程序联系起来。每一个程序都创建一个指定的Bootstrapper，通常是继承至UnityBootStrapper或者是MefBootstrapper。下图展示了这种关系。你需要决定使用哪一种来构建模块目录。每个程序至少需要提供一个模块目录和一个Shell。默认情况下，Bootstrapper使用.NET Framwork Trace类记录事件日志。大部分程序会使用自己的日志服务，比如Enterprise Library。程序可以在特定的Bootstrapper中使用特定的日志服务。默认情况下，UnityBootstrapper和MefBootstrapper允许使用Prism Library Service。这些可以在你自定义的Bootstrapper中禁用或者被替换。

Shell定义:

Shell提供给应用程序一个基本的布局。这个布局使用Region定义以便于后续由Module中的View显示。View也能像Shell一样，使用Region定义成可添加内容的区域，如下图所示。Shell通常设置整个程序的外形，包含了程序使用的Style。

创建Module：

Module包含程序特定功能的View和服务。大多数情况下，这些是被包含在不同的程序集中，被不同的团队开发。一个Module是由一个实现了IModule接口的类表示。此类Module，在初始化时注册他们的View和Service而且可能添加一个或多个View到Shell。根据具体情况，你可能需要为你的模型类定义属性或定义模型之间的依赖。

添加模块View到Shell：

Module通过Shell中的Region替换内容。在初始化时，Module通过RegionManager来定位Shell中的Region然后添加一个或多个View到这些Region或者是注册一个或多个将被Region创建View类型。RegionManager负责追踪程序中的Region，是从Bootstrapper实现的核心服务。

项目实例：带导航Prism，MVVM，WPF工程，包含Bootstrapper，Shell，Module，Region，MVVM，Navigation的使用。

Prism框架(MVVM)工程创建步骤：

1、添加Prism库文件

2、Bootstrapper初始化Prism的组件和服务，使用Container添加依赖注入Shell初始界面

3、添加Models、ViewModels、Views文件夹及相关文件

4、添加Module，独立工程模块，使用IModuleCatalog添加

5、Shell添加Region，通过IRegionManager将Module中的页面放进了定义好的Region中

6、添加Navigation等

1.添加Prism库文件，常用库文件如下：

2.Bootstrapper初始化Prism的组件和服务，使用Container添加依赖注入Shell初始界面。去掉App.xaml StartupUri，重写App.xaml.cs。

using BasicRegionNavigation.Views;
using Prism.Ioc;
using Prism.Modularity;
using Prism.Unity;
using System.Windows;

namespace BasicRegionNavigation
{
    /// <summary>
    /// Interaction logic for App.xaml
    /// </summary>
    public partial class App : PrismApplication
    {
        protected override Window CreateShell()
        {
            //Bootstrapper初始化Prism的组件和服务，使用Container添加依赖注入Shell初始界面
            return Container.Resolve<MainWindow>();
        }
        protected override void RegisterTypes(IContainerRegistry containerRegistry)
        {

        }
        protected override void ConfigureModuleCatalog(IModuleCatalog moduleCatalog)
        {
            //使用IModuleCatalog 添加模块
            moduleCatalog.AddModule<ModuleA.ModuleAModule>();
        }
    }
}

using Prism.Ioc;
using Prism.Modularity;
namespace ModuleA
{
    public class ModuleAModule : IModule
    {
        public void OnInitialized(IContainerProvider containerProvider)
        {

        }
        public void RegisterTypes(IContainerRegistry containerRegistry)
        {
            //注册导航模块
            containerRegistry.RegisterForNavigation<ViewA>();
            containerRegistry.RegisterForNavigation<ViewB>();
        }
    }
}

3.添加Models、ViewModels、Views文件夹及相关文件

<!--View-->
<Window x:Class="BasicRegionNavigation.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/"
        prism:ViewModelLocator.AutoWireViewModel="True"
        Title="{Binding Title}" Height="350" Width="525">
    <DockPanel LastChildFill="True">
        <StackPanel Orientation="Horizontal" DockPanel.Dock="Top" Margin="5" >
            <Button Command="{Binding NavigateCommand}" CommandParameter="ViewA" Margin="5">Navigate to View A</Button>
            <Button Command="{Binding NavigateCommand}" CommandParameter="ViewB" Margin="5">Navigate to View B</Button>
        </StackPanel>
        <!--Region-->
        <ContentControl prism:RegionManager.RegionName="ContentRegion" Margin="5"  />
    </DockPanel>
</Window>

<!--ViewModel-->
using System;
using Prism.Commands;
using Prism.Mvvm;
using Prism.Regions;

namespace BasicRegionNavigation.ViewModels
{
    public class MainWindowViewModel : BindableBase
    {
        private readonly IRegionManager _regionManager;
        private string _title = "Prism Unity Application";
        public string Title
        {
            get { return _title; }
            set { SetProperty(ref _title, value); }
        }
        public DelegateCommand<string> NavigateCommand { get; private set; }
        public MainWindowViewModel(IRegionManager regionManager)
        {
            _regionManager = regionManager;

            NavigateCommand = new DelegateCommand<string>(Navigate);
        }
        private void Navigate(string navigatePath)
        {
            if (navigatePath != null)
                _regionManager.RequestNavigate("ContentRegion", navigatePath, NavigationComplete);
        }
        private void NavigationComplete(NavigationResult result)
        {
            System.Windows.MessageBox.Show(String.Format("Navigation to {0} complete. ", result.Context.Uri));
        }
    }
}

4.添加Module，独立工程模块，使用IModuleCatalog添加(在第2步的代码中)

<UserControl x:Class="ModuleA.Views.ViewA"
             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             xmlns:prism="http://prismlibrary.com/"             
             prism:ViewModelLocator.AutoWireViewModel="True">
    <Grid>
        <TextBlock Text="ViewA" FontSize="48" HorizontalAlignment="Center" VerticalAlignment="Center" />
    </Grid>
</UserControl>


using Prism.Ioc;
using Prism.Modularity;
namespace ModuleA
{
    public class ModuleAModule : IModule
    {
        public void OnInitialized(IContainerProvider containerProvider)
        {

        }
        public void RegisterTypes(IContainerRegistry containerRegistry)
        {
            containerRegistry.RegisterForNavigation<ViewA>();
            containerRegistry.RegisterForNavigation<ViewB>();
        }
    }
}

5.Shell添加Region，通过IRegionManager将Module中的页面放进了定义好的Region中(在第3步的代码中)

6.添加Navigation等(在第2步的代码中注册，第3步中使用)

参考：1: Introduction to the Prism Library 5.0 for WPF | Microsoft Docs